/*
 * =============================================================================
 * 
 *   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;


 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. 

Author:
Daniel Fernández
Since:
1.3/**
 * <p>
 * Bean implementation for {@link StringDigesterConfig}. This class allows 
 * the values for the configuration parameters to be set
 * via "standard" <tt>setX</tt> methods.
 * </p>
 * <p>
 * For any of the configuration parameters, if its <tt>setX</tt>
 * method is not called, 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 SimpleStringDigesterConfig 
        extends SimpleDigesterConfig
        implements StringDigesterConfig {
    
    private Boolean unicodeNormalizationIgnored = null;
    private String stringOutputType = null;
    private String prefix = null;
    private String suffix = null;
    

    

Creates a new SimpleStringDigesterConfig instance.

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

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() 
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>
     * <p>
     * Determines the result of: {@link #isUnicodeNormalizationIgnored()}
     * </p>
     * 
     * @param unicodeNormalizationIgnored whether the unicode text 
     *        normalization step should be ignored or not.
     */
    public void setUnicodeNormalizationIgnored(final Boolean unicodeNormalizationIgnored) {
        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.

 Determines the result of: isUnicodeNormalizationIgnored() 
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>
     * <p>
     * Determines the result of: {@link #isUnicodeNormalizationIgnored()}
     * </p>
     *
     * @since 1.4
     * 
     * @param unicodeNormalizationIgnored whether the unicode text 
     *        normalization step should be ignored or not.
     */
    public void setUnicodeNormalizationIgnored(final String unicodeNormalizationIgnored) {
        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.

 Determines the result of: getStringOutputType() 
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>
     * <p>
     * Determines the result of: {@link #getStringOutputType()}
     * </p>
     * 
     * @param stringOutputType the string output type.
     */
    public void setStringOutputType(final String stringOutputType) {
        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.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.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;
    }

    
}