Package eu.europa.esig.dss.enumerations

Enum Class EncryptionAlgorithm

java.lang.Object

java.lang.Enum<EncryptionAlgorithm>

eu.europa.esig.dss.enumerations.EncryptionAlgorithm

All Implemented Interfaces:

OidBasedEnum, Serializable, Comparable<EncryptionAlgorithm>, Constable

public enum EncryptionAlgorithm
extends Enum<EncryptionAlgorithm>
implements OidBasedEnum

Supported signature encryption algorithms.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DSA	DSA
ECDSA	ECDSA
EDDSA	EdDSA
HMAC	HMAC
PLAIN_ECDSA	PLAIN-ECDSA
RSA	RSA
RSASSA_PSS	RSASSA-PSS
X25519	X25519
X448	X448

Method Summary

Modifier and Type	Method	Description
static EncryptionAlgorithm	forKey(Key key)	Returns the encryption algorithm associated to the given key.
static EncryptionAlgorithm	forName(String name)	Returns the encryption algorithm associated to the given JCE name.
static EncryptionAlgorithm	forName(String name, EncryptionAlgorithm defaultValue)	Returns the encryption algorithm associated to the given JCE name.
static EncryptionAlgorithm	forOID(String oid)	Returns the encryption algorithm associated to the given OID.
String	getName()	Get the algorithm name
String	getOid()	Get the ASN1 algorithm OID
String	getPadding()	Get the algorithm padding
boolean	isEquivalent(EncryptionAlgorithm encryptionAlgorithm)	Verifies if the provided encryptionAlgorithm is equivalent to the current one.
static EncryptionAlgorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EncryptionAlgorithm[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RSA

public static final EncryptionAlgorithm RSA

RSA

RSASSA_PSS

public static final EncryptionAlgorithm RSASSA_PSS

RSASSA-PSS

DSA

public static final EncryptionAlgorithm DSA

DSA

ECDSA

public static final EncryptionAlgorithm ECDSA

ECDSA

PLAIN_ECDSA

public static final EncryptionAlgorithm PLAIN_ECDSA

PLAIN-ECDSA

X25519

public static final EncryptionAlgorithm X25519

X25519

X448

public static final EncryptionAlgorithm X448

X448

EDDSA

public static final EncryptionAlgorithm EDDSA

EdDSA

HMAC

public static final EncryptionAlgorithm HMAC

HMAC

Method Details

values

public static EncryptionAlgorithm[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EncryptionAlgorithm valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

forOID

public static EncryptionAlgorithm forOID(String oid)

Returns the encryption algorithm associated to the given OID.

Parameters:

oid - the ASN1 algorithm OID

Returns:

the linked encryption algorithm

Throws:

IllegalArgumentException - if the oid doesn't match any algorithm

forKey

public static EncryptionAlgorithm forKey(Key key)

Returns the encryption algorithm associated to the given key.

Parameters:

key - the key

Returns:

the linked encryption algorithm

Throws:

IllegalArgumentException - if the key doesn't match any algorithm

forName

public static EncryptionAlgorithm forName(String name)

Returns the encryption algorithm associated to the given JCE name.

Parameters:

name - the encryption algorithm name

Returns:

the linked encryption algorithm

Throws:

IllegalArgumentException - if the name doesn't match any algorithm

forName

public static EncryptionAlgorithm forName(String name,
 EncryptionAlgorithm defaultValue)

Returns the encryption algorithm associated to the given JCE name.

Parameters:

name - the encryption algorithm name

defaultValue - The default value for the EncryptionAlgorithm

Returns:

the corresponding EncryptionAlgorithm or the default value

getName

public String getName()

Get the algorithm name

Returns:

the name

getOid

public String getOid()

Get the ASN1 algorithm OID

Specified by:

getOid in interface OidBasedEnum

Returns:

the OID

getPadding

public String getPadding()

Get the algorithm padding

Returns:

the padding

isEquivalent

public boolean isEquivalent(EncryptionAlgorithm encryptionAlgorithm)

Verifies if the provided encryptionAlgorithm is equivalent to the current one. Equivalent means the same token key can be used for signature creation with both algorithms.

Parameters:

encryptionAlgorithm - EncryptionAlgorithm to check

Returns:

TRUE if the algorithms are equivalent, FALSE otherwise