Package org.forgerock.opendj.server.config.client

Interface FileBasedKeyManagerProviderCfgClient

All Superinterfaces:

ConfigurationClient, KeyManagerProviderCfgClient

public interface FileBasedKeyManagerProviderCfgClient
extends KeyManagerProviderCfgClient

A client-side interface for reading and modifying File Based Key Manager Provider settings.

The File Based Key Manager Provider can be used to obtain the server certificate from a key store file on the local file system.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends FileBasedKeyManagerProviderCfgClient,? extends FileBasedKeyManagerProviderCfg>	definition()	Get the configuration definition associated with this File Based Key Manager Provider.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getKeyStoreFile()	Gets the "key-store-file" property.
ValueOrExpression<String>	getKeyStorePin()	Gets the "key-store-pin" property.
ValueOrExpression<String>	getKeyStoreType()	Gets the "key-store-type" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setKeyStoreFile(ValueOrExpression<String> value)	Sets the "key-store-file" property.
void	setKeyStorePin(ValueOrExpression<String> value)	Sets the "key-store-pin" property.
void	setKeyStoreType(ValueOrExpression<String> value)	Sets the "key-store-type" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.KeyManagerProviderCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends FileBasedKeyManagerProviderCfgClient,? extends FileBasedKeyManagerProviderCfg> definition()

Get the configuration definition associated with this File Based Key Manager Provider.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface KeyManagerProviderCfgClient

Returns:

Returns the configuration definition associated with this File Based Key Manager Provider.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation.

Default value: org.opends.server.extensions.FileBasedKeyManagerProvider

Specified by:

getJavaClass in interface KeyManagerProviderCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation.

Specified by:

setJavaClass in interface KeyManagerProviderCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getKeyStoreFile

@MandatoryProperty
ValueOrExpression<String> getKeyStoreFile()

Gets the "key-store-file" property.

Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.

Changes to this property will take effect the next time that the key manager is accessed.

Returns:

Returns the value of the "key-store-file" property.

setKeyStoreFile

@MandatoryProperty
void setKeyStoreFile(ValueOrExpression<String> value)
              throws PropertyException

Sets the "key-store-file" property.

Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.

Changes to this property will take effect the next time that the key manager is accessed.

Parameters:

value - The value of the "key-store-file" property.

Throws:

PropertyException - If the new value is invalid.

getKeyStorePin

ValueOrExpression<String> getKeyStorePin()

Gets the "key-store-pin" property.

Specifies the clear-text PIN needed to access the File Based Key Manager Provider .

Default value is undefined

Returns:

Returns the value of the "key-store-pin" property.

setKeyStorePin

void setKeyStorePin(ValueOrExpression<String> value)
             throws PropertyException

Sets the "key-store-pin" property.

Specifies the clear-text PIN needed to access the File Based Key Manager Provider .

Parameters:

value - The value of the "key-store-pin" property.

Throws:

PropertyException - If the new value is invalid.

getKeyStoreType

ValueOrExpression<String> getKeyStoreType()

Gets the "key-store-type" property.

Specifies the format for the data in the key store file.

Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well. If no value is provided, the JVM-default value is used. Changes to this configuration attribute will take effect the next time that the key manager is accessed.

Default value is undefined

Returns:

Returns the value of the "key-store-type" property.

setKeyStoreType

void setKeyStoreType(ValueOrExpression<String> value)
              throws PropertyException

Sets the "key-store-type" property.

Specifies the format for the data in the key store file.

Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well. If no value is provided, the JVM-default value is used. Changes to this configuration attribute will take effect the next time that the key manager is accessed.

Parameters:

value - The value of the "key-store-type" property.

Throws:

PropertyException - If the new value is invalid.