Package com.unboundid.ldap.sdk

Class SCRAMSHA1BindRequest

java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.BindRequest
com.unboundid.ldap.sdk.SASLBindRequest
com.unboundid.ldap.sdk.SCRAMBindRequest
com.unboundid.ldap.sdk.SCRAMSHA1BindRequest
All Implemented Interfaces:
ReadOnlyLDAPRequest, Serializable
@ThreadSafety(level=NOT_THREADSAFE) public final class SCRAMSHA1BindRequest extends SCRAMBindRequest
This class provides an implementation of the SCRAM-SHA-1 SASL mechanism as described in RFC 5802.
See Also:

  • Field Details

  • Constructor Details

    • SCRAMSHA1BindRequest

      public SCRAMSHA1BindRequest(@NotNull String username, @NotNull String password, @Nullable Control... controls)
      Creates a new SCRAM-SHA-1 bind request with the provided information.
      Parameters:
      username - The username for this bind request. It must not be null or empty.
      password - The password for this bind request. It must not be null or empty.
      controls - The set of controls to include in the bind request. It may be null or empty if no controls are needed.

    • SCRAMSHA1BindRequest

      public SCRAMSHA1BindRequest(@NotNull String username, @NotNull byte[] password, @Nullable Control... controls)
      Creates a new SCRAM-SHA-1 bind request with the provided information.
      Parameters:
      username - The username for this bind request. It must not be null or empty.
      password - The password for this bind request. It must not be null or empty.
      controls - The set of controls to include in the bind request. It may be null or empty if no controls are needed.

  • Method Details

    • getSASLMechanismName

      @NotNull public String getSASLMechanismName()
      Retrieves the name of the SASL mechanism used in this SASL bind request.
      Specified by:
      getSASLMechanismName in class SASLBindRequest
      Returns:
      The name of the SASL mechanism used in this SASL bind request.

    • getDigestAlgorithmName

      @NotNull protected String getDigestAlgorithmName()
      Retrieves the name of the digest algorithm that will be used in the authentication processing.
      Specified by:
      getDigestAlgorithmName in class SCRAMBindRequest
      Returns:
      The name of the digest algorithm that will be used in the authentication processing.

    • getMACAlgorithmName

      @NotNull protected String getMACAlgorithmName()
      Retrieves the name of the MAC algorithm that will be used in the authentication processing.
      Specified by:
      getMACAlgorithmName in class SCRAMBindRequest
      Returns:
      The name of the MAC algorithm that will be used in the authentication processing.

    • getRebindRequest

      @NotNull public SCRAMSHA1BindRequest getRebindRequest(@NotNull String host, int port)
      Retrieves a bind request that may be used to re-bind using the same credentials authentication type and credentials as previously used to perform the initial bind. This may be used in an attempt to automatically re-establish a connection that is lost, or potentially when following a referral to another directory instance.

      It is recommended that all bind request types which implement this capability be implemented so that the elements needed to create a new request are immutable. If this is not done, then changes made to a bind request object may alter the authentication/authorization identity and/or credentials associated with that request so that a rebind request created from it will not match the original request used to authenticate on a connection.
      Specified by:
      getRebindRequest in class SCRAMBindRequest
      Parameters:
      host - The address of the directory server to which the connection is established.
      port - The port of the directory server to which the connection is established.
      Returns:
      A bind request that may be used to re-bind using the same authentication type and credentials as previously used to perform the initial bind, or null to indicate that automatic re-binding is not supported for this type of bind request.

    • duplicate

      @NotNull public SCRAMSHA1BindRequest duplicate()
      Creates a new instance of this LDAP request that may be modified without impacting this request.
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      Specified by:
      duplicate in class SCRAMBindRequest
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • duplicate

      @NotNull public SCRAMSHA1BindRequest duplicate(@Nullable Control[] controls)
      Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      Specified by:
      duplicate in class SCRAMBindRequest
      Parameters:
      controls - The set of controls to include in the duplicate request.
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this request to the provided buffer.
      Specified by:
      toString in interface ReadOnlyLDAPRequest
      Specified by:
      toString in class SCRAMBindRequest
      Parameters:
      buffer - The buffer to which to append a string representation of this request.

    • toCode

      public void toCode(@NotNull List<String> lineList, @NotNull String requestID, int indentSpaces, boolean includeProcessing)
      Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.
      Specified by:
      toCode in interface ReadOnlyLDAPRequest
      Specified by:
      toCode in class SCRAMBindRequest
      Parameters:
      lineList - The list to which the source code lines should be added.
      requestID - The name that should be used as an identifier for the request. If this is null or empty, then a generic ID will be used.
      indentSpaces - The number of spaces that should be used to indent the generated code. It must not be negative.
      includeProcessing - Indicates whether the generated code should include code required to actually process the request and handle the result (if true), or just to generate the request (if false).