org.apache.hadoop.fs.s3a

Enum S3AEncryptionMethods

java.lang.Object

java.lang.Enum<S3AEncryptionMethods>

org.apache.hadoop.fs.s3a.S3AEncryptionMethods

All Implemented Interfaces:

Serializable, Comparable<S3AEncryptionMethods>

public enum S3AEncryptionMethods
extends Enum<S3AEncryptionMethods>

This enum is to centralize the encryption methods and the value required in the configuration. There's two enum values for the two client encryption mechanisms the AWS S3 SDK supports, even though these are not currently supported in S3A. This is to aid supporting CSE in some form in future, fundamental issues about file length of encrypted data notwithstanding.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CSE_CUSTOM
CSE_KMS
NONE
SSE_C
SSE_KMS
SSE_S3

Method Summary

Modifier and Type	Method and Description
String	getMethod()
static S3AEncryptionMethods	getMethod(String name) Get the encryption mechanism from the value provided.
boolean	isServerSide() Flag to indicate this is a server-side encryption option.
static S3AEncryptionMethods	valueOf(String name) Returns the enum constant of this type with the specified name.
static S3AEncryptionMethods[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final S3AEncryptionMethods NONE

SSE_S3

public static final S3AEncryptionMethods SSE_S3

SSE_KMS

public static final S3AEncryptionMethods SSE_KMS

SSE_C

public static final S3AEncryptionMethods SSE_C

CSE_KMS

public static final S3AEncryptionMethods CSE_KMS

CSE_CUSTOM

public static final S3AEncryptionMethods CSE_CUSTOM

Method Detail

values

public static S3AEncryptionMethods[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (S3AEncryptionMethods c : S3AEncryptionMethods.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static S3AEncryptionMethods valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMethod

public String getMethod()

isServerSide

public boolean isServerSide()

Flag to indicate this is a server-side encryption option.

Returns:

true if this is server side.

getMethod

public static S3AEncryptionMethods getMethod(String name)
                                      throws IOException

Get the encryption mechanism from the value provided.

Parameters:

name - algorithm name

Returns:

the method

Throws:

IOException - if the algorithm is unknown