dk.heick.properties.types.derived

Class PrivateKeyFilePropertyType

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<PrivateKey>

dk.heick.properties.types.derived.PrivateKeyFilePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class PrivateKeyFilePropertyType
extends AbstractKeyPropertyType<PrivateKey>
implements MarkerPathPropertyType

Loads a PrivateKey from a File, which is defined with another Property.
No default value for this PropertyType, either it loads or it do not.
Example:

                Property<File> FILE_PROPERTY = new Property<File>("privatekey.file.property", new FilePropertyType(new File("c:\temp\myprivatekey.ppk"));
                Property<PrivateKey> A_PROPERTY= new Property<PrivateKey>("name", new PrivateKeyFilePropertyType(FILE_PROPERTY,"DSA"));
 

Since:

1.9

Version:

0.8 Beta

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of PrivateKey PropertyType.

Fields inherited from class dk.heick.properties.types.derived.AbstractKeyPropertyType

PKCS8_ENCODED_KEY_SPEC, X509_ENCODED_KEY_SPEC

Constructor Summary

Constructors

Constructor and Description
PrivateKeyFilePropertyType(Property<File> derivedFromFile, KeyFactoryAlgorithms algorithm) Constructor.
PrivateKeyFilePropertyType(Property<File> derivedFromFile, KeyFactoryAlgorithms algorithm, Class<? extends EncodedKeySpec> encodedKeySpecClass) Constructor.
PrivateKeyFilePropertyType(Property<File> derivedFromFile, String algorithm) Constructor.
PrivateKeyFilePropertyType(Property<File> derivedFromFile, String algorithm, Class<? extends EncodedKeySpec> encodedKeySpecClass) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	getDerivedToRestrictions() Gets a detailed description of the "Derived->TO->PropertyType" with any constraints that might influence the validation. Without any futher description of of the properties it is derived from, this is taken care of in the method "getDerivedFromRestrictions".
protected PrivateKey	validateKey(EncodedKeySpec spec) Gets the PrivateKey from KeyFactory.

Methods inherited from class dk.heick.properties.types.derived.AbstractKeyPropertyType

getAlgorithm, getEncodedKeySpecClass, getEncodedKeySpecInstance, getKeyFactory, validateConstraints, validateDerivedValue

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

getDerivedFromProperty, getDerivedFromPropertyValue

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

getDerivedFrom, getDerivedFromCount, getDerivedFromProperty, getDerivedFromRestrictions, 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

TYPE

public static final String TYPE

The type name string constant of PrivateKey PropertyType.

See Also:

Constant Field Values

Constructor Detail

PrivateKeyFilePropertyType

public PrivateKeyFilePropertyType(Property<File> derivedFromFile,
                                  String algorithm,
                                  Class<? extends EncodedKeySpec> encodedKeySpecClass)

Constructor.

Parameters:

derivedFromFile - the property which returns the file where the PrivateKey is stored.

algorithm - the name of the algortihm used.

encodedKeySpecClass - the class used to encoded the bytes.

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec, KeyFactory, KeyFactoryAlgorithms

PrivateKeyFilePropertyType

public PrivateKeyFilePropertyType(Property<File> derivedFromFile,
                                  KeyFactoryAlgorithms algorithm,
                                  Class<? extends EncodedKeySpec> encodedKeySpecClass)

Constructor.

Parameters:

derivedFromFile - the property which returns the file where the PrivateKey is stored.

algorithm - the name of the algortihm used.

encodedKeySpecClass - the class used to encoded the bytes.

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec, KeyFactory, KeyFactoryAlgorithms

PrivateKeyFilePropertyType

public PrivateKeyFilePropertyType(Property<File> derivedFromFile,
                                  String algorithm)

Constructor. Using PKCS8EncodedKeySpec.class as encodedKeySpecClass.

Parameters:

derivedFromFile - the property which returns the file where the PrivateKey is stored.

algorithm - the name of the algortihm used.

See Also:

EncodedKeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec, KeyFactory, KeyFactoryAlgorithms

PrivateKeyFilePropertyType

public PrivateKeyFilePropertyType(Property<File> derivedFromFile,
                                  KeyFactoryAlgorithms algorithm)

Constructor. Using PKCS8EncodedKeySpec.class as encodedKeySpecClass.

Parameters:

derivedFromFile - the property which returns the file where the PrivateKey is stored.

algorithm - the enum of the algortihm used.

Throws:

NullPointerException - if algortihm is null.

Method Detail

getDerivedToRestrictions

public List<String> getDerivedToRestrictions()

Description copied from class: DerivedPropertyType

Gets a detailed description of the "Derived->TO->PropertyType" with any constraints that might influence the validation.
Without any futher description of of the properties it is derived from, this is taken care of in the method "getDerivedFromRestrictions". This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getDerivedToRestrictions in class DerivedPropertyType<PrivateKey>

Returns:

the restrictions of the PropertyType as a list of strings.

validateKey

protected PrivateKey validateKey(EncodedKeySpec spec)
                          throws PropertyException

Gets the PrivateKey from KeyFactory.

         return getKeyFactory().generatePrivate(spec);
 

Specified by:

validateKey in class AbstractKeyPropertyType<PrivateKey>

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.