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

Class LDAPKeyManagerProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<LDAPKeyManagerProviderCfgClient,LDAPKeyManagerProviderCfg>

org.forgerock.opendj.server.config.meta.LDAPKeyManagerProviderCfgDefn

public final class LDAPKeyManagerProviderCfgDefn
extends ManagedObjectDefinition<LDAPKeyManagerProviderCfgClient,LDAPKeyManagerProviderCfg>

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

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
LDAPKeyManagerProviderCfgClient	createClientConfiguration(ManagedObject<? extends LDAPKeyManagerProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
LDAPKeyManagerProviderCfg	createServerConfiguration(ServerManagedObject<? extends LDAPKeyManagerProviderCfg> 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 LDAPKeyManagerProviderCfgDefn	getInstance()	Get the LDAP Key Manager Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getKeyStorePinEnvironmentVariablePropertyDefinition()	Get the "key-store-pin-environment-variable" property definition.
StringPropertyDefinition	getKeyStorePinFilePropertyDefinition()	Get the "key-store-pin-file" property definition.
StringPropertyDefinition	getKeyStorePinPropertyDefinition()	Get the "key-store-pin" property definition.
StringPropertyDefinition	getKeyStorePinPropertyPropertyDefinition()	Get the "key-store-pin-property" property definition.
Class<LDAPKeyManagerProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object 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 LDAPKeyManagerProviderCfgDefn getInstance()

Get the LDAP Key Manager Provider configuration definition singleton.

Returns:

Returns the LDAP Key Manager Provider configuration definition singleton.

createClientConfiguration

public LDAPKeyManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends LDAPKeyManagerProviderCfgClient> 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<LDAPKeyManagerProviderCfgClient,LDAPKeyManagerProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<LDAPKeyManagerProviderCfgClient,LDAPKeyManagerProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<LDAPKeyManagerProviderCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<LDAPKeyManagerProviderCfgClient,LDAPKeyManagerProviderCfg>

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.

Indicates whether the LDAP Key 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 Key Manager Provider implementation.

Returns:

Returns the "java-class" property definition.

getKeyStorePinPropertyDefinition

public StringPropertyDefinition getKeyStorePinPropertyDefinition()

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

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

Returns:

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

getKeyStorePinEnvironmentVariablePropertyDefinition

public StringPropertyDefinition getKeyStorePinEnvironmentVariablePropertyDefinition()

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

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

Returns:

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

getKeyStorePinFilePropertyDefinition

public StringPropertyDefinition getKeyStorePinFilePropertyDefinition()

Get the "key-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 Key Manager Provider .

Returns:

Returns the "key-store-pin-file" property definition.

getKeyStorePinPropertyPropertyDefinition

public StringPropertyDefinition getKeyStorePinPropertyPropertyDefinition()

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

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

Returns:

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