org.apache.commons.crypto.cipher

Enum CryptoCipherFactory.CipherProvider

java.lang.Object

java.lang.Enum<CryptoCipherFactory.CipherProvider>

org.apache.commons.crypto.cipher.CryptoCipherFactory.CipherProvider

All Implemented Interfaces:

Serializable, Comparable<CryptoCipherFactory.CipherProvider>

Enclosing class:

CryptoCipherFactory

public static enum CryptoCipherFactory.CipherProvider
extends Enum<CryptoCipherFactory.CipherProvider>

Defines the internal CryptoCipher implementations.

Usage:

 props.setProperty(CryptoCipherFactory.CLASSES_KEY, CipherProvider.OPENSSL.getClassName());
 props.setProperty(...); // if required by the implementation
 cipher = CryptoCipherFactory.getInstance(transformation, props);
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
JCE The JCE cipher implementation from the JVM
OPENSSL The OpenSSL cipher implementation (using JNI)

Method Summary

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

The OpenSSL cipher implementation (using JNI)

This implementation does not use any properties

JCE

public static final CryptoCipherFactory.CipherProvider JCE

The JCE cipher implementation from the JVM

uses the property CryptoCipherFactory.JCE_PROVIDER_KEY to define the provider name, if present.

Method Detail

values

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

Returns:

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

valueOf

public static CryptoCipherFactory.CipherProvider 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 fully qualified name of the provider class

getImplClass

public Class<? extends CryptoCipher> getImplClass()

Gets the implementation class of the provider.

Returns:

the implementation class of the provider