openGionopenGion
5.4.3.6

org.opengion.fukurou.util
インタフェース ConnectIF

既知の実装クラスの一覧:
AbstractConnect, FTPConnect, SFTPConnect, SMBConnect

public interface ConnectIF

ConnectIF.java は、サーバーアクセス関連のクラスを共通的に使用するためのインターフェースです。 connect()、action( String command, String localFile, String remoteFile )、disconnect() の 一連処理のメソッドと、setHostUserPass( String host , String user , String pass ) 、getErrMsg() の 簡易的な共通メソッドを用意しています。

変更履歴:
5.1.6.0 (2010/05/01) 新規追加
バージョン
5.0
作成者
Kazuhiko Hasegawa
導入されたバージョン:
JDK5.0,

メソッドの概要
 void action(java.lang.String command, java.lang.String localFile, java.lang.String remoteFile)
          command , localFile , remoteFile を元に、処理を行います。
 void connect()
          サーバーへの接続、ログインを行います。
 void disconnect()
          サーバーとの接続をクローズします。
 java.lang.String getErrMsg()
          処理中に発生したエラーメッセージを取り出します。
 void setDebug(boolean isDebug)
          デバッグ情報の表示可否 を設定します。
 void setDisplay(boolean isDisplay)
          実行状況の表示可否 を設定します。
 void setHostUserPass(java.lang.String host, java.lang.String user, java.lang.String pass)
          サーバーの、ホスト、ユーザー、パスワードを設定します。
 void setMkdirs(boolean isMkdirs)
          それぞれの受け側ファイルにディレクトリを作成するかどうか。
 void setPort(java.lang.String port)
          接続に利用するポート番号を設定します。
 void setTimeout(int timeout)
          Dataタイムアウトを秒で指定します。
 

メソッドの詳細

connect

void connect()
サーバーへの接続、ログインを行います。 このメソッドは、初期化メソッドです。 接続先を変更する場合は、もう一度このメソッドをコールする必要があります。 (そのような場合は、通常、オブジェクトを構築しなおす方がよいと思います。)


action

void action(java.lang.String command,
            java.lang.String localFile,
            java.lang.String remoteFile)
command , localFile , remoteFile を元に、処理を行います。 このメソッドは、connect()メソッド実行後に、呼び出す必要があります。

パラメータ:
command - String GET/PUT/DEL など
localFile - String ローカルのファイル名
remoteFile - String 接続先のファイル名

disconnect

void disconnect()
サーバーとの接続をクローズします。 ログインされている場合は、ログアウトも行います。 コネクトされている場合は、ディスコネクトします。


setHostUserPass

void setHostUserPass(java.lang.String host,
                     java.lang.String user,
                     java.lang.String pass)
サーバーの、ホスト、ユーザー、パスワードを設定します。

パラメータ:
host - String サーバー
user - String ユーザー
pass - String パスワード

setPort

void setPort(java.lang.String port)
接続に利用するポート番号を設定します。

パラメータ:
port - String 接続に利用するポート番号

setMkdirs

void setMkdirs(boolean isMkdirs)
それぞれの受け側ファイルにディレクトリを作成するかどうか。(初期値:true:作成する) -mkdirs=[true/false] は、受け側のファイル(GET時:LOCAL、PUT時:サーバー)に取り込むファイルのディレクトリが 存在しない場合に、作成するかどうかを指定します。(初期値:true) 通常、サーバーに、フォルダ階層を作成してPUTする場合、動的にフォルダ階層を作成したいケースで便利です。 逆に、フォルダは確定しており、指定フォルダ以外に PUT するのはバグっていると事が分かっている場合には false に設定して、存在しないフォルダにPUT しようとすると、エラーになるようにします。

パラメータ:
isMkdirs - boolean 受け側ファイルにディレクトリを作成するかどうか。true:作成する

setTimeout

void setTimeout(int timeout)
Dataタイムアウトを秒で指定します。(初期値:600 [秒]) オリジナルの FTPClient#setDataTimeout( int ) は、ミリ秒でセット しますが、ここのメソッドでは、秒でセットします。

パラメータ:
timeout - int タイムアウト[秒]

setDisplay

void setDisplay(boolean isDisplay)
実行状況の表示可否 を設定します。(初期値 false:表示しない)

パラメータ:
isDisplay - boolean 実行状況の表示可否

setDebug

void setDebug(boolean isDebug)
デバッグ情報の表示可否 を設定します。(初期値 false:表示しない)

パラメータ:
isDebug - boolean デバッグ情報の表示可否

getErrMsg

java.lang.String getErrMsg()
処理中に発生したエラーメッセージを取り出します。

戻り値:
String エラーメッセージ

openGion 5.4.3.6

Webアプリケーションフレームワーク openGion
SourceForge.JPCopyright (c) 2009 The openGion Project.