com.amazonaws.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 aws-java-sdk-s3 Show documentation

The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with Amazon Simple Storage Service

There is a newer version: 1.12.778

Show newest version

/*
 * Copyright 2014-2014 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.amazonaws.services.s3.model;

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

import com.amazonaws.services.s3.AmazonS3Client;
import com.amazonaws.services.s3.AmazonS3EncryptionClient;

/**
 * 
 * This class is an extension of {@link InitiateMultipartUploadRequest} to allow
 * additional encryption material description to be specified on a per-request
 * basis. 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 {
    /**
     * description of encryption materials to be used with this request.
     */
    private Map materialsDescription;
    
    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;
    }
}