com.unboundid.ldap.sdk
Class PLAINBindRequest

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPRequest
      extended by com.unboundid.ldap.sdk.BindRequest
          extended by com.unboundid.ldap.sdk.SASLBindRequest
              extended by com.unboundid.ldap.sdk.PLAINBindRequest
All Implemented Interfaces:
ReadOnlyLDAPRequest, java.io.Serializable

@NotMutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class PLAINBindRequest
extends SASLBindRequest

This class provides a SASL PLAIN bind request implementation as described in RFC 4616. The SASL PLAIN mechanism allows the client to authenticate with an authentication ID and password, and optionally allows the client to provide an authorization ID for use in performing subsequent operations.

Elements included in a PLAIN bind request include:

Example

The following example demonstrates the process for performing a PLAIN bind against a directory server with a username of "test.user" and a password of "password":
 PLAINBindRequest bindRequest =
      new PLAINBindRequest("u:test.user", "password");
 BindResult bindResult;
 try
 {
   bindResult = connection.bind(bindRequest);
   // If we get here, then the bind was successful.
 }
 catch (LDAPException le)
 {
   // The bind failed for some reason.
   bindResult = new BindResult(le.toLDAPResult());
   ResultCode resultCode = le.getResultCode();
   String errorMessageFromServer = le.getDiagnosticMessage();
 }
 

See Also:
Serialized Form

Field Summary
static java.lang.String PLAIN_MECHANISM_NAME
          The name for the PLAIN SASL mechanism.
 
Fields inherited from class com.unboundid.ldap.sdk.SASLBindRequest
CRED_TYPE_SASL
 
Fields inherited from class com.unboundid.ldap.sdk.BindRequest
VERSION_ELEMENT
 
Constructor Summary
PLAINBindRequest(java.lang.String authenticationID, ASN1OctetString password)
          Creates a new SASL PLAIN bind request with the provided authentication ID and password.
PLAINBindRequest(java.lang.String authenticationID, ASN1OctetString password, Control... controls)
          Creates a new SASL PLAIN bind request with the provided authentication ID, password, and set of controls.
PLAINBindRequest(java.lang.String authenticationID, byte[] password)
          Creates a new SASL PLAIN bind request with the provided authentication ID and password.
PLAINBindRequest(java.lang.String authenticationID, byte[] password, Control... controls)
          Creates a new SASL PLAIN bind request with the provided authentication ID, password, and set of controls.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String password)
          Creates a new SASL PLAIN bind request with the provided authentication ID and password.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, ASN1OctetString password)
          Creates a new SASL PLAIN bind request with the provided authentication ID, authorization ID, and password.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, ASN1OctetString password, Control... controls)
          Creates a new SASL PLAIN bind request with the provided information.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, byte[] password)
          Creates a new SASL PLAIN bind request with the provided authentication ID, authorization ID, and password.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, byte[] password, Control... controls)
          Creates a new SASL PLAIN bind request with the provided information.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String password, Control... controls)
          Creates a new SASL PLAIN bind request with the provided authentication ID, password, and set of controls.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String password)
          Creates a new SASL PLAIN bind request with the provided authentication ID, authorization ID, and password.
PLAINBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String password, Control... controls)
          Creates a new SASL PLAIN bind request with the provided information.
 
Method Summary
 PLAINBindRequest duplicate()
          Creates a new instance of this LDAP request that may be modified without impacting this request.
 PLAINBindRequest duplicate(Control[] controls)
          Creates a new instance of this LDAP request that may be modified without impacting this request.
 java.lang.String getAuthenticationID()
          Retrieves the authentication ID for this bind request.
 java.lang.String getAuthorizationID()
          Retrieves the authorization ID for this bind request.
 byte[] getPasswordBytes()
          Retrieves the bytes that comprise the the password for this bind request.
 java.lang.String getPasswordString()
          Retrieves the string representation of the password for this bind request.
 PLAINBindRequest getRebindRequest(java.lang.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.
 java.lang.String getSASLMechanismName()
          Retrieves the name of the SASL mechanism used in this SASL bind request.
protected  BindResult process(LDAPConnection connection, int depth)
          Sends this bind request to the target server over the provided connection and returns the corresponding response.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this request to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.SASLBindRequest
getBindType, getLastMessageID, responseReceived, sendBindRequest, sendMessage
 
Methods inherited from class com.unboundid.ldap.sdk.BindRequest
getOperationType
 
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PLAIN_MECHANISM_NAME

public static final java.lang.String PLAIN_MECHANISM_NAME
The name for the PLAIN SASL mechanism.

See Also:
Constant Field Values
Constructor Detail

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String password)
Creates a new SASL PLAIN bind request with the provided authentication ID and password. It will not include an authorization ID or set of controls.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
password - The password for this bind request. It must not be null.

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        byte[] password)
Creates a new SASL PLAIN bind request with the provided authentication ID and password. It will not include an authorization ID or set of controls.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
password - The password for this bind request. It must not be null.

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        ASN1OctetString password)
Creates a new SASL PLAIN bind request with the provided authentication ID and password. It will not include an authorization ID or set of controls.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
password - The password for this bind request. It must not be null.

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String authorizationID,
                        java.lang.String password)
Creates a new SASL PLAIN bind request with the provided authentication ID, authorization ID, and password. It will not include a set of controls.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
authorizationID - The authorization ID for this bind request, or null if there is to be no authorization ID.
password - The password for this bind request. It must not be null.

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String authorizationID,
                        byte[] password)
Creates a new SASL PLAIN bind request with the provided authentication ID, authorization ID, and password. It will not include a set of controls.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
authorizationID - The authorization ID for this bind request, or null if there is to be no authorization ID.
password - The password for this bind request. It must not be null.

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String authorizationID,
                        ASN1OctetString password)
Creates a new SASL PLAIN bind request with the provided authentication ID, authorization ID, and password. It will not include a set of controls.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
authorizationID - The authorization ID for this bind request, or null if there is to be no authorization ID.
password - The password for this bind request. It must not be null.

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String password,
                        Control... controls)
Creates a new SASL PLAIN bind request with the provided authentication ID, password, and set of controls. It will not include an authorization ID.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
password - The password for this bind request. It must not be null.
controls - The set of controls to include

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        byte[] password,
                        Control... controls)
Creates a new SASL PLAIN bind request with the provided authentication ID, password, and set of controls. It will not include an authorization ID.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
password - The password for this bind request. It must not be null.
controls - The set of controls to include

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        ASN1OctetString password,
                        Control... controls)
Creates a new SASL PLAIN bind request with the provided authentication ID, password, and set of controls. It will not include an authorization ID.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
password - The password for this bind request. It must not be null.
controls - The set of controls to include

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String authorizationID,
                        java.lang.String password,
                        Control... controls)
Creates a new SASL PLAIN bind request with the provided information.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
authorizationID - The authorization ID for this bind request, or null if there is to be no authorization ID.
password - The password for this bind request. It must not be null.
controls - The set of controls to include

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String authorizationID,
                        byte[] password,
                        Control... controls)
Creates a new SASL PLAIN bind request with the provided information.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
authorizationID - The authorization ID for this bind request, or null if there is to be no authorization ID.
password - The password for this bind request. It must not be null.
controls - The set of controls to include

PLAINBindRequest

public PLAINBindRequest(java.lang.String authenticationID,
                        java.lang.String authorizationID,
                        ASN1OctetString password,
                        Control... controls)
Creates a new SASL PLAIN bind request with the provided information.

Parameters:
authenticationID - The authentication ID for this bind request. It must not be null.
authorizationID - The authorization ID for this bind request, or null if there is to be no authorization ID.
password - The password for this bind request. It must not be null.
controls - The set of controls to include
Method Detail

getSASLMechanismName

public java.lang.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.

getAuthenticationID

public java.lang.String getAuthenticationID()
Retrieves the authentication ID for this bind request.

Returns:
The authentication ID for this bind request.

getAuthorizationID

public java.lang.String getAuthorizationID()
Retrieves the authorization ID for this bind request.

Returns:
The authorization ID for this bind request, or null if there is no authorization ID.

getPasswordString

public java.lang.String getPasswordString()
Retrieves the string representation of the password for this bind request.

Returns:
The string representation of the password for this bind request.

getPasswordBytes

public byte[] getPasswordBytes()
Retrieves the bytes that comprise the the password for this bind request.

Returns:
The bytes that comprise the password for this bind request.

process

protected BindResult process(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.

getRebindRequest

public PLAINBindRequest getRebindRequest(java.lang.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.

Overrides:
getRebindRequest in class BindRequest
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

public PLAINBindRequest 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

public PLAINBindRequest duplicate(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(java.lang.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.