パッケージ org.springframework.integration.smb.session

クラス SmbSession

java.lang.ObjectSE
org.springframework.integration.smb.session.SmbSession
実装されたすべてのインターフェース:
CloseableSE、AutoCloseableSE、Session<jcifs.smb.SmbFile>
public class SmbSession extends ObjectSE implements Session<jcifs.smb.SmbFile>
CIFS (Common Internet File System) としても知られる Server Message Block (SMB) 用の Session インターフェースの実装。Samba プロジェクトは、SMB の非 Windows 実装を作成することを目指しました。そのため、Samba は SMB とシノニムとして使用されることがよくあります。

SMB は、ファイル、プリンター、その他のネットワークリソースへの共有アクセスを管理するアプリケーション層ネットワークプロトコルです。

詳細については、サーバーメッセージブロックを参照してください。

導入:
6.0
作成者:
Markus Spann, Mark Fisher, Oleg Zhurakousky, Artem Bilan, Prafull Kumar Soni, Gregory Bragg, Adam Jones, Paolo Fosser

  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    SmbSession(SmbShare _smbShare)
    SMB セッションのコンストラクター。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    append(InputStreamSE inputStream, StringSE destination)
    ファイルに追加します。
    void
    close()
    jcifs.smb.SmbFile
    createSmbDirectoryObject(StringSE _path)
    リモートディレクトリを指す SMB ファイルオブジェクトを作成します。
    jcifs.smb.SmbFile
    createSmbFileObject(StringSE _path)
    リモートファイルを指す SMB ファイルオブジェクトを作成します。
    boolean
    exists(StringSE _path)
    リモートリソースが存在するかどうかを確認します。
    boolean
    finalizeRaw()
    Session.readRaw(String) から InputStream を閉じた後に呼び出します。
    ObjectSE
    getClientInstance()
    このセッションの基礎となるクライアントライブラリのクライアントインスタンスを取得します。
    StringSE
    getHostPort()
    このセッションが接続されているホストとポートのペアを返します。
    boolean
    isDirectory(StringSE _path)
    リモートリソースがディレクトリであるかどうかを確認します。
    boolean
    isFile(StringSE _path)
    リモートリソースがファイルであるかどうかを確認します。
    boolean
    isOpen()
    リモートファイルのリストを試行し、エラー条件を確認して、この SMB セッションが開いていて、作業の準備ができているかどうかを確認します。
    jcifs.smb.SmbFile[]
    list(StringSE path)
    指定された SMB リソースの内容を SmbFile オブジェクトの配列として返します。
    StringSE[]
    listNames(StringSE _path)
    指定された SMB リソースの内容を SmbFile ファイル名の配列として返します。
    boolean
    mkdir(StringSE _path)
    指定された リモートパスがまだ存在しない場合は作成します。
    void
    read(StringSE _path, OutputStreamSE _outputStream)
    path で指定された リモートリソースを読み取り、その内容を指定された OutputStreamSE にコピーします。
    InputStreamSE
    readRaw(StringSE source)
    リモートファイルを生の InputStreamSE として取得します。
    boolean
    remove(StringSE _path)
    指定されたパスにあるファイルまたはディレクトリを削除します。
    void
    rename(StringSE _pathFrom, StringSE _pathTo)
    boolean
    rmdir(StringSE directory)
    リモートディレクトリを削除します。
    jcifs.smb.SmbFile
    write(byte[] _contents, StringSE _path)
    バイト配列を リモートロケーションに書き込む簡易メソッド。
    jcifs.smb.SmbFile
    write(FileSE _file, StringSE _path)
    ローカルファイルオブジェクトを リモートの場所に書き込む簡易メソッド。
    void
    write(InputStreamSE _inputStream, StringSE _path)
    指定された InputStreamSE の内容を、パスで指定された リモートリソースに書き込みます。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

    インターフェース org.springframework.integration.file.remote.session.Session から継承されたメソッド

    dirty, test

  • コンストラクターの詳細

    • SmbSession

      public SmbSession(SmbShare _smbShare)
      SMB セッションのコンストラクター。
      パラメーター:
      _smbShare - SMB 共有リソース

  • メソッドの詳細

    • remove

      public boolean remove(StringSE _path) throws IOExceptionSE
      指定されたパスにあるファイルまたはディレクトリを削除します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の remove 
      パラメーター:
      _path - リモートファイルまたはディレクトリへのパス
      戻り値:
      削除が成功した場合は true、リソースが存在しない場合は false
      例外:
      IOExceptionSE - CIFS サーバーから返されたエラー状態について

    • list

      public jcifs.smb.SmbFile[] list(StringSE path) throws IOExceptionSE
      指定された SMB リソースの内容を SmbFile オブジェクトの配列として返します。リモートリソースが存在しない場合は、空の配列が返されます。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の list 
      パラメーター:
      path - リモートディレクトリまたは リモートファイルパスへのパス
      戻り値:
      SmbFile オブジェクトの配列
      例外:
      IOExceptionSE - CIFS サーバーによって返されたエラー状態の場合。

    • listNames

      public StringSE[] listNames(StringSE _path) throws IOExceptionSE
      指定された SMB リソースの内容を SmbFile ファイル名の配列として返します。リモートリソースが存在しない場合は、空の配列が返されます。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の listNames 
      パラメーター:
      _path - リモートディレクトリへのパス
      戻り値:
      SmbFile ファイル名の配列
      例外:
      IOExceptionSE - CIFS サーバーからエラー状態が返された場合、または リモートリソースがディレクトリではない場合。

    • read

      public void read(StringSE _path, OutputStreamSE _outputStream) throws IOExceptionSE
      path で指定された リモートリソースを読み取り、その内容を指定された OutputStreamSE にコピーします。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の read 
      パラメーター:
      _path - リモートファイルへのパス
      _outputStream - 出力ストリーム
      例外:
      IOExceptionSE - CIFS サーバーからエラー状態が返された場合、または リモートリソースがファイルではない場合。

    • write

      public void write(InputStreamSE _inputStream, StringSE _path) throws IOExceptionSE
      指定された InputStreamSE の内容を、パスで指定された リモートリソースに書き込みます。リモートディレクトリは、必要に応じて暗黙的に作成されます。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の write 
      パラメーター:
      _inputStream - 入力ストリーム
      _path - 書き込む リモート (ファイルの) パス
      例外:
      IOExceptionSE - CIFS サーバーから返されたエラー状態について

    • write

      public jcifs.smb.SmbFile write(FileSE _file, StringSE _path) throws IOExceptionSE
      ローカルファイルオブジェクトを リモートの場所に書き込む簡易メソッド。
      パラメーター:
      _file - ローカルファイル
      _path - 書き込み先の リモートパス
      戻り値:
      リモートファイルの SmbFile 
      例外:
      IOExceptionSE - IO 例外

    • write

      public jcifs.smb.SmbFile write(byte[] _contents, StringSE _path) throws IOExceptionSE
      バイト配列を リモートロケーションに書き込む簡易メソッド。
      パラメーター:
      _contents - 書き込む byte[] 
      _path - 書き込み先の リモートファイル
      戻り値:
      リモートファイルの SmbFile 
      例外:
      IOExceptionSE - IO 例外

    • mkdir

      public boolean mkdir(StringSE _path) throws IOExceptionSE
      指定された リモートパスがまだ存在しない場合は作成します。指定されたリソースがパスではなくファイルの場合、そのファイルにつながるすべてのディレクトリを作成します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の mkdir 
      パラメーター:
      _path - 作成する リモートパス
      戻り値:
      常に True (エラー状態は例外によって表されます)
      例外:
      IOExceptionSE - CIFS サーバーから返されたエラー状態について

    • exists

      public boolean exists(StringSE _path) throws IOExceptionSE
      リモートリソースが存在するかどうかを確認します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の exists 
      パラメーター:
      _path - リモートパス
      戻り値:
      存在する場合は true、そうでない場合は false
      例外:
      IOExceptionSE - CIFS サーバーから返されたエラー状態について

    • isFile

      public boolean isFile(StringSE _path) throws IOExceptionSE
      リモートリソースがファイルであるかどうかを確認します。
      パラメーター:
      _path - リモートパス
      戻り値:
      リソースがファイルの場合は true、そうでない場合は false
      例外:
      IOExceptionSE - CIFS サーバーから返されたエラー状態について

    • isDirectory

      public boolean isDirectory(StringSE _path) throws IOExceptionSE
      リモートリソースがディレクトリであるかどうかを確認します。
      パラメーター:
      _path - リモートパス
      戻り値:
      リソースがディレクトリの場合は true、そうでない場合は false
      例外:
      IOExceptionSE - CIFS サーバーから返されたエラー状態について

    • rename

      public void rename(StringSE _pathFrom, StringSE _pathTo) throws IOExceptionSE
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の rename 
      例外:
      IOExceptionSE

    • append

      public void append(InputStreamSE inputStream, StringSE destination) throws IOExceptionSE
      インターフェースからコピーされた説明: Session
      ファイルに追加します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の append 
      パラメーター:
      inputStream - ストリーム。
      destination - 宛先。
      例外:
      IOExceptionSE - IO 例外。

    • rmdir

      public boolean rmdir(StringSE directory) throws IOExceptionSE
      インターフェースからコピーされた説明: Session
      リモートディレクトリを削除します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の rmdir 
      パラメーター:
      directory - ディレクトリ。
      戻り値:
      ディレクトリが削除された場合は true。
      例外:
      IOExceptionSE - IO 例外。

    • readRaw

      public InputStreamSE readRaw(StringSE source) throws IOExceptionSE
      インターフェースからコピーされた説明: Session
      リモートファイルを生の InputStreamSE として取得します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の readRaw 
      パラメーター:
      source - リモートファイルのパス。
      戻り値:
      生の inputStream。
      例外:
      IOExceptionSE - IOException。

    • finalizeRaw

      public boolean finalizeRaw()
      インターフェースからコピーされた説明: Session
      Session.readRaw(String) から InputStream を閉じた後に呼び出します。一部のセッションプロバイダーで必要です。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の finalizeRaw 
      戻り値:
      成功した場合は true。

    • getClientInstance

      public ObjectSE getClientInstance()
      インターフェースからコピーされた説明: Session
      このセッションの基礎となるクライアントライブラリのクライアントインスタンスを取得します。-file、-ftp、-sftp モジュールへの大幅な変更を避けるために Object を返します。これは、別のジェネリクスパラメーターを追加した場合に必要になります。実装では、戻り値の型を絞り込む必要があります。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の getClientInstance 
      戻り値:
      クライアントインスタンス。

    • close

      public void close()
      次で指定:
      インターフェース AutoCloseableSE の close 
      次で指定:
      インターフェース CloseableSE の close 
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の close 

    • isOpen

      public boolean isOpen()
      リモートファイルのリストを試行し、エラー条件を確認して、この SMB セッションが開いていて、作業の準備ができているかどうかを確認します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の isOpen 
      戻り値:
      セッションが開いている場合は true、そうでない場合は false

    • createSmbFileObject

      public jcifs.smb.SmbFile createSmbFileObject(StringSE _path) throws IOExceptionSE
      リモートファイルを指す SMB ファイルオブジェクトを作成します。
      パラメーター:
      _path - リモートファイルパス
      戻り値:
      リモートパスの SmbFile 
      例外:
      IOExceptionSE - IO 例外

    • createSmbDirectoryObject

      public jcifs.smb.SmbFile createSmbDirectoryObject(StringSE _path) throws IOExceptionSE
      リモートディレクトリを指す SMB ファイルオブジェクトを作成します。
      パラメーター:
      _path - リモートディレクトリパス
      戻り値:
      リモートパスの SmbFile 
      例外:
      IOExceptionSE - IO 例外

    • getHostPort

      public StringSE getHostPort()
      インターフェースからコピーされた説明: Session
      このセッションが接続されているホストとポートのペアを返します。
      次で指定:
      インターフェース Session<jcifs.smb.SmbFile> の getHostPort 
      戻り値:
      このセッションが接続されているホスト: ポートのペア。