org.jasypt.digest.config
Class EnvironmentStringDigesterConfig

Object
  extended by org.jasypt.digest.config.SimpleDigesterConfig
      extended by org.jasypt.digest.config.EnvironmentDigesterConfig
          extended by org.jasypt.digest.config.EnvironmentStringDigesterConfig
All Implemented Interfaces:
DigesterConfig, StringDigesterConfig

public class EnvironmentStringDigesterConfig
extends EnvironmentDigesterConfig
implements StringDigesterConfig

Implementation for StringDigesterConfig which can retrieve configuration values from environment variables or system properties.

The name of the environment variable or system property (JVM property) to query for each parameter can be set with its corresponding setXEnvName or setXSysProperty method.

As this class extends SimpleDigesterConfig, parameter values can be also set with the usual setX methods.

For any of the configuration parameters, if its value is not configured in any way, a null value will be returned by the corresponding getX method.

Since:
1.3
Author:
Daniel Fernández Garrido

Constructor Summary
EnvironmentStringDigesterConfig()
           Creates a new EnvironmentStringDigesterConfig instance.
 
Method Summary
 String getStringOutputType()
           This parameter lets the user specify the form in which String output will be encoded.
 String getStringOutputTypeEnvName()
          Retrieve the name of the environment variable which value has been loaded as the String output type.
 String getStringOutputTypeSysPropertyName()
          Retrieve the name of the JVM system property which value has been loaded as the String output type.
 String getUnicodeNormalizationIgnoredEnvName()
          Retrieve the name of the environment variable which value has been loaded as a value for the "unicode normalization ignored" parameter.
 String getUnicodeNormalizationIgnoredSysPropertyName()
          Retrieve the name of the JVM system property which value has been loaded as a value for the "unicode normalization ignored" parameter.
 Boolean isUnicodeNormalizationIgnored()
           This parameter lets the user specify if the Unicode text normalization step performed during String digest and matching should be ignored.
 void setStringOutputType(String stringOutputType)
           Sets the the form in which String output will be encoded.
 void setStringOutputTypeEnvName(String stringOutputTypeEnvName)
          Set the config object to use the specified environment variable to load the value for the String output type.
 void setStringOutputTypeSysPropertyName(String stringOutputTypeSysPropertyName)
          Set the config object to use the specified JVM system property to load the value for the String output type.
 void setUnicodeNormalizationIgnored(Boolean unicodeNormalizationIgnored)
           Sets whether the unicode text normalization step should be ignored.
 void setUnicodeNormalizationIgnored(String unicodeNormalizationIgnored)
           Sets whether the unicode text normalization step should be ignored.
 void setUnicodeNormalizationIgnoredEnvName(String unicodeNormalizationIgnoredEnvName)
          Set the config object to use the specified environment variable to load the value for the "unicode normalization ignored" parameter.
 void setUnicodeNormalizationIgnoredSysPropertyName(String unicodeNormalizationIgnoredSysPropertyName)
          Set the config object to use the specified JVM system property to load a value for the "unicode normalization ignored" parameter.
 
Methods inherited from class org.jasypt.digest.config.EnvironmentDigesterConfig
getAlgorithmEnvName, getAlgorithmSysPropertyName, getIterationsEnvName, getIterationsSysPropertyName, getProviderClassNameEnvName, getProviderClassNameSysPropertyName, getProviderNameEnvName, getProviderNameSysPropertyName, getSaltGeneratorClassNameEnvName, getSaltGeneratorClassNameSysPropertyName, getSaltSizeBytesEnvName, getSaltSizeBytesSysPropertyName, setAlgorithm, setAlgorithmEnvName, setAlgorithmSysPropertyName, setIterations, setIterations, setIterationsEnvName, setIterationsSysPropertyName, setProvider, setProviderClassName, setProviderClassNameEnvName, setProviderClassNameSysPropertyName, setProviderName, setProviderNameEnvName, setProviderNameSysPropertyName, setSaltGenerator, setSaltGeneratorClassName, setSaltGeneratorClassNameEnvName, setSaltGeneratorClassNameSysPropertyName, setSaltSizeBytes, setSaltSizeBytes, setSaltSizeBytesEnvName, setSaltSizeBytesSysPropertyName
 
Methods inherited from class org.jasypt.digest.config.SimpleDigesterConfig
getAlgorithm, getIterations, getProvider, getProviderName, getSaltGenerator, getSaltSizeBytes
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jasypt.digest.config.DigesterConfig
getAlgorithm, getIterations, getProvider, getProviderName, getSaltGenerator, getSaltSizeBytes
 

Constructor Detail

EnvironmentStringDigesterConfig

public EnvironmentStringDigesterConfig()

Creates a new EnvironmentStringDigesterConfig instance.

Method Detail

getUnicodeNormalizationIgnoredEnvName

public String getUnicodeNormalizationIgnoredEnvName()
Retrieve the name of the environment variable which value has been loaded as a value for the "unicode normalization ignored" parameter.

