Interface SaslMechanismHandlerCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
AnonymousSaslMechanismHandlerCfg, CramMd5SaslMechanismHandlerCfg, DigestMd5SaslMechanismHandlerCfg, ExternalSaslMechanismHandlerCfg, GssapiSaslMechanismHandlerCfg, PlainSaslMechanismHandlerCfg, ScramSha256SaslMechanismHandlerCfg, ScramSha512SaslMechanismHandlerCfg

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 OpenDJ directory server.

  • Method Details

    • configurationClass

      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

      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.