Packageorg.unbland.net.ftp
Classpublic class FTPCommand


Example


Public Properties
 PropertyDefined by
  instance : FTPCommand
[static][read-only] このクラスのインスタンスです.
FTPCommand
Public Methods
 MethodDefined by
  
abor():String
現在実行中のデータ転送をすべて中止するためのコマンド文字列を生成します.
FTPCommand
  
acct(account:String):String
課金情報を指定するためのコマンド文字列を生成します.
FTPCommand
  
allo(fileBytes:uint, recordOrPageBytes:uint = 0):String
あらかじめサーバー上で指定したバイト分領域を確保するためのコマンド文字列を生成します.
FTPCommand
  
appe(fileName:String):String
サーバへ送信するデータを指定したファイルへ追加するためのコマンド文字列を生成します.
FTPCommand
  
cdup():String
1 つ上位のディレクトリ(親ディレクトリ)をカレントディレクトリとするためのコマンド文字列を生成します.
FTPCommand
  
cwd(directoryName:String):String
指定したディレクトリをカレントディレクトリとするためのコマンド文字列を生成します.
FTPCommand
  
dele(fileName:String):String
指定したファイルを削除するためのコマンド文字列です.
FTPCommand
  
epsv():String
拡張パッシブモードへの移行を指示するためのコマンド文字列を生成します.
FTPCommand
  
help(command:String = null):String
コマンド一覧を表示するためのコマンド文字列を生成します.
FTPCommand
  
list(fileOrDirectoryName:String = null):String
現在のワーキングディレクトリ内のファイル一覧を表示します.
FTPCommand
  
mkd(directoryName:String):String
指定したディレクトリを作成するためのコマンド文字列を生成します.
FTPCommand
  
mode(fileMode:String):String
転送モードを指定するためのコマンド文字列を生成します.
FTPCommand
  
nlst(fileOrDirectoryName:String = null, option:String = null):String
現在のワーキングディレクトリ内のファイル一覧を表示するためのコマンド文字列を生成します.
FTPCommand
  
noop():String
サーバーの稼動を確認するために何もしない命令を実行するためのコマンド文字列を生成します.
FTPCommand
  
pass(password:String):String
パスワードを指定するためのコマンド文字列を生成します.
FTPCommand
  
pasv():String
パッシブモードへの移行を指示するためのコマンド文字列を生成します.
FTPCommand
  
port(ipAndPort:String):String
データコネクションで使用する IP アドレスとポート番号を指示するためのコマンド文字列を生成します.
FTPCommand
  
pwd():String
現在のワーキングディレクトリを表示するためのコマンド文字列を生成します.
FTPCommand
  
quit():String
ログアウトするためのコマンド文字列を生成します.
FTPCommand
  
rein():String
コントロールコネクションをリセットするためのコマンド文字列を生成します.
FTPCommand
  
rest(marker:String):String
ファイル送受信をファイルの途中から行える一種のレジューム（リスタート）機能を提供するためのコマンド文字列を生成します..
FTPCommand
  
retr(fileName:String):String
指定したファイルの内容をサーバから取得するためのコマンド文字列を生成します.
FTPCommand
  
rmd(directoryName:String):String
指定したディレクトリを削除するためのコマンド文字列を生成します.
FTPCommand
  
rnfr(fileName:String):String
指定したファイル名を変更するためのコマンド文字列を生成します.
FTPCommand
  
rnto(fileName:String):String
RNFR の後に実行されるコマンド文字列を生成します.
FTPCommand
  
site(command:String):String
任意の OS コマンドを実行するためのコマンド文字列を生成します.
FTPCommand
  
smnt(fileSystem:String):String
指定した外部や他ディレクトリのファイルシステムをマウントするためのコマンド文字列を生成します.
FTPCommand
  
stat(fileOrDirectoryName:String = null):String
現在のシステムや転送状態の情報を表示するためのコマンド文字列を生成します.
FTPCommand
  
stor(fileName:String):String
指定したファイル名で, サーバへ送信するデータでファイルを作成するためのコマンド文字列を生成します.
FTPCommand
  
