org.apache.commons.crypto.random

Enum CryptoRandomFactory.RandomProvider

java.lang.Object

java.lang.Enum<CryptoRandomFactory.RandomProvider>

org.apache.commons.crypto.random.CryptoRandomFactory.RandomProvider

All Implemented Interfaces:

Serializable, Comparable<CryptoRandomFactory.RandomProvider>

Enclosing class:

CryptoRandomFactory

public static enum CryptoRandomFactory.RandomProvider
extends Enum<CryptoRandomFactory.RandomProvider>

Defines the internal CryptoRandom implementations.

Usage:

 props.setProperty(CryptoRandomFactory.CLASSES_KEY, RandomProvider.OPENSSL.getClassName());
 props.setProperty(...); // if required by the implementation
 random = CryptoRandomFactory.getCryptoRandom(transformation, props);
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
JAVA The SecureRandom implementation from the JVM
OPENSSL The OpenSSL Random implementation (using JNI)
OS The OS random device implementation.

Method Summary

Modifier and Type	Method and Description
String	getClassName() Gets the class name of the provider.
Class<? extends CryptoRandom>	getImplClass() Gets the implementation class of the provider.
static CryptoRandomFactory.RandomProvider	valueOf(String name) Returns the enum constant of this type with the specified name.
static CryptoRandomFactory.RandomProvider[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPENSSL

public static final CryptoRandomFactory.RandomProvider OPENSSL

The OpenSSL Random implementation (using JNI)

No properties are used for configuration, but they are passed to the JAVA backup implementation

JAVA

public static final CryptoRandomFactory.RandomProvider JAVA

The SecureRandom implementation from the JVM

Uses the property with key CryptoRandomFactory.JAVA_ALGORITHM_KEY with the default of CryptoRandomFactory.JAVA_ALGORITHM_DEFAULT

OS

public static final CryptoRandomFactory.RandomProvider OS

The OS random device implementation. May not be available on some OSes.

Uses CryptoRandomFactory.DEVICE_FILE_PATH_KEY to determine the path to the random device, default is CryptoRandomFactory.DEVICE_FILE_PATH_DEFAULT

Method Detail

values

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

Returns:

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

valueOf

public static CryptoRandomFactory.RandomProvider 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

getClassName

public String getClassName()

Gets the class name of the provider.

Returns:

the name of the provider class

getImplClass

public Class<? extends CryptoRandom> getImplClass()

Gets the implementation class of the provider.

Returns:

the implementation class of the provider