org.opengion.hayabusa.io

## インタフェース StorageAPI

- 既知の実装クラスのリスト:
    StorageAPI_bluemix

      public interface StorageAPI

       クラウドストレージ操作用のインターフェイス。

       継承クラスのコンストラクターはコンテナ名とHTTPセッションを持たせます。

  変更履歴:

    5.9.25.0 (2017/10/06) 新規作成

  機能分類
  バージョン
    5.0
  作成者
    T.OTA

- - ### フィールドのサマリー

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

  - ### メソッドのサマリー

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

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

    - #### SESSION_CLOUD_TOKEN

          static final java.lang.String SESSION_CLOUD_TOKEN

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

    - #### FILEINFO_SIZE

          static final java.lang.String FILEINFO_SIZE

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

    - #### FILEINFO_LASTMODIFIED

          static final java.lang.String FILEINFO_LASTMODIFIED

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

  - ### メソッドの詳細

    - #### delete

          void delete(java.lang.String filePath,
                      HttpSession hsession)

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

    - #### copy

          void copy(java.lang.String oldFilePath,
                    java.lang.String newFilePath,
                    HttpSession hsession)

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

    - #### get

          java.io.InputStream get(java.lang.String filePath,
                                  HttpSession hsession)

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

    - #### add

          void add(java.io.InputStream partInputStream,
                   java.lang.String updFolder,
                   java.lang.String updFileName,
                   HttpSession hsession)

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

    - #### rename

          void rename(java.lang.String fileUrl,
                      java.lang.String oldFileName,
                      java.lang.String newFileName,
                      boolean useBackup,
                      HttpSession session)

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

    - #### list

          java.lang.String[] list(java.lang.String startsWith,
                                  HttpSession hsession)

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

    - #### exists

          boolean exists(java.lang.String path,
                         HttpSession hsession)

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

    - #### getInfo

          java.util.Map getInfo(java.lang.String path,
                                HttpSession hsession)

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

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