com.nifty.cloud.ncs.service

クラス StorageClient

java.lang.Object

com.nifty.cloud.ncs.http.HttpClient

com.nifty.cloud.ncs.NiftyCloudClient

com.nifty.cloud.ncs.service.StorageClient

直系の既知のサブクラス:

StorageEncryptionClient

public class StorageClient
extends NiftyCloudClient

ニフクラストレージクライアントです。

フィールドのサマリー

クラスから継承されたフィールド com.nifty.cloud.ncs.http.HttpClient

DEFAULT_ENCODING

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

コンストラクタ

コンストラクタと説明
StorageClient(Credentials credentials) 指定したアクセスキー、シークレットキーを使用してStorageClientを構築します。
StorageClient(Credentials credentials, ClientProperties properties) 指定したアクセスキー、シークレットキー、およびクライアント設定を使用してStorageClientを構築します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	abortMultipartUpload(java.lang.String bucketName, java.lang.String objectName, java.lang.String uploadId) マルチパートアップロードをキャンセルします。
CompleteMultipartUploadResult	completeMultipartUpload(java.lang.String bucketName, java.lang.String objectName, java.lang.String uploadId, java.util.List<PartETag> partETags) マルチパートアップロードを完了します。
java.lang.String	copyObject(NcsObject srcObject, NcsObject destObject) オブジェクトをコピーします。
java.lang.String	copyObject(NcsObject srcObject, NcsObject destObject, Policy policy) オブジェクトをコピーします。
java.lang.String	copyObject(java.lang.String srcBucketName, java.lang.String srcObjectName, java.lang.String destBucketName, java.lang.String destObjectName) オブジェクトをコピーします。
java.lang.String	copyObject(java.lang.String srcBucketName, java.lang.String srcObjectName, java.lang.String destBucketName, java.lang.String destObjectName, Policy policy) オブジェクトをコピーします。
void	deleteBucket(java.lang.String bucketName) 指定したバケットを削除します。
void	deleteObject(java.lang.String bucketName, java.lang.String objectName) 指定したオブジェクトを削除します。
void	getObject(NcsObject object, java.lang.String fileName) NcsObjectにより指定したオブジェクトを取得し、ファイルに保存します。
NcsObject	getObject(java.lang.String bucketName, java.lang.String objectName, long[] range) 指定したオブジェクトをメモリ上に取得します。
void	getObject(java.lang.String bucketName, java.lang.String objectName, long[] range, java.lang.String fileName) 指定したオブジェクトを取得し、ファイルに保存します。
void	getObjectPart(java.lang.String bucketName, java.lang.String objectName, long contentLength, long[] range, java.lang.String fileName)
java.util.List<NcsBucket>	getService() バケット一覧を取得します。
java.util.Map<java.lang.String,java.lang.Object>	headObject(java.lang.String bucketName, java.lang.String objectName) 指定したオブジェクトのメタデータを返却します。
java.lang.String	initiateMultipartUpload(NcsObject object, Policy policy) NcsObject、ACLを指定して、マルチパートアップロードの準備をします。
java.lang.String	initiateMultipartUpload(java.lang.String bucketName, java.lang.String objectName) バケット名、オブジェクト名を指定して、マルチパートアップロードの準備をします。
java.lang.String	initiateMultipartUpload(java.lang.String bucketName, java.lang.String objectName, Policy policy) バケット名、オブジェクト名、ACLを指定して、マルチパートアップロードの準備をします。
ObjectListing	listObjects(java.lang.String bucketName, java.lang.String prefix, java.lang.String marker, java.lang.Integer maxKeys) 指定バケット内のオブジェクト一覧を取得します。
ObjectListing	listObjects(java.lang.String bucketName, java.lang.String delimiter, java.lang.String prefix, java.lang.String marker, java.lang.Integer maxKeys) 指定バケット内のオブジェクト一覧を取得します。
NcsBucket	putBucket(NcsBucket bucket) 指定したバケットを作成します。
NcsBucket	putBucket(NcsBucket bucket, Policy policy) バケット情報とACLを指定してバケットを作成します。
NcsBucket	putBucket(java.lang.String bucketName) 指定した名前のバケットを作成します。
NcsBucket	putBucket(java.lang.String bucketName, Policy policy) バケット名とACLを指定してバケットを作成します。
java.lang.String	putObject(NcsObject object, java.io.File file, Policy policy) NcsObjectおよびファイルを指定してオブジェクトを作成します。
java.lang.String	putObject(NcsObject object, java.io.InputStream input, java.lang.String contentSHA256, java.lang.String contentType, Policy policy) NcsObjectおよび入力ストリームを指定してオブジェクトを作成します。
java.lang.String	putObject(NcsObject object, Policy policy) NcsObjectを指定してディレクトリを作成します。
java.lang.String	putObject(java.lang.String bucketName, java.lang.String objectName, java.io.File file, Policy policy) ファイルを指定してオブジェクトを作成します。
java.lang.String	putObject(java.lang.String bucketName, java.lang.String objectName, java.io.InputStream input, java.lang.String contentSHA256, long contentLength, java.lang.String contentType, Policy policy) 入力ストリームを指定してオブジェクトを作成します。
java.lang.String	putObject(java.lang.String bucketName, java.lang.String objectName, Policy policy) バケット名、オブジェクト名を指定してディレクトリを作成します。
java.lang.String	putObject(java.lang.String bucketName, java.lang.String objectName, java.lang.String fileName, Policy policy) ファイル名を指定してオブジェクトを作成します。
void	setEndpoint(java.lang.String endpoint) ニフクラサービスのエンドポイントを設定します。
PartETag	uploadPart(UploadPartRequest uploadPartRequest) マルチパートアップロードのパートをアップロードします。

