public final class FTPConnect extends AbstractConnect
FTPConnect.java は、共通的に使用される FTP関連の基本機能を実装した、クラスです。 これは、org.apache.commons.net.ftp.FTPClient をベースに開発されています。 このクラスの実行には、commons-net-ftp-2.0.jar が必要です。 -host=FTPサーバー -user=ユーザー -passwd=パスワード -remoteFile=FTP先のファイル名 を必須設定します。 -localFile=ローカルのファイル名は、必須ではありませんが、-command=DEL の場合にのみ不要であり、 それ以外の command の場合は、必要です。 -mode=[ASCII/BINARY] は、ファイル転送時に、ファイルの種類によって指定します。 ASCIIモードは、OS毎に異なる改行コードを変換して転送します。BINARYモードは、そのままの姿でやり取りします。 -command=[GET/PUT/DEL] は、FTPサーバーに対しての処理の方法を指定します。 GET:FTPサーバーからローカルにファイル転送します(初期値)。 PUT:ローカルファイルをFTPサーバーに PUT(STORE、SAVE、UPLOAD、などと同意語)します。 DEL:FTPサーバーの指定のファイルを削除します。この場合のみ、-localFile 属性の指定は不要です。 -passive=[true/false] は、パッシブモード(ローカルからサーバーへ接続を張る)を利用する場合に宣言します。 初期値は、true:使用する です。 通常のFTPでは、アクティブモードでファイルをやり取りします。これは、クライアント側が、サーバーソケットを オープンし、指定のポートで待ちうけ状態を作り、FTPサーバー側から接続してもらいます。 一般的な企業内では、ファイアウォールの設定等で、外部からの接続を制限しているケースが多く、アクティブモード では、繋がらない場合が、ほとんどです。 このクラスでは、初期値をパッシブモードにすることで、企業内のファイアウォールのある環境でも 接続できるようにしています。 -mkdirs=[true/false] は、受け側のファイル(GET時:LOCAL、PUT時:FTPサーバー)に取り込むファイルのディレクトリが 存在しない場合に、作成するかどうかを指定します(初期値:true)。 通常、FTPサーバーに、フォルダ階層を作成してPUTする場合、動的にフォルダ階層を作成したいケースで便利です。 逆に、フォルダは確定しており、指定フォルダ以外に PUT するのはバグっていると事が分かっている場合には false に設定して、存在しないフォルダにPUT しようとすると、エラーになるようにします。 引数文字列中に空白を含む場合は、ダブルコーテーション("") で括って下さい。 引数文字列の 『=』の前後には、空白は挟めません。必ず、-key=value の様に 繋げてください。
FTPConnect -host=FTPサーバー -user=ユーザー -passwd=パスワード -remoteFile=FTP先のファイル名 [-localFile=ローカルのファイル名] [-mode=[ASCII/BINARY] ] [-command=[GET/PUT/DEL] ] [-passive=[true/false] ] -host=FTPサーバー :接続先のFTPサーバーのアドレスまたは、サーバー名 -user=ユーザー :接続するユーザー名 -passwd=パスワード :接続するユーザーのパスワード -remoteFile=FTP先のファイル名 :接続先のFTPサーバー側のファイル名。PUT,GET 関係なくFTP側として指定します。 [-localFile=ローカルのファイル名] :ローカルのファイル名。PUT,GET 関係なくローカルファイルを指定します。 [-port=ポート ] :接続するサーバーのポートを指定します。 [-mode=[ASCII/BINARY] ] :扱うファイルの種類を指定します(初期値:ASCII) [-command=[GET/PUT/DEL] ] :FTPサーバー側での処理の方法を指定します。 GET:FTP⇒LOCAL、PUT:LOCAL⇒FTP への転送です(初期値:GET) DEL:FTPファイルを削除します。 [-passive=[true/false] ] :パッシブモード(ローカルからサーバーへ接続を張る)を利用するかどうか(初期値:true) (false:アクティブモード(通常のFTPの初期値)で通信します。) [-mkdirs=[true/false] ] :受け側ファイル(GET時:LOCAL、PUT時:FTPサーバー)にディレクトリを作成するかどうか(初期値:true) (false:ディレクトリが無ければ、エラーにします。) [-encode=エンコード名 ] :日本語ファイル名などのエンコード名を指定します(初期値:UTF-8) [-timeout=タイムアウト[秒] ] :Dataタイムアウト(初期値:600 [秒]) [-display=[false/true] ] :trueは、検索状況を表示します(初期値:false) [-debug=[false|true] ] :デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])
5.1.6.0 (2010/05/01) 新規追加 |
コンストラクタと説明 |
---|
FTPConnect()
デフォルトコンストラクター
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected void |
actionDEL(String remoteFile)
command="DEL" が指定されたときの処理を行います。
|
protected void |
actionDELdir(String remoteDir)
command="DELDIR" が指定されたときの処理を行います。
|
protected void |
actionGET(String localFile,
String remoteFile)
command="GET" が指定されたときの処理を行います。
|
protected void |
actionGETdir(String localDir,
String remoteDir)
command="GETDIR" が指定されたときの処理を行います。
|
protected void |
actionPUT(String localFile,
String remoteFile)
command="PUT" が指定されたときの処理を行います。
|
void |
connect()
FTPサーバーへの接続、ログインを行います。
|
void |
disconnect()
FTPサーバーとの接続をクローズします。
|
static void |
main(String[] args)
このクラスの動作確認用の、main メソッドです。
|
void |
setEncode(String encode)
日本語ファイル名などのエンコード名を指定します(初期値:UTF-8)。
|
void |
setMode(String mode)
扱うファイルの種類を指定します (初期値:ASCII)。
|
void |
setPassive(boolean isPassive)
パッシブモードを利用するかどうか(true:パッシブ)を設定します(初期値:true)。
|
action, actionPUTdir, addFile, errAppend, errAppend, getErrMsg, getPort, getPort, makeLocalDir, setDebug, setDisplay, setHostUserPass, setMkdirs, setPort, setTimeout
public void connect()
connect
インタフェース内 ConnectIF
connect
クラス内 AbstractConnect
public void disconnect()
disconnect
インタフェース内 ConnectIF
disconnect
クラス内 AbstractConnect
protected void actionGET(String localFile, String remoteFile) throws IOException
actionGET
クラス内 AbstractConnect
localFile
- ローカルのファイル名remoteFile
- FTP先のファイル名IOException
- 入出力エラーが発生したときprotected void actionGETdir(String localDir, String remoteDir) throws IOException
actionGETdir
クラス内 AbstractConnect
localDir
- ローカルのディレクトリ名remoteDir
- FTP先のディレクトリ名IOException
- 入出力エラーが発生したときprotected void actionPUT(String localFile, String remoteFile) throws IOException
actionPUT
クラス内 AbstractConnect
localFile
- ローカルのファイル名remoteFile
- FTP先のファイル名IOException
- 入出力エラーが発生したときprotected void actionDEL(String remoteFile) throws IOException
actionDEL
クラス内 AbstractConnect
remoteFile
- FTP先のファイル名IOException
- 入出力エラーが発生したときprotected void actionDELdir(String remoteDir) throws IOException
actionDELdir
クラス内 AbstractConnect
remoteDir
- FTP先のディレクトリ名IOException
- 入出力エラーが発生したときpublic void setMode(String mode)
mode
- 扱うファイルの種類を指定します [ASCII/BINARY]public void setPassive(boolean isPassive)
isPassive
- パッシブモードを利用するかどうか。(true:パッシブ)public void setEncode(String encode)
encode
- エンコード名public static void main(String[] args)
args
- コマンド引数配列Webアプリケーションフレームワーク openGionCopyright (c) 2009 The openGion Project.