|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.extensions.WhoAmIExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class WhoAmIExtendedResult
This class implements a data structure for storing the information from an
extended result for the "Who Am I?" extended request as defined in
RFC 4532. It is able to
decode a generic extended result to extract the returned authorization
identify from it.
See the documentation for the WhoAmIExtendedRequest
class for an
example that demonstrates using the "Who Am I?" extended operation.
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
WhoAmIExtendedResult(ExtendedResult extendedResult)
Creates a new "Who Am I?" extended result from the provided extended result. |
|
WhoAmIExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
java.lang.String authorizationID,
Control[] responseControls)
Creates a new "Who Am I?" extended result with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getAuthorizationID()
Retrieves the authorization ID for this "Who Am I?" extended result, if available. |
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult |
---|
getOID, getValue, hasValue, toString |
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult |
---|
getDiagnosticMessage, getMatchedDN, getMessageID, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WhoAmIExtendedResult(ExtendedResult extendedResult)
extendedResult
- The extended result to be decoded as a "Who Am I?"
extended result.public WhoAmIExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String authorizationID, Control[] responseControls)
messageID
- The message ID for the LDAP message that is
associated with this LDAP result.resultCode
- The result code from the response.diagnosticMessage
- The diagnostic message from the response, if
available.matchedDN
- The matched DN from the response, if available.referralURLs
- The set of referral URLs from the response, if
available.authorizationID
- The authorization ID for this response, if
available.responseControls
- The set of controls from the response, if
available.Method Detail |
---|
public java.lang.String getAuthorizationID()
null
if none was provided.public java.lang.String getExtendedResultName()
null
will be returned.
getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended result will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |