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

Class WhoAmIExtendedOperationHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<WhoAmIExtendedOperationHandlerCfgClient,WhoAmIExtendedOperationHandlerCfg>

org.forgerock.opendj.server.config.meta.WhoAmIExtendedOperationHandlerCfgDefn

public final class WhoAmIExtendedOperationHandlerCfgDefn
extends ManagedObjectDefinition<WhoAmIExtendedOperationHandlerCfgClient,WhoAmIExtendedOperationHandlerCfg>

An interface for querying the Who Am I Extended Operation Handler managed object definition meta information.

The Who Am I Extended Operation Handler provides the ability for clients to request their authorization identity using the "Who Am I?" extended operation as defined in RFC 4532.

Method Summary

Modifier and Type	Method	Description
WhoAmIExtendedOperationHandlerCfgClient	createClientConfiguration(ManagedObject<? extends WhoAmIExtendedOperationHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
WhoAmIExtendedOperationHandlerCfg	createServerConfiguration(ServerManagedObject<? extends WhoAmIExtendedOperationHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static WhoAmIExtendedOperationHandlerCfgDefn	getInstance()	Get the Who Am I Extended Operation Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<WhoAmIExtendedOperationHandlerCfg>	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 WhoAmIExtendedOperationHandlerCfgDefn getInstance()

Get the Who Am I Extended Operation Handler configuration definition singleton.

Returns:

Returns the Who Am I Extended Operation Handler configuration definition singleton.

createClientConfiguration

public WhoAmIExtendedOperationHandlerCfgClient createClientConfiguration(ManagedObject<? extends WhoAmIExtendedOperationHandlerCfgClient> 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<WhoAmIExtendedOperationHandlerCfgClient,WhoAmIExtendedOperationHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<WhoAmIExtendedOperationHandlerCfgClient,WhoAmIExtendedOperationHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<WhoAmIExtendedOperationHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<WhoAmIExtendedOperationHandlerCfgClient,WhoAmIExtendedOperationHandlerCfg>

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 Who Am I Extended Operation Handler is enabled (that is, whether the types of extended operations are allowed in the server).

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the Who Am I Extended Operation Handler implementation.

Returns:

Returns the "java-class" property definition.