クラスから継承されたメソッド com.nifty.cloud.ncs.NiftyCloudClient

execute, getEndpoint, getQueryString, normalizePath, urlEncode

クラスから継承されたメソッド com.nifty.cloud.ncs.http.HttpClient

shutdown

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

StorageClient

public StorageClient(Credentials credentials)

指定したアクセスキー、シークレットキーを使用してStorageClientを構築します。

パラメータ:

credentials - アクセスキー、シークレットキー情報

StorageClient

public StorageClient(Credentials credentials,
                     ClientProperties properties)

指定したアクセスキー、シークレットキー、およびクライアント設定を使用してStorageClientを構築します。

パラメータ:

credentials - アクセスキー、シークレットキー情報

properties - ストレージクライアントの設定

メソッドの詳細

setEndpoint

public void setEndpoint(java.lang.String endpoint)
                 throws java.lang.IllegalArgumentException

ニフクラサービスのエンドポイントを設定します。

オーバーライド:

setEndpoint クラス内 NiftyCloudClient

パラメータ:

endpoint - ニフクラサービスのエンドポイント

例外:

java.lang.IllegalArgumentException

getService

public java.util.List<NcsBucket> getService()
                                     throws NiftyCloudClientException,
                                            NiftyCloudServiceException

バケット一覧を取得します。

戻り値:

NcsBucketのリスト

例外:

NiftyCloudClientException

NiftyCloudServiceException

putBucket

public NcsBucket putBucket(java.lang.String bucketName)
                    throws NiftyCloudClientException,
                           NiftyCloudServiceException

指定した名前のバケットを作成します。

パラメータ:

bucketName - バケット名

戻り値:

作成されたNcsBucket

例外:

NiftyCloudClientException

NiftyCloudServiceException

putBucket

public NcsBucket putBucket(NcsBucket bucket)
                    throws NiftyCloudClientException,
                           NiftyCloudServiceException

指定したバケットを作成します。

パラメータ:

bucket - バケット

戻り値:

作成されたNcsBucket

例外:

NiftyCloudClientException

NiftyCloudServiceException

putBucket

public NcsBucket putBucket(java.lang.String bucketName,
                           Policy policy)
                    throws NiftyCloudClientException,
                           NiftyCloudServiceException

バケット名とACLを指定してバケットを作成します。

パラメータ:

bucketName - バケット名

policy - 設定したいACL(privateのみ指定可能)

戻り値:

作成されたNcsBucket

例外:

NiftyCloudClientException

NiftyCloudServiceException

putBucket

public NcsBucket putBucket(NcsBucket bucket,
                           Policy policy)
                    throws NiftyCloudClientException,
                           NiftyCloudServiceException

バケット情報とACLを指定してバケットを作成します。

パラメータ:

bucket - バケット情報

policy - 設定したいACL(privateのみ指定可能)

戻り値:

作成されたNcsBucket

例外:

NiftyCloudClientException

NiftyCloudServiceException

deleteBucket

public void deleteBucket(java.lang.String bucketName)
                  throws NiftyCloudClientException,
                         NiftyCloudServiceException

指定したバケットを削除します。

パラメータ:

bucketName - 削除したいバケット名

例外:

