com.ibm.cloud.objectstorage.services.s3.model

Enum CryptoStorageMode

java.lang.Object

java.lang.Enum<CryptoStorageMode>

com.ibm.cloud.objectstorage.services.s3.model.CryptoStorageMode

All Implemented Interfaces:

Serializable, Comparable<CryptoStorageMode>

public enum CryptoStorageMode
extends Enum<CryptoStorageMode>

Denotes the different storage modes available for storing the encryption information that accompanies encrypted objects in S3. The encryption information includes an encrypted envelope symmetric key, an initialization vector, and a description of the encryption materials used during encryption.

ObjectMetadata is the default storage mode. If the ObjectMetadata mode is used, then encryption information will be placed in the metadata of the encrypted object stored in S3. Note: There is a 2 KB limit on the size of the metadata, so be careful that you do not run out of space if you are storing a lot of your own metadata.

If the InstructionFile mode is used, then encryption information will be placed in a separate instruction file that will be stored in the same bucket as the encrypted object in S3. No metadata will be used for storing encryption information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
InstructionFile
ObjectMetadata

Method Summary

Modifier and Type	Method and Description
static CryptoStorageMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CryptoStorageMode[]	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

InstructionFile

public static final CryptoStorageMode InstructionFile

ObjectMetadata

public static final CryptoStorageMode ObjectMetadata

Method Detail

values

public static CryptoStorageMode[] 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 (CryptoStorageMode c : CryptoStorageMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static CryptoStorageMode 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