org.opengion.plugin.cloud

## クラス FileOperation_AWS

- java.lang.Object
- - java.io.File
  - - org.opengion.fukurou.model.FileOperation
    - - org.opengion.fukurou.model.CloudFileOperation
      - - org.opengion.plugin.cloud.FileOperation_AWS

- すべての実装されたインタフェース:
    java.io.Serializable, java.lang.Comparable<java.io.File>

      public class FileOperation_AWS
      extends CloudFileOperation

  FileOperation_AWSは、S3ストレージに対して、 ファイル操作を行うクラスです。 認証は下記の２通りが可能です。 ・実行サーバのEC2のインスタンスに、S3ストレージのアクセス許可を付与する ・システムリソースにアクセスキー・シークレットキー・エンドポイント・レギオンを登録する （CLOUD_STORAGE_S3_ACCESS_KEY、CLOUD_STORAGE_S3_SECRET_KEY、CLOUD_STORAGE_S3_SERVICE_END_POINT、CLOUD_STORAGE_S3_REGION） 注意： バケット名は全ユーザで共有のため、自身のバケット名か、作成されていないバケット名を指定する必要があります。
  関連項目:
    直列化された形式
  変更履歴:

    5.10.8.0 (2019/02/01) 新規作成

  バージョン
    5.0
  作成者
    oota

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

    - ### クラスから継承されたフィールド org.opengion.fukurou.model.CloudFileOperation

      `conBucket, conPath`

    - ### クラスから継承されたフィールド java.io.File

      `pathSeparator, pathSeparatorChar, separator, separatorChar`

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

    コンストラクタ
    コンストラクタと説明
    `FileOperation_AWS(java.lang.String bucket, java.lang.String inPath)` コンストラクター 初期化処理です。

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

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `copy(java.lang.String afPath)` コピー処理 ファイルを指定先に、コピーします。
    `boolean` | `delete()` 削除処理 ファイルを削除します。
    `FileOperation` | `getParentFile()` 親ディレクトリ情報の取得 親のディレクトリを返します。
    `boolean` | `isDirectory()` ディレクトリ判定 ディレクトリの場合は、trueを返します。
    `boolean` | `isFile()` ファイル判定 ファイルの場合は、trueを返します。
    `long` | `lastModified()` 最終更新時刻取得 最終更新時刻を取得します。
    `long` | `length()` ファイルサイズ取得 ファイルサイズを返します。
    `java.io.File[]` | `listFiles(java.io.FileFilter filter)` ファイル一覧取得 パスのファイルとディレクトリ一覧を取得します。
    `java.io.InputStream` | `read()` 読み込み処理 データを読み込み、InputStreamとして、返します。
    `void` | `write(java.io.InputStream is)` 書き込み処理 InputStreamのデータを書き込みます。

    - ### クラスから継承されたメソッド org.opengion.fukurou.model.CloudFileOperation

      `canExecute, canRead, canWrite, createNewFile, deleteOnExit, drawName, drawParent, editPath, exists, filter, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getFreeSpace, getName, getParent, getPath, getTotalSpace, getUsableSpace, isAbsolute, isHidden, isLocal, mkdir, mkdirs, move, renameTo, replaceFileSeparetor, rTrim, setDirTail, setLastModified, setReadable, setReadable, setWritable, setWritable, toByteArray, toString, toURI`

    - ### クラスから継承されたメソッド org.opengion.fukurou.model.FileOperation

      `getBucket, getPlugin, setPlugin`

    - ### クラスから継承されたメソッド java.io.File

      `compareTo, createTempFile, createTempFile, equals, getCanonicalPath, hashCode, list, list, listFiles, listFiles, listRoots, setExecutable, setExecutable, setReadOnly, toPath, toURL`

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

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### FileOperation_AWS

          public FileOperation_AWS(java.lang.String bucket,
                           java.lang.String inPath)

      コンストラクター 初期化処理です。 AWSの認証処理を行います。
      パラメータ:
        `bucket` - バケット
        `inPath` - パス

  - ### メソッドの詳細

    - #### write

          public void write(java.io.InputStream is)
                     throws java.io.IOException

      書き込み処理 InputStreamのデータを書き込みます。
      定義:
        `write` クラス内 `CloudFileOperation`
      パラメータ:
        `is` - 書き込みデータのInputStream
      例外:
        `java.io.IOException` - ファイル関連エラー情報

    - #### read

          public java.io.InputStream read()
                                   throws java.io.FileNotFoundException

      読み込み処理 データを読み込み、InputStreamとして、返します。
      定義:
        `read` クラス内 `CloudFileOperation`
      戻り値:
        読み込みデータのInputStream
      例外:
        `java.io.FileNotFoundException` - ファイル非存在エラー情報

    - #### delete

          public boolean delete()

      削除処理 ファイルを削除します。
      定義:
        `delete` クラス内 `CloudFileOperation`
      戻り値:
        成否フラグ

    - #### copy

          public boolean copy(java.lang.String afPath)

      コピー処理 ファイルを指定先に、コピーします。
      定義:
        `copy` クラス内 `CloudFileOperation`
      パラメータ:
        `afPath` - コピー先
      戻り値:
        成否フラグ

    - #### length

          public long length()

      ファイルサイズ取得 ファイルサイズを返します。
      定義:
        `length` クラス内 `CloudFileOperation`
      戻り値:
        ファイルサイズ

    - #### lastModified

          public long lastModified()

      最終更新時刻取得 最終更新時刻を取得します。
      定義:
        `lastModified` クラス内 `CloudFileOperation`
      戻り値:
        最終更新時刻

    - #### isFile

          public boolean isFile()

      ファイル判定 ファイルの場合は、trueを返します。
      定義:
        `isFile` クラス内 `CloudFileOperation`
      戻り値:
        ファイル判定フラグ

    - #### isDirectory

          public boolean isDirectory()

      ディレクトリ判定 ディレクトリの場合は、trueを返します。
      定義:
        `isDirectory` クラス内 `CloudFileOperation`
      戻り値:
        ディレクトリ判定フラグ

    - #### listFiles

          public java.io.File[] listFiles(java.io.FileFilter filter)

      ファイル一覧取得 パスのファイルとディレクトリ一覧を取得します。
      定義:
        `listFiles` クラス内 `CloudFileOperation`
      パラメータ:
        `filter` - フィルタ情報
      戻り値:
        ファイルとティレクトリ一覧

    - #### getParentFile

          public FileOperation getParentFile()

      親ディレクトリ情報の取得 親のディレクトリを返します。
      定義:
        `getParentFile` クラス内 `CloudFileOperation`
      戻り値:
        親のディレクトリ情報

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