Package org.forgerock.opendj.server.config.meta

Class LDAPTrustManagerProviderCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<LDAPTrustManagerProviderCfgClient,LDAPTrustManagerProviderCfg>

org.forgerock.opendj.server.config.meta.LDAPTrustManagerProviderCfgDefn

public final class LDAPTrustManagerProviderCfgDefn
extends ManagedObjectDefinition<LDAPTrustManagerProviderCfgClient,LDAPTrustManagerProviderCfg>

An interface for querying the LDAP Trust Manager Provider managed object definition meta information.

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
LDAPTrustManagerProviderCfgClient	createClientConfiguration(ManagedObject<? extends LDAPTrustManagerProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
LDAPTrustManagerProviderCfg	createServerConfiguration(ServerManagedObject<? extends LDAPTrustManagerProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
DNPropertyDefinition	getBaseDNPropertyDefinition()	Get the "base-dn" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static LDAPTrustManagerProviderCfgDefn	getInstance()	Get the LDAP Trust Manager Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<LDAPTrustManagerProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getTrustStorePinEnvironmentVariablePropertyDefinition()	Get the "trust-store-pin-environment-variable" property definition.
StringPropertyDefinition	getTrustStorePinFilePropertyDefinition()	Get the "trust-store-pin-file" property definition.
StringPropertyDefinition	getTrustStorePinPropertyDefinition()	Get the "trust-store-pin" property definition.
StringPropertyDefinition	getTrustStorePinPropertyPropertyDefinition()	Get the "trust-store-pin-property" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static LDAPTrustManagerProviderCfgDefn getInstance()

Get the LDAP Trust Manager Provider configuration definition singleton.

Returns:

Returns the LDAP Trust Manager Provider configuration definition singleton.

createClientConfiguration

public LDAPTrustManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends LDAPTrustManagerProviderCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<LDAPTrustManagerProviderCfgClient,LDAPTrustManagerProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public LDAPTrustManagerProviderCfg createServerConfiguration(ServerManagedObject<? extends LDAPTrustManagerProviderCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<LDAPTrustManagerProviderCfgClient,LDAPTrustManagerProviderCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<LDAPTrustManagerProviderCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<LDAPTrustManagerProviderCfgClient,LDAPTrustManagerProviderCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getBaseDNPropertyDefinition

public DNPropertyDefinition getBaseDNPropertyDefinition()

Get the "base-dn" property definition.

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

Returns:

Returns the "base-dn" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicate whether the LDAP Trust Manager Provider is enabled for use.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getTrustStorePinPropertyDefinition

public StringPropertyDefinition getTrustStorePinPropertyDefinition()

Get the "trust-store-pin" property definition.

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

Returns:

Returns the "trust-store-pin" property definition.

getTrustStorePinEnvironmentVariablePropertyDefinition

public StringPropertyDefinition getTrustStorePinEnvironmentVariablePropertyDefinition()

Get the "trust-store-pin-environment-variable" property definition.

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

Returns:

Returns the "trust-store-pin-environment-variable" property definition.

getTrustStorePinFilePropertyDefinition

public StringPropertyDefinition getTrustStorePinFilePropertyDefinition()

Get the "trust-store-pin-file" property definition.

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 "trust-store-pin-file" property definition.

getTrustStorePinPropertyPropertyDefinition

public StringPropertyDefinition getTrustStorePinPropertyPropertyDefinition()

Get the "trust-store-pin-property" property definition.

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

Returns:

Returns the "trust-store-pin-property" property definition.