dk.heick.properties.types.derived

Class KeySignedFilePropertyType

java.lang.Object

dk.heick.properties.PropertyType<T>

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

dk.heick.properties.types.derived.KeySignedFilePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class KeySignedFilePropertyType
extends DerivedPropertyType<SignedFile>
implements MarkerPathPropertyType

Loads and validates a signed file.
It will need the following properties.

• Property<File> - REQURIED - The signed file.
• Property<PublicKey> - REQUIRED - The public key.
• Property<byte[]> - The signature file loadeds as bytes.
• Algorithm Parameter - OPTIONAL - Default SHA1withDSA.
• Provider Parameter - OPTIONAL - Default SUN.

Example:

 Property<File> signedDataFile = new Property<File>("p.data.file",new FilePropertyType());
 Property<File> publicKeyFile = new Property<File>("p.publickey.file",new FilePropertyType());
 Property<File> signatuteFile = new Property<File>("p.signature.file",new FilePropertyType());
 //
 Property<PublicKey> publicKeyFromFile = new Property<PublicKey>("na.public.key.from.file",new PublicKeyFilePropertyType(publicKeyFile, "DSA"));
 Property<byte[]> signatureDataFile = new Property<byte[]>("na.p.signature.data",new BytesFromFilePropertyType(signatuteFile));
 //
 Property<SignedFile> signedFile = new Property<SignedFile>("signed.file",new KeySignedFilePropertyType(signedDataFile,publicKeyFromFile,signatureDataFile));
 

Since:

1.9

Version:

Beta

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALGORITHM The default algorithm "SHA1withDSA".
static String	DEFAULT_PROVIDER The default Signature Provider "SUN".
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
KeySignedFilePropertyType(Property<File> signedFileProperty, Property<PublicKey> publicKeyProperty, Property<byte[]> signatureFileProperty) Constructor using default algorithm "SHA1withDSA" and default provider "SUN".
KeySignedFilePropertyType(Property<File> signedFileProperty, Property<PublicKey> publicKeyProperty, Property<byte[]> signatureFileProperty, String algorithm) Constructor using default algorithm "SHA1withDSA".
KeySignedFilePropertyType(Property<File> signedFileProperty, Property<PublicKey> publicKeyProperty, Property<byte[]> signatureFileProperty, String algorithm, String provider) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm() The algorithm.
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".
String	getProvider() The provider
Property<PublicKey>	getPublicKeyProperty()
Property<byte[]>	getSignatureProperty()
Property<File>	getSignedFileProperty()
void	validateConstraints(String propertyName) Validates that : PublicKey Property is not null. SignedFile Property is not null. Signature Property is not null. Algorithm is not null an not empty. Provider is not null an not empty.
SignedFile	validateDerivedValue(String propertyName) Should convert the dependent Properties to the type T.

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

See Also:

Constant Field Values

DEFAULT_PROVIDER

public static final String DEFAULT_PROVIDER

The default Signature Provider "SUN".

See Also:

Constant Field Values

DEFAULT_ALGORITHM

public static final String DEFAULT_ALGORITHM

The default algorithm "SHA1withDSA".

See Also:

Constant Field Values

Constructor Detail

KeySignedFilePropertyType

public KeySignedFilePropertyType(Property<File> signedFileProperty,
                                 Property<PublicKey> publicKeyProperty,
                                 Property<byte[]> signatureFileProperty)

Constructor using default algorithm "SHA1withDSA" and default provider "SUN".

Parameters:

signedFileProperty - a Property returning a File pointing to the signed file.

publicKeyProperty - a Property returning a PublicKey file used to verifed the signed file.

signatureFileProperty - a Property returning a Signature file in form of a byte[] used to verifed the signed file.

See Also:

DEFAULT_ALGORITHM, DEFAULT_PROVIDER

KeySignedFilePropertyType

public KeySignedFilePropertyType(Property<File> signedFileProperty,
                                 Property<PublicKey> publicKeyProperty,
                                 Property<byte[]> signatureFileProperty,
                                 String algorithm)

Constructor using default algorithm "SHA1withDSA".

Parameters:

signedFileProperty - a Property returning a File pointing to the signed file.

publicKeyProperty - a Property returning a PublicKey file used to verifed the signed file.

signatureFileProperty - a Property returning a Signature file in form of a byte[] used to verifed the signed file.

algorithm - the algorithm used.

See Also:

DEFAULT_PROVIDER

KeySignedFilePropertyType

public KeySignedFilePropertyType(Property<File> signedFileProperty,
                                 Property<PublicKey> publicKeyProperty,
                                 Property<byte[]> signatureFileProperty,
                                 String algorithm,
                                 String provider)

Constructor.

Parameters:

signedFileProperty - a Property returning a File pointing to the signed file.

publicKeyProperty - a Property returning a PublicKey file used to verifed the signed file.

signatureFileProperty - a Property returning a Signature file in form of a byte[] used to verifed the signed file.

algorithm - the algorithm used.

provider - the provider used.

Method Detail

getSignedFileProperty

public Property<File> getSignedFileProperty()

getPublicKeyProperty

public Property<PublicKey> getPublicKeyProperty()

getSignatureProperty

public Property<byte[]> getSignatureProperty()

getAlgorithm

public String getAlgorithm()

The algorithm.

Returns:

the algorithm

getProvider

public String getProvider()

The provider

Returns:

the provider

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateDerivedValue

public SignedFile validateDerivedValue(String propertyName)
                                throws PropertyException

Description copied from class: DerivedPropertyType

Should convert the dependent Properties to the type T.

Specified by:

validateDerivedValue in class DerivedPropertyType<SignedFile>

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.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Validates that :

• PublicKey Property is not null.
• SignedFile Property is not null.
• Signature Property is not null.
• Algorithm is not null an not empty.
• Provider is not null an not empty.

Overrides:

validateConstraints in class DerivedPropertyType<SignedFile>

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()