org.antfarmer.ejce

Interface EncryptorInterface<T extends EncryptorInterface<T>>

Type Parameters:

T - the concrete type of this Encryptor object.

All Known Subinterfaces:

ValueEncryptorInterface<T>

All Known Implementing Classes:

AbstractEncryptor, AbstractValueEncryptor, Encryptor

public interface EncryptorInterface<T extends EncryptorInterface<T>>

Interface for encrypting/decrypting byte arrays.

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(byte[] bytes) Decrypts the byte array.
byte[]	decrypt(byte[] bytes, Key decKey) Decrypts the byte array using the given Key.
byte[]	encrypt(byte[] bytes) Encrypts the byte array.
byte[]	encrypt(byte[] bytes, Key encKey) Encrypts the byte array using the given Key.
AlgorithmParameters<?>	getAlgorithmParameters() Gets the algorithm parameters used for initialization.
Charset	getCharset() Returns the charset used by the encryptor.
void	initialize() Initializes the encryptor.
boolean	isInitialized() Indicates whether or not the encryptor has been initialized.
T	setAlgorithmParameters(AlgorithmParameters<?> parameters) Sets the algorithm parameters used for initialization.

Method Detail

initialize

void initialize()
         throws GeneralSecurityException

Initializes the encryptor. AlgorithmParameters must be set before calling this method.

Throws:

GeneralSecurityException - GeneralSecurityException

encrypt

byte[] encrypt(byte[] bytes)
        throws GeneralSecurityException

Encrypts the byte array.

Parameters:

bytes - the byte array to be encrypted

Returns:

the encrypted byte array

Throws:

GeneralSecurityException - GeneralSecurityException

encrypt

byte[] encrypt(byte[] bytes,
               Key encKey)
        throws GeneralSecurityException

Encrypts the byte array using the given Key.

Parameters:

bytes - the byte array to be encrypted

encKey - the encryption key

Returns:

the encrypted byte array

Throws:

GeneralSecurityException - GeneralSecurityException

decrypt

byte[] decrypt(byte[] bytes)
        throws GeneralSecurityException

Decrypts the byte array.

Parameters:

bytes - the byte array to be decrypted

Returns:

the decrypted byte array

Throws:

GeneralSecurityException - GeneralSecurityException

decrypt

byte[] decrypt(byte[] bytes,
               Key decKey)
        throws GeneralSecurityException

Decrypts the byte array using the given Key.

Parameters:

bytes - the byte array to be decrypted

decKey - the decryption key

Returns:

the decrypted byte array

Throws:

GeneralSecurityException - GeneralSecurityException

setAlgorithmParameters

T setAlgorithmParameters(AlgorithmParameters<?> parameters)

Sets the algorithm parameters used for initialization.

Parameters:

parameters - the algorithm parameters

Returns:

this encryptor

getAlgorithmParameters

AlgorithmParameters<?> getAlgorithmParameters()

Gets the algorithm parameters used for initialization.

Returns:

the algorithm parameters used for initialization

isInitialized

boolean isInitialized()

Indicates whether or not the encryptor has been initialized.

Returns:

true if the encryptor has been initialized, false otherwise

getCharset

Charset getCharset()

Returns the charset used by the encryptor.

Returns:

the charset used by the encryptor