http://www.jasypt.org: Java library which enables encryption in java apps with minimum effort. (The JASYPT team)
  • Daniel Fernandez 
/*
 * =============================================================================
 * 
 *   Copyright (c) 2007-2010, The JASYPT team (http://www.jasypt.org)
 * 
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 * 
 * =============================================================================
 */
package org.jasypt.digest.config;

import org.jasypt.commons.CommonUtils;


 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. 



Author:Daniel Fernández
Since:1.3
/**
 * <p>
 * Implementation for {@link StringDigesterConfig} which can retrieve configuration
 * values from environment variables or system properties.
 * </p>
 * <p>
 * The name of the environment variable or system property (JVM property) to
 * query for each parameter can be set with its corresponding 
 * <tt>setXEnvName</tt> or <tt>setXSysProperty</tt> method.
 * </p>
 * <p>
 * As this class extends {@link SimpleDigesterConfig}, parameter values
 * can be also set with the usual <tt>setX</tt> methods.
 * </p>
 * <p>
 * For any of the configuration parameters, if its value is not configured
 * in any way, a <tt>null</tt> value will be returned by the
 * corresponding <tt>getX</tt> method. 
 * </p>
 * 
 * @since 1.3
 * 
 * @author Daniel Fern&aacute;ndez
 * 
 */
public class EnvironmentStringDigesterConfig 
        extends EnvironmentDigesterConfig 
        implements StringDigesterConfig {
    
    private Boolean unicodeNormalizationIgnored = null;
    private String stringOutputType = null;
    private String prefix = null;
    private String suffix = null;
    
    private String unicodeNormalizationIgnoredEnvName = null;
    private String stringOutputTypeEnvName = null;
    private String prefixEnvName = null;
    private String suffixEnvName = null;

    private String unicodeNormalizationIgnoredSysPropertyName = null;
    private String stringOutputTypeSysPropertyName = null;
    private String prefixSysPropertyName = null;
    private String suffixSysPropertyName = null;
    
    

    

Creates a new EnvironmentStringDigesterConfig instance.



/**
     * <p>
     * Creates a new <tt>EnvironmentStringDigesterConfig</tt> instance.
     * </p>
     */
    public EnvironmentStringDigesterConfig() {
        super();
    }



    
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
/**
     * Retrieve the name of the environment variable which value has been
     * loaded as a value for the "unicode normalization ignored" parameter.
     *   
     * @return the name of the variable
     */
    public String getUnicodeNormalizationIgnoredEnvName() {
        return this.unicodeNormalizationIgnoredEnvName;
    }


    
Set the config object to use the specified environment variable to
load the value for the "unicode normalization ignored" parameter.

Params:
  • unicodeNormalizationIgnoredEnvName – the name of the environment 
       variable
/**
     * Set the config object to use the specified environment variable to
     * load the value for the "unicode normalization ignored" parameter.
     * 
     * @param unicodeNormalizationIgnoredEnvName the name of the environment 
     *        variable
     */
    public void setUnicodeNormalizationIgnoredEnvName(final String unicodeNormalizationIgnoredEnvName) {
        this.unicodeNormalizationIgnoredEnvName = 
            unicodeNormalizationIgnoredEnvName;
        if (unicodeNormalizationIgnoredEnvName == null) {
            this.unicodeNormalizationIgnored = null;
        } else {
            this.unicodeNormalizationIgnoredSysPropertyName = null;
            final String unicodeNormalizationIgnoredValue = 
                System.getenv(unicodeNormalizationIgnoredEnvName);
            if (unicodeNormalizationIgnoredValue != null) {
                this.unicodeNormalizationIgnored =
                    CommonUtils.getStandardBooleanValue(
                            unicodeNormalizationIgnoredValue);
            } else {
                this.unicodeNormalizationIgnored = null;
            }
        }
    }


    
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
/**
     * Retrieve the name of the JVM system property which value has been
     * loaded as a value for the "unicode normalization ignored" parameter.
     *   
     * @return the name of the property
     */
    public String getUnicodeNormalizationIgnoredSysPropertyName() {
        return this.unicodeNormalizationIgnoredSysPropertyName;
    }


    
Set the config object to use the specified JVM system property to
load a value for the "unicode normalization ignored" parameter.

Params:
  • unicodeNormalizationIgnoredSysPropertyName – the name of the property
/**
     * Set the config object to use the specified JVM system property to
     * load a value for the "unicode normalization ignored" parameter.
     * 
     * @param unicodeNormalizationIgnoredSysPropertyName the name of the property
     */
    public void setUnicodeNormalizationIgnoredSysPropertyName(final String unicodeNormalizationIgnoredSysPropertyName) {
        this.unicodeNormalizationIgnoredSysPropertyName = 
            unicodeNormalizationIgnoredSysPropertyName;
        if (unicodeNormalizationIgnoredSysPropertyName == null) {
            this.unicodeNormalizationIgnored = null;
        } else {
            this.unicodeNormalizationIgnoredEnvName = null;
            final String unicodeNormalizationIgnoredValue = 
                System.getProperty(unicodeNormalizationIgnoredSysPropertyName);
            if (unicodeNormalizationIgnoredValue != null) {
                this.unicodeNormalizationIgnored =
                    CommonUtils.getStandardBooleanValue(
                            unicodeNormalizationIgnoredValue);
            } else {
                this.unicodeNormalizationIgnored = null;
            }
        }
    }


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

Returns:the name of the variable
/**
     * Retrieve the name of the environment variable which value has been
     * loaded as the String output type.
     *   
     * @return the name of the variable
     */
    public String getStringOutputTypeEnvName() {
        return this.stringOutputTypeEnvName;
    }


    
Set the config object to use the specified environment variable to
load the value for the String output type.

Params:
  • stringOutputTypeEnvName – the name of the environment variable
/**
     * Set the config object to use the specified environment variable to
     * load the value for the String output type.
     * 
     * @param stringOutputTypeEnvName the name of the environment variable
     */
    public void setStringOutputTypeEnvName(final String stringOutputTypeEnvName) {
        this.stringOutputTypeEnvName = stringOutputTypeEnvName;
        if (stringOutputTypeEnvName == null) {
            this.stringOutputType = null;
        } else {
            this.stringOutputTypeSysPropertyName = null;
            this.stringOutputType =
                CommonUtils.getStandardStringOutputType(
                        System.getenv(stringOutputTypeEnvName));
        }
    }


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

Returns:the name of the property
/**
     * Retrieve the name of the JVM system property which value has been
     * loaded as the String output type.
     *   
     * @return the name of the property
     */
    public String getStringOutputTypeSysPropertyName() {
        return this.stringOutputTypeSysPropertyName;
    }


    
Set the config object to use the specified JVM system property to
load the value for the String output type.

Params:
  • stringOutputTypeSysPropertyName – the name of the property
/**
     * Set the config object to use the specified JVM system property to
     * load the value for the String output type.
     * 
     * @param stringOutputTypeSysPropertyName the name of the property
     */
    public void setStringOutputTypeSysPropertyName(final String stringOutputTypeSysPropertyName) {
        this.stringOutputTypeSysPropertyName = stringOutputTypeSysPropertyName;
        if (stringOutputTypeSysPropertyName == null) {
            this.stringOutputType = null;
        } else {
            this.stringOutputTypeEnvName = null;
            this.stringOutputType =
                CommonUtils.getStandardStringOutputType(
                        System.getProperty(stringOutputTypeSysPropertyName));
        }
    }

    
    

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.



Params:
  • unicodeNormalizationIgnored – whether the unicode text 
       normalization step should be ignored or not.
/**
     * <p>
     * Sets whether the unicode text normalization step should be ignored.
     * </p>
     * <p>
     * The Java Virtual Machine internally handles all Strings as UNICODE. When
     * digesting or matching digests in jasypt, these Strings are first 
     * <b>normalized to 
     * its NFC form</b> so that digest matching is not affected by the specific
     * form in which the messages where input.
     * </p>
     * <p>
     * <b>It is normally safe (and recommended) to leave this parameter set to 
     * its default FALSE value (and thus DO perform normalization 
     * operations)</b>. But in some specific cases in which issues with legacy
     * software could arise, it might be useful to set this to TRUE.
     * </p>
     * <p>
     * For more information on unicode text normalization, see this issue of 
     * <a href="http://java.sun.com/mailers/techtips/corejava/2007/tt0207.html">Core Java Technologies Tech Tips</a>.
     * </p>
     * <p>
     * If not set, null will be returned.
     * </p>
     * 
     * @param unicodeNormalizationIgnored whether the unicode text 
     *        normalization step should be ignored or not.
     */
    public void setUnicodeNormalizationIgnored(final Boolean unicodeNormalizationIgnored) {
        this.unicodeNormalizationIgnoredEnvName = null;
        this.unicodeNormalizationIgnoredSysPropertyName = null;
        this.unicodeNormalizationIgnored = 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.



Params:
  • unicodeNormalizationIgnored – whether the unicode text 
       normalization step should be ignored or not.
Since:1.4
/**
     * <p>
     * Sets whether the unicode text normalization step should be ignored.
     * </p>
     * <p>
     * The Java Virtual Machine internally handles all Strings as UNICODE. When
     * digesting or matching digests in jasypt, these Strings are first 
     * <b>normalized to 
     * its NFC form</b> so that digest matching is not affected by the specific
     * form in which the messages where input.
     * </p>
     * <p>
     * <b>It is normally safe (and recommended) to leave this parameter set to 
     * its default FALSE value (and thus DO perform normalization 
     * operations)</b>. But in some specific cases in which issues with legacy
     * software could arise, it might be useful to set this to TRUE.
     * </p>
     * <p>
     * For more information on unicode text normalization, see this issue of 
     * <a href="http://java.sun.com/mailers/techtips/corejava/2007/tt0207.html">Core Java Technologies Tech Tips</a>.
     * </p>
     * <p>
     * If not set, null will be returned.
     * </p>
     * 
     * @since 1.4
     * 
     * @param unicodeNormalizationIgnored whether the unicode text 
     *        normalization step should be ignored or not.
     */
    public void setUnicodeNormalizationIgnored(final String unicodeNormalizationIgnored) {
        this.unicodeNormalizationIgnoredEnvName = null;
        this.unicodeNormalizationIgnoredSysPropertyName = null;
        if (unicodeNormalizationIgnored != null) {
            this.unicodeNormalizationIgnored = 
                CommonUtils.getStandardBooleanValue(unicodeNormalizationIgnored);
        } else {
            this.unicodeNormalizationIgnored = null;
        }
    }

    
    

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



    
  
  • base64 (default)
    • 
  
  • hexadecimal
    • 




If not set, null will be returned.



Params:
  • stringOutputType – the string output type.
/**
     * <p>
     * Sets the the form in which String output
     * will be encoded. Available encoding types are:
     * </p>
     * <ul>
     *   <li><tt><b>base64</b></tt> (default)</li>
     *   <li><tt><b>hexadecimal</b></tt></li>
     * </ul>
     * <p>
     * If not set, null will be returned.
     * </p>
     * 
     * @param stringOutputType the string output type.
     */
    public void setStringOutputType(final String stringOutputType) {
        this.stringOutputTypeEnvName = null;
        this.stringOutputTypeSysPropertyName = null;
        this.stringOutputType =
            CommonUtils.
                getStandardStringOutputType(stringOutputType);
    }
    
    


    
 Sets the prefix to be added at the beginning of encryption results, and also to be expected at the beginning of plain messages provided for matching operations (raising an EncryptionOperationNotPossibleException if not). 



If not set, null will be returned.



 Determines the result of: getPrefix() 


Params:
  • prefix – 
Since:1.7
/**
     * <p>
     * Sets the prefix to be added at the beginning of encryption results, and also to
     * be expected at the beginning of plain messages provided for matching operations
     * (raising an {@link EncryptionOperationNotPossibleException} if not).
     * </p>
     * <p>
     * If not set, null will be returned.
     * </p>
     * <p>
     * Determines the result of: {@link #getPrefix()}
     * </p>
     * 
     * @since 1.7
     * 
     * @param prefix
     */
    public void setPrefix(final String prefix) {
        this.prefixEnvName = null;
        this.prefixSysPropertyName = null;
        this.prefix = prefix;
    }
    


    
 Sets the suffix to be added at the end of encryption results, and also to be expected at the end of plain messages provided for matching operations (raising an EncryptionOperationNotPossibleException if not). 



If not set, null will be returned.



 Determines the result of: getSuffix() 


Params:
  • suffix – 
Since:1.7
/**
     * <p>
     * Sets the suffix to be added at the end of encryption results, and also to
     * be expected at the end of plain messages provided for matching operations
     * (raising an {@link EncryptionOperationNotPossibleException} if not).
     * </p>
     * <p>
     * If not set, null will be returned.
     * </p>
     * <p>
     * Determines the result of: {@link #getSuffix()}
     * </p>
     * 
     * @since 1.7
     * 
     * @param suffix
     */
    public void setSuffix(final String suffix) {
        this.suffixEnvName = null;
        this.suffixSysPropertyName = null;
        this.suffix = suffix;
    }
    
    
    
    public Boolean isUnicodeNormalizationIgnored() {
        return this.unicodeNormalizationIgnored;
    }

    
    public String getStringOutputType() {
        return this.stringOutputType;
    }



    public String getPrefix() {
        return this.prefix;
    }


    public String getSuffix() {
        return this.suffix;
    }

    
    
    
    


    
Retrieve the name of the environment variable which value has been
loaded as a value for the "prefix" parameter.

Since:1.7
Returns:the name of the variable
/**
     * Retrieve the name of the environment variable which value has been
     * loaded as a value for the "prefix" parameter.
     *
     * @since 1.7
     * 
     * @return the name of the variable
     */
    public String getPrefixEnvName() {
        return this.prefixEnvName;
    }



    
Set the config object to use the specified environment variable to
load the value for the "prefix" parameter.

Params:
  • prefixEnvName – the name of the environment 
       variable
Since:1.7
/**
     * Set the config object to use the specified environment variable to
     * load the value for the "prefix" parameter.
     * 
     * @since 1.7
     * 
     * @param prefixEnvName the name of the environment 
     *        variable
     */
    public void setPrefixEnvName(final String prefixEnvName) {
        this.prefixEnvName = prefixEnvName;
        if (prefixEnvName == null) {
            this.prefix = null;
        } else {
            this.prefixSysPropertyName = null;
            this.prefix = System.getenv(prefixEnvName);
        }
    }



    
Retrieve the name of the JVM system property which value has been
loaded as a value for the "prefix" parameter.

Since:1.7
Returns:the name of the property
/**
     * Retrieve the name of the JVM system property which value has been
     * loaded as a value for the "prefix" parameter.
     * 
     * @since 1.7
     *   
     * @return the name of the property
     */
    public String getPrefixSysPropertyName() {
        return this.prefixSysPropertyName;
    }



    
Set the config object to use the specified JVM system property to
load a value for the "prefix" parameter.

Params:
  • prefixSysPropertyName – the name of the property
Since:1.7
/**
     * Set the config object to use the specified JVM system property to
     * load a value for the "prefix" parameter.
     * 
     * @since 1.7
     * 
     * @param prefixSysPropertyName the name of the property
     */
    public void setPrefixSysPropertyName(final String prefixSysPropertyName) {
        this.prefixSysPropertyName = prefixSysPropertyName;
        if (prefixSysPropertyName == null) {
            this.prefix = null;
        } else {
            this.prefixEnvName = null;
            this.prefix = System.getProperty(prefixSysPropertyName);
        }
    }



    
Retrieve the name of the environment variable which value has been
loaded as a value for the "suffix" parameter.

Since:1.7
Returns:the name of the variable
/**
     * Retrieve the name of the environment variable which value has been
     * loaded as a value for the "suffix" parameter.
     *
     * @since 1.7
     * 
     * @return the name of the variable
     */
    public String getSuffixEnvName() {
        return this.suffixEnvName;
    }



    
Set the config object to use the specified environment variable to
load the value for the "suffix" parameter.

Params:
  • suffixEnvName – the name of the environment 
       variable
Since:1.7
/**
     * Set the config object to use the specified environment variable to
     * load the value for the "suffix" parameter.
     * 
     * @since 1.7
     * 
     * @param suffixEnvName the name of the environment 
     *        variable
     */
    public void setSuffixEnvName(final String suffixEnvName) {
        this.suffixEnvName = suffixEnvName;
        if (suffixEnvName == null) {
            this.suffix = null;
        } else {
            this.suffixSysPropertyName = null;
            this.suffix = System.getenv(suffixEnvName);
        }
    }



    
Retrieve the name of the JVM system property which value has been
loaded as a value for the "suffix" parameter.

Since:1.7
Returns:the name of the property
/**
     * Retrieve the name of the JVM system property which value has been
     * loaded as a value for the "suffix" parameter.
     * 
     * @since 1.7
     *   
     * @return the name of the property
     */
    public String getSuffixSysPropertyName() {
        return this.suffixSysPropertyName;
    }



    
Set the config object to use the specified JVM system property to
load a value for the "suffix" parameter.

Params:
  • suffixSysPropertyName – the name of the property
Since:1.7
/**
     * Set the config object to use the specified JVM system property to
     * load a value for the "suffix" parameter.
     * 
     * @since 1.7
     * 
     * @param suffixSysPropertyName the name of the property
     */
    public void setSuffixSysPropertyName(final String suffixSysPropertyName) {
        this.suffixSysPropertyName = suffixSysPropertyName;
        if (suffixSysPropertyName == null) {
            this.suffix = null;
        } else {
            this.suffixEnvName = null;
            this.suffix = System.getProperty(suffixSysPropertyName);
        }
    }


    
    
    
    
}