org.antfarmer.ejce

Interface ValueEncryptorInterface<T extends ValueEncryptorInterface<T>>

Type Parameters:

T - the concrete type of this Encryptor object.

All Superinterfaces:

EncryptorInterface<T>

All Known Implementing Classes:

AbstractValueEncryptor, Encryptor

public interface ValueEncryptorInterface<T extends ValueEncryptorInterface<T>>
extends EncryptorInterface<T>

Interface for encrypting/decrypting text and other values.

Method Summary

Modifier and Type	Method and Description
String	decrypt(String text) Returns the decoded and decrypted text for the given text representation.
String	decrypt(String text, Key key) Returns the decoded and decrypted text for the given text representation, using the given Key.
byte[]	decryptAndDecode(String text) Returns the decoded and decrypted bytes for the given text representation.
byte[]	decryptAndDecode(String text, Key key) Returns the decoded and decrypted bytes for the given text representation, using the given Key.
Boolean	decryptBoolean(String text) Returns the decoded and decrypted boolean for the given text representation.
Boolean	decryptBoolean(String text, Key key) Returns the decoded and decrypted boolean for the given text representation, using the given Key.
Character	decryptCharacter(String text) Returns the decoded and decrypted character for the given text representation.
Character	decryptCharacter(String text, Key key) Returns the decoded and decrypted character for the given text representation, using the given Key.
Double	decryptDouble(String text) Returns the decoded and decrypted double for the given text representation.
Double	decryptDouble(String text, Key key) Returns the decoded and decrypted double for the given text representation, using the given Key.
Float	decryptFloat(String text) Returns the decoded and decrypted float for the given text representation.
Float	decryptFloat(String text, Key key) Returns the decoded and decrypted float for the given text representation, using the given Key.
Integer	decryptInteger(String text) Returns the decoded and decrypted integer for the given text representation.
Integer	decryptInteger(String text, Key key) Returns the decoded and decrypted integer for the given text representation, using the given Key.
Long	decryptLong(String text) Returns the decoded and decrypted long for the given text representation.
Long	decryptLong(String text, Key key) Returns the decoded and decrypted long for the given text representation, using the given Key.
Object	decryptObject(String text) Returns the decoded and decrypted object for the given text representation.
Object	decryptObject(String text, Key key) Returns the decoded and decrypted object for the given text representation, using the given Key.
Short	decryptShort(String text) Returns the decoded and decrypted short for the given text representation.
Short	decryptShort(String text, Key key) Returns the decoded and decrypted short for the given text representation, using the given Key.
String	encrypt(String text) Returns an encrypted and encoded text representation of the given text.
String	encrypt(String text, Key key) Returns an encrypted and encoded text representation of the given text, using the given Key.
String	encryptAndEncode(byte[] bytes) Returns an encrypted and encoded text representation of the given bytes.
String	encryptAndEncode(byte[] bytes, Key key) Returns an encrypted and encoded text representation of the given bytes, using the given Key.
String	encryptBoolean(Boolean value) Returns an encrypted and encoded text representation of the given boolean.
String	encryptBoolean(Boolean value, Key key) Returns an encrypted and encoded text representation of the given boolean, using the given Key.
String	encryptCharacter(Character number) Returns an encrypted and encoded text representation of the given character.
String	encryptCharacter(Character number, Key key) Returns an encrypted and encoded text representation of the given character, using the given Key.
String	encryptDouble(Double number) Returns an encrypted and encoded text representation of the given double.
String	encryptDouble(Double number, Key key) Returns an encrypted and encoded text representation of the given double, using the given Key.
String	encryptFloat(Float number) Returns an encrypted and encoded text representation of the given float.
String	encryptFloat(Float number, Key key) Returns an encrypted and encoded text representation of the given float, using the given Key.
String	encryptInteger(Integer number) Returns an encrypted and encoded text representation of the given integer.
String	encryptInteger(Integer number, Key key) Returns an encrypted and encoded text representation of the given integer, using the given Key.
String	encryptLong(Long number) Returns an encrypted and encoded text representation of the given long.
String	encryptLong(Long number, Key key) Returns an encrypted and encoded text representation of the given long, using the given Key.
String	encryptObject(Object object) Returns an encrypted and encoded text representation of the given object.
String	encryptObject(Object object, Key key) Returns an encrypted and encoded text representation of the given object, using the given Key.
String	encryptShort(Short number) Returns an encrypted and encoded text representation of the given short.
String	encryptShort(Short number, Key key) Returns an encrypted and encoded text representation of the given short, using the given Key.

Methods inherited from interface org.antfarmer.ejce.EncryptorInterface

decrypt, decrypt, encrypt, encrypt, getAlgorithmParameters, getCharset, initialize, isInitialized, setAlgorithmParameters

Method Detail

encrypt

String encrypt(String text)
        throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given text.

Parameters:

text - the text to be encrypted

Returns:

an encrypted and encoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

decrypt

String decrypt(String text)
        throws GeneralSecurityException

Returns the decoded and decrypted text for the given text representation. This method will only work with data encrypted using the encrypt method.

Parameters:

text - the text to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptAndEncode

String encryptAndEncode(byte[] bytes)
                 throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given bytes.

Parameters:

bytes - the bytes to be encrypted

Returns:

an encrypted and encoded version of the bytes

Throws:

GeneralSecurityException - GeneralSecurityException

decryptAndDecode

byte[] decryptAndDecode(String text)
                 throws GeneralSecurityException

Returns the decoded and decrypted bytes for the given text representation. This method will only work with data encrypted using the encryptAndEncode method.

Parameters:

text - the text to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptBoolean

String encryptBoolean(Boolean value)
               throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given boolean. This is generally the most efficient means of encrypting a boolean, as the bit representation is used for encryption rather than the string representation.

Parameters:

value - the short to be encrypted

Returns:

an encrypted and encoded version of the boolean

Throws:

GeneralSecurityException - GeneralSecurityException

decryptBoolean

Boolean decryptBoolean(String text)
                throws GeneralSecurityException

Returns the decoded and decrypted boolean for the given text representation. This method will only work with data encrypted using the encryptBoolean method.

Parameters:

text - the text to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptCharacter

String encryptCharacter(Character number)
                 throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given character.

Parameters:

number - the character to be encrypted

Returns:

an encrypted and encoded version of the character

Throws:

GeneralSecurityException - GeneralSecurityException

decryptCharacter

Character decryptCharacter(String text)
                    throws GeneralSecurityException

Returns the decoded and decrypted character for the given text representation. This method will only work with data encrypted using the encryptCharacter method.

Parameters:

text - the character to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptDouble

String encryptDouble(Double number)
              throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given double. This is generally the most efficient means of encrypting a double, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the double to be encrypted

Returns:

an encrypted and encoded version of the double

Throws:

GeneralSecurityException - GeneralSecurityException

decryptDouble

Double decryptDouble(String text)
              throws GeneralSecurityException

Returns the decoded and decrypted double for the given text representation. This method will only work with data encrypted using the encryptDouble method.

Parameters:

text - the double to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptFloat

String encryptFloat(Float number)
             throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given float. This is generally the most efficient means of encrypting a float, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the float to be encrypted

Returns:

an encrypted and encoded version of the float

Throws:

GeneralSecurityException - GeneralSecurityException

decryptFloat

Float decryptFloat(String text)
            throws GeneralSecurityException

Returns the decoded and decrypted float for the given text representation. This method will only work with data encrypted using the encryptFloat method.

Parameters:

text - the float to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptInteger

String encryptInteger(Integer number)
               throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given integer. This is generally the most efficient means of encrypting an integer, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the integer to be encrypted

Returns:

an encrypted and encoded version of the integer

Throws:

GeneralSecurityException - GeneralSecurityException

decryptInteger

Integer decryptInteger(String text)
                throws GeneralSecurityException

Returns the decoded and decrypted integer for the given text representation. This method will only work with data encrypted using the encryptInteger method.

Parameters:

text - the text to be decrypted

Returns:

a decrypted and decoded version of the integer

Throws:

GeneralSecurityException - GeneralSecurityException

encryptLong

String encryptLong(Long number)
            throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given long. This is generally the most efficient means of encrypting a long, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the long to be encrypted

Returns:

an encrypted and encoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

decryptLong

Long decryptLong(String text)
          throws GeneralSecurityException

Returns the decoded and decrypted long for the given text representation. This method will only work with data encrypted using the encryptLong method.

Parameters:

text - the text to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptObject

String encryptObject(Object object)
              throws GeneralSecurityException,
                     IOException

Returns an encrypted and encoded text representation of the given object. The object should implement Serializable.

Parameters:

object - the object to be encrypted

Returns:

an encrypted and encoded version of the object

Throws:

GeneralSecurityException - GeneralSecurityException

IOException - IOException

decryptObject

Object decryptObject(String text)
              throws GeneralSecurityException,
                     IOException,
                     ClassNotFoundException

Returns the decoded and decrypted object for the given text representation. This method will only work with data encrypted using the encryptObject method.

Parameters:

text - the text to be decrypted

Returns:

a decrypted and decoded version of the object

Throws:

GeneralSecurityException - GeneralSecurityException

IOException - IOException

ClassNotFoundException - ClassNotFoundException

encryptShort

String encryptShort(Short number)
             throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given short. This is generally the most efficient means of encrypting a short, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the short to be encrypted

Returns:

an encrypted and encoded version of the short

Throws:

GeneralSecurityException - GeneralSecurityException

decryptShort

Short decryptShort(String text)
            throws GeneralSecurityException

Returns the decoded and decrypted short for the given text representation. This method will only work with data encrypted using the encryptShort method.

Parameters:

text - the text to be decrypted

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encrypt

String encrypt(String text,
               Key key)
        throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given text, using the given Key.

Parameters:

text - the text to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

decrypt

String decrypt(String text,
               Key key)
        throws GeneralSecurityException

Returns the decoded and decrypted text for the given text representation, using the given Key. This method will only work with data encrypted using the encrypt method.

Parameters:

