com.fortanix.sdkms.v1.model

Class CipherMode

java.lang.Object

com.fortanix.sdkms.v1.model.CipherMode

public class CipherMode
extends Object

Type of cipher mode, required for symmetric key algorithms.

This class functions similarly to a Java enum, but allows client software to operate with a server that provides enumeration values that aren't known by the client. Client software can use standard enum values with CipherMode.VALUE, or instantiate extended enum values with CipherMode.fromValue(VALUE). This class cannot be used with the Java switch() construction.

Field Summary

Fields

Modifier and Type	Field and Description
static CipherMode	CBC
static CipherMode	CBCNOPAD
static CipherMode	CCM
static CipherMode	CFB
static CipherMode	CTR
static CipherMode	ECB
static CipherMode	GCM
static CipherMode	KW
static CipherMode	KWP
static CipherMode	OFB

Method Summary

Modifier and Type	Method and Description
static CipherMode	fromValue(String val) Intantiate an enumeration member from a value.
String	getValue() Get the serialized value of this enumeration member.
String	toString() Returns the serialized value of this enumeration member, converted to a string.
static CipherMode[]	values() Return an array containing the known enumeration values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ECB

public static final CipherMode ECB

CBC

public static final CipherMode CBC

CBCNOPAD

public static final CipherMode CBCNOPAD

CFB

public static final CipherMode CFB

OFB

public static final CipherMode OFB

CTR

public static final CipherMode CTR

GCM

public static final CipherMode GCM

CCM

public static final CipherMode CCM

KW

public static final CipherMode KW

KWP

public static final CipherMode KWP

Method Detail

getValue

public String getValue()

Get the serialized value of this enumeration member.

Returns:

Seralized value of this enumeration member.

toString

public String toString()

Returns the serialized value of this enumeration member, converted to a string.

For String enumerations, this will return the same value as getValue(). For integer enumerations, it will return the integer value converted to a string.

Overrides:

toString in class Object

Returns:

Serialized value of this enumeration member, converted to String.

values

public static CipherMode[] values()

Return an array containing the known enumeration values.

This method returns all enumeration values known at the time the method is invoked. Since the enumeration is extensible, new enumeration values will be added as they are encountered (usually because new enumeration values were returned by the server). This can result in two calls to values() returning arrays of different length.

Returns:

Array of known CipherMode values.

fromValue

public static CipherMode fromValue(String val)

Intantiate an enumeration member from a value.

This method is normally invoked internally by the library to deserialize enumeration values. It is not normally necessary to call this method directly in client software. You can use one of the CipherMode.VALUE members if you want to use a defined enumeration value.

Returns:

A CipherMode representing the value.