java.lang.Object
- org.opends.server.api.SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
- - org.opends.server.extensions.DigestMD5SASLMechanismHandler

All Implemented Interfaces:

ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg>
```
public class DigestMD5SASLMechanismHandler
extends SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
implements ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg>
```
This class provides an implementation of a SASL mechanism that authenticates clients through DIGEST-MD5.

Constructor Summary

Constructors
Constructor Description

DigestMD5SASLMechanismHandler()
Creates a new instance of this SASL mechanism handler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ConfigChangeResult`	`applyConfigurationChange(DigestMD5SASLMechanismHandlerCfg configuration)`	Applies the configuration changes to this change listener.
`void`	`finalizeSASLMechanismHandler()`	Performs any finalization that may be necessary for this SASL mechanism handler.
`void`	`initializeSASLMechanismHandler(DigestMD5SASLMechanismHandlerCfg configuration)`	Initializes this SASL mechanism handler based on the information in the provided configuration entry.
`boolean`	`isConfigurationAcceptable(SASLMechanismHandlerCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)`	Indicates whether the provided configuration is acceptable for this SASL mechanism handler.
`boolean`	`isConfigurationChangeAcceptable(DigestMD5SASLMechanismHandlerCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)`	Indicates whether the proposed change to the configuration is acceptable to this change listener.
`boolean`	`isPasswordBased(String mechanism)`	Indicates whether the specified SASL mechanism is password-based or uses some other form of credentials (e.g., an SSL client certificate or Kerberos ticket).
`boolean`	`isSecure(String mechanism)`	Indicates whether the specified SASL mechanism should be considered secure (i.e., it does not expose the authentication credentials in a manner that is useful to a third-party observer, and other aspects of the authentication are generally secure).
`void`	`processSASLBind(BindOperation bindOp)`	Processes the SASL bind operation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DigestMD5SASLMechanismHandler
```
public DigestMD5SASLMechanismHandler()
```
    Creates a new instance of this SASL mechanism handler. No initialization should be done in this method, as it should all be performed in the initializeSASLMechanismHandler method.
- Method Detail
  - initializeSASLMechanismHandler
```
public void initializeSASLMechanismHandler(DigestMD5SASLMechanismHandlerCfg configuration)
                                    throws ConfigException,
                                           InitializationException
```
    Description copied from class: SASLMechanismHandler
    
    Initializes this SASL mechanism handler based on the information in the provided configuration entry. It should also register itself with the Directory Server for the particular kinds of SASL mechanisms that it will process.
    
    Specified by:
    
    initializeSASLMechanismHandler in class SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
    
    Parameters:
    
    configuration - The configuration to use to initialize this SASL mechanism handler.
    
    Throws:
    
    ConfigException - If an unrecoverable problem arises in the process of performing the initialization.
    
    InitializationException - If a problem occurs during initialization that is not related to the server configuration.
  - finalizeSASLMechanismHandler
```
public void finalizeSASLMechanismHandler()
```
    Description copied from class: SASLMechanismHandler
    
    Performs any finalization that may be necessary for this SASL mechanism handler. By default, no finalization is performed.
    
    Overrides:
    
    finalizeSASLMechanismHandler in class SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
  - processSASLBind
```
public void processSASLBind(BindOperation bindOp)
```
    Description copied from class: SASLMechanismHandler
    Processes the SASL bind operation. SASL mechanism implementations must ensure that the following actions are taken during the processing of this method:
    
    The BindOperation.setResultCode method must be used to set the appropriate result code.
    
    If the SASL processing gets far enough to be able to map the request to a user entry (regardless of whether the authentication is ultimately successful), then this method must call the BindOperation.setSASLAuthUserEntry method to provide it with the entry for the user that attempted to authenticate.
    
    If the bind processing was successful, then the BindOperation.setAuthenticationInfo method must be used to set the authentication info for the bind operation.
    
    If the bind processing was not successful, then the BindOperation.setAuthFailureReason method should be used to provide a message explaining why the authentication failed.
    Specified by:
    
    processSASLBind in class SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
    
    Parameters:
    
    bindOp - The SASL bind operation to be processed.
  - isPasswordBased
```
public boolean isPasswordBased(String mechanism)
```
    Description copied from class: SASLMechanismHandler
    
    Indicates whether the specified SASL mechanism is password-based or uses some other form of credentials (e.g., an SSL client certificate or Kerberos ticket).
    
    Specified by:
    
    isPasswordBased in class SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
    
    Parameters:
    
    mechanism - The name of the mechanism for which to make the determination. This will only be invoked with names of mechanisms for which this handler has previously registered.
    
    Returns:
    
    true if this SASL mechanism is password-based, or false if it uses some other form of credentials.
  - isSecure
```
public boolean isSecure(String mechanism)
```
    Description copied from class: SASLMechanismHandler
    
    Indicates whether the specified SASL mechanism should be considered secure (i.e., it does not expose the authentication credentials in a manner that is useful to a third-party observer, and other aspects of the authentication are generally secure).
    
    Specified by:
    
    isSecure in class SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
    
    Parameters:
    
    mechanism - The name of the mechanism for which to make the determination. This will only be invoked with names of mechanisms for which this handler has previously registered.
    
    Returns:
    
    true if this SASL mechanism should be considered secure, or false if not.
  - isConfigurationAcceptable
```
public boolean isConfigurationAcceptable(SASLMechanismHandlerCfg configuration,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
```
    Description copied from class: SASLMechanismHandler
    
    Indicates whether the provided configuration is acceptable for this SASL mechanism handler. It should be possible to call this method on an uninitialized SASL mechanism handler instance in order to determine whether the SASL mechanism handler would be able to use the provided configuration.
    
    Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.
    
    Overrides:
    
    isConfigurationAcceptable in class SASLMechanismHandler<DigestMD5SASLMechanismHandlerCfg>
    
    Parameters:
    
    configuration - The SASL mechanism handler configuration for which to make the determination.
    
    unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.
    
    Returns:
    
    true if the provided configuration is acceptable for this SASL mechanism handler, or false if not.
  - isConfigurationChangeAcceptable
```
public boolean isConfigurationChangeAcceptable(DigestMD5SASLMechanismHandlerCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
```
    Description copied from interface: ConfigurationChangeListener
    
    Indicates whether the proposed change to the configuration is acceptable to this change listener.
    
    Specified by:
    
    isConfigurationChangeAcceptable in interface ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg>
    
    Parameters:
    
    configuration - The new configuration containing the changes.
    
    unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
    
    Returns:
    
    Returns true if the proposed change is acceptable, or false if it is not.
  - applyConfigurationChange
```
public ConfigChangeResult applyConfigurationChange(DigestMD5SASLMechanismHandlerCfg configuration)
```
    Description copied from interface: ConfigurationChangeListener
    
    Applies the configuration changes to this change listener.
    
    Specified by:
    
    applyConfigurationChange in interface ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg>
    
    Parameters:
    
    configuration - The new configuration containing the changes.
    
    Returns:
    
    Returns information about the result of changing the configuration.

Class DigestMD5SASLMechanismHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DigestMD5SASLMechanismHandler

Method Detail

initializeSASLMechanismHandler

finalizeSASLMechanismHandler

processSASLBind

isPasswordBased

isSecure

isConfigurationAcceptable

isConfigurationChangeAcceptable

applyConfigurationChange