SaslMechanismHandlerCfg (OpenDJ Public API Javadoc 7.4.4-20250319151205-3e38ada61695e05f34ebbd799d03be9218ebe6be Documentation)

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 Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addChangeListener(ConfigurationChangeListener<SaslMechanismHandlerCfg> listener)`	Register to be notified when this SASL Mechanism Handler is changed.
`Class<? extends SaslMechanismHandlerCfg>`	`configurationClass()`	Gets the configuration class associated with this SASL Mechanism Handler.
`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.forgerock.opendj.config.Configuration
dn, name

- Method Detail
  - 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.