|
|||||||||
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.GenericSASLBindRequest
public final class GenericSASLBindRequest
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.
Field Summary |
---|
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 | |
---|---|
GenericSASLBindRequest(java.lang.String bindDN,
java.lang.String mechanism,
ASN1OctetString credentials,
Control... controls)
Creates a new generic SASL bind request with the provided information. |
Method Summary | |
---|---|
GenericSASLBindRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
GenericSASLBindRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getBindDN()
Retrieves the bind DN for this SASL bind request, if any. |
ASN1OctetString |
getCredentials()
Retrieves the credentials for the SASL bind request, if any. |
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, getLastMessageID, responseReceived, sendBindRequest, sendMessage |
Methods inherited from class com.unboundid.ldap.sdk.BindRequest |
---|
getOperationType, getRebindRequest |
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 |
Constructor Detail |
---|
public GenericSASLBindRequest(java.lang.String bindDN, java.lang.String mechanism, ASN1OctetString credentials, Control... controls)
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 Detail |
---|
public java.lang.String getBindDN()
null
if the
target identity should be determined from the credentials or some
other mechanism.public java.lang.String getSASLMechanismName()
getSASLMechanismName
in class SASLBindRequest
public ASN1OctetString getCredentials()
null
if
there are none.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 GenericSASLBindRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
public GenericSASLBindRequest 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.public void toCode(java.util.List<java.lang.String> lineList, java.lang.String requestID, int indentSpaces, boolean includeProcessing)
toCode
in interface ReadOnlyLDAPRequest
toCode
in class SASLBindRequest
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
).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |