Class WhoAmIExtendedResult
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPResult
-
- com.unboundid.ldap.sdk.ExtendedResult
-
- com.unboundid.ldap.sdk.extensions.WhoAmIExtendedResult
-
- All Implemented Interfaces:
LDAPResponse
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class WhoAmIExtendedResult extends ExtendedResult
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 theWhoAmIExtendedRequest
class for an example that demonstrates using the "Who Am I?" extended operation.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description 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.WhoAmIExtendedResult(ExtendedResult extendedResult)
Creates a new "Who Am I?" extended result from the provided extended result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
-
-
-
-
Constructor Detail
-
WhoAmIExtendedResult
public WhoAmIExtendedResult(ExtendedResult extendedResult)
Creates a new "Who Am I?" extended result from the provided extended result.- Parameters:
extendedResult
- The extended result to be decoded as a "Who Am I?" extended result.
-
WhoAmIExtendedResult
public 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.- Parameters:
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
-
getAuthorizationID
public java.lang.String getAuthorizationID()
Retrieves the authorization ID for this "Who Am I?" extended result, if available.- Returns:
- The authorization ID for this "Who Am I?" extended result, or
null
if none was provided.
-
getExtendedResultName
public java.lang.String getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, thennull
will be returned.- Overrides:
getExtendedResultName
in classExtendedResult
- Returns:
- The user-friendly name for this extended request, the response OID
if a user-friendly name is not available but a response OID is, or
null
if neither a user-friendly name nor a response OID are available.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer.- Specified by:
toString
in interfaceLDAPResponse
- Overrides:
toString
in classExtendedResult
- Parameters:
buffer
- The buffer to which a string representation of this extended result will be appended.
-
-