|
|||||||||
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.PasswordModifyExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordModifyExtendedResult
This class implements a data structure for storing the information from an
extended result for the password modify extended request as defined in
RFC 3062. It is identical
to the standard ExtendedResult
object except that it is also able to
extract the generated password if one was included. See the documentation
for the PasswordModifyExtendedRequest
class for an example of this.
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
PasswordModifyExtendedResult(ExtendedResult extendedResult)
Creates a new password modify extended result from the provided extended result. |
|
PasswordModifyExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
ASN1OctetString generatedPassword,
Control[] responseControls)
Creates a new password modify extended result with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
java.lang.String |
getGeneratedPassword()
Retrieves the string representation of the generated password contained in this extended result, if available. |
byte[] |
getGeneratedPasswordBytes()
Retrieves the binary representation of the generated password contained in this extended result, if available. |
ASN1OctetString |
getRawGeneratedPassword()
Retrieves the raw generated password contained in this 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 PasswordModifyExtendedResult(ExtendedResult extendedResult) throws LDAPException
extendedResult
- The extended result to be decoded as a password
modify extended result. It must not be
null
.
LDAPException
- If the provided extended result cannot be decoded
as a password modify extended result.public PasswordModifyExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, ASN1OctetString generatedPassword, 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.generatedPassword
- The generated password for this response, if
available.responseControls
- The set of controls from the response, if
available.Method Detail |
---|
public java.lang.String getGeneratedPassword()
null
if no generated password was
included in the extended result.public byte[] getGeneratedPasswordBytes()
null
if no generated password was
included in the extended result.public ASN1OctetString getRawGeneratedPassword()
null
if no generated password was included in the extended
result.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 |