Package 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	Description
ManagedObjectDefinition<? extends LdapKeyManagerProviderCfgClient,? extends LdapKeyManagerProviderCfg>	definition()	Get the configuration definition associated with this LDAP Key Manager Provider.
ValueOrExpression<Dn>	getBaseDn()	Gets the "base-dn" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getKeyStorePin()	Gets the "key-store-pin" property.
void	setBaseDn(ValueOrExpression<Dn> value)	Sets the "base-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setKeyStorePin(ValueOrExpression<String> value)	Sets the "key-store-pin" 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 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

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setBaseDn(ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

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

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

ValueOrExpression<String> getKeyStorePin()

Gets the "key-store-pin" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.