|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.BindRequest
com.unboundid.ldap.sdk.SASLBindRequest
com.unboundid.ldap.sdk.EXTERNALBindRequest
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class EXTERNALBindRequest
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).
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(); }
Field Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
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 |
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, 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 |
---|
public static final java.lang.String EXTERNAL_MECHANISM_NAME
Constructor Detail |
---|
public EXTERNALBindRequest()
public EXTERNALBindRequest(java.lang.String authzID)
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.public EXTERNALBindRequest(Control... controls)
controls
- The set of controls to include in this SASL EXTERNAL
bind request.public EXTERNALBindRequest(java.lang.String authzID, Control... controls)
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 |
---|
public java.lang.String getAuthorizationID()
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.public java.lang.String getSASLMechanismName()
getSASLMechanismName
in class SASLBindRequest
protected BindResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class BindRequest
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.
LDAPException
- If a problem occurs while sending the request or
reading the response.public EXTERNALBindRequest getRebindRequest(java.lang.String host, int port)
getRebindRequest
in class BindRequest
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.
null
to indicate that automatic
re-binding is not supported for this type of bind request.public int getLastMessageID()
getLastMessageID
in class SASLBindRequest
public EXTERNALBindRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
public EXTERNALBindRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
controls
- The set of controls to include in the duplicate request.
public void toString(java.lang.StringBuilder buffer)
toString
in interface ReadOnlyLDAPRequest
toString
in class LDAPRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |