Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2014-2015 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;
 
 
Represents a customer provided key for use with Amazon S3 server-side encryption. Server-side encryption is about data encryption at rest, that is, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. Amazon S3 manages encryption and decryption for you. This class allows you to specify your own encryption key for Amazon S3 to use when encrypting your data on the server-side, instead of allowing Amazon to automatically generate an encryption key for you. For more information on Amazon S3 server-side encryption, see: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html This encryption is done entirely on the server-side. Your data is transmitted to Amazon S3 over a secure SSL connection and then encrypted when it reaches Amazon's servers. The SDK also offers client-side encryption, where the encryption keys and unencrypted data never leave your machines. For more information on client-side encryption for Amazon S3 data, see: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
 
 public class SSECustomerKey {
     private final String base64EncodedKey;
     private String base64EncodedMd5;
     private String algorithm;


    
Constructs a new customer provided server-side encryption key using the specified base64-encoded key material. By default, this is assumed to be an AES-256 key, but the key algorithm can be set through the setAlgorithm(java.lang.String) method. Currently, Amazon S3 only supports AES-256 encryption keys.

Parameters:
base64EncodedKey The base 64 encoded encryption key material.
 
     public SSECustomerKey(String base64EncodedKey) {
         if (base64EncodedKey == null || base64EncodedKey.length() == 0)
             throw new IllegalArgumentException("Encryption key must be specified");
 
         // Default to AES-256 encryption
         this. = ..getAlgorithm();
         this. = base64EncodedKey;
     }

    
Constructs a new customer provided server-side encryption key using the specified raw key material. By default, this is assumed to be an AES-256 key, but the key algorithm can be set through the setAlgorithm(java.lang.String) method. Currently, Amazon S3 only supports AES-256 encryption keys.

Parameters:
rawKeyMaterial The raw bytes of the customer provided encryption key.
 
     public SSECustomerKey(byte[] rawKeyMaterial) {
         if (rawKeyMaterial == null || rawKeyMaterial.length == 0)
             throw new IllegalArgumentException("Encryption key must be specified");
 
         // Default to AES-256 encryption
         this. = ..getAlgorithm();
         this. = Base64.encodeAsString(rawKeyMaterial);
     }

    
Constructs a new customer provided server-side encryption key using the specified SecretKey. By default, this is assumed to be an AES-256 key, but the key algorithm can be set through the setAlgorithm(java.lang.String) method. Currently, Amazon S3 only supports AES-256 encryption keys.

Parameters:
key The customer provided server-side encryption key.
    public SSECustomerKey(SecretKey key) {
        if (key == null)
            throw new IllegalArgumentException("Encryption key must be specified");
        // Default to AES-256 encryption
        this. = ..getAlgorithm();
        this. = Base64.encodeAsString(key.getEncoded());
    }

    
Constructs a new SSECustomerKey instance with key as null.
    private SSECustomerKey() {
        this. = null;
    }


    
Returns the base64-encoded server-side encryption key that was provided in this object's constructor.

Returns:
The base64-encoded server-side encryption key.
    public String getKey() {
        return ;
    }

    
Returns the encryption algorithm to use with this customer-provided server-side encryption key. Currently, "AES256" is the only supported algorithm.

Returns:
The encryption algorithm to use with this customer-provided server-side encryption key.
    public String getAlgorithm() {
        return ;
    }

    
Sets the encryption algorithm to use with this customer-provided server-side encryption key. Currently, "AES256" is the only supported algorithm.

Parameters:
algorithm The server-side encryption algorithm to use with this customer-provided server-side encryption key.
See also:
SSEAlgorithm.AES256
    public void setAlgorithm(String algorithm) {
        this. = algorithm;
    }

    
Sets the encryption algorithm to use with this customer-provided server-side encryption key, and returns this object so that method calls can be chained together. Currently, "AES256" is the only supported algorithm.

Parameters:
algorithm The server-side encryption algorithm to use with this customer-provided server-side encryption key.
Returns:
The updated ServerSideEncryptionKey object, so that method calls may be chained together.
See also:
SSEAlgorithm.AES256
    public SSECustomerKey withAlgorithm(String algorithm) {
        setAlgorithm(algorithm);
        return this;
    }

    
Returns the optional base64-encoded MD5 digest of the encryption key to use when validating the integrity of the transmitted server-side encryption key. If a MD5 digest is not explicitly specified, then it will be automatically calculated.

Returns:
The base64-encoded MD5 digest of this customer-provided server-side encryption key.
    public String getMd5() {
        return ;
    }

    
Sets the optional MD5 digest (base64-encoded) of the encryption key to use when encrypting the object. This will be used as a message integrity check that the key was transmitted without error. If not set, the SDK will fill in this value by calculating the MD5 digest of the secret key, before sending the request.

Parameters:
md5Digest The MD5 digest (base64-encoded) of the encryption key to use when encrypting the object.
    public void setMd5(String md5Digest) {
        this. = md5Digest;
    }

    
Sets the optional MD5 digest (base64-encoded) of the encryption key to use when encrypting the object, and returns the updated object so that additional method calls can be chained together. This will be used as a message integrity check that the key was transmitted without error. If not set, the SDK will fill in this value by calculating the MD5 digest of the secret key, before sending the request.

Parameters:
md5Digest The MD5 digest (base64-encoded) of the encryption key to use when encrypting the object.
Returns:
The updated object, so that additional method calls can be chained together.
    public SSECustomerKey withMd5(String md5Digest) {
        setMd5(md5Digest);
        return this;
    }

    
Constructs a new SSECustomerKey that can be used for generating the presigned URL's. Currently, "AES256" is the only supported algorithm.

Parameters:
algorithm The server-side encryption algorithm to use with this customer-provided server-side encryption key; must not be null.
Throws:
java.lang.IllegalArgumentException if the input parameter is null.
See also:
SSEAlgorithm.AES256
            String algorithm) {
        if (algorithm == null)
            throw new IllegalArgumentException();
        return new SSECustomerKey().withAlgorithm(algorithm);
    }
New to GrepCode? Check out our FAQ X