com.unboundid.util.ssl.cert

Enum SignatureAlgorithmIdentifier

java.lang.Object

java.lang.Enum<SignatureAlgorithmIdentifier>

com.unboundid.util.ssl.cert.SignatureAlgorithmIdentifier

All Implemented Interfaces:

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

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum SignatureAlgorithmIdentifier
extends java.lang.Enum<SignatureAlgorithmIdentifier>

This enum defines a set of algorithm names and OIDs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MD2_WITH_RSA The algorithm identifier for the MD2 message digest with RSA encryption.
MD5_WITH_RSA The algorithm identifier for the MD5 message digest with RSA encryption.
SHA_1_WITH_DSA The algorithm identifier for the SHA-1 message digest with the DSA signature algorithm.
SHA_1_WITH_ECDSA The algorithm identifier for the SHA-1 message digest with the ECDSA signature algorithm.
SHA_1_WITH_RSA The algorithm identifier for the SHA-1 message digest with RSA encryption.
SHA_224_WITH_DSA The algorithm identifier for the 224-bit SHA-2 message digest with the DSA signature algorithm.
SHA_224_WITH_ECDSA The algorithm identifier for the 224-bit SHA-2 message digest with the ECDSA signature algorithm.
SHA_224_WITH_RSA The algorithm identifier for the 224-bit SHA-2 message digest with RSA encryption.
SHA_256_WITH_DSA The algorithm identifier for the 256-bit SHA-2 message digest with the DSA signature algorithm.
SHA_256_WITH_ECDSA The algorithm identifier for the 256-bit SHA-2 message digest with the ECDSA signature algorithm.
SHA_256_WITH_RSA The algorithm identifier for the 256-bit SHA-2 message digest with RSA encryption.
SHA_384_WITH_ECDSA The algorithm identifier for the 384-bit SHA-2 message digest with the ECDSA signature algorithm.
SHA_384_WITH_RSA The algorithm identifier for the 384-bit SHA-2 message digest with RSA encryption.
SHA_512_WITH_ECDSA The algorithm identifier for the 512-bit SHA-2 message digest with the ECDSA signature algorithm.
SHA_512_WITH_RSA The algorithm identifier for the 512-bit SHA-2 message digest with RSA encryption.

Method Summary

Modifier and Type	Method and Description
static SignatureAlgorithmIdentifier	forName(java.lang.String name) Retrieves the signature algorithm identifier instance with the specified name.
static SignatureAlgorithmIdentifier	forOID(OID oid) Retrieves the signature algorithm identifier instance with the specified OID.
java.lang.String	getJavaName() Retrieves the name for this signature algorithm as it would be used internally by Java.
static java.lang.String	getNameOrOID(OID oid) Retrieves the user-friendly name for the signature algorithm identifier value with the provided OID, or a string representation of the OID if there is no value with that OID.
OID	getOID() Retrieves the OID for this signature algorithm.
java.lang.String	getUserFriendlyName() Retrieves the user-friendly name for this signature algorithm.
java.lang.String	toString() Retrieves a string representation of this signature algorithm identifier.
static SignatureAlgorithmIdentifier	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SignatureAlgorithmIdentifier[]	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

MD2_WITH_RSA

public static final SignatureAlgorithmIdentifier MD2_WITH_RSA

The algorithm identifier for the MD2 message digest with RSA encryption. This identifier is defined in RFC 3279 section 2.2.1.

MD5_WITH_RSA

public static final SignatureAlgorithmIdentifier MD5_WITH_RSA

The algorithm identifier for the MD5 message digest with RSA encryption. This identifier is defined in RFC 3279 section 2.2.1.

SHA_1_WITH_RSA

public static final SignatureAlgorithmIdentifier SHA_1_WITH_RSA

The algorithm identifier for the SHA-1 message digest with RSA encryption. This identifier is defined in RFC 3279 section 2.2.1.

SHA_224_WITH_RSA

public static final SignatureAlgorithmIdentifier SHA_224_WITH_RSA

The algorithm identifier for the 224-bit SHA-2 message digest with RSA encryption. This identifier is defined in RFC 4055 section 5.

SHA_256_WITH_RSA

public static final SignatureAlgorithmIdentifier SHA_256_WITH_RSA

The algorithm identifier for the 256-bit SHA-2 message digest with RSA encryption. This identifier is defined in RFC 4055 section 5.

SHA_384_WITH_RSA

public static final SignatureAlgorithmIdentifier SHA_384_WITH_RSA

