dk.heick.properties.types.custom

Interface Encryption

All Known Subinterfaces:

MarkerPasswordPropertyType, PasswordEncryption

All Known Implementing Classes:

AbstractEncryption, AbstractPasswordEncryption, AESEncryption, MD5Encryption, PasswordPropertyType, SHA512Encryption

public interface Encryption

Interface for an encryption implementation

Since:

2.0

Author:

Frederik Heick

Field Summary

Fields

Modifier and Type	Field and Description
static char	ENCRYPTION_METHOD_END_CHAR The end char which encapsulates the encryption method.
static char	ENCRYPTION_METHOD_START_CHAR The start char which encapsulates the encryption method.

Method Summary

Modifier and Type	Method and Description
String	getDecryptedValue(String value) Decrypt's a string value.
String	getEncryptedValue(String value) Encrypts a string value.
String	getEncryptionMethod() Gets the method name of encryption.
boolean	isDecryptable() Determines if the encrypted string is decryptable, with the method used.
boolean	isEncrypted(String value) Determines if the value is already in in encrypted form.

Field Detail

ENCRYPTION_METHOD_START_CHAR

static final char ENCRYPTION_METHOD_START_CHAR

The start char which encapsulates the encryption method.

See Also:

Constant Field Values

ENCRYPTION_METHOD_END_CHAR

static final char ENCRYPTION_METHOD_END_CHAR

The end char which encapsulates the encryption method.

See Also:

Constant Field Values

Method Detail

getEncryptionMethod

String getEncryptionMethod()

Gets the method name of encryption.

Returns:

short encryption name.

getEncryptedValue

String getEncryptedValue(String value)
                  throws PropertyException

Encrypts a string value.

Parameters:

value - the string value

Returns:

return the encrypted string with "[method]encryptedvalue"

Throws:

PropertyException - if value is null or encryption is not possible or an error during encryption as occurred.

getDecryptedValue

String getDecryptedValue(String value)
                  throws PropertyException

Decrypt's a string value.

Parameters:

value - the string value

Returns:

the decrypted string, must be able to handle that "[method]" is a front the encrypted value.

Throws:

PropertyException - if value is null or decryption is not possible or an error during decryption as occurred.

isDecryptable

boolean isDecryptable()

Determines if the encrypted string is decryptable, with the method used.

Returns:

true if it is decryptable, otherwise false.

isEncrypted

boolean isEncrypted(String value)
             throws PropertyException

Determines if the value is already in in encrypted form. Determines if "[method]" is a front the string value.

Parameters:

value - the string

Returns:

true if the string is encrypted otherwise false, also returns false if the value is null. Determines if "[method]" is a front the string value.

Throws:

PropertyException - if a the password is encrypted with another method.