Package org.apache.hadoop.crypto

Enum CipherSuite

java.lang.Object

java.lang.Enum<CipherSuite>

org.apache.hadoop.crypto.CipherSuite

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CipherSuite>

@Private
public enum CipherSuite
extends java.lang.Enum<CipherSuite>

Defines properties of a CipherSuite. Modeled after the ciphers in Cipher.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AES_CTR_NOPADDING
SM4_CTR_NOPADDING
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static CipherSuite	convert(java.lang.String name)	Convert to CipherSuite from name, algoBlockSize is fixed for certain cipher suite, just need to compare the name.
int	getAlgorithmBlockSize()
java.lang.String	getConfigSuffix()	Returns suffix of cipher suite configuration.
java.lang.String	getName()
int	getUnknownValue()
void	setUnknownValue(int unknown)
java.lang.String	toString()
static CipherSuite	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CipherSuite[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final CipherSuite UNKNOWN

AES_CTR_NOPADDING

public static final CipherSuite AES_CTR_NOPADDING

SM4_CTR_NOPADDING

public static final CipherSuite SM4_CTR_NOPADDING

Method Detail

values

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

Returns:

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

valueOf

public static CipherSuite valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

setUnknownValue

public void setUnknownValue(int unknown)

getUnknownValue

public int getUnknownValue()

getName

public java.lang.String getName()

Returns:

name of cipher suite, as in Cipher

getAlgorithmBlockSize

public int getAlgorithmBlockSize()

Returns:

size of an algorithm block in bytes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<CipherSuite>

convert

public static CipherSuite convert(java.lang.String name)

Convert to CipherSuite from name, algoBlockSize is fixed for certain cipher suite, just need to compare the name.

Parameters:

name - cipher suite name

Returns:

CipherSuite cipher suite

getConfigSuffix

public java.lang.String getConfigSuffix()

Returns suffix of cipher suite configuration.

Returns:

String configuration suffix