The algorithm identifier for the 384-bit SHA-2 message digest with RSA encryption. This identifier is defined in RFC 4055 section 5.

SHA_512_WITH_RSA

public static final SignatureAlgorithmIdentifier SHA_512_WITH_RSA

The algorithm identifier for the 512-bit SHA-2 message digest with RSA encryption. This identifier is defined in RFC 4055 section 5.

SHA_1_WITH_DSA

public static final SignatureAlgorithmIdentifier SHA_1_WITH_DSA

The algorithm identifier for the SHA-1 message digest with the DSA signature algorithm. This identifier is defined in RFC 3279 section 2.2.2.

SHA_224_WITH_DSA

public static final SignatureAlgorithmIdentifier SHA_224_WITH_DSA

The algorithm identifier for the 224-bit SHA-2 message digest with the DSA signature algorithm. This identifier is defined in RFC 5758 section 3.1.

SHA_256_WITH_DSA

public static final SignatureAlgorithmIdentifier SHA_256_WITH_DSA

The algorithm identifier for the 256-bit SHA-2 message digest with the DSA signature algorithm. This identifier is defined in RFC 5758 section 3.1.

SHA_1_WITH_ECDSA

public static final SignatureAlgorithmIdentifier SHA_1_WITH_ECDSA

The algorithm identifier for the SHA-1 message digest with the ECDSA signature algorithm. This identifier is defined in RFC 3279 section 2.2.3.

SHA_224_WITH_ECDSA

public static final SignatureAlgorithmIdentifier SHA_224_WITH_ECDSA

The algorithm identifier for the 224-bit SHA-2 message digest with the ECDSA signature algorithm. This identifier is defined in RFC 5758 section 3.2.

SHA_256_WITH_ECDSA

public static final SignatureAlgorithmIdentifier SHA_256_WITH_ECDSA

The algorithm identifier for the 256-bit SHA-2 message digest with the ECDSA signature algorithm. This identifier is defined in RFC 5758 section 3.2.

SHA_384_WITH_ECDSA

public static final SignatureAlgorithmIdentifier SHA_384_WITH_ECDSA

The algorithm identifier for the 384-bit SHA-2 message digest with the ECDSA signature algorithm. This identifier is defined in RFC 5758 section 3.2.

SHA_512_WITH_ECDSA

public static final SignatureAlgorithmIdentifier SHA_512_WITH_ECDSA

The algorithm identifier for the 512-bit SHA-2 message digest with the ECDSA signature algorithm. This identifier is defined in RFC 5758 section 3.2.

Method Detail

values

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

Returns:

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

valueOf

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

getOID

@NotNull
public OID getOID()

Retrieves the OID for this signature algorithm.

Returns:

The OID for this signature algorithm.

getJavaName

@NotNull
public java.lang.String getJavaName()

Retrieves the name for this signature algorithm as it would be used internally by Java.

Returns:

The name for this signature algorithm as it would be used internally by Java.

getUserFriendlyName

@NotNull
public java.lang.String getUserFriendlyName()

Retrieves the user-friendly name for this signature algorithm.

Returns:

The user-friendly name for this signature algorithm.

forOID

@Nullable
public static SignatureAlgorithmIdentifier forOID(@NotNull
                                                            OID oid)

Retrieves the signature algorithm identifier instance with the specified OID.

Parameters:

oid - The OID for the signature algorithm identifier instance to retrieve.

Returns:

The appropriate signature algorithm identifier instance, or null if the provided OID does not reference a known signature algorithm identifier.

forName

@Nullable
public static SignatureAlgorithmIdentifier forName(@NotNull
                                                             java.lang.String name)

Retrieves the signature algorithm identifier instance with the specified name.

Parameters:

name - The name of the signature algorithm identifier instance to retrieve.

Returns:

The appropriate signature algorithm identifier instance, or null if the provided name does not reference a known signature algorithm identifier.

getNameOrOID

@NotNull
public static java.lang.String getNameOrOID(@NotNull
                                                     OID oid)

Retrieves the user-friendly name for the signature algorithm identifier value with the provided OID, or a string representation of the OID if there is no value with that OID.

Parameters:

oid - The OID for the signature algorithm identifier to retrieve.

Returns:

The user-friendly name for the signature algorithm identifier value with the provided OID, or a string representation of the OID if there is no value with that OID.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this signature algorithm identifier.

Overrides:

toString in class java.lang.Enum<SignatureAlgorithmIdentifier>

Returns:

A string representation of this signature algorithm identifier.