パッケージ org.opengion.hayabusa.io

## インタフェース StorageAPI

-     public interface StorageAPI

  クラウドストレージ操作用のインターフェイス。 継承クラスのコンストラクターはコンテナ名とHTTPセッションを持たせます。
  変更履歴:
    5.9.25.0 (2017/10/06) 新規作成
  機能分類
  バージョン
    5.0
  作成者
    T.OTA
  導入されたバージョン:
    JDK7.0

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールド | 説明
    --- | --- | ---
    `static String` | `FILEINFO_LASTMODIFIED` | 最終更新時刻
    `static String` | `FILEINFO_SIZE` | ファイル情報に格納されている値 サイズ
    `static String` | `SESSION_CLOUD_TOKEN` | トークンキー

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド abstractメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `void` | `add​(InputStream partInputStream, String updFolder, String updFileName, jakarta.servlet.http.HttpSession hsession)` | ｱｯﾌﾟﾛｰﾄﾞ。
    `void` | `copy​(String oldFilePath, String newFilePath, jakarta.servlet.http.HttpSession hsession)` | ｺﾋﾟｰ。
    `void` | `delete​(String filePath, jakarta.servlet.http.HttpSession hsession)` | 削除。
    `boolean` | `exists​(String path, jakarta.servlet.http.HttpSession hsession)` | ﾌｧｲﾙ存在ﾁｪｯｸ。
    `InputStream` | `get​(String filePath, jakarta.servlet.http.HttpSession hsession)` | ﾀﾞｳﾝﾛｰﾄﾞ。
    `Map<String,​String>` | `getInfo​(String path, jakarta.servlet.http.HttpSession hsession)` | ﾌｧｲﾙ情報取得。
    `String[]` | `list​(String startsWith, jakarta.servlet.http.HttpSession hsession)` | ﾌｧｲﾙ一覧取得。
    `void` | `rename​(String fileUrl, String oldFileName, String newFileName, boolean useBackup, jakarta.servlet.http.HttpSession session)` | ﾌｧｲﾙ名変更。

- - ### フィールドの詳細

    - #### SESSION_CLOUD_TOKEN

          static final String SESSION_CLOUD_TOKEN

      トークンキー
      関連項目:
        定数フィールド値

    - #### FILEINFO_SIZE

          static final String FILEINFO_SIZE

      ファイル情報に格納されている値 サイズ
      関連項目:
        定数フィールド値

    - #### FILEINFO_LASTMODIFIED

          static final String FILEINFO_LASTMODIFIED

      最終更新時刻
      関連項目:
        定数フィールド値

  - ### メソッドの詳細

    - #### delete

          void delete​(String filePath,
                      jakarta.servlet.http.HttpSession hsession)

      削除。
      パラメータ:
        `filePath` - 削除ﾌｧｲﾙのﾊﾟｽ
        `hsession` - ｾｯｼｮﾝ

    - #### copy

          void copy​(String oldFilePath,
                    String newFilePath,
                    jakarta.servlet.http.HttpSession hsession)

      ｺﾋﾟｰ。
      パラメータ:
        `oldFilePath` - ｺﾋﾟｰ元ﾌｧｲﾙﾊﾟｽ
        `newFilePath` - ｺﾋﾟｰ先ﾌｧｲﾙﾊﾟｽ
        `hsession` - ｾｯｼｮﾝ

    - #### get

          InputStream get​(String filePath,
                          jakarta.servlet.http.HttpSession hsession)

      ﾀﾞｳﾝﾛｰﾄﾞ。
      パラメータ:
        `filePath` - ﾀﾞｳﾝﾛｰﾄﾞ対象のﾌｧｲﾙﾊﾟｽ
        `hsession` - ｾｯｼｮﾝ
      戻り値:
        ストリーム

    - #### add

          void add​(InputStream partInputStream,
                   String updFolder,
                   String updFileName,
                   jakarta.servlet.http.HttpSession hsession)

      ｱｯﾌﾟﾛｰﾄﾞ。
      パラメータ:
        `partInputStream` - ｱｯﾌﾟﾛｰﾄﾞ対象のｽﾄﾘｰﾑ
        `updFolder` - ｱｯﾌﾟﾛｰﾄﾞﾌｫﾙﾀ名
        `updFileName` - ｱｯﾌﾟﾛｰﾄﾞﾌｧｲﾙ名
        `hsession` - ｾｯｼｮﾝ

    - #### rename

          void rename​(String fileUrl,
                      String oldFileName,
                      String newFileName,
                      boolean useBackup,
                      jakarta.servlet.http.HttpSession session)

      ﾌｧｲﾙ名変更。
      パラメータ:
        `fileUrl` - ﾌｧｲﾙﾊﾟｽ
        `oldFileName` - 変更前ﾌｧｲﾙ名
        `newFileName` - 変更後ﾌｧｲﾙ名
        `useBackup` - 変更後ﾌｧｲﾙ名が既に存在する場合のﾊﾞｯｸｱｯﾌﾟ作成ﾌﾗｸﾞ
        `session` - ｾｯｼｮﾝ

    - #### list

          String[] list​(String startsWith,
                        jakarta.servlet.http.HttpSession hsession)

      ﾌｧｲﾙ一覧取得。
      パラメータ:
        `startsWith` - ﾊﾟｽの前方一致
        `hsession` - ｾｯｼｮﾝ
      戻り値:
        ﾌｧｲﾙﾊﾟｽ一覧

    - #### exists

          boolean exists​(String path,
                         jakarta.servlet.http.HttpSession hsession)

      ﾌｧｲﾙ存在ﾁｪｯｸ。
      パラメータ:
        `path` - ﾌｧｲﾙﾊﾟｽ
        `hsession` - ｾｯｼｮﾝ
      戻り値:
        true:存在 false:存在しない

    - #### getInfo

          Map<String,​String> getInfo​(String path,
                                           jakarta.servlet.http.HttpSession hsession)

      ﾌｧｲﾙ情報取得。
      パラメータ:
        `path` - ﾌｧｲﾙﾊﾟｽ
        `hsession` - ｾｯｼｮﾝ
      戻り値:
        ﾌｧｲﾙ情報格納Map