org.forgerock.opendj.server.config.client

Interface LDAPKeyManagerProviderCfgClient

All Superinterfaces:

ConfigurationClient, KeyManagerProviderCfgClient

public interface LDAPKeyManagerProviderCfgClient
extends KeyManagerProviderCfgClient

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

The LDAP key manager provider uses an LDAP key store managed by the server to obtain server certificates.

Method Summary

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends LDAPKeyManagerProviderCfgClient,? extends LDAPKeyManagerProviderCfg>	definition() Get the configuration definition associated with this LDAP Key Manager Provider.
org.forgerock.opendj.ldap.DN	getBaseDN() Gets the "base-dn" property.
String	getJavaClass() Gets the "java-class" 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.
void	setBaseDN(org.forgerock.opendj.ldap.DN value) Sets the "base-dn" property.
void	setJavaClass(String value) Sets the "java-class" 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.

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

isEnabled, setEnabled

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends LDAPKeyManagerProviderCfgClient,? extends LDAPKeyManagerProviderCfg> definition()

Get the configuration definition associated with this LDAP Key Manager Provider.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface KeyManagerProviderCfgClient

Returns:

Returns the configuration definition associated with this LDAP Key Manager Provider.

getBaseDN

org.forgerock.opendj.ldap.DN getBaseDN()

Gets the "base-dn" property.

The base DN beneath which LDAP key store entries are located.

Returns:

Returns the value of the "base-dn" property.

setBaseDN

void setBaseDN(org.forgerock.opendj.ldap.DN value)
        throws PropertyException

Sets the "base-dn" property.

The base DN beneath which LDAP key store entries are located.

Parameters:

value - The value of the "base-dn" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

The fully-qualified name of the Java class that provides the LDAP 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 LDAP 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.

getKeyStorePin

String getKeyStorePin()

Gets the "key-store-pin" property.

Specifies the clear-text PIN needed to access the LDAP 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 LDAP 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 LDAP 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 LDAP 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 LDAP 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 LDAP 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 LDAP 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 LDAP Key Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.