org.opends.server.admin.std.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
 void addCramMD5ChangeListener(ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener)
          Register to be notified when this Cram MD5 SASL Mechanism Handler is changed.
 java.lang.Class<? extends CramMD5SASLMechanismHandlerCfg> configurationClass()
          Gets the configuration class associated with this Cram MD5 SASL Mechanism Handler.
 java.lang.String getIdentityMapper()
          Gets the "identity-mapper" property.
 DN getIdentityMapperDN()
          Gets the "identity-mapper" property as a DN.
 java.lang.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.opends.server.admin.std.server.SASLMechanismHandlerCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.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

java.lang.String getIdentityMapper()
Gets the "identity-mapper" property.

Specifies the name of the identity mapper 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 value of the "identity-mapper" property.

getIdentityMapperDN

DN getIdentityMapperDN()
Gets the "identity-mapper" property as a DN.

Specifies the name of the identity mapper 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 value of the "identity-mapper" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

Specified by:
getJavaClass in interface SASLMechanismHandlerCfg
Returns:
Returns the value of the "java-class" property.