org.antfarmer.ejce.util

Class ConfigurerUtil

java.lang.Object

org.antfarmer.ejce.util.ConfigurerUtil

public final class ConfigurerUtil
extends Object

Configuration utility for instantiating an Encryptor using a Properties object for configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ALGORITHM Property key for the encryption algorithm to be used to configure the Encryptor.
static String	KEY_BLOCK_MODE Property key for the block mode to be used with the encryption algorithm.
static String	KEY_BLOCK_SIZE Property key for the block size to be used with the encryption algorithm.
static String	KEY_CHARSET Property key for the full class name of the TextEncoder to be used with the Encryptor.
static String	KEY_CIPHER_KEY Property key for the encryption key to be used to configure the Encryptor.
static String	KEY_COMPRESS_LOB Property key for enabling compression of LOB data.
static String	KEY_DECRYPTION_KEY Property key for the encryption key to be used to configure the Encryptor.
static String	KEY_ENCODER_CLASS Property key for the full class name of the TextEncoder to be used with the Encryptor.
static String	KEY_ENCRYPTION_KEY Property key for the encryption key to be used to configure the Encryptor.
static String	KEY_ENCRYPTOR_STORE_KEY Property key for the EncryptorStore key which maps to a code-configured Encryptor.
static String	KEY_GCM_TAG_LEN Property key for the Authentication Tag length in bits to be used with the encryption algorithm in GCM block mode.
static String	KEY_ITERATION_COUNT Property key for the number of PBE iterations to be used with a PBE algorithm.
static String	KEY_KEY_LOADER Property key for the encryption KeyLoader to be used to configure the Encryptor.
static String	KEY_MAC_ALGORITHM Property key for the MAC algorithm to be used to configure the Encryptor.
static String	KEY_MAC_KEY Property key for the MAC key to be used to configure the Encryptor.
static String	KEY_MAC_KEY_LOADER Property key for the MAC KeyLoader to be used to configure the Encryptor.
static String	KEY_MAX_IN_MEM_BUFF_SIZE Property key that controls the maxmimum in-memory buffer size used in LOB-type streaming in pre-JDBC4 environments.
static String	KEY_PADDING Property key for the padding to be used with the encryption algorithm.
static String	KEY_PARAM_CLASS Property key for the full class name of the algorithm parameter class to be used to configure the Encryptor.
static String	KEY_PARAM_ENCODER_CLASS Property key for the full class name of the TextEncoder to be used with the algorithm parameter object.
static String	KEY_PROPERTY_PREFIX Property key for the prefix to be used to lookup configuration settings within the system properties.
static String	KEY_PROVIDER_CLASS Property key for the JCE provider class to be used with the Encryptor.
static String	KEY_PROVIDER_NAME Property key for the JCE provider name to be used with the Encryptor.
static String	KEY_PSWD_ENCODER_CLASS Property key for the full class name of the ConfigurablePasswordEncoder to be used with the EncodedPasswordType.
static String	KEY_PSWD_ENCODER_STORE_EXPORT_KEY Property key for the key to be used to export the ConfigurablePasswordEncoder into the PasswordEncoderStore.
static String	KEY_SALT_GENERATOR Property key for the SaltGenerator to be used to configure the Encryptor.
static String	KEY_SALT_MATCHER Property key for the SaltMatcher to be used to configure the Encryptor.
static String	KEY_SALT_SIZE Property key for the salt size (in bytes) to be used with a PBE algorithm.
static String	KEY_STREAM_BUFF_SIZE Property key that controls in-memory buffer size used in LOB-type streaming in pre-JDBC4 environments.
static String	KEY_STREAM_LOBS Property key for enabling streaming of LOB data.

Method Summary

Modifier and Type	Method and Description
static Encryptor	configureEncryptor(Properties properties) Loads and configures an encryptor based on settings within the given properties.
static Encryptor	configureEncryptor(Properties properties, String prefix) Loads and configures an encryptor based on settings within the given properties.
static ConfigurablePasswordEncoder	configurePswdEncoder(Properties properties) Loads and configures a ConfigurablePasswordEncoder based on settings within the given properties.
static ConfigurablePasswordEncoder	configurePswdEncoder(Properties properties, String prefix) Loads and configures a ConfigurablePasswordEncoder based on settings within the given properties.
static Cipher	getCipherInstance(AlgorithmParameters<?> parameters) Returns a Cipher instance for the given AlgorithmParameters.
static AlgorithmParameters<?>	loadAlgorithmParameters(Properties parameters, String prefix) Loads an AlgorithmParameters instance for the given encryption configuration parameters.
static Integer	parseInt(String value) Parses the given string as an integer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_PROPERTY_PREFIX

