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

Class KeyManagerProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>

org.forgerock.opendj.server.config.meta.KeyManagerProviderCfgDefn

public final class KeyManagerProviderCfgDefn
extends ManagedObjectDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>

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

Key Manager Providers are responsible for managing the key material that is used to authenticate an SSL connection to its peer.

Method Summary

Modifier and Type	Method	Description
KeyManagerProviderCfgClient	createClientConfiguration(ManagedObject<? extends KeyManagerProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
KeyManagerProviderCfg	createServerConfiguration(ServerManagedObject<? extends KeyManagerProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static KeyManagerProviderCfgDefn	getInstance()	Get the Key Manager Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<KeyManagerProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 Details

getInstance

public static KeyManagerProviderCfgDefn getInstance()

Get the Key Manager Provider configuration definition singleton.

Returns:

Returns the Key Manager Provider configuration definition singleton.

createClientConfiguration

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

Description copied from class: ManagedObjectDefinition

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<KeyManagerProviderCfgClient,KeyManagerProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<KeyManagerProviderCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>

Returns:

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

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

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

Returns:

Returns the "java-class" property definition.