com.ibm.cloud.objectstorage.services.s3.model.EncryptedInitiateMultipartUploadRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibm-cos-java-sdk-s3 Show documentation
The IBM COS Java SDK for Amazon S3 module holds the client classes that are used for communicating with IBM Cloud Object Storage Service
The newest version!
/*
 * Copyright 2014-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.ibm.cloud.objectstorage.services.s3.model;

import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import com.ibm.cloud.objectstorage.services.s3.AmazonS3Client;
import com.ibm.cloud.objectstorage.services.s3.AmazonS3EncryptionClient;

/**
 * This class is an extension of {@link InitiateMultipartUploadRequest} to allow
 * additional crypto related attributes to be specified.
 * 
 * In particular, this includes the options to
 * 

 * specify encryption material description on a per-request basis;
 * specify whether a new set of encryption material is to be created for the
 * upload or not;
 * 
 * In particular, {@link EncryptedInitiateMultipartUploadRequest} is only
 * recognized by {@link AmazonS3EncryptionClient}.
 * 
 * 
 * If {@link EncryptedInitiateMultipartUploadRequest} is used against the
 * non-encrypting {@link AmazonS3Client}, these additional attributes will be
 * ignored.
 */
public class EncryptedInitiateMultipartUploadRequest extends
        InitiateMultipartUploadRequest implements MaterialsDescriptionProvider, Serializable {
    /**
     * description of encryption materials to be used with this request.
     */
    private Map materialsDescription;
    /**
     * True if a new set of encryption material is to be created; false
     * otherwise. Default is true.
     */
    private boolean createEncryptionMaterial = true;

    public EncryptedInitiateMultipartUploadRequest(String bucketName, String key) {
        super(bucketName, key);
    }

    public EncryptedInitiateMultipartUploadRequest(String bucketName, String key, ObjectMetadata objectMetadata) {
        super(bucketName, key, objectMetadata);
    }

    @Override
    public Map getMaterialsDescription() {
        return materialsDescription;
    }

    /**
     * sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.
     * @param materialsDescription the materialsDescription to set
     */
    public void setMaterialsDescription(Map materialsDescription) {
        this.materialsDescription = materialsDescription == null
                ? null
                : Collections.unmodifiableMap(new HashMap(materialsDescription))
                ;
    }

    /**
     * sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.
     * @param materialsDescription the materialsDescription to set
     */
    public EncryptedInitiateMultipartUploadRequest withMaterialsDescription(Map materialsDescription) {
        setMaterialsDescription(materialsDescription);
        return this;
    }

    /**
     * Returns true if a new set of encryption material is to be created; false
     * otherwise.  Default is true.
     */
    public boolean isCreateEncryptionMaterial() {
        return createEncryptionMaterial;
    }

    /**
     * @param createEncryptionMaterial
     *            true if a new set of encryption material is to be created;
     *            false otherwise.
     */
    public void setCreateEncryptionMaterial(boolean createEncryptionMaterial) {
        this.createEncryptionMaterial = createEncryptionMaterial;
    }

    /**
     * @param createEncryptionMaterial
     *            true if a new set of encryption material is to be created;
     *            false otherwise.
     */
    public EncryptedInitiateMultipartUploadRequest withCreateEncryptionMaterial(
            boolean createEncryptionMaterial) {
        this.createEncryptionMaterial = createEncryptionMaterial;
        return this;
    }
}