Class GeneratePasswordExtendedResult
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPResult
-
- com.unboundid.ldap.sdk.ExtendedResult
-
- com.unboundid.ldap.sdk.unboundidds.extensions.GeneratePasswordExtendedResult
-
- All Implemented Interfaces:
LDAPResponse
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GeneratePasswordExtendedResult extends ExtendedResult
This class provides an implementation of an extended result that may be used provide the client with the passwords generated by the server in response to aGeneratePasswordExtendedRequest
.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
If the extended request was processed successfully, then this result will have an OID of 1.3.6.1.4.1.30221.2.6.63 and a value with the following encoding:
GeneratePasswordResponse ::= SEQUENCE { passwordPolicyDN LDAPDN, generatedPasswords SEQUENCE OF SEQUENCE { generatedPassword OCTET STRING, validationAttempted BOOLEAN, validationErrors [0] SEQUENCE OF OCTET STRING OPTIONAL, ... }, ... }
The elements of the response value are:- passwordPolicyDN -- The DN of the password policy that was used to select the password generator and validators used in the course of creating the passwords.
- generatedPassword -- A clear-text password that was generated by the server.
- validationAttempted -- Indicates whether the server attempted to perform any validation for the generated password.
- validationErrors -- A list of messages describing any problems that were identified while validating the generated password.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
GENERATE_PASSWORD_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.57) for the generate TOTP shared secret extended result.-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description GeneratePasswordExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String passwordPolicyDN, java.util.List<GeneratedPassword> generatedPasswords, Control... controls)
Creates a new generate password extended result with the provided information.GeneratePasswordExtendedResult(int messageID, java.lang.String passwordPolicyDN, java.util.List<GeneratedPassword> generatedPasswords, Control... controls)
Creates a new generate password extended result that indicates successful processing with the provided information.GeneratePasswordExtendedResult(ExtendedResult extendedResult)
Creates a new generate password extended result from the provided extended result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available.java.util.List<GeneratedPassword>
getGeneratedPasswords()
Retrieves the list of passwords that were generated by the server.java.lang.String
getPasswordPolicyDN()
Retrieves the DN of the password policy that was used in the course of generating and validating the passwords.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
-
-
-
-
Field Detail
-
GENERATE_PASSWORD_RESULT_OID
public static final java.lang.String GENERATE_PASSWORD_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.57) for the generate TOTP shared secret extended result.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GeneratePasswordExtendedResult
public GeneratePasswordExtendedResult(int messageID, java.lang.String passwordPolicyDN, java.util.List<GeneratedPassword> generatedPasswords, Control... controls)
Creates a new generate password extended result that indicates successful processing with the provided information.- Parameters:
messageID
- The message ID for the LDAP message that is associated with this LDAP result.passwordPolicyDN
- The DN of the password policy that was used in in the course of generating the password. It must not benull
.generatedPasswords
- The list of generated passwords. It must not benull
or empty.controls
- An optional set of controls for the response, if any. It may benull
or empty if no controls are needed.
-
GeneratePasswordExtendedResult
public GeneratePasswordExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String passwordPolicyDN, java.util.List<GeneratedPassword> generatedPasswords, Control... controls)
Creates a new generate password 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 for the response. It must not benull
.diagnosticMessage
- The diagnostic message for the response. It may benull
if none is needed.matchedDN
- The matched DN for the response. It may benull
if none is needed.referralURLs
- The set of referral URLs for the response. It may benull
or empty if none are needed.passwordPolicyDN
- The DN of the password policy that was used in in the course of generating the password. It must not benull
for a successful result, but must benull
for a non-successful result.generatedPasswords
- The list of generated passwords. It must not benull
or empty for a successful result, but must benull
or empty for a non-successful result.controls
- An optional set of controls for the response, if any. It may benull
or empty if no controls are needed.
-
GeneratePasswordExtendedResult
public GeneratePasswordExtendedResult(ExtendedResult extendedResult) throws LDAPException
Creates a new generate password extended result from the provided extended result.- Parameters:
extendedResult
- The extended result to be decoded as a generate password extended result. It must not benull
.- Throws:
LDAPException
- If the provided extended result cannot be decoded as a generate password result.
-
-
Method Detail
-
getPasswordPolicyDN
public java.lang.String getPasswordPolicyDN()
Retrieves the DN of the password policy that was used in the course of generating and validating the passwords.- Returns:
- The DN of the password policy that was used in the course of
generating and validating the passwords, or
null
if the operation was not processed successfully.
-
getGeneratedPasswords
public java.util.List<GeneratedPassword> getGeneratedPasswords()
Retrieves the list of passwords that were generated by the server.- Returns:
- The list of passwords that were generated by the server, or an empty list if the operation was not processed successfully.
-
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.
-
-