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

Interface ExactMatchIdentityMapperCfg

All Superinterfaces:

Configuration, IdentityMapperCfg

public interface ExactMatchIdentityMapperCfg
extends IdentityMapperCfg

A server-side interface for querying Exact Match Identity Mapper settings.

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
void	addExactMatchChangeListener(ConfigurationChangeListener<ExactMatchIdentityMapperCfg> listener)	Register to be notified when this Exact Match Identity Mapper is changed.
Class<? extends ExactMatchIdentityMapperCfg>	configurationClass()	Gets the configuration class associated with this Exact Match Identity Mapper.
String	getJavaClass()	Gets the "java-class" property.
SortedSet<AttributeType>	getMatchAttribute()	Gets the "match-attribute" property.
SortedSet<Dn>	getMatchBaseDn()	Gets the "match-base-dn" property.
void	removeExactMatchChangeListener(ConfigurationChangeListener<ExactMatchIdentityMapperCfg> listener)	Deregister an existing Exact Match Identity Mapper configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.IdentityMapperCfg

addChangeListener, isEnabled, removeChangeListener

Method Details

configurationClass

Class<? extends ExactMatchIdentityMapperCfg> configurationClass()

Gets the configuration class associated with this Exact Match Identity Mapper.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface IdentityMapperCfg

Returns:

Returns the configuration class associated with this Exact Match Identity Mapper.

addExactMatchChangeListener

void addExactMatchChangeListener(ConfigurationChangeListener<ExactMatchIdentityMapperCfg> listener)

Register to be notified when this Exact Match Identity Mapper is changed.

Parameters:

listener - The Exact Match Identity Mapper configuration change listener.

removeExactMatchChangeListener

void removeExactMatchChangeListener(ConfigurationChangeListener<ExactMatchIdentityMapperCfg> listener)

Deregister an existing Exact Match Identity Mapper configuration change listener.

Parameters:

listener - The Exact Match Identity Mapper configuration change listener.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Exact Match Identity Mapper implementation.

Default value: org.opends.server.extensions.ExactMatchIdentityMapper

Specified by:

getJavaClass in interface IdentityMapperCfg

Returns:

Returns the value of the "java-class" property.

getMatchAttribute

SortedSet<AttributeType> getMatchAttribute()

Gets the "match-attribute" property.

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.

Default value: uid

Returns:

Returns an unmodifiable set containing the values of the "match-attribute" property.

getMatchBaseDn

SortedSet<Dn> getMatchBaseDn()

Gets the "match-base-dn" property.

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 an unmodifiable set containing the values of the "match-base-dn" property.