public static final String KEY_PROPERTY_PREFIX

Property key for the prefix to be used to lookup configuration settings within the system properties.

See Also:

Constant Field Values

KEY_ENCRYPTOR_STORE_KEY

public static final String KEY_ENCRYPTOR_STORE_KEY

Property key for the EncryptorStore key which maps to a code-configured Encryptor.

See Also:

Constant Field Values

KEY_ENCODER_CLASS

public static final String KEY_ENCODER_CLASS

Property key for the full class name of the TextEncoder to be used with the Encryptor.

See Also:

Constant Field Values

KEY_CHARSET

public static final String KEY_CHARSET

Property key for the full class name of the TextEncoder to be used with the Encryptor.

See Also:

Constant Field Values

KEY_PARAM_CLASS

public static final String KEY_PARAM_CLASS

Property key for the full class name of the algorithm parameter class to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_PARAM_ENCODER_CLASS

public static final String KEY_PARAM_ENCODER_CLASS

Property key for the full class name of the TextEncoder to be used with the algorithm parameter object.

See Also:

Constant Field Values

KEY_CIPHER_KEY

public static final String KEY_CIPHER_KEY

Property key for the encryption key to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_KEY_LOADER

public static final String KEY_KEY_LOADER

Property key for the encryption KeyLoader to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_ENCRYPTION_KEY

public static final String KEY_ENCRYPTION_KEY

Property key for the encryption key to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_DECRYPTION_KEY

public static final String KEY_DECRYPTION_KEY

Property key for the encryption key to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_ALGORITHM

public static final String KEY_ALGORITHM

Property key for the encryption algorithm to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_PROVIDER_NAME

public static final String KEY_PROVIDER_NAME

Property key for the JCE provider name to be used with the Encryptor.

See Also:

Constant Field Values

KEY_PROVIDER_CLASS

public static final String KEY_PROVIDER_CLASS

Property key for the JCE provider class to be used with the Encryptor.

See Also:

Constant Field Values

KEY_MAC_KEY

public static final String KEY_MAC_KEY

Property key for the MAC key to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_MAC_KEY_LOADER

public static final String KEY_MAC_KEY_LOADER

Property key for the MAC KeyLoader to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_MAC_ALGORITHM

public static final String KEY_MAC_ALGORITHM

Property key for the MAC algorithm to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_SALT_GENERATOR

public static final String KEY_SALT_GENERATOR

Property key for the SaltGenerator to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_SALT_MATCHER

public static final String KEY_SALT_MATCHER

Property key for the SaltMatcher to be used to configure the Encryptor.

See Also:

Constant Field Values

KEY_BLOCK_MODE

public static final String KEY_BLOCK_MODE

Property key for the block mode to be used with the encryption algorithm.

See Also:

Constant Field Values

KEY_BLOCK_SIZE

public static final String KEY_BLOCK_SIZE

Property key for the block size to be used with the encryption algorithm.

See Also:

Constant Field Values

KEY_GCM_TAG_LEN

public static final String KEY_GCM_TAG_LEN

Property key for the Authentication Tag length in bits to be used with the encryption algorithm in GCM block mode.

See Also:

Constant Field Values

KEY_PADDING

public static final String KEY_PADDING

Property key for the padding to be used with the encryption algorithm.

See Also:

Constant Field Values

KEY_SALT_SIZE

public static final String KEY_SALT_SIZE

Property key for the salt size (in bytes) to be used with a PBE algorithm.

See Also:

Constant Field Values

KEY_ITERATION_COUNT

public static final String KEY_ITERATION_COUNT

Property key for the number of PBE iterations to be used with a PBE algorithm.

See Also:

Constant Field Values

KEY_COMPRESS_LOB

public static final String KEY_COMPRESS_LOB

Property key for enabling compression of LOB data. Used only by types extending AbstractLobType.