NiftyCloudClientException

NiftyCloudServiceException

listObjects

public ObjectListing listObjects(java.lang.String bucketName,
                                 java.lang.String prefix,
                                 java.lang.String marker,
                                 java.lang.Integer maxKeys)
                          throws NiftyCloudClientException,
                                 NiftyCloudServiceException

指定バケット内のオブジェクト一覧を取得します。

パラメータ:

bucketName - オブジェクト一覧取得対象のバケット名

prefix - prefixパラメータ

marker - markerパラメータ

maxKeys - max-keysパラメータ

戻り値:

指定バケット内のオブジェクト一覧

例外:

NiftyCloudClientException

NiftyCloudServiceException

listObjects

public ObjectListing listObjects(java.lang.String bucketName,
                                 java.lang.String delimiter,
                                 java.lang.String prefix,
                                 java.lang.String marker,
                                 java.lang.Integer maxKeys)
                          throws NiftyCloudClientException,
                                 NiftyCloudServiceException

指定バケット内のオブジェクト一覧を取得します。

パラメータ:

bucketName - オブジェクト一覧取得対象のバケット名

delimiter - delimiterパラメータ

prefix - prefixパラメータ

marker - markerパラメータ

maxKeys - max-keysパラメータ

戻り値:

指定バケット内のオブジェクト一覧

例外:

NiftyCloudClientException

NiftyCloudServiceException

headObject

public java.util.Map<java.lang.String,java.lang.Object> headObject(java.lang.String bucketName,
                                                                   java.lang.String objectName)
                                                            throws NiftyCloudClientException,
                                                                   NiftyCloudServiceException

指定したオブジェクトのメタデータを返却します。

パラメータ:

bucketName - 取得対象オブジェクトを格納するバケット名

objectName - 取得対象オブジェクト名

戻り値:

取得したMetadataを保持するHashMap

例外:

NiftyCloudClientException

NiftyCloudServiceException

getObject

public NcsObject getObject(java.lang.String bucketName,
                           java.lang.String objectName,
                           long[] range)
                    throws NiftyCloudClientException,
                           NiftyCloudServiceException

指定したオブジェクトをメモリ上に取得します。

パラメータ:

bucketName - 取得対象オブジェクトを格納するバケット名

objectName - 取得対象オブジェクト名

range - Rangeヘッダに設定する値

戻り値:

取得したNcsObject

例外:

NiftyCloudClientException

NiftyCloudServiceException

getObject

public void getObject(java.lang.String bucketName,
                      java.lang.String objectName,
                      long[] range,
                      java.lang.String fileName)
               throws NiftyCloudClientException,
                      NiftyCloudServiceException

指定したオブジェクトを取得し、ファイルに保存します。

パラメータ:

bucketName - 取得対象オブジェクトを格納するバケット名

objectName - 取得対象オブジェクト名

range - Rangeヘッダに設定される値

fileName - 保存対象ファイル名

例外:

NiftyCloudClientException

NiftyCloudServiceException

getObject

public void getObject(NcsObject object,
                      java.lang.String fileName)
               throws NiftyCloudClientException,
                      NiftyCloudServiceException

NcsObjectにより指定したオブジェクトを取得し、ファイルに保存します。

パラメータ:

object - 取得するオブジェクト情報を含むNcsObject

fileName - 保存対象ファイル名

例外:

NiftyCloudClientException

NiftyCloudServiceException

getObjectPart

public void getObjectPart(java.lang.String bucketName,
                          java.lang.String objectName,
                          long contentLength,
                          long[] range,
                          java.lang.String fileName)
                   throws NiftyCloudClientException,
                          NiftyCloudServiceException

例外:

NiftyCloudClientException

NiftyCloudServiceException

putObject

public java.lang.String putObject(java.lang.String bucketName,
                                  java.lang.String objectName,
                                  java.lang.String fileName,
                                  Policy policy)
                           throws NiftyCloudClientException,
                                  NiftyCloudServiceException

ファイル名を指定してオブジェクトを作成します。

パラメータ:

bucketName - 作成対象オブジェクトが格納されるバケット名

objectName - 作成対象オブジェクト名

fileName - アップロードするファイル名

policy - 設定するACL(privateのみ指定可能)

戻り値:

作成したオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

putObject

public java.lang.String putObject(java.lang.String bucketName,
                                  java.lang.String objectName,
                                  java.io.File file,
                                  Policy policy)
                           throws NiftyCloudClientException,
                                  NiftyCloudServiceException

