Package com.unboundid.ldap.sdk

Class GenericSASLBindRequest

java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.BindRequest
com.unboundid.ldap.sdk.SASLBindRequest
com.unboundid.ldap.sdk.GenericSASLBindRequest
All Implemented Interfaces:
ReadOnlyLDAPRequest, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GenericSASLBindRequest extends SASLBindRequest
This class provides a mechanism for performing SASL authentication in a generic manner. The caller is responsible for properly encoding the credentials (if any) and interpreting the result. Further, if the requested SASL mechanism is one that requires multiple stages, then the caller is responsible for all processing in each stage.
See Also:

  • Constructor Details

    • GenericSASLBindRequest

      public GenericSASLBindRequest(@Nullable String bindDN, @NotNull String mechanism, @Nullable ASN1OctetString credentials, @Nullable Control... controls)
      Creates a new generic SASL bind request with the provided information.
      Parameters:
      bindDN - The bind DN that should be used for the request. It may be null if the target identity should be derived from the credentials or some other source.
      mechanism - The name of the mechanism that should be used for the SASL bind. It must not be null.
      credentials - The credentials that should be used for the SASL bind. It may be null if no credentials should be used.
      controls - The set of controls to include in the SASL bind request. It may be null or empty if no request controls are needed.

  • Method Details

    • getBindDN

      @Nullable public String getBindDN()
      Retrieves the bind DN for this SASL bind request, if any.
      Returns:
      The bind DN for this SASL bind request, or null if the target identity should be determined from the credentials or some other mechanism.

    • 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.

    • getCredentials

      @Nullable public ASN1OctetString getCredentials()
      Retrieves the credentials for the SASL bind request, if any.
      Returns:
      The credentials for the SASL bind request, or null if there are none.

    • process

      @NotNull protected BindResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
      Sends this bind request to the target server over the provided connection and returns the corresponding response.
      Specified by:
      process in class BindRequest
      Parameters:
      connection - The connection to use to send this bind request to the server and read the associated response.
      depth - The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.
      Returns:
      The bind response read from the server.
      Throws:
      LDAPException - If a problem occurs while sending the request or reading the response.

    • duplicate

      @NotNull public GenericSASLBindRequest 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 BindRequest
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • duplicate

      @NotNull public GenericSASLBindRequest 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 BindRequest
      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 LDAPRequest
      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
      Overrides:
      toCode in class SASLBindRequest
      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).