org.dihedron.crypto.constants

Enum EncryptionAlgorithm

java.lang.Object

java.lang.Enum<EncryptionAlgorithm>

org.dihedron.crypto.constants.EncryptionAlgorithm

All Implemented Interfaces:

Serializable, Comparable<EncryptionAlgorithm>

@License
public enum EncryptionAlgorithm
extends Enum<EncryptionAlgorithm>

An enumeration of supported encryption algorithms.

Author:

Andrea Funto'

Enum Constant Summary

Enum Constants

Enum Constant and Description
RSA RSA asymmetric key encryption algorithm.

Method Summary

Methods

Modifier and Type	Method and Description
static EncryptionAlgorithm	fromAsn1Id(String asn1) Factory method: returns the Encryption object corresponding to the given ASN.1 algorithm code (e.g.
static EncryptionAlgorithm	fromBouncyCastleCode(String bcCode) Factory method: returns the Encryption object corresponding to the given BouncyCastle algorithm code (e.g.
static EncryptionAlgorithm	fromDescription(String description) Factory method: returns the Encryption object corresponding to the given text description.
String	getAsn1Id() Returns the numeric (in text form) id of the encryption algorithm.
String	getBouncyCastleCode() returns the BouncyCastle code for the given encryption algorithm.
String	getDescription() Returns the text description of the encryption algorithm.
String	toString() Formats the object as a string.
static EncryptionAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static EncryptionAlgorithm[]	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

RSA

public static final EncryptionAlgorithm RSA

RSA asymmetric key encryption algorithm.

Method Detail

values

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

Returns:

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

valueOf

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

fromDescription

public static EncryptionAlgorithm fromDescription(String description)

Factory method: returns the Encryption object corresponding to the given text description.

Parameters:

description - the algorithm description, e.g. "rsa".

Returns:

the Encryption object, or null if none found corresponding to the given algorithm description.

fromAsn1Id

public static EncryptionAlgorithm fromAsn1Id(String asn1)

Factory method: returns the Encryption object corresponding to the given ASN.1 algorithm code (e.g. "1.3.26.1.13").

Parameters:

bcCode - the ASN.1 algorithm BouncyCastle code, e.g. "1.3.13.2.26".

Returns:

the Encryption object, or null if none found corresponding to the given algorithm ASN.1 code.

fromBouncyCastleCode

public static EncryptionAlgorithm fromBouncyCastleCode(String bcCode)

Factory method: returns the Encryption object corresponding to the given BouncyCastle algorithm code (e.g. "RSA").

Parameters:

bcCode - the algorithm BouncyCastle code, e.g. "RSA".

Returns:

the Encryption object, or null if none found corresponding to the given algorithm description.

getDescription

public String getDescription()

Returns the text description of the encryption algorithm.

Returns:

the text description of the encryption algorithm.

getBouncyCastleCode

public String getBouncyCastleCode()

returns the BouncyCastle code for the given encryption algorithm.

Returns:

the BouncyCastle code for the given encryption algorithm.

getAsn1Id

public String getAsn1Id()

Returns the numeric (in text form) id of the encryption algorithm.

Returns:

the id of the encryption algorithm.

toString

public String toString()

Formats the object as a string.

Overrides:

toString in class Enum<EncryptionAlgorithm>