org.opends.server.admin.std.server
Interface PlainSASLMechanismHandlerCfg

All Superinterfaces:
Configuration, SASLMechanismHandlerCfg

public interface PlainSASLMechanismHandlerCfg
extends SASLMechanismHandlerCfg

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

The Plain SASL Mechanism Handler performs all processing related to SASL PLAIN authentication.


Method Summary
 void addPlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener)
          Register to be notified when this Plain SASL Mechanism Handler is changed.
 java.lang.Class<? extends PlainSASLMechanismHandlerCfg> configurationClass()
          Gets the configuration class associated with this Plain 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 removePlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener)
          Deregister an existing Plain 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 PlainSASLMechanismHandlerCfg> configurationClass()
Gets the configuration class associated with this Plain SASL Mechanism Handler.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface SASLMechanismHandlerCfg
Returns:
Returns the configuration class associated with this Plain SASL Mechanism Handler.

addPlainChangeListener

void addPlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener)
Register to be notified when this Plain SASL Mechanism Handler is changed.

Parameters:
listener - The Plain SASL Mechanism Handler configuration change listener.

removePlainChangeListener

void removePlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener)
Deregister an existing Plain SASL Mechanism Handler configuration change listener.

Parameters:
listener - The Plain SASL Mechanism Handler configuration change listener.

getIdentityMapper

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

Specifies the name of the identity mapper that is to be used with this SASL mechanism handler to match the authentication or authorization 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 that is to be used with this SASL mechanism handler to match the authentication or authorization 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.