Package org.opencms.crypto

Interface I_CmsTextEncryption

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

CmsAESTextEncryption

public interface I_CmsTextEncryption
extends I_CmsConfigurationParameterHandler

Interfaces for classes that encrypt text as text.

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	Description
java.lang.String	decrypt(java.lang.String input)	Decrypts encrypted data.
java.lang.String	encrypt(java.lang.String input)	Encrypts data.
java.lang.String	getName()	Gets the name of the encryption handler.
void	initialize(CmsObject cms)	Initializes the encryption handler.
void	setName(java.lang.String name)	Sets the name of the encryption handler.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Detail

decrypt

java.lang.String decrypt(java.lang.String input)
                  throws CmsEncryptionException

Decrypts encrypted data.

Parameters:

input - the encrypted data

Returns:

the decrypted data

Throws:

CmsEncryptionException - if the data couldn't be decrypted

encrypt

java.lang.String encrypt(java.lang.String input)
                  throws CmsEncryptionException

Encrypts data.

Parameters:

input - the data to encrypt

Returns:

the encrypted data

Throws:

CmsEncryptionException - if the data couldn't be encrypted

getName

java.lang.String getName()

Gets the name of the encryption handler.

Returns:

the name

initialize

void initialize(CmsObject cms)

Initializes the encryption handler.

Parameters:

cms - an Admin CMS context

setName

void setName(java.lang.String name)

Sets the name of the encryption handler.

Parameters:

name - the name that should be set