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

Interface LdapTrustManagerProviderCfgClient

All Superinterfaces:

ConfigurationClient, TrustManagerProviderCfgClient

public interface LdapTrustManagerProviderCfgClient
extends TrustManagerProviderCfgClient

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

The LDAP trust manager provider determines whether to trust a presented certificate based on whether that certificate exists in an LDAP key store managed by the server.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LdapTrustManagerProviderCfgClient,? extends LdapTrustManagerProviderCfg>	definition()	Get the configuration definition associated with this LDAP Trust Manager Provider.
ValueOrExpression<Dn>	getBaseDn()	Gets the "base-dn" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getTrustStorePin()	Gets the "trust-store-pin" property.
void	setBaseDn(ValueOrExpression<Dn> value)	Sets the "base-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setTrustStorePin(ValueOrExpression<String> value)	Sets the "trust-store-pin" property.

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

commit, properties

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

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends LdapTrustManagerProviderCfgClient,? extends LdapTrustManagerProviderCfg> definition()

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

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface TrustManagerProviderCfgClient

Returns:

Returns the configuration definition associated with this LDAP Trust 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 Trust Manager Provider implementation.

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

Specified by:

getJavaClass in interface TrustManagerProviderCfgClient

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 Trust Manager Provider implementation.

Specified by:

setJavaClass in interface TrustManagerProviderCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getTrustStorePin

ValueOrExpression<String> getTrustStorePin()

Gets the "trust-store-pin" property.

Specifies the clear-text PIN needed to access the LDAP Trust Manager Provider .

Default value is undefined

Returns:

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

setTrustStorePin

void setTrustStorePin(ValueOrExpression<String> value)
               throws PropertyException

Sets the "trust-store-pin" property.

Specifies the clear-text PIN needed to access the LDAP Trust Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.