org.opends.server.admin.std.server
Interface SASLMechanismHandlerCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
AnonymousSASLMechanismHandlerCfg, CramMD5SASLMechanismHandlerCfg, DigestMD5SASLMechanismHandlerCfg, ExternalSASLMechanismHandlerCfg, GSSAPISASLMechanismHandlerCfg, PlainSASLMechanismHandlerCfg

public interface SASLMechanismHandlerCfg
extends Configuration

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

The SASL mechanism handler configuration entry is the parent for all SASL mechanism handlers defined in the OpenDS Directory Server.


Method Summary
 void addChangeListener(ConfigurationChangeListener<SASLMechanismHandlerCfg> listener)
          Register to be notified when this SASL Mechanism Handler is changed.
 java.lang.Class<? extends SASLMechanismHandlerCfg> configurationClass()
          Gets the configuration class associated with this SASL Mechanism Handler.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isEnabled()
          Gets the "enabled" property.
 void removeChangeListener(ConfigurationChangeListener<SASLMechanismHandlerCfg> listener)
          Deregister an existing SASL Mechanism Handler configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends SASLMechanismHandlerCfg> configurationClass()
Gets the configuration class associated with this SASL Mechanism Handler.

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

addChangeListener

void addChangeListener(ConfigurationChangeListener<SASLMechanismHandlerCfg> listener)
Register to be notified when this SASL Mechanism Handler is changed.

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

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<SASLMechanismHandlerCfg> listener)
Deregister an existing SASL Mechanism Handler configuration change listener.

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

isEnabled

boolean isEnabled()
Gets the "enabled" property.

Indicates whether the SASL mechanism handler 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 SASL mechanism handler implementation.

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