Package com.unboundid.ldap.sdk.unboundidds.extensions

Class PasswordPolicyStateExtendedResult

java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.PasswordPolicyStateExtendedResult
All Implemented Interfaces:
LDAPResponse, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordPolicyStateExtendedResult extends ExtendedResult
This class implements a data structure for storing the information from an extended result for the password policy state extended request as used in the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server. It is able to decode a generic extended result to obtain the user DN and operations. See the documentation in the PasswordPolicyStateExtendedRequest class for an example that demonstrates the use of the password policy state extended operation.
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.

This extended result does not have an OID. If the request was processed successfully, then the result will have a value that has the same encoding as the request, which was described in the class-level documentation for the PasswordPolicyStateExtendedRequest class.
See Also:

  • Constructor Details

    • PasswordPolicyStateExtendedResult

      public PasswordPolicyStateExtendedResult(@NotNull ExtendedResult extendedResult) throws LDAPException
      Creates a new password policy state extended result from the provided extended result.
      Parameters:
      extendedResult - The extended result to be decoded as a password policy state extended result. It must not be null.
      Throws:
      LDAPException - If the provided extended result cannot be decoded as a password policy state extended result.

    • PasswordPolicyStateExtendedResult

      public PasswordPolicyStateExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable String userDN, @Nullable PasswordPolicyStateOperation[] operations, @Nullable Control[] responseControls)
      Creates a new password policy state 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.
      userDN - The user DN from the response.
      operations - The set of operations from the response, mapped from operation type to the corresponding operation data.
      responseControls - The set of controls from the response, if available.

  • Method Details

    • getUserDN

      @Nullable public String getUserDN()
      Retrieves the user DN included in the response.
      Returns:
      The user DN included in the response, or null if the user DN is not available (e.g., if this is an error response).

    • getOperations

      @NotNull public Iterable<PasswordPolicyStateOperation> getOperations()
      Retrieves the set of password policy operations included in the response.
      Returns:
      The set of password policy operations included in the response.

    • getOperation

      @Nullable public PasswordPolicyStateOperation getOperation(int opType)
      Retrieves the specified password policy state operation from the response.
      Parameters:
      opType - The operation type for the password policy state operation to retrieve.
      Returns:
      The requested password policy state operation, or null if no such operation was included in the response.

    • getStringValue

      @Nullable public String getStringValue(int opType)
      Retrieves the value for the specified password policy state operation as a string.
      Parameters:
      opType - The operation type for the password policy state operation to retrieve.
      Returns:
      The string value of the requested password policy state operation, or null if the specified operation was not included in the response or did not have any values.

    • getStringValues

      @Nullable public String[] getStringValues(int opType)
      Retrieves the set of string values for the specified password policy state operation.
      Parameters:
      opType - The operation type for the password policy state operation to retrieve.
      Returns:
      The set of string values for the requested password policy state operation, or null if the specified operation was not included in the response.

    • getBooleanValue

      public boolean getBooleanValue(int opType) throws NoSuchElementException, IllegalStateException
      Retrieves the value of the specified password policy state operation as a boolean.
      Parameters:
      opType - The operation type for the password policy state operation to retrieve.
      Returns:
      The boolean value of the requested password policy state operation.
      Throws:
      NoSuchElementException - If the specified operation was not included in the response.
      IllegalStateException - If the specified password policy state operation does not have exactly one value, or if the value cannot be parsed as a boolean value.

    • getIntValue

      public int getIntValue(int opType) throws NoSuchElementException, IllegalStateException
      Retrieves the value of the specified password policy state operation as an integer.
      Parameters:
      opType - The operation type for the password policy state operation to retrieve.
      Returns:
      The integer value of the requested password policy state operation.
      Throws:
      NoSuchElementException - If the specified operation was not included in the response.
      IllegalStateException - If the value of the specified password policy state operation cannot be parsed as an integer value.

    • getGeneralizedTimeValue

      @Nullable public Date getGeneralizedTimeValue(int opType) throws ParseException
      Retrieves the value for the specified password policy state operation as a Date in generalized time format.
      Parameters:
      opType - The operation type for the password policy state operation to retrieve.
      Returns:
      The value of the requested password policy state operation as a Date, or null if the specified operation was not included in the response or did not have any values.
      Throws:
      ParseException - If the value cannot be parsed as a date in generalized time format.

    • getGeneralizedTimeValues

      @Nullable public Date[] getGeneralizedTimeValues(int opType) throws ParseException
      Retrieves the set of values for the specified password policy state operation as Dates in generalized time format.
      Parameters:
      opType - The operation type for the password policy state operation to retrieve.
      Returns:
      The set of values of the requested password policy state operation as Dates.
      Throws:
      ParseException - If any of the values cannot be parsed as a date in generalized time format.

    • getExtendedResultName

      @NotNull public 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, then null will be returned.
      Overrides:
      getExtendedResultName in class ExtendedResult
      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(@NotNull StringBuilder buffer)
      Appends a string representation of this extended result to the provided buffer.
      Specified by:
      toString in interface LDAPResponse
      Overrides:
      toString in class ExtendedResult
      Parameters:
      buffer - The buffer to which a string representation of this extended result will be appended.