ファイルを指定してオブジェクトを作成します。

パラメータ:

bucketName - 作成対象オブジェクトが格納されるバケット名

objectName - 作成対象オブジェクト名

file - アップロードするファイル

policy - 設定するACL(privateのみ指定可能)

戻り値:

作成したオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

putObject

public java.lang.String putObject(NcsObject object,
                                  java.io.File file,
                                  Policy policy)
                           throws NiftyCloudClientException,
                                  NiftyCloudServiceException

NcsObjectおよびファイルを指定してオブジェクトを作成します。

パラメータ:

object - 作成するオブジェクト情報を含むNcsObject

file - アップロードするファイル

policy - 設定するACL(privateのみ指定可能)

戻り値:

作成したオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

putObject

public java.lang.String putObject(java.lang.String bucketName,
                                  java.lang.String objectName,
                                  java.io.InputStream input,
                                  java.lang.String contentSHA256,
                                  long contentLength,
                                  java.lang.String contentType,
                                  Policy policy)
                           throws NiftyCloudClientException,
                                  NiftyCloudServiceException

入力ストリームを指定してオブジェクトを作成します。

パラメータ:

bucketName - 作成対象オブジェクトが格納されるバケット名

objectName - 作成対象オブジェクト

input - オブジェクトのボディとなる入力ストリーム

contentSHA256 - オブジェクトのボディのSHA256ハッシュ値

contentLength - データサイズ

contentType - コンテンツタイプ

policy - 設定するACL(privateのみ指定可能)

戻り値:

作成したオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

putObject

public java.lang.String putObject(NcsObject object,
                                  java.io.InputStream input,
                                  java.lang.String contentSHA256,
                                  java.lang.String contentType,
                                  Policy policy)
                           throws NiftyCloudClientException,
                                  NiftyCloudServiceException

NcsObjectおよび入力ストリームを指定してオブジェクトを作成します。

パラメータ:

object - 作成するオブジェクトの情報を含むNcsObject

input - オブジェクトのボディとなる入力ストリーム

contentSHA256 - オブジェクトのボディのSHA256ハッシュ値

contentType - コンテンツタイプ

policy - 設定するACL(privateのみ指定可能)

戻り値:

作成したオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

putObject

public java.lang.String putObject(java.lang.String bucketName,
                                  java.lang.String objectName,
                                  Policy policy)
                           throws NiftyCloudClientException,
                                  NiftyCloudServiceException

バケット名、オブジェクト名を指定してディレクトリを作成します。

パラメータ:

bucketName - バケット名

objectName - オブジェクト名

policy - 設定するACL(privateのみ指定可能)

戻り値:

作成したオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

putObject

public java.lang.String putObject(NcsObject object,
                                  Policy policy)
                           throws NiftyCloudClientException,
                                  NiftyCloudServiceException

NcsObjectを指定してディレクトリを作成します。

パラメータ:

object - 作成するオブジェクトの情報を含むNcsObject

policy - 設定するACL(privateのみ指定可能)

戻り値:

作成したオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

copyObject

public java.lang.String copyObject(java.lang.String srcBucketName,
                                   java.lang.String srcObjectName,
                                   java.lang.String destBucketName,
                                   java.lang.String destObjectName)
                            throws NiftyCloudClientException,
                                   NiftyCloudServiceException

オブジェクトをコピーします。

パラメータ:

srcBucketName - コピー元バケット名

srcObjectName - コピー元オブジェクト名

destBucketName - 宛先バケット名

destObjectName - 宛先オブジェクト名

戻り値:

コピーしたオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

copyObject

public java.lang.String copyObject(java.lang.String srcBucketName,
                                   java.lang.String srcObjectName,
                                   java.lang.String destBucketName,
                                   java.lang.String destObjectName,
                                   Policy policy)
                            throws NiftyCloudClientException,
                                   NiftyCloudServiceException

オブジェクトをコピーします。

パラメータ:

srcBucketName - コピー元バケット名

srcObjectName - コピー元オブジェクト名

destBucketName - 宛先バケット名

destObjectName - 宛先オブジェクト名

policy - コピーするオブジェクトのACL(privateのみ指定可能)

戻り値:

コピーしたオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

copyObject

public java.lang.String copyObject(NcsObject srcObject,
                                   NcsObject destObject)
                            throws NiftyCloudClientException,
                                   NiftyCloudServiceException

オブジェクトをコピーします。

パラメータ:

