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.
String	getJavaClass()	Gets the "java-class" property.
String	getKeyStoreFile()	Gets the "key-store-file" property.
String	getKeyStorePin()	Gets the "key-store-pin" property.
String	getKeyStorePinEnvironmentVariable()	Gets the "key-store-pin-environment-variable" property.
String	getKeyStorePinFile()	Gets the "key-store-pin-file" property.
String	getKeyStorePinProperty()	Gets the "key-store-pin-property" property.
String	getKeyStoreType()	Gets the "key-store-type" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setKeyStoreFile(String value)	Sets the "key-store-file" property.
void	setKeyStorePin(String value)	Sets the "key-store-pin" property.
void	setKeyStorePinEnvironmentVariable(String value)	Sets the "key-store-pin-environment-variable" property.
void	setKeyStorePinFile(String value)	Sets the "key-store-pin-file" property.
void	setKeyStorePinProperty(String value)	Sets the "key-store-pin-property" property.
void	setKeyStoreType(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

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface KeyManagerProviderCfgClient

Returns:

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

setJavaClass

void setJavaClass(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

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

void setKeyStoreFile(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

String getKeyStorePin()

Gets the "key-store-pin" property.

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

Returns:

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

setKeyStorePin

void setKeyStorePin(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.

getKeyStorePinEnvironmentVariable

String getKeyStorePinEnvironmentVariable()

Gets the "key-store-pin-environment-variable" property.

Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider .

Returns:

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

setKeyStorePinEnvironmentVariable

void setKeyStorePinEnvironmentVariable(String value)
                                throws PropertyException

Sets the "key-store-pin-environment-variable" property.

Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getKeyStorePinFile

String getKeyStorePinFile()

Gets the "key-store-pin-file" property.

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the File Based Key Manager Provider .

Returns:

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

setKeyStorePinFile

void setKeyStorePinFile(String value)
                 throws PropertyException

Sets the "key-store-pin-file" property.

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the File Based Key Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getKeyStorePinProperty

String getKeyStorePinProperty()

Gets the "key-store-pin-property" property.

Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider .

Returns:

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

setKeyStorePinProperty

void setKeyStorePinProperty(String value)
                     throws PropertyException

Sets the "key-store-pin-property" property.

Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getKeyStoreType

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.

Returns:

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

setKeyStoreType

void setKeyStoreType(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.