Interface PreParseBindOperation

All Superinterfaces:
PluginOperation, PreParseOperation
All Known Implementing Classes:
BindOperation

public interface PreParseBindOperation extends PreParseOperation
This class defines a set of methods that are available for use by pre-parse plugins for bind operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
  • Method Details

    • getAuthenticationType

      AuthenticationType getAuthenticationType()
      Retrieves the authentication type for this bind operation.
      Returns:
      The authentication type for this bind operation.
    • getBindDN

      Dn getBindDN()
      Retrieves the bind DN for this bind operation as contained in the client request.
      Returns:
      The bind DN for this bind operation as contained in the client request.
    • setBindDN

      void setBindDN(Dn bindDN)
      Specifies the bind DN for this bind operation.
      Parameters:
      bindDN - The bind DN for this bind
    • getSimplePassword

      ByteString getSimplePassword()
      Retrieves the simple authentication password for this bind operation.
      Returns:
      The simple authentication password for this bind operation.
    • setSimplePassword

      void setSimplePassword(ByteString simplePassword)
      Specifies the simple authentication password for this bind operation.
      Parameters:
      simplePassword - The simple authentication password for this bind operation.
    • getSASLMechanism

      String getSASLMechanism()
      Retrieves the SASL mechanism for this bind operation.
      Returns:
      The SASL mechanism for this bind operation, or null if the bind does not use SASL authentication.
    • getSASLCredentials

      ByteString getSASLCredentials()
      Retrieves the SASL credentials for this bind operation.
      Returns:
      The SASL credentials for this bind operation, or null if there are none or if the bind does not use SASL authentication.
    • setSASLCredentials

      void setSASLCredentials(String saslMechanism, ByteString saslCredentials)
      Specifies the SASL credentials for this bind operation.
      Parameters:
      saslMechanism - The SASL mechanism for this bind operation.
      saslCredentials - The SASL credentials for this bind operation, or null if there are none.
    • setServerSASLCredentials

      void setServerSASLCredentials(ByteString serverSASLCredentials)
      Specifies the set of server SASL credentials to include in the bind response.
      Parameters:
      serverSASLCredentials - The set of server SASL credentials to include in the bind response.
    • setAuthFailureReason

      void setAuthFailureReason(LocalizableMessage reason)
      Specifies the reason that the authentication failed.
      Parameters:
      reason - A human-readable message providing the reason that the authentication failed.