stou(fileName:String):String
指定したファイル名で, サーバへ送信するデータでファイルを作成するためのコマンド文字列を生成します.
FTPCommand
  
stru(structureType:String):String
転送するファイルのファイル構造を示すためのコマンド文字列を生成します.
FTPCommand
  
syst():String
システム名を表示するためのコマンド文字列を生成します.
FTPCommand
  
type(fileType:String):String
転送データの形式を指定するためのコマンド文字列を生成します.
FTPCommand
  
user(userName:String):String
指定したユーザー名でログインするためのコマンド文字列を生成します.
FTPCommand
Property detail
instanceproperty
instance:FTPCommand  [read-only]

このクラスのインスタンスです.

Implementation
    public static function get instance():FTPCommand
Method detail
abor()method
public function abor():String

現在実行中のデータ転送をすべて中止するためのコマンド文字列を生成します. データコネクションは破棄されます.

Returns
String — 現在実行中のデータ転送をすべて中止するためのコマンド文字列.
acct()method 
public function acct(account:String):String

課金情報を指定するためのコマンド文字列を生成します. 課金情報は特定のシステムでユーザーの利用状況に合わせた課金のための情報収集を行うことを想定していますが, 実装していない場合も多いです.

Parameters
account:String — 課金情報です.

Returns
String — 課金情報を指定するためのコマンド文字列.
allo()method 
public function allo(fileBytes:uint, recordOrPageBytes:uint = 0):String

あらかじめサーバー上で指定したバイト分領域を確保するためのコマンド文字列を生成します. レコード/ページでも指定しなくてはならない場合は, オプションで指定（必要かどうかは OS に依存）できます.

Parameters
fileBytes:uint — 確保するバイト分領域です.
 
recordOrPageBytes:uint (default = 0) — レコード/ページ用に確保するバイト分領域です.

Returns
String — あらかじめサーバー上で指定したバイト分領域を確保するためのコマンド文字列.
appe()method 
public function appe(fileName:String):String

サーバへ送信するデータを指定したファイルへ追加するためのコマンド文字列を生成します. ファイルが存在していない場合は新規作成します.

Parameters
fileName:String — 対象のファイル名です.

Returns
String — サーバへ送信するデータを指定したファイルへ追加するためのコマンド文字列.
cdup()method 
public function cdup():String

1 つ上位のディレクトリ(親ディレクトリ)をカレントディレクトリとするためのコマンド文字列を生成します.

Returns
String — 1 つ上位のディレクトリ(親ディレクトリ)をカレントディレクトリとするためのコマンド文字列.
cwd()method 
public function cwd(directoryName:String):String

指定したディレクトリをカレントディレクトリとするためのコマンド文字列を生成します. 絶対パスか相対パスが使用できます.

Parameters
directoryName:String — 対象のディレクトリ名です.

Returns
String — 指定したディレクトリをカレントディレクトリとするためのコマンド文字列.
dele()method 
public function dele(fileName:String):String

指定したファイルを削除するためのコマンド文字列です.

Parameters
fileName:String — 対象のファイル名です.

Returns
String — 指定したファイルを削除するためのコマンド文字列.
epsv()method 
public function epsv():String

拡張パッシブモードへの移行を指示するためのコマンド文字列を生成します.

Returns
String — 拡張パッシブモードへの移行を指示するためのコマンド文字列.
help()method 
public function help(command:String = null):String

コマンド一覧を表示するためのコマンド文字列を生成します.

Parameters
command:String (default = null) — ヘルプを表示したいコマンドです.

Returns
String — コマンド一覧を表示するためのコマンド文字列.
list()method 
public function list(fileOrDirectoryName:String = null):String

現在のワーキングディレクトリ内のファイル一覧を表示します. ファイル名やディレクトリ名が指定された場合はそのファイルやディレクトリの内容を示します. NLST との違いは, LIST では属性を含めた詳細情報を表示する点です. ただし, OS に依存した結果かも知れないことに注意が必要です.

Parameters
fileOrDirectoryName:String (default = null) — 対象のファイル名, もしくはディレクトリ名です.

