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

Class IdentityMapperCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<IdentityMapperCfgClient,IdentityMapperCfg>

org.forgerock.opendj.server.config.meta.IdentityMapperCfgDefn

public final class IdentityMapperCfgDefn
extends ManagedObjectDefinition<IdentityMapperCfgClient,IdentityMapperCfg>

An interface for querying the Identity Mapper managed object definition meta information.

Identity Mappers are responsible for establishing a mapping between an identifier string provided by a client, and the entry for the user that corresponds to that identifier. Identity Mappers are used to process several SASL mechanisms to map an authorization ID (e.g., a Kerberos principal when using GSSAPI) to a directory user. They are also used when processing requests with the proxied authorization control.

Method Summary

Modifier and Type	Method	Description
IdentityMapperCfgClient	createClientConfiguration(ManagedObject<? extends IdentityMapperCfgClient> impl)	Creates a client configuration view of the provided managed object.
IdentityMapperCfg	createServerConfiguration(ServerManagedObject<? extends IdentityMapperCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static IdentityMapperCfgDefn	getInstance()	Get the Identity Mapper configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<IdentityMapperCfg>	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, 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 Detail

getInstance

public static IdentityMapperCfgDefn getInstance()

Get the Identity Mapper configuration definition singleton.

Returns:

Returns the Identity Mapper configuration definition singleton.

createClientConfiguration

public IdentityMapperCfgClient createClientConfiguration(ManagedObject<? extends IdentityMapperCfgClient> 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<IdentityMapperCfgClient,IdentityMapperCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<IdentityMapperCfgClient,IdentityMapperCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<IdentityMapperCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<IdentityMapperCfgClient,IdentityMapperCfg>

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 Identity Mapper is enabled for use.

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 Identity Mapper implementation.

Returns:

Returns the "java-class" property definition.