org.opends.server.extensions
Class AnonymousSASLMechanismHandler

java.lang.Object
  extended by org.opends.server.api.SASLMechanismHandler<AnonymousSASLMechanismHandlerCfg>
      extended by org.opends.server.extensions.AnonymousSASLMechanismHandler

public class AnonymousSASLMechanismHandler
extends SASLMechanismHandler<AnonymousSASLMechanismHandlerCfg>

This class provides an implementation of a SASL mechanism, as defined in RFC 4505, that does not perform any authentication. That is, anyone attempting to bind with this SASL mechanism will be successful and will be given the rights of an unauthenticated user. The request may or may not include a set of SASL credentials which will serve as trace information. If provided, then that trace information will be written to the server error log.


Constructor Summary
AnonymousSASLMechanismHandler()
          Creates a new instance of this SASL mechanism handler.
 
Method Summary
 void finalizeSASLMechanismHandler()
          Performs any finalization that may be necessary for this SASL mechanism handler.
 void initializeSASLMechanismHandler(AnonymousSASLMechanismHandlerCfg configuration)
          Initializes this SASL mechanism handler based on the information in the provided configuration entry.
 boolean isPasswordBased(java.lang.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(java.lang.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 bindOperation)
          Processes the SASL bind operation.
 
Methods inherited from class org.opends.server.api.SASLMechanismHandler
isConfigurationAcceptable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnonymousSASLMechanismHandler

public AnonymousSASLMechanismHandler()
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(AnonymousSASLMechanismHandlerCfg configuration)
                                    throws ConfigException,
                                           InitializationException
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<AnonymousSASLMechanismHandlerCfg>
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()
Performs any finalization that may be necessary for this SASL mechanism handler. By default, no finalization is performed.

Overrides:
finalizeSASLMechanismHandler in class SASLMechanismHandler<AnonymousSASLMechanismHandlerCfg>

processSASLBind

public void processSASLBind(BindOperation bindOperation)
Processes the SASL bind operation. SASL mechanism implementations must ensure that the following actions are taken during the processing of this method:

Specified by:
processSASLBind in class SASLMechanismHandler<AnonymousSASLMechanismHandlerCfg>
Parameters:
bindOperation - The SASL bind operation to be processed.

isPasswordBased

public boolean isPasswordBased(java.lang.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).

Specified by:
isPasswordBased in class SASLMechanismHandler<AnonymousSASLMechanismHandlerCfg>
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(java.lang.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).

Specified by:
isSecure in class SASLMechanismHandler<AnonymousSASLMechanismHandlerCfg>
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.