Returns
String — 現在のワーキングディレクトリ内のファイル一覧を表示するためのコマンド文字列.
mkd()method 
public function mkd(directoryName:String):String

指定したディレクトリを作成するためのコマンド文字列を生成します. 絶対パスか相対パスが使用できます.

Parameters
directoryName:String — 対象のディレクトリ名です.

Returns
String — 指定したディレクトリを作成するためのコマンド文字列.
mode()method 
public function mode(fileMode:String):String

転送モードを指定するためのコマンド文字列を生成します. S: ストリーム（バイトストリームによる転送） B: ブロック（転送をブロックごとに行う） C: 圧縮（Run-Length 手法による圧縮） が指定できます. デフォルトはストリームで, それ以外はほとんど使用されることはありません.

Parameters
fileMode:String — ファイルの転送モードです.

Returns
String — 転送モードを指定するためのコマンド文字列.
nlst()method 
public function nlst(fileOrDirectoryName:String = null, option:String = null):String

現在のワーキングディレクトリ内のファイル一覧を表示するためのコマンド文字列を生成します. ファイル名やディレクトリ名が指定された場合は, そのファイルやディレクトリの内容を示します. オプションにより, 詳細表示が行えます.

Parameters
fileOrDirectoryName:String (default = null) — 対象のファイル名, もしくはディレクトリ名です.
 
option:String (default = null) — オプションです.

Returns
String — 現在のワーキングディレクトリ内のファイル一覧を表示するためのコマンド文字列.
noop()method 
public function noop():String

サーバーの稼動を確認するために何もしない命令を実行するためのコマンド文字列を生成します. 常に正常終了します.

Returns
String — サーバーの稼動を確認するために何もしない命令を実行するためのコマンド文字列
pass()method 
public function pass(password:String):String

パスワードを指定するためのコマンド文字列を生成します.

Parameters
password:String — パスワードです.

Returns
String — パスワードを指定するためのコマンド文字列.
pasv()method 
public function pasv():String

パッシブモードへの移行を指示するためのコマンド文字列を生成します. これを受けたサーバはデータコネクションで使用する IP アドレスとポート番号を表示します.

Returns
String — パッシブモードへの移行を指示するためのコマンド文字列.
port()method 
public function port(ipAndPort:String):String

データコネクションで使用する IP アドレスとポート番号を指示するためのコマンド文字列を生成します.

Parameters
ipAndPort:String — データコネクションで使用する IP アドレスとポート番号です.

Returns
String — データコネクションで使用する IP アドレスとポート番号を指示するためのコマンド文字列.
pwd()method 
public function pwd():String

現在のワーキングディレクトリを表示するためのコマンド文字列を生成します.

Returns
String — 現在のワーキングディレクトリを表示するためのコマンド文字列.
quit()method 
public function quit():String

ログアウトするためのコマンド文字列を生成します.

Returns
String — ログアウトするためのコマンド文字列.
rein()method 
public function rein():String

コントロールコネクションをリセットするためのコマンド文字列を生成します. ユーザーは再度ログインしなくてはなりません.

Returns
String — コントロールコネクションをリセットするためのコマンド文字列
rest()method 
public function rest(marker:String):String

ファイル送受信をファイルの途中から行える一種のレジューム（リスタート）機能を提供するためのコマンド文字列を生成します.. ただしこの機能は, マーカーと呼ばれる目印を, 転送モードがブロックか圧縮の場合にのみ任意に挿入して, 指定したマーカーの位置から再開できるという複雑な仕様なので, 仕様通りに実装されている例は少ないです.

Parameters
marker:String — マーカーです.

Returns
String — ファイル送受信をファイルの途中から行える一種のレジューム（リスタート）機能を提供するためのコマンド文字列.
retr()method 
public function retr(fileName:String):String

指定したファイルの内容をサーバから取得するためのコマンド文字列を生成します.

Parameters
fileName:String — 対象のファイル名です.

Returns
String — 指定したファイルの内容をサーバから取得するためのコマンド文字列.
rmd()method 
public function rmd(directoryName:String):String

指定したディレクトリを削除するためのコマンド文字列を生成します. 絶対パスか相対パスが使用できます.

