org.jasypt.encryption.pbe.config.StringPBEConfig Maven / Gradle / Ivy
/*
* =============================================================================
*
* 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.encryption.pbe.config;
/**
*
* Common interface for config classes applicable to
* {@link org.jasypt.encryption.pbe.StandardPBEStringEncryptor} objects.
* This interface extends {@link PBEConfig} to add config parameters specific
* to String encryption.
*
*
* This interface lets the user create new PBEConfig
* 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 encryptor object.
*
*
* The config objects passed to an encryptor will only be queried once
* for each configuration parameter, and this will happen
* during the initialization of the encryptor object.
*
*
* For a default implementation, see {@link SimpleStringPBEConfig}.
*
*
* @since 1.3
*
* @author Daniel Fernández
*
*/
public interface StringPBEConfig extends PBEConfig {
/**
*
* 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();
}