de.alpharogroup.crypto.core

Class AbstractCryptor<C,K>

java.lang.Object

de.alpharogroup.crypto.core.AbstractCryptor<C,K>

Type Parameters:

C - the generic type of the cipher

K - the generic type of the key

All Implemented Interfaces:

de.alpharogroup.crypto.api.Cryptor, Serializable

Direct Known Subclasses:

AbstractDecryptor, AbstractEncryptor, BaseCryptor

public abstract class AbstractCryptor<C,K>
extends Object
implements Serializable, de.alpharogroup.crypto.api.Cryptor

The abstract class AbstractCryptor provides factory methods that may or must be overwritten dependent of the specific implementor class.

Version:

1.0

Author:

Asterios Raptis

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected de.alpharogroup.crypto.model.CryptModel<C,K>	model The crypto model.

Constructor Summary

Constructors

Constructor and Description
AbstractCryptor(de.alpharogroup.crypto.model.CryptModel<C,K> model) Constructor with the given CryptModel.
AbstractCryptor(K key) Constructor with a key.

Method Summary

Modifier and Type	Method and Description
protected String	newAlgorithm() Factory method for creating a new algorithm that will be used with the cipher object.
protected AlgorithmParameterSpec	newAlgorithmParameterSpec(byte[] salt, int iterationCount) Factory method for creating a new AlgorithmParameterSpec from the given salt and iteration count.
protected C	newCipher(K key) Factory method for creating a new Cipher from the given private key.
protected abstract C	newCipher(K key, String algorithm, byte[] salt, int iterationCount, int operationMode) Factory method for creating a new Cipher from the given parameters.
protected int	newIterationCount() Factory method for creating a new iteration count that will be used with the cipher object.
protected byte[]	newSalt() Factory method for creating a new salt that will be used with the cipher object.
protected SecretKeyFactory	newSecretKeyFactory(String algorithm) Factory method for creating a new SecretKeyFactory from the given algorithm.
protected void	onInitialize() This method initialize the cipher object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.alpharogroup.crypto.api.Cryptor

newOperationMode

Field Detail

model

protected final de.alpharogroup.crypto.model.CryptModel<C,K> model

The crypto model.

Constructor Detail

AbstractCryptor

public AbstractCryptor(de.alpharogroup.crypto.model.CryptModel<C,K> model)
                throws InvalidKeyException,
                       NoSuchAlgorithmException,
                       InvalidKeySpecException,
                       NoSuchPaddingException,
                       InvalidAlgorithmParameterException,
                       UnsupportedEncodingException

Constructor with the given CryptModel.

Parameters:

model - The crypt model.

Throws:

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

NoSuchPaddingException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

AbstractCryptor

public AbstractCryptor(K key)
                throws InvalidKeyException,
                       NoSuchAlgorithmException,
                       InvalidKeySpecException,
                       NoSuchPaddingException,
                       InvalidAlgorithmParameterException,
                       UnsupportedEncodingException

Constructor with a key.

Parameters:

key - The key.

Throws:

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

NoSuchPaddingException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

Method Detail

newAlgorithm

protected String newAlgorithm()

Factory method for creating a new algorithm that will be used with the cipher object. Overwrite this method to provide a specific algorithm.

Returns:

the new algorithm that will be used with the cipher object.

newAlgorithmParameterSpec

protected AlgorithmParameterSpec newAlgorithmParameterSpec(byte[] salt,
                                                           int iterationCount)

Factory method for creating a new AlgorithmParameterSpec from the given salt and iteration count. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new AlgorithmParameterSpec from the given salt and iteration count.

Parameters:

salt - the salt

iterationCount - the iteration count

Returns:

the new AlgorithmParameterSpec from the given salt and iteration count.

newCipher

protected C newCipher(K key)
               throws NoSuchAlgorithmException,
                      InvalidKeySpecException,
                      NoSuchPaddingException,
                      InvalidKeyException,
                      InvalidAlgorithmParameterException,
                      UnsupportedEncodingException

Factory method for creating a new Cipher from the given private key. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new Cipher from the given private key.

Parameters:

key - the key

Returns:

the new Cipher from the given private key.

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchPaddingException - is thrown if instantiation of the cypher object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

newCipher

protected abstract C newCipher(K key,
                               String algorithm,
                               byte[] salt,
                               int iterationCount,
                               int operationMode)
                        throws NoSuchAlgorithmException,
                               InvalidKeySpecException,
                               NoSuchPaddingException,
                               InvalidKeyException,
                               InvalidAlgorithmParameterException,
                               UnsupportedEncodingException

Factory method for creating a new Cipher from the given parameters. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new Cipher from the given parameters.

Parameters:

key - the key

algorithm - the algorithm

salt - the salt.

iterationCount - the iteration count

operationMode - the operation mode for the new cipher object

Returns:

the cipher

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchPaddingException - is thrown if instantiation of the cypher object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

newIterationCount

protected int newIterationCount()

Factory method for creating a new iteration count that will be used with the cipher object.

Returns:

the salt byte array

newSalt

protected byte[] newSalt()

Factory method for creating a new salt that will be used with the cipher object.

Returns:

the salt byte array

newSecretKeyFactory

protected SecretKeyFactory newSecretKeyFactory(String algorithm)
                                        throws NoSuchAlgorithmException

Factory method for creating a new SecretKeyFactory from the given algorithm. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new SecretKeyFactory from the given algorithm.

Parameters:

algorithm - the algorithm

Returns:

the new SecretKeyFactory from the given algorithm.

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

onInitialize

protected void onInitialize()
                     throws InvalidKeyException,
                            NoSuchAlgorithmException,
                            InvalidKeySpecException,
                            NoSuchPaddingException,
                            InvalidAlgorithmParameterException,
                            UnsupportedEncodingException

This method initialize the cipher object.

Throws:

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

NoSuchPaddingException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.