Returns:
the name of the variable

setUnicodeNormalizationIgnoredEnvName

public void setUnicodeNormalizationIgnoredEnvName(String unicodeNormalizationIgnoredEnvName)
Set the config object to use the specified environment variable to load the value for the "unicode normalization ignored" parameter.

Parameters:
unicodeNormalizationIgnoredEnvName - the name of the environment variable

getUnicodeNormalizationIgnoredSysPropertyName

public String getUnicodeNormalizationIgnoredSysPropertyName()
Retrieve the name of the JVM system property which value has been loaded as a value for the "unicode normalization ignored" parameter.

Returns:
the name of the property

setUnicodeNormalizationIgnoredSysPropertyName

public void setUnicodeNormalizationIgnoredSysPropertyName(String unicodeNormalizationIgnoredSysPropertyName)
Set the config object to use the specified JVM system property to load a value for the "unicode normalization ignored" parameter.

Parameters:
unicodeNormalizationIgnoredSysPropertyName - the name of the property

getStringOutputTypeEnvName

public String getStringOutputTypeEnvName()
Retrieve the name of the environment variable which value has been loaded as the String output type.

Returns:
the name of the variable

setStringOutputTypeEnvName

public void setStringOutputTypeEnvName(String stringOutputTypeEnvName)
Set the config object to use the specified environment variable to load the value for the String output type.

Parameters:
stringOutputTypeEnvName - the name of the environment variable

getStringOutputTypeSysPropertyName

public String getStringOutputTypeSysPropertyName()
Retrieve the name of the JVM system property which value has been loaded as the String output type.

Returns:
the name of the property

setStringOutputTypeSysPropertyName

public void setStringOutputTypeSysPropertyName(String stringOutputTypeSysPropertyName)
Set the config object to use the specified JVM system property to load the value for the String output type.

Parameters:
stringOutputTypeSysPropertyName - the name of the property

setUnicodeNormalizationIgnored

public void setUnicodeNormalizationIgnored(Boolean unicodeNormalizationIgnored)

Sets whether the unicode text normalization step should be ignored.

The Java Virtual Machine internally handles all Strings as UNICODE. When digesting or matching digests in jasypt, these Strings are first normalized to its NFC form so that digest matching is not affected by the specific form in which the messages where input.

It is normally safe (and recommended) to leave this parameter set to its default FALSE value (and thus DO perform normalization operations). But in some specific cases in which issues with legacy software could arise, it might be useful to set this to TRUE.

For more information on unicode text normalization, see this issue of Core Java Technologies Tech Tips.

If not set, null will be returned.

Parameters:
unicodeNormalizationIgnored - whether the unicode text normalization step should be ignored or not.

setUnicodeNormalizationIgnored

public void setUnicodeNormalizationIgnored(String unicodeNormalizationIgnored)

Sets whether the unicode text normalization step should be ignored.

The Java Virtual Machine internally handles all Strings as UNICODE. When digesting or matching digests in jasypt, these Strings are first normalized to its NFC form so that digest matching is not affected by the specific form in which the messages where input.

It is normally safe (and recommended) to leave this parameter set to its default FALSE value (and thus DO perform normalization operations). But in some specific cases in which issues with legacy software could arise, it might be useful to set this to TRUE.

For more information on unicode text normalization, see this issue of Core Java Technologies Tech Tips.

If not set, null will be returned.

Parameters:
unicodeNormalizationIgnored - whether the unicode text normalization step should be ignored or not.
Since:
1.4

setStringOutputType

public void setStringOutputType(String stringOutputType)

Sets the the form in which String output will be encoded. Available encoding types are:

If not set, null will be returned.

Parameters:
stringOutputType - the string output type.

isUnicodeNormalizationIgnored

public Boolean isUnicodeNormalizationIgnored()
Description copied from interface: StringDigesterConfig

This parameter lets the user specify if the Unicode text normalization step performed during String digest and matching should be ignored.

The Java Virtual Machine internally handles all Strings as UNICODE. When digesting or matching digests in jasypt, these Strings are first normalized to its NFC form so that digest matching is not affected by the specific form in which the messages where input.

It is normally safe (and recommended) to leave this parameter set to its default FALSE value (and thus DO perform normalization operations). But in some specific cases in which issues with legacy software could arise, it might be useful to set this to TRUE.

For more information on unicode text normalization, see this issue of Core Java Technologies Tech Tips.

Specified by:
isUnicodeNormalizationIgnored in interface StringDigesterConfig
Returns:
whether the unicode text normalization step should be ignored or not.

getStringOutputType

public String getStringOutputType()
Description copied from interface: StringDigesterConfig

This parameter lets the user specify the form in which String output will be encoded. Available encoding types are:

Specified by:
getStringOutputType in interface StringDigesterConfig
Returns:
The name of the encoding type for String output


Copyright © 2008 The JASYPT team. All Rights Reserved.