dk.heick.properties.types.derived

Class KeyStoreFilePropertyType

java.lang.Object

dk.heick.properties.PropertyType<T>

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

dk.heick.properties.types.derived.KeyStoreFilePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class KeyStoreFilePropertyType
extends DerivedPropertyType<KeyStore>
implements MarkerPathPropertyType

Loads a KeyStore from a KeyStore file.
This is derived from two other Properties.

• A File Property, which points to the keystore file.
• A PasswordType Property, which has an decryptable password.

Providers traverses the list of registered security Providers, starting with the most preferred Provider.
A new KeyStore object encapsulating the KeyStoreSpi implementation from the first Provider that supports the specified type is returned.


List of the Provider I see.

• SUN (default)
• SunRsaSign
• SunEC
• SunJSSE
• SunJCE
• SunJGSS
• SunSASL
• XMLDSig
• SunPCSC
• SunMSCAPI

Example:

    Property<File> keyStoreFile = new Property<File>("keystore_file",new FilePropertyType());
    Property<PasswordTypeVO> password = new Property<PasswordTypeVO>("password",new PasswordPropertyType());
    Property<KeyStore> keystore= new Property<KeyStore>("keystore",new KeyStoreFilePropertyType(keyStoreFile,password));
 

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 KeyStoreFilePropertyType implementation.

Constructor Summary

Constructors

Constructor and Description
KeyStoreFilePropertyType(Property<File> keyStoreFile, Property<PasswordTypeVO> keyStorePasswordProperty) Constructor, using one of the preferred registered security Providers, starting with the most preferred Provider.
KeyStoreFilePropertyType(String keyStoreType, Property<File> keyStoreFile, Property<PasswordTypeVO> keyStorePasswordProperty) Constructor, using one of the preferred registered security Providers, starting with the most preferred Provider.
KeyStoreFilePropertyType(String keyStoreType, String provider, Property<File> keyStoreFile, Property<PasswordTypeVO> keyStorePasswordProperty) 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".
Property<File>	getKeyStoreFile()
Property<PasswordTypeVO>	getKeyStorePassword()
String	getKeyStoreType() The keystore type, if null than default is used.
String	getProvider() The provider, if null than default is used, see class description.
void	validateConstraints(String propertyName) Validates the constraints.
KeyStore	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

The type name string constant of KeyStoreFilePropertyType implementation.

See Also:

Constant Field Values

Constructor Detail

KeyStoreFilePropertyType

public KeyStoreFilePropertyType(String keyStoreType,
                                String provider,
                                Property<File> keyStoreFile,
                                Property<PasswordTypeVO> keyStorePasswordProperty)

Constructor.

Parameters:

keyStoreType - the keyStoreType. Default is "jks"

provider - the provider, see list in class description.

keyStoreFile - the Property of type File, which points to the keystore file.

keyStorePasswordProperty - the Property of type PasswordTypeVO, which holds the password, it must be "decryptable", which points to the keystoer file.

See Also:

PasswordTypeVO.isDecryptable()

KeyStoreFilePropertyType

public KeyStoreFilePropertyType(String keyStoreType,
                                Property<File> keyStoreFile,
                                Property<PasswordTypeVO> keyStorePasswordProperty)

Constructor, using one of the preferred registered security Providers, starting with the most preferred Provider. "SUN"

Parameters:

keyStoreType - the keyStoreType. Default is "jks"

keyStoreFile - the Property of type File, which points to the keystore file.

keyStorePasswordProperty - the Property of type PasswordTypeVO, which holds the password, it must be "decryptable", which points to the keystoer file.

See Also:

PasswordTypeVO.isDecryptable()

KeyStoreFilePropertyType

public KeyStoreFilePropertyType(Property<File> keyStoreFile,
                                Property<PasswordTypeVO> keyStorePasswordProperty)

Constructor, using one of the preferred registered security Providers, starting with the most preferred Provider. "SUN" and default "keyStoreType" is "jks".

Parameters:

keyStoreFile - the Property of type File, which points to the keystore file.

keyStorePasswordProperty - the Property of type PasswordTypeVO, which holds the password, it must be "decryptable", which points to the keystoer file.

See Also:

PasswordTypeVO.isDecryptable()

Method Detail

getKeyStoreFile

public Property<File> getKeyStoreFile()

getKeyStorePassword

public Property<PasswordTypeVO> getKeyStorePassword()

getKeyStoreType

public String getKeyStoreType()

The keystore type, if null than default is used.

Returns:

the keyStoreType

getProvider

public String getProvider()

The provider, if null than default is used, see class description.

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Validates the constraints.

• If keyStoreType is not null, then it must be non empty.
• If provider is not null, then it must be non empty.

Overrides:

validateConstraints in class DerivedPropertyType<KeyStore>

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

validateDerivedValue

public KeyStore 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<KeyStore>

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.