パッケージ 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) 新規追加
導入されたバージョン:
JDK5.0,
  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    void
    action(String command, String localFile, String remoteFile)
    command , localFile , remoteFile を元に、処理を行います。
    void
    サーバーへの接続、ログインを行います。
    void
    サーバーとの接続をクローズします。
    処理中に発生したエラーメッセージを取り出します。
    void
    setDebug(boolean isDebug)
    デバッグ情報の表示可否 を設定します(初期値:false:表示しない)。
    void
    setDisplay(boolean isDisplay)
    実行状況の表示可否 を設定します(初期値:false:表示しない)。
    void
    setHostUserPass(String host, String user, String pass)
    サーバーの、ホスト、ユーザー、パスワードを設定します。
    void
    setMkdirs(boolean isMkdirs)
    それぞれの受け側ファイルにディレクトリを作成するかどうか(初期値:true:作成する)。
    void
    接続に利用するポート番号を設定します。
    void
    setTimeout(int timeout)
    Dataタイムアウトを秒で指定します(初期値:600 [秒])。
  • メソッドの詳細

    • connect

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

      void action(String command, String localFile, String remoteFile)
      command , localFile , remoteFile を元に、処理を行います。 このメソッドは、connect()メソッド実行後に、呼び出す必要があります。
      パラメータ:
      command - GET/PUT/DEL など
      localFile - ローカルのファイル名
      remoteFile - 接続先のファイル名
    • disconnect

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

      void setHostUserPass(String host, String user, String pass)
      サーバーの、ホスト、ユーザー、パスワードを設定します。
      パラメータ:
      host - サーバー
      user - ユーザー
      pass - パスワード
    • setPort

      void setPort(String port)
      接続に利用するポート番号を設定します。
      パラメータ:
      port - 接続に利用するポート番号
    • setMkdirs

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

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

      void setDisplay(boolean isDisplay)
      実行状況の表示可否 を設定します(初期値:false:表示しない)。
      パラメータ:
      isDisplay - 実行状況の表示可否
    • setDebug

      void setDebug(boolean isDebug)
      デバッグ情報の表示可否 を設定します(初期値:false:表示しない)。
      パラメータ:
      isDebug - デバッグ情報の表示可否
    • getErrMsg

      処理中に発生したエラーメッセージを取り出します。
      戻り値:
      エラーメッセージ