srcObject - コピー元オブジェクトの情報を含むNcsObject

destObject - 宛先オブジェクトの情報を含むNcsObject
メタデータを設定するにはNcsObject.addUserMetadata(String, String)メソッドを使用します。

戻り値:

コピーしたオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

copyObject

public java.lang.String copyObject(NcsObject srcObject,
                                   NcsObject destObject,
                                   Policy policy)
                            throws NiftyCloudClientException,
                                   NiftyCloudServiceException

オブジェクトをコピーします。

パラメータ:

srcObject - コピー元オブジェクトの情報を含むNcsObject

destObject - 宛先オブジェクトの情報を含むNcsObject
メタデータを設定するにはNcsObject.addUserMetadata(String, String)メソッドを使用します。

policy - コピーするオブジェクトのACL(privateのみ指定可能)

戻り値:

コピーしたオブジェクトのMD5ハッシュ値

例外:

NiftyCloudClientException

NiftyCloudServiceException

deleteObject

public void deleteObject(java.lang.String bucketName,
                         java.lang.String objectName)
                  throws NiftyCloudClientException,
                         NiftyCloudServiceException

指定したオブジェクトを削除します。

パラメータ:

bucketName - 削除対象オブジェクトが格納されているバケット名

objectName - 削除対象オブジェクト名

例外:

NiftyCloudClientException

NiftyCloudServiceException

initiateMultipartUpload

public java.lang.String initiateMultipartUpload(java.lang.String bucketName,
                                                java.lang.String objectName)
                                         throws NiftyCloudClientException,
                                                NiftyCloudServiceException

バケット名、オブジェクト名を指定して、マルチパートアップロードの準備をします。

パラメータ:

bucketName - バケット名

objectName - オブジェクト名

戻り値:

マルチパートアップロードの識別ID

例外:

NiftyCloudClientException

NiftyCloudServiceException

initiateMultipartUpload

public java.lang.String initiateMultipartUpload(java.lang.String bucketName,
                                                java.lang.String objectName,
                                                Policy policy)
                                         throws NiftyCloudClientException,
                                                NiftyCloudServiceException

バケット名、オブジェクト名、ACLを指定して、マルチパートアップロードの準備をします。

パラメータ:

bucketName - バケット名

objectName - オブジェクト名

policy - 設定するACL(privateのみ指定可能)

戻り値:

uploadId

例外:

NiftyCloudClientException

NiftyCloudServiceException

initiateMultipartUpload

public java.lang.String initiateMultipartUpload(NcsObject object,
                                                Policy policy)
                                         throws NiftyCloudClientException,
                                                NiftyCloudServiceException

NcsObject、ACLを指定して、マルチパートアップロードの準備をします。

パラメータ:

object - 作成するオブジェクト情報を含むNcsObject

policy - 設定するACL(privateのみ指定可能)

戻り値:

マルチパートアップロードの識別ID

例外:

NiftyCloudClientException

NiftyCloudServiceException

uploadPart

public PartETag uploadPart(UploadPartRequest uploadPartRequest)
                    throws NiftyCloudClientException,
                           NiftyCloudServiceException

マルチパートアップロードのパートをアップロードします。

パラメータ:

uploadPartRequest - アップロードするパート情報を含むUploadPartRequest

戻り値:

パートデータのETag

例外:

NiftyCloudClientException

NiftyCloudServiceException

abortMultipartUpload

public void abortMultipartUpload(java.lang.String bucketName,
                                 java.lang.String objectName,
                                 java.lang.String uploadId)
                          throws NiftyCloudClientException,
                                 NiftyCloudServiceException

マルチパートアップロードをキャンセルします。

パラメータ:

bucketName - バケット名

objectName - オブジェクト名

uploadId - マルチパートアップロードの識別ID

例外:

NiftyCloudClientException

NiftyCloudServiceException

completeMultipartUpload

public CompleteMultipartUploadResult completeMultipartUpload(java.lang.String bucketName,
                                                             java.lang.String objectName,
                                                             java.lang.String uploadId,
                                                             java.util.List<PartETag> partETags)
                                                      throws NiftyCloudClientException,
                                                             NiftyCloudServiceException

マルチパートアップロードを完了します。

パラメータ:

bucketName - バケット名

objectName - オブジェクト名

uploadId - マルチパートアップロードの識別ID

partETags - パートデータ群のETagリスト

戻り値:

CompleteMultipartUploadの結果

例外:

NiftyCloudClientException

NiftyCloudServiceException