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

Interface CramMd5SaslMechanismHandlerCfg

All Superinterfaces:

Configuration, SaslMechanismHandlerCfg

public interface CramMd5SaslMechanismHandlerCfg
extends SaslMechanismHandlerCfg

A server-side interface for querying CRAM-MD5 SASL Mechanism Handler settings.

The CRAM-MD5 SASL mechanism provides the ability for clients to perform password-based authentication in a manner that does not expose their password in the clear.

Method Summary

Modifier and Type	Method	Description
void	addCramMd5ChangeListener(ConfigurationChangeListener<CramMd5SaslMechanismHandlerCfg> listener)	Register to be notified when this CRAM-MD5 SASL Mechanism Handler is changed.
Class<? extends CramMd5SaslMechanismHandlerCfg>	configurationClass()	Gets the configuration class associated with this CRAM-MD5 SASL Mechanism Handler.
SortedSet<String>	getIdentityMapper()	Gets the "identity-mapper" property.
SortedSet<Dn>	getIdentityMapperDns()	Gets the "identity-mapper" property as a set of DNs.
String	getJavaClass()	Gets the "java-class" property.
void	removeCramMd5ChangeListener(ConfigurationChangeListener<CramMd5SaslMechanismHandlerCfg> listener)	Deregister an existing CRAM-MD5 SASL Mechanism Handler configuration change listener.

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

dn, name

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

addChangeListener, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends CramMd5SaslMechanismHandlerCfg> configurationClass()

Gets the configuration class associated with this CRAM-MD5 SASL Mechanism Handler.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface SaslMechanismHandlerCfg

Returns:

Returns the configuration class associated with this CRAM-MD5 SASL Mechanism Handler.

addCramMd5ChangeListener

void addCramMd5ChangeListener(ConfigurationChangeListener<CramMd5SaslMechanismHandlerCfg> listener)

Register to be notified when this CRAM-MD5 SASL Mechanism Handler is changed.

Parameters:

listener - The CRAM-MD5 SASL Mechanism Handler configuration change listener.

removeCramMd5ChangeListener

void removeCramMd5ChangeListener(ConfigurationChangeListener<CramMd5SaslMechanismHandlerCfg> listener)

Deregister an existing CRAM-MD5 SASL Mechanism Handler configuration change listener.

Parameters:

listener - The CRAM-MD5 SASL Mechanism Handler configuration change listener.

getIdentityMapper

SortedSet<String> getIdentityMapper()

Gets the "identity-mapper" property.

Specifies the name(s) of the identity mapper(s) used with this SASL mechanism handler to match the authentication ID included in the SASL bind request to the corresponding user in the directory.

Returns:

Returns an unmodifiable set containing the values of the "identity-mapper" property.

getIdentityMapperDns

SortedSet<Dn> getIdentityMapperDns()

Gets the "identity-mapper" property as a set of DNs.

Specifies the name(s) of the identity mapper(s) used with this SASL mechanism handler to match the authentication ID included in the SASL bind request to the corresponding user in the directory.

Returns:

Returns the DN values of the "identity-mapper" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.

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

Specified by:

getJavaClass in interface SaslMechanismHandlerCfg

Returns:

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