text - the text to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptAndEncode

String encryptAndEncode(byte[] bytes,
                        Key key)
                 throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given bytes, using the given Key.

Parameters:

bytes - the bytes to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the bytes

Throws:

GeneralSecurityException - GeneralSecurityException

decryptAndDecode

byte[] decryptAndDecode(String text,
                        Key key)
                 throws GeneralSecurityException

Returns the decoded and decrypted bytes for the given text representation, using the given Key. This method will only work with data encrypted using the encryptAndEncode method.

Parameters:

text - the text to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptBoolean

String encryptBoolean(Boolean value,
                      Key key)
               throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given boolean, using the given Key. This is generally the most efficient means of encrypting a boolean, as the bit representation is used for encryption rather than the string representation.

Parameters:

value - the short to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the boolean

Throws:

GeneralSecurityException - GeneralSecurityException

decryptBoolean

Boolean decryptBoolean(String text,
                       Key key)
                throws GeneralSecurityException

Returns the decoded and decrypted boolean for the given text representation, using the given Key. This method will only work with data encrypted using the encryptBoolean method.

Parameters:

text - the text to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptCharacter

String encryptCharacter(Character number,
                        Key key)
                 throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given character, using the given Key.

Parameters:

number - the character to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the character

Throws:

GeneralSecurityException - GeneralSecurityException

decryptCharacter

Character decryptCharacter(String text,
                           Key key)
                    throws GeneralSecurityException

Returns the decoded and decrypted character for the given text representation, using the given Key. This method will only work with data encrypted using the encryptCharacter method.

Parameters:

text - the character to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptDouble

String encryptDouble(Double number,
                     Key key)
              throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given double, using the given Key. This is generally the most efficient means of encrypting a double, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the double to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the double

Throws:

GeneralSecurityException - GeneralSecurityException

decryptDouble

Double decryptDouble(String text,
                     Key key)
              throws GeneralSecurityException

Returns the decoded and decrypted double for the given text representation, using the given Key. This method will only work with data encrypted using the encryptDouble method.

Parameters:

text - the double to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptFloat

String encryptFloat(Float number,
                    Key key)
             throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given float, using the given Key. This is generally the most efficient means of encrypting a float, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the float to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the float

Throws:

GeneralSecurityException - GeneralSecurityException

decryptFloat

Float decryptFloat(String text,
                   Key key)
            throws GeneralSecurityException

Returns the decoded and decrypted float for the given text representation, using the given Key. This method will only work with data encrypted using the encryptFloat method.

Parameters:

text - the float to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptInteger

String encryptInteger(Integer number,
                      Key key)
               throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given integer, using the given Key. This is generally the most efficient means of encrypting an integer, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the integer to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the integer

Throws:

GeneralSecurityException - GeneralSecurityException

decryptInteger

Integer decryptInteger(String text,
                       Key key)
                throws GeneralSecurityException

Returns the decoded and decrypted integer for the given text representation, using the given Key. This method will only work with data encrypted using the encryptInteger method.

Parameters:

text - the text to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the integer

Throws:

GeneralSecurityException - GeneralSecurityException

encryptLong

String encryptLong(Long number,
                   Key key)
            throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given long, using the given Key. This is generally the most efficient means of encrypting a long, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the long to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

decryptLong

Long decryptLong(String text,
                 Key key)
          throws GeneralSecurityException

Returns the decoded and decrypted long for the given text representation, using the given Key. This method will only work with data encrypted using the encryptLong method.

Parameters:

text - the text to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException

encryptObject

String encryptObject(Object object,
                     Key key)
              throws GeneralSecurityException,
                     IOException

Returns an encrypted and encoded text representation of the given object, using the given Key. The object should implement Serializable.

Parameters:

object - the object to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the object

Throws:

GeneralSecurityException - GeneralSecurityException

IOException - IOException

decryptObject

Object decryptObject(String text,
                     Key key)
              throws GeneralSecurityException,
                     IOException,
                     ClassNotFoundException

Returns the decoded and decrypted object for the given text representation, using the given Key. This method will only work with data encrypted using the encryptObject method.

Parameters:

text - the text to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the object

Throws:

GeneralSecurityException - GeneralSecurityException

IOException - IOException

ClassNotFoundException - ClassNotFoundException

encryptShort

String encryptShort(Short number,
                    Key key)
             throws GeneralSecurityException

Returns an encrypted and encoded text representation of the given short, using the given Key. This is generally the most efficient means of encrypting a short, as the byte representation is used for encryption rather than the string representation.

Parameters:

number - the short to be encrypted

key - the encryption key

Returns:

an encrypted and encoded version of the short

Throws:

GeneralSecurityException - GeneralSecurityException

decryptShort

Short decryptShort(String text,
                   Key key)
            throws GeneralSecurityException

Returns the decoded and decrypted short for the given text representation, using the given Key. This method will only work with data encrypted using the encryptShort method.

Parameters:

text - the text to be decrypted

key - the decryption key

Returns:

a decrypted and decoded version of the text

Throws:

GeneralSecurityException - GeneralSecurityException