Object Storage Service:追加アップロード (Java SDK V1)

注意事項

• このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスするには、内部エンドポイントを使用します。サポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

• このトピックでは、アクセス認証情報は環境変数から取得されます。アクセス認証情報の設定方法の詳細については、「アクセス認証情報の設定」をご参照ください。

• このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。カスタムドメイン名または Security Token Service (STS) を使用して OSSClient インスタンスを作成する場合は、「一般的なシナリオの設定例」をご参照ください。

• ファイルが存在しない場合、AppendObject API 操作を呼び出すと、追加可能オブジェクトが作成されます。

• ファイルが既に存在する場合：

  • ファイルが追加可能オブジェクトであり、指定された追加位置がファイルの現在の長さと同じである場合、コンテンツはファイルの末尾に追加されます。

  • ファイルが追加可能オブジェクトであっても、指定された追加位置がファイルの現在の長さと異なる場合、PositionNotEqualToLength 例外がスローされます。

  • ファイルが追加可能オブジェクトではない場合 (シンプルアップロードでアップロードされた通常オブジェクトなど)、ObjectNotAppendable 例外がスローされます。

権限

デフォルトでは、Alibaba Cloud アカウントは完全な権限を持っています。Alibaba Cloud アカウント配下の RAM ユーザーまたは RAM ロールには、デフォルトでは権限がありません。Alibaba Cloud アカウントまたはアカウント管理者は、RAM ポリシーまたはバケットポリシーを通じて操作権限を付与する必要があります。

サンプルコード

次のコードは、オブジェクトにデータを追加する方法の例を示しています。

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.AppendObjectRequest;
import com.aliyun.oss.model.AppendObjectResult;
import com.aliyun.oss.model.ObjectMetadata;
import java.io.ByteArrayInputStream;

public class Demo {

    public static void main(String[] args) throws Exception {
        // エンドポイントを設定します。ここでは、中国 (杭州) を例として使用します。必要に応じて値を設定してください。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // バケット名を指定します。例: examplebucket。
        String bucketName = "examplebucket";
        // オブジェクトのフルパスを指定します。フルパスにバケット名を含めることはできません。例: exampledir/exampleobject.txt。
        String objectName = "exampledir/exampleobject.txt";
        String content1 = "Hello OSS A \n";
        String content2 = "Hello OSS B \n";
        String content3 = "Hello OSS C \n";
        // バケットが配置されているリージョンを指定します。たとえば、バケットが中国 (杭州) リージョンにある場合は、リージョンを cn-hangzhou に設定します。
        String region = "cn-hangzhou";

        // OSSClient インスタンスを作成します。
        // OSSClient インスタンスが不要になったら、shutdown メソッドを呼び出してリソースを解放します。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            ObjectMetadata meta = new ObjectMetadata();
            // コンテンツタイプを指定します。
            meta.setContentType("text/plain");
            // オブジェクトの Web ページのキャッシュ動作を指定します。
            //meta.setCacheControl("no-cache");
            // オブジェクトがダウンロードされるときの名前を指定します。
            //meta.setContentDisposition("attachment;filename=oss_download.txt");
            // オブジェクトのコンテンツのエンコード形式を指定します。
            //meta.setContentEncoding(OSSConstants.DEFAULT_CHARSET_NAME);
            // このリクエストヘッダーは、メッセージの内容が送信された内容と一致するかどうかを確認するために使用されます。
            //meta.setContentMD5("ohhnqLBJFiKkPSBO1eNaUA==");
            // 有効期限を指定します。
            //try {
            //    meta.setExpirationTime(DateUtil.parseRfc822Date("Wed, 08 Jul 2022 16:57:01 GMT"));
            //} catch (ParseException e) {
            //    e.printStackTrace();
            //}
            // サーバー側暗号化方式を指定します。この例では、OSS マネージドキー (SSE-OSS) によるサーバー側暗号化が使用されます。
            //meta.setServerSideEncryption(ObjectMetadata.AES_256_SERVER_SIDE_ENCRYPTION);
            // オブジェクトのアクセス権限を指定します。この例では、アクセス権限は非公開に設定されています。
            //meta.setObjectAcl(CannedAccessControlList.Private);
            // オブジェクトのストレージクラスを指定します。
            //meta.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard);
            // 追加可能オブジェクトを作成する際に x-oss-meta-* を追加できます。後続の追加ではこのパラメーターを渡すことはできません。x-oss-meta- で始まるパラメーターを設定すると、そのパラメーターはメタデータと見なされます。
            //meta.setHeader("x-oss-meta-author", "Alice");

            // AppendObjectRequest を使用して複数のパラメーターを設定します。
            AppendObjectRequest appendObjectRequest = new AppendObjectRequest(bucketName, objectName, new ByteArrayInputStream(content1.getBytes()),meta);

            // AppendObjectRequest を使用して単一のパラメーターを設定します。
            // バケット名を設定します。
            //appendObjectRequest.setBucketName(bucketName);
            // オブジェクト名を設定します。
            //appendObjectRequest.setKey(objectName);
            // 追加するコンテンツを設定します。コンテンツは InputStream または File タイプにすることができます。この例では、コンテンツは InputStream タイプです。
            //appendObjectRequest.setInputStream(new ByteArrayInputStream(content1.getBytes()));
            // 追加するコンテンツを設定します。コンテンツは InputStream または File タイプにすることができます。この例では、コンテンツは File タイプです。
            //appendObjectRequest.setFile(new File("D:\\localpath\\examplefile.txt"));
            // ファイルのメタデータを指定します。これは最初の追加でのみ有効です。
            //appendObjectRequest.setMetadata(meta);

            // 最初の追加。
            // ファイルの追加位置を設定します。
            appendObjectRequest.setPosition(0L);
            AppendObjectResult appendObjectResult = ossClient.appendObject(appendObjectRequest);
            // ファイルの 64 ビット CRC 値。
            System.out.println(appendObjectResult.getObjectCRC());

            // 2 回目の追加。
            // nextPosition は、次のリクエストで指定する必要がある位置、つまりファイルの現在の長さを示します。
            appendObjectRequest.setPosition(appendObjectResult.getNextPosition());
            appendObjectRequest.setInputStream(new ByteArrayInputStream(content2.getBytes()));
            appendObjectResult = ossClient.appendObject(appendObjectRequest);

            // 3 回目の追加。
            appendObjectRequest.setPosition(appendObjectResult.getNextPosition());
            appendObjectRequest.setInputStream(new ByteArrayInputStream(content3.getBytes()));
            appendObjectResult = ossClient.appendObject(appendObjectRequest);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

関連ドキュメント

• 追加アップロードの完全なサンプルコードについては、「GitHub サンプル」をご参照ください。

• 追加アップロードの API 操作の詳細については、「AppendObject」をご参照ください。