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

Class ExactMatchIdentityMapperCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<ExactMatchIdentityMapperCfgClient,ExactMatchIdentityMapperCfg>

org.forgerock.opendj.server.config.meta.ExactMatchIdentityMapperCfgDefn

public final class ExactMatchIdentityMapperCfgDefn
extends ManagedObjectDefinition<ExactMatchIdentityMapperCfgClient,ExactMatchIdentityMapperCfg>

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

The Exact Match Identity Mapper maps an identifier string to user entries by searching for the entry containing a specified attribute whose value is the provided identifier. For example, the username provided by the client for DIGEST-MD5 authentication must match the value of the uid attribute

Method Summary

Modifier and Type	Method	Description
ExactMatchIdentityMapperCfgClient	createClientConfiguration(ManagedObject<? extends ExactMatchIdentityMapperCfgClient> impl)	Creates a client configuration view of the provided managed object.
ExactMatchIdentityMapperCfg	createServerConfiguration(ServerManagedObject<? extends ExactMatchIdentityMapperCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static ExactMatchIdentityMapperCfgDefn	getInstance()	Get the Exact Match Identity Mapper configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
AttributeTypePropertyDefinition	getMatchAttributePropertyDefinition()	Get the "match-attribute" property definition.
DnPropertyDefinition	getMatchBaseDnPropertyDefinition()	Get the "match-base-dn" property definition.
Class<ExactMatchIdentityMapperCfg>	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 ExactMatchIdentityMapperCfgDefn getInstance()

Get the Exact Match Identity Mapper configuration definition singleton.

Returns:

Returns the Exact Match Identity Mapper configuration definition singleton.

createClientConfiguration

public ExactMatchIdentityMapperCfgClient createClientConfiguration(ManagedObject<? extends ExactMatchIdentityMapperCfgClient> 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<ExactMatchIdentityMapperCfgClient,ExactMatchIdentityMapperCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ExactMatchIdentityMapperCfgClient,ExactMatchIdentityMapperCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<ExactMatchIdentityMapperCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ExactMatchIdentityMapperCfgClient,ExactMatchIdentityMapperCfg>

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

Returns:

Returns the "java-class" property definition.

getMatchAttributePropertyDefinition

public AttributeTypePropertyDefinition getMatchAttributePropertyDefinition()

Get the "match-attribute" property definition.

Specifies the attribute whose value should exactly match the ID string provided to this identity mapper.

At least one value must be provided. All values must refer to the name or OID of an attribute type defined in the directory server schema. If multiple attributes or OIDs are provided, at least one of those attributes must contain the provided ID string value in exactly one entry. The internal search performed includes a logical OR across all of these values.

Returns:

Returns the "match-attribute" property definition.

getMatchBaseDnPropertyDefinition

public DnPropertyDefinition getMatchBaseDnPropertyDefinition()

Get the "match-base-dn" property definition.

Specifies the set of base DNs below which to search for users.

The base DNs will be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all specified base DNs.

Returns:

Returns the "match-base-dn" property definition.