com.absio.crypto.cipher

Enum CipherTransformation

java.lang.Object

java.lang.Enum<CipherTransformation>

com.absio.crypto.cipher.CipherTransformation

All Implemented Interfaces:

Serializable, Comparable<CipherTransformation>

public enum CipherTransformation
extends Enum<CipherTransformation>

The transformation is the complete encryption scheme for a cipher. It includes the algorithm, mode and padding. CipherTransformation is an enumeration of the schemes that Absio knowingly supports. The transformation is represented by an enumeration value for each of the parts (CipherAlgorithm, CipherMode and CipherPadding). It also includes the default scheme Absio uses: DEFAULT.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AES_CTR_NOPADDING This represents the "AES/CTR/NoPadding" transformation.

Field Summary

Fields

Modifier and Type	Field and Description
static CipherTransformation	DEFAULT This is the default transformation that Absio uses: AES_CTR_NOPADDING

Method Summary

Modifier and Type	Method and Description
com.absio.crypto.cipher.CipherTransformation.CipherAlgorithm	getAlgorithm() Get the CipherAlgorithm of the transformation.
int	getBlockSize() Get the block size of the algorithm.
static CipherTransformation	getByIndex(long index) Gets the transformation by index.
int	getIndex() Get the index of the transformation.
com.absio.crypto.cipher.CipherTransformation.CipherMode	getMode() Get the CipherMode of the transformation.
com.absio.crypto.cipher.CipherTransformation.CipherPadding	getPadding() Get the CipherPadding of the transformation.
String	getTransformation() Get the transformation in the string format the JCE understands: "algorithm/mode/padding".
static CipherTransformation	valueOf(String name) Returns the enum constant of this type with the specified name.
static CipherTransformation[]	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

AES_CTR_NOPADDING

public static final CipherTransformation AES_CTR_NOPADDING

This represents the "AES/CTR/NoPadding" transformation.

Field Detail

DEFAULT

public static final CipherTransformation DEFAULT

This is the default transformation that Absio uses: AES_CTR_NOPADDING

Method Detail

values

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

Returns:

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

valueOf

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

getByIndex

public static CipherTransformation getByIndex(long index)
                                       throws NoSuchAlgorithmException

Gets the transformation by index.

Parameters:

index - the index of the transformation to get

Returns:

the transformation with the given index

Throws:

NoSuchAlgorithmException - thrown if no transformation exists with the given index

getAlgorithm

public com.absio.crypto.cipher.CipherTransformation.CipherAlgorithm getAlgorithm()

Get the CipherAlgorithm of the transformation.

Returns:

the CipherAlgorithm of the transformation

getBlockSize

public int getBlockSize()

Get the block size of the algorithm.

Returns:

the block size of the algorithm

getIndex

public int getIndex()

Get the index of the transformation. This is used as an identifier for the enumeration value.

Returns:

the index of the transformation

getMode

public com.absio.crypto.cipher.CipherTransformation.CipherMode getMode()

Get the CipherMode of the transformation.

Returns:

the CipherMode of the transformation

getPadding

public com.absio.crypto.cipher.CipherTransformation.CipherPadding getPadding()

Get the CipherPadding of the transformation.

Returns:

the CipherPadding of the transformation

getTransformation

public String getTransformation()

Get the transformation in the string format the JCE understands: "algorithm/mode/padding".

Returns:

the transformation in string form