Parameters
directoryName:String — 対象のディレクトリ名です.

Returns
String — 指定したディレクトリを削除するためのコマンド文字列.
rnfr()method 
public function rnfr(fileName:String):String

指定したファイル名を変更するためのコマンド文字列を生成します. 変更元ファイル名の指定であり, RNTO を続けて実行しなくてはなりません.

Parameters
fileName:String — 変更元のファイル名です.

Returns
String — 指定したファイル名を変更するためのコマンド文字列.
rnto()method 
public function rnto(fileName:String):String

RNFR の後に実行されるコマンド文字列を生成します. RNFR コマンドで指定したファイルを, 指定したファイル名に変更します. 変更先ファイル名の指定です.

Parameters
fileName:String — 変更先のファイル名です.

Returns
String — RNFR の後に実行されるコマンド文字列.
site()method 
public function site(command:String):String

任意の OS コマンドを実行するためのコマンド文字列を生成します.

Parameters
command:String — OS コマンドです.

Returns
String — 任意の OS コマンドを実行するためのコマンド文字列.
smnt()method 
public function smnt(fileSystem:String):String

指定した外部や他ディレクトリのファイルシステムをマウントするためのコマンド文字列を生成します. 実装されていないことも多いです.

Parameters
fileSystem:String — ファイルシステムです.

Returns
String — 指定した外部や他ディレクトリのファイルシステムをマウントするためのコマンド文字列.
stat()method 
public function stat(fileOrDirectoryName:String = null):String

現在のシステムや転送状態の情報を表示するためのコマンド文字列を生成します. ファイル/ディレクトリ名が与えられた場合は, その情報を表示します（NLST などとほぼ等価）.

Parameters
fileOrDirectoryName:String (default = null) — 対象のファイル名, もしくはディレクトリ名です.

Returns
String — 現在のシステムや転送状態の情報を表示するためのコマンド文字列.
stor()method 
public function stor(fileName:String):String

指定したファイル名で, サーバへ送信するデータでファイルを作成するためのコマンド文字列を生成します. 同一名のファイルがすでにある場合には上書きします.

Parameters
fileName:String — 対象のファイル名です.

Returns
String — 指定したファイル名で, サーバへ送信するデータでファイルを作成するためのコマンド文字列.
stou()method 
public function stou(fileName:String):String

指定したファイル名で, サーバへ送信するデータでファイルを作成するためのコマンド文字列を生成します. 同一名のファイルがすでにある場合には, 重ならないようなファイル名を自動的に付けて作成します.

Parameters
fileName:String — 対象のファイル名です.

Returns
String — 指定したファイル名で, サーバへ送信するデータでファイルを作成するためのコマンド文字列.
stru()method 
public function stru(structureType:String):String

転送するファイルのファイル構造を示すためのコマンド文字列を生成します. F: ファイル構造（バイト志向の通常のバイナリ） R: レコード構造（シーケンシャルなどのレコードイメージを持ったデータ） P: ページ構造（インデックス化されたページ志向のファイル） が指定できます. これは OS によりファイルシステム上のファイル構造には差異があるためで, この差異を吸収する役目を持っています. デフォルトはファイルで, それ以外はほとんど使用されることはありません.

Parameters
structureType:String — ファイル構造です.

Returns
String — 転送するファイルのファイル構造を示すためのコマンド文字列.
syst()method 
public function syst():String

システム名を表示するためのコマンド文字列を生成します.

Returns
String — システム名を表示するためのコマンド文字列.
type()method 
public function type(fileType:String):String

転送データの形式を指定するためのコマンド文字列を生成します. A: アスキー（テキスト） I: バイナリ（イメージなど） E: EBCDIC などが指定できます.

Parameters
fileType:String — 転送データの形式です.

Returns
String — 転送データの形式を指定するためのコマンド文字列.
user()method 
public function user(userName:String):String

指定したユーザー名でログインするためのコマンド文字列を生成します.

Parameters
userName:String — ユーザー名です.

Returns
String — 指定したユーザー名でログインするためのコマンド文字列.