org.opends.server.admin.std.server
Interface IdentityMapperCfg

All Superinterfaces:

Configuration

All Known Subinterfaces:

ExactMatchIdentityMapperCfg, RegularExpressionIdentityMapperCfg

public interface IdentityMapperCfg
extends Configuration

A server-side interface for querying Identity Mapper settings.

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

void	addChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener) Register to be notified when this Identity Mapper is changed.
java.lang.Class<? extends IdentityMapperCfg>	configurationClass() Gets the configuration class associated with this Identity Mapper.
java.lang.String	getJavaClass() Gets the "java-class" property.
boolean	isEnabled() Gets the "enabled" property.
void	removeChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener) Deregister an existing Identity Mapper configuration change listener.

Methods inherited from interface org.opends.server.admin.Configuration

dn

Method Detail

configurationClass

java.lang.Class<? extends IdentityMapperCfg> configurationClass()

Gets the configuration class associated with this Identity Mapper.

Specified by:

configurationClass in interface Configuration

Returns:

Returns the configuration class associated with this Identity Mapper.

addChangeListener

void addChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener)

Register to be notified when this Identity Mapper is changed.

Parameters:

listener - The Identity Mapper configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener)

Deregister an existing Identity Mapper configuration change listener.

Parameters:

listener - The Identity Mapper configuration change listener.

isEnabled

boolean isEnabled()

Gets the "enabled" property.

Indicates whether the Identity Mapper is enabled for use.

Returns:

Returns the value of the "enabled" property.

getJavaClass

java.lang.String getJavaClass()

Gets the "java-class" property.

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

Returns:

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