See Also:

Constant Field Values

KEY_STREAM_LOBS

public static final String KEY_STREAM_LOBS

Property key for enabling streaming of LOB data. Used only by types extending AbstractLobType.

See Also:

Constant Field Values

KEY_STREAM_BUFF_SIZE

public static final String KEY_STREAM_BUFF_SIZE

Property key that controls in-memory buffer size used in LOB-type streaming in pre-JDBC4 environments. Used only by types extending AbstractLobType.

See Also:

Constant Field Values

KEY_MAX_IN_MEM_BUFF_SIZE

public static final String KEY_MAX_IN_MEM_BUFF_SIZE

Property key that controls the maxmimum in-memory buffer size used in LOB-type streaming in pre-JDBC4 environments. Used only by types extending AbstractLobType.

See Also:

Constant Field Values

KEY_PSWD_ENCODER_CLASS

public static final String KEY_PSWD_ENCODER_CLASS

Property key for the full class name of the ConfigurablePasswordEncoder to be used with the EncodedPasswordType.

See Also:

Constant Field Values

KEY_PSWD_ENCODER_STORE_EXPORT_KEY

public static final String KEY_PSWD_ENCODER_STORE_EXPORT_KEY

Property key for the key to be used to export the ConfigurablePasswordEncoder into the PasswordEncoderStore. This allows the application to easily reference the password encoder.

See Also:

Constant Field Values

Method Detail

configureEncryptor

public static Encryptor configureEncryptor(Properties properties)
                                    throws EncryptorConfigurationException

Loads and configures an encryptor based on settings within the given properties.

Parameters:

properties - the properties with encryptor settings

Returns:

an encryptor based on settings within the given properties

Throws:

EncryptorConfigurationException - an error was found with the given configuration

configureEncryptor

public static Encryptor configureEncryptor(Properties properties,
                                           String prefix)
                                    throws EncryptorConfigurationException

Loads and configures an encryptor based on settings within the given properties. The prefix is prepended on each of the property keys.

Parameters:

properties - the properties with encryptor settings

prefix - prefix to be used with the property keys

Returns:

an encryptor based on settings within the given properties

Throws:

EncryptorConfigurationException - an error was found with the given configuration

loadAlgorithmParameters

public static AlgorithmParameters<?> loadAlgorithmParameters(Properties parameters,
                                                             String prefix)
                                                      throws EncryptorConfigurationException

Loads an AlgorithmParameters instance for the given encryption configuration parameters.

Parameters:

parameters - the encryption configuration parameters

prefix - the property key prefix (may be null)

Returns:

an AlgorithmParameters instance for the given encryption configuration parameters

Throws:

EncryptorConfigurationException - an error was found with the given configuration

configurePswdEncoder

public static ConfigurablePasswordEncoder configurePswdEncoder(Properties properties)
                                                        throws EncryptorConfigurationException

Loads and configures a ConfigurablePasswordEncoder based on settings within the given properties.

Parameters:

properties - the properties with password encoder settings

Returns:

a ConfigurablePasswordEncoder based on settings within the given properties

Throws:

EncryptorConfigurationException - an error was found with the given configuration

configurePswdEncoder

public static ConfigurablePasswordEncoder configurePswdEncoder(Properties properties,
                                                               String prefix)
                                                        throws EncryptorConfigurationException

Loads and configures a ConfigurablePasswordEncoder based on settings within the given properties. The prefix is prepended on each of the property keys.

Parameters:

properties - the properties with password encoder settings

prefix - prefix to be used with the property keys

Returns:

a ConfigurablePasswordEncoder based on settings within the given properties

Throws:

EncryptorConfigurationException - an error was found with the given configuration

getCipherInstance

public static Cipher getCipherInstance(AlgorithmParameters<?> parameters)
                                throws GeneralSecurityException

Returns a Cipher instance for the given AlgorithmParameters.

Parameters:

parameters - the AlgorithmParameters

Returns:

a Cipher instance for the given AlgorithmParameters

Throws:

GeneralSecurityException - GeneralSecurityException

parseInt

public static Integer parseInt(String value)

Parses the given string as an integer.

Parameters:

value - the input string

Returns:

the integer value of the given string, or null if the string does not represent an integer