dk.heick.properties.types.derived

Class AbstractKeyPropertyType<T extends Key>

java.lang.Object

dk.heick.properties.PropertyType<T>

dk.heick.properties.derived.DerivedPropertyType<T>

dk.heick.properties.derived.DerivedFromSinglePropertyType<File,T>

dk.heick.properties.types.derived.AbstractKeyPropertyType<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PrivateKeyFilePropertyType, PublicKeyFilePropertyType

public abstract class AbstractKeyPropertyType<T extends Key>
extends DerivedFromSinglePropertyType<File,T>

An abstract implementation which loads a File to a Private or Public key.
Using the notes stated in http://stackoverflow.com/questions/11410770/java-load-rsa-public-key-from-file.

Since:

1.9, 1.9

Version:

0.8 Beta

Author:

Frederik Heick

See Also:

PrivateKeyFilePropertyType, PublicKeyFilePropertyType, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Class<PKCS8EncodedKeySpec>	PKCS8_ENCODED_KEY_SPEC The class of PKCS8EncodedKeySpec.
static Class<X509EncodedKeySpec>	X509_ENCODED_KEY_SPEC The class of X509EncodedKeySpec.

Constructor Summary

Constructors

Constructor and Description
AbstractKeyPropertyType(String typeName, Property<File> derivedFromType, KeyFactoryAlgorithms algorithm, Class<? extends EncodedKeySpec> encodedKeySpecClass) Constructor.
AbstractKeyPropertyType(String typeName, Property<File> derivedFromType, KeyFactoryAlgorithms algorithm, Class<? extends EncodedKeySpec> encodedKeySpecClass, T defaultValue) Constructor.
AbstractKeyPropertyType(String typeName, Property<File> derivedFromType, String algorithm, Class<? extends EncodedKeySpec> encodedKeySpecClass) Constructor.
AbstractKeyPropertyType(String typeName, Property<File> derivedFromType, String algorithm, Class<? extends EncodedKeySpec> encodedKeySpecClass, T defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm() Gets the algorithm to initialize the KeyFactory with.
Class<? extends EncodedKeySpec>	getEncodedKeySpecClass() The class which implements EncodedKeySpec.
protected EncodedKeySpec	getEncodedKeySpecInstance(byte[] keyBytes) Constructors an instance of EncodedKeySpecClass initialized with the bytes loaded from the file provided.
protected KeyFactory	getKeyFactory() Gets a KeyFactory instance on the base of the algorithm.
void	validateConstraints(String propertyName) Validates any constraints there are on a Key.
T	validateDerivedValue(String propertyName) Loads the Key from a file.
protected abstract T	validateKey(EncodedKeySpec spec) Validates the EncodedKeySpec to a ket of type T.

Methods inherited from class dk.heick.properties.derived.DerivedFromSinglePropertyType

getDerivedFromProperty, getDerivedFromPropertyValue

Methods inherited from class dk.heick.properties.derived.DerivedPropertyType

getDerivedFrom, getDerivedFromCount, getDerivedFromProperty, getDerivedFromRestrictions, getDerivedToRestrictions, getMaxDerivedFrom, getMinDerivedFrom, getRestrictions, isMinAndMaxTheSame, isUseMaxDerivedFrom, isUseMinDerivedFrom, validateValue

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toString, toType, validate, validateNullType

Methods inherited from class java.lang.Object

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

Field Detail

X509_ENCODED_KEY_SPEC

public static final Class<X509EncodedKeySpec> X509_ENCODED_KEY_SPEC

The class of X509EncodedKeySpec.

PKCS8_ENCODED_KEY_SPEC

public static final Class<PKCS8EncodedKeySpec> PKCS8_ENCODED_KEY_SPEC

The class of PKCS8EncodedKeySpec.

Constructor Detail

AbstractKeyPropertyType

public AbstractKeyPropertyType(String typeName,
                               Property<File> derivedFromType,
                               String algorithm,
                               Class<? extends EncodedKeySpec> encodedKeySpecClass)
                        throws NullPointerException

Constructor.

Parameters:

typeName - the type name string constant of File to Key

derivedFromType - the property which points to the file where the key is stored.

algorithm - the name of the algortihm used.

encodedKeySpecClass - the class used to encoded the bytes.

Throws:

NullPointerException - if any of the parameters is null.

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec, KeyFactory, KeyFactoryAlgorithms

AbstractKeyPropertyType

public AbstractKeyPropertyType(String typeName,
                               Property<File> derivedFromType,
                               String algorithm,
                               Class<? extends EncodedKeySpec> encodedKeySpecClass,
                               T defaultValue)
                        throws NullPointerException

Constructor.

Parameters:

typeName - the type name string constant of File to Key

derivedFromType - the property which points to the file where the key is stored.

algorithm - the name of the algortihm used.

encodedKeySpecClass - the class used to encoded the bytes.

defaultValue -

Throws:

NullPointerException - if any of the parameters is null.

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec, KeyFactory, KeyFactoryAlgorithms

AbstractKeyPropertyType

public AbstractKeyPropertyType(String typeName,
                               Property<File> derivedFromType,
                               KeyFactoryAlgorithms algorithm,
                               Class<? extends EncodedKeySpec> encodedKeySpecClass)
                        throws NullPointerException

Constructor.

Parameters:

typeName - the type name string constant of File to Key

derivedFromType - the property which points to the file where the key is stored.

algorithm - the name of the algortihm used.

encodedKeySpecClass - the class used to encoded the bytes.

Throws:

NullPointerException - if any of the parameters is null.

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec, KeyFactory, KeyFactoryAlgorithms

AbstractKeyPropertyType

public AbstractKeyPropertyType(String typeName,
                               Property<File> derivedFromType,
                               KeyFactoryAlgorithms algorithm,
                               Class<? extends EncodedKeySpec> encodedKeySpecClass,
                               T defaultValue)
                        throws NullPointerException

Constructor.

Parameters:

typeName - the type name string constant of File to Key

derivedFromType - the property which points to the file where the key is stored.

algorithm - the name of the algortihm used.

encodedKeySpecClass - the class used to encoded the bytes.

defaultValue - the default key value

Throws:

NullPointerException - if any of the parameters is null.

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec, KeyFactory, KeyFactoryAlgorithms

Method Detail

getAlgorithm

public final String getAlgorithm()

Gets the algorithm to initialize the KeyFactory with.

Returns:

the algorithm

getEncodedKeySpecClass

public final Class<? extends EncodedKeySpec> getEncodedKeySpecClass()

The class which implements EncodedKeySpec.

Returns:

the encodedKeySpecClass

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec

validateKey

protected abstract T validateKey(EncodedKeySpec spec)
                          throws PropertyException

Validates the EncodedKeySpec to a ket of type T.

Parameters:

spec - an instance of EncodedKeySpec, which can be used with the KeyFactory to generate a Key.

Returns:

an instance T of the Key.

Throws:

PropertyException - the key could not be converted and/or validated to type T of key.

validateDerivedValue

public final T validateDerivedValue(String propertyName)
                             throws PropertyException

Loads the Key from a file.

   fis = new FileInputStream(obj);
   dis = new DataInputStream(fis);
   byte[] keyBytes = new byte[(int) obj.length()];
   dis.readFully(keyBytes);
   EncodedKeySpec encodedKeySpec = getEncodedKeySpecInstance(keyBytes);
   return validateKey(encodedKeySpec);   
 

Specified by:

validateDerivedValue in class DerivedPropertyType<T extends Key>

Parameters:

propertyName - the name of derived Property

Returns:

the type T from the property dependencies.

Throws:

PropertyException - if it could not be converted into type T.

getEncodedKeySpecInstance

protected final EncodedKeySpec getEncodedKeySpecInstance(byte[] keyBytes)
                                                  throws PropertyException

Constructors an instance of EncodedKeySpecClass initialized with the bytes loaded from the file provided.

Parameters:

keyBytes - the bytes loaded from the file.

Returns:

an instance of EncodedKeySpec.

Throws:

PropertyException - if their could not be made a instance of the class

See Also:

getEncodedKeySpecClass()

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Validates any constraints there are on a Key. Throws an PropertyException if :

• The algorithm is null.
• The algorithm name is empty.
• The KeyFactory could not instancetiated with the algorithm.

Overrides:

validateConstraints in class DerivedPropertyType<T extends Key>

Parameters:

propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues.

Throws:

PropertyException - if the constraints have invalid/conflicting values.

See Also:

Property.validate()

getKeyFactory

protected final KeyFactory getKeyFactory()
                                  throws PropertyException

Gets a KeyFactory instance on the base of the algorithm.

Returns:

a keyFactory instance.

Throws:

PropertyException - if an the "algorithm" is null or empty, or is not found.

See Also:

getAlgorithm()