All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jasypt.digest.config.StringDigesterConfig Maven / Gradle / Ivy

There is a newer version: 6.1.3
Show newest version
/*
 * =============================================================================
 * 
 *   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;




/**
 * 

* Common interface for config classes applicable to * {@link org.jasypt.digest.StandardStringDigester} objects. This interface * extends {@link DigesterConfig} to add config parameters specific to * String digesting. *

*

* This interface lets the user create new StringDigesterConfig * classes which retrieve values for this parameters from different * (and maybe more secure) sources (remote servers, LDAP, other databases...), * and do this transparently for the digester object. *

*

* The config objects passed to a digester will only be queried once * for each configuration parameter, and this will happen * during the initialization of the digester object. *

*

* For a default implementation, see {@link SimpleStringDigesterConfig}. *

* * @since 1.3 * * @author Daniel Fernández * */ public interface StringDigesterConfig extends DigesterConfig { /** *

* 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. *

* * @return whether the unicode text normalization step should be ignored or * not. */ public Boolean isUnicodeNormalizationIgnored(); /** *

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

*
    *
  • base64 (default)
  • *
  • hexadecimal
  • *
* * @return The name of the encoding type for String output */ public String getStringOutputType(); /** *

* Adds the returned (plain) prefix at the beginning of generated digests, * and also expects to find it in any plain message provided for matching * operations (raising an {@link EncryptionOperationNotPossibleException} * if not). *

* * @since 1.7 * * @return the prefix to be added to all digests */ public String getPrefix(); /** *

* Adds the returned (plain) suffix at the end of generated digests, * and also expects to find it in any plain message provided for matching * operations (raising an {@link EncryptionOperationNotPossibleException} * if not). *

* * @since 1.7 * * @return the suffix to be added to all digests */ public String getSuffix(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy