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.
org.forgerock.opendj.ldap.DN	getBaseDN()	Gets the "base-dn" property.
String	getJavaClass()	Gets the "java-class" property.
String	getTrustStorePin()	Gets the "trust-store-pin" property.
String	getTrustStorePinEnvironmentVariable()	Gets the "trust-store-pin-environment-variable" property.
String	getTrustStorePinFile()	Gets the "trust-store-pin-file" property.
String	getTrustStorePinProperty()	Gets the "trust-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	setTrustStorePin(String value)	Sets the "trust-store-pin" property.
void	setTrustStorePinEnvironmentVariable(String value)	Sets the "trust-store-pin-environment-variable" property.
void	setTrustStorePinFile(String value)	Sets the "trust-store-pin-file" property.
void	setTrustStorePinProperty(String value)	Sets the "trust-store-pin-property" 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

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

Specified by:

getJavaClass in interface TrustManagerProviderCfgClient

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

String getTrustStorePin()

Gets the "trust-store-pin" property.

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

Returns:

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

setTrustStorePin

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

getTrustStorePinEnvironmentVariable

String getTrustStorePinEnvironmentVariable()

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

Specifies the name of the environment variable that contains the clear-text PIN needed to access the LDAP Trust Manager Provider .

Returns:

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

setTrustStorePinEnvironmentVariable

void setTrustStorePinEnvironmentVariable(String value)
                                  throws PropertyException

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

Specifies the name of the environment variable that contains the clear-text PIN needed to access the LDAP Trust Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getTrustStorePinFile

String getTrustStorePinFile()

Gets the "trust-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 Trust Manager Provider .

Returns:

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

setTrustStorePinFile

void setTrustStorePinFile(String value)
                   throws PropertyException

Sets the "trust-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 Trust Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getTrustStorePinProperty

String getTrustStorePinProperty()

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

Specifies the name of the Java property that contains the clear-text PIN needed to access the LDAP Trust Manager Provider .

Returns:

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

setTrustStorePinProperty

void setTrustStorePinProperty(String value)
                       throws PropertyException

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

Specifies the name of the Java property that contains the clear-text PIN needed to access the LDAP Trust Manager Provider .

Parameters:

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

Throws:

PropertyException - If the new value is invalid.