com.unboundid.ldap.sdk

Class EXTERNALBindRequest

java.lang.Object

com.unboundid.ldap.sdk.LDAPRequest

com.unboundid.ldap.sdk.BindRequest

com.unboundid.ldap.sdk.SASLBindRequest

com.unboundid.ldap.sdk.EXTERNALBindRequest

All Implemented Interfaces:

ReadOnlyLDAPRequest, java.io.Serializable

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

This class provides a SASL EXTERNAL bind request implementation as described in RFC 4422. The EXTERNAL mechanism is used to authenticate using information that is available outside of the LDAP layer (e.g., a certificate presented by the client during SSL or StartTLS negotiation).

Example

The following example demonstrates the process for performing an EXTERNAL bind against a directory server:

 EXTERNALBindRequest bindRequest = new EXTERNALBindRequest("");
 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

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTERNAL_MECHANISM_NAME The name for the EXTERNAL 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

Constructors

Constructor and Description
EXTERNALBindRequest() Creates a new SASL EXTERNAL bind request with no authorization ID and no controls.
EXTERNALBindRequest(Control... controls) Creates a new SASL EXTERNAL bind request with the provided set of controls.
EXTERNALBindRequest(java.lang.String authzID) Creates a new SASL EXTERNAL bind request with the specified authorization ID and no controls.
EXTERNALBindRequest(java.lang.String authzID, Control... controls) Creates a new SASL EXTERNAL bind request with the provided set of controls.

Method Summary

Modifier and Type	Method and Description
EXTERNALBindRequest	duplicate() Creates a new instance of this LDAP request that may be modified without impacting this request.
EXTERNALBindRequest	duplicate(Control[] controls) Creates a new instance of this LDAP request that may be modified without impacting this request.
java.lang.String	getAuthorizationID() Retrieves the authorization ID that should be included in the bind request, if any.
int	getLastMessageID() Retrieves the message ID for the last LDAP message sent using this request.
EXTERNALBindRequest	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	toCode(java.util.List<java.lang.String> lineList, java.lang.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.
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, 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, getReferralConnector, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EXTERNAL_MECHANISM_NAME

@NotNull
public static final java.lang.String EXTERNAL_MECHANISM_NAME

The name for the EXTERNAL SASL mechanism.

See Also:

Constant Field Values

Constructor Detail

EXTERNALBindRequest

public EXTERNALBindRequest()

Creates a new SASL EXTERNAL bind request with no authorization ID and no controls.

EXTERNALBindRequest

public EXTERNALBindRequest(@Nullable
                           java.lang.String authzID)

Creates a new SASL EXTERNAL bind request with the specified authorization ID and no controls.

Parameters:

authzID - The authorization ID to use for the bind request. It may be null if the client should not send any authorization ID at all (which may be required by some servers). It may be an empty string if the server should determine the authorization identity from what it knows about the client (e.g., a client certificate). It may be a non-empty string if the authorization identity should be different from the authentication identity.

EXTERNALBindRequest

public EXTERNALBindRequest(@Nullable
                           Control... controls)

Creates a new SASL EXTERNAL bind request with the provided set of controls.

Parameters:

controls - The set of controls to include in this SASL EXTERNAL bind request.

EXTERNALBindRequest

public EXTERNALBindRequest(@Nullable
                           java.lang.String authzID,
                           @Nullable
                           Control... controls)

Creates a new SASL EXTERNAL bind request with the provided set of controls.

Parameters:

authzID - The authorization ID to use for the bind request. It may be null if the client should not send any authorization ID at all (which may be required by some servers). It may be an empty string if the server should determine the authorization identity from what it knows about the client (e.g., a client certificate). It may be a non-empty string if the authorization identity should be different from the authentication identity.

controls - The set of controls to include in this SASL EXTERNAL bind request.

Method Detail

getAuthorizationID

@Nullable
public java.lang.String getAuthorizationID()

Retrieves the authorization ID that should be included in the bind request, if any.

Returns:

The authorization ID that should be included in the bind request, or null if the bind request should be sent without an authorization ID (which is a form that some servers require). It may be an empty string if the authorization identity should be the same as the authentication identity and should be determined from what the server already knows about the client.

getSASLMechanismName

@NotNull
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.

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.

getRebindRequest

@NotNull
public EXTERNALBindRequest getRebindRequest(@NotNull
                                                     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.

getLastMessageID

public int getLastMessageID()

Retrieves the message ID for the last LDAP message sent using this request.

Overrides:

getLastMessageID in class SASLBindRequest

Returns:

The message ID for the last LDAP message sent using this request, or -1 if it no LDAP messages have yet been sent using this request.

duplicate

@NotNull
public EXTERNALBindRequest 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 EXTERNALBindRequest 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
                     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.

toCode

public void toCode(@NotNull
                   java.util.List<java.lang.String> lineList,
                   @NotNull
                   java.lang.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).