org.jasypt.digest.config
Class SimpleStringDigesterConfig

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

public class SimpleStringDigesterConfig
extends SimpleDigesterConfig
implements StringDigesterConfig

Bean implementation for StringDigesterConfig. This class allows the values for the configuration parameters to be set via "standard" setX methods.

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

Since:
1.3
Author:
Daniel Fernández Garrido

Constructor Summary
SimpleStringDigesterConfig()
           Creates a new SimpleStringDigesterConfig instance.
 
Method Summary
 String getStringOutputType()
           This parameter lets the user specify the form in which String output will be encoded.
 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 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.
 
Methods inherited from class org.jasypt.digest.config.SimpleDigesterConfig
getAlgorithm, getIterations, getProvider, getProviderName, getSaltGenerator, getSaltSizeBytes, setAlgorithm, setIterations, setIterations, setProvider, setProviderClassName, setProviderName, setSaltGenerator, setSaltGeneratorClassName, setSaltSizeBytes, setSaltSizeBytes
 
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

SimpleStringDigesterConfig

public SimpleStringDigesterConfig()

Creates a new SimpleStringDigesterConfig instance.

Method Detail

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.

Determines the result of: isUnicodeNormalizationIgnored()

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.

Determines the result of: isUnicodeNormalizationIgnored()

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.

Determines the result of: getStringOutputType()

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.