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

Class PurgeRetiredInterServerCertificatesExtendedRequest

java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.PurgeRetiredInterServerCertificatesExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PurgeRetiredInterServerCertificatesExtendedRequest extends ExtendedRequest
This class defines an extended request that may be used to request that a Ping Identity Directory Server instance (or related Ping Identity server product) purge information about any retired inter-server certificates from its topology registry. This extended request has an OID of 1.3.6.1.4.1.30221.2.6.71 and no value.
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.
See Also:

  • Field Details

  • Constructor Details

    • PurgeRetiredInterServerCertificatesExtendedRequest

      public PurgeRetiredInterServerCertificatesExtendedRequest(@Nullable Control... requestControls)
      Creates a new purge retired inter-server certificates extended request with the provided information.
      Parameters:
      requestControls - The set of controls to include in the extended request. It may be null or empty if no request controls should be included.

    • PurgeRetiredInterServerCertificatesExtendedRequest

      public PurgeRetiredInterServerCertificatesExtendedRequest(@NotNull ExtendedRequest request) throws LDAPException
      Creates a new purge retired inter-server certificates extended request that is decoded from the provided generic extended request.
      Parameters:
      request - The generic extended request to be decoded as a purge retired inter-server certificates extended request. It must not be null.
      Throws:
      LDAPException - If a problem occurs while attempting to decode the provided extended request as a purge retired inter-server certificates request.

  • Method Details

    • process

      @NotNull public PurgeRetiredInterServerCertificatesExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
      Sends this extended request to the directory server over the provided connection and returns the associated response.
      Overrides:
      process in class ExtendedRequest
      Parameters:
      connection - The connection to use to communicate with the directory server.
      depth - The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.
      Returns:
      An LDAP result object that provides information about the result of the extended operation processing.
      Throws:
      LDAPException - If a problem occurs while sending the request or reading the response.

    • getExtendedRequestName

      @NotNull public String getExtendedRequestName()
      Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.
      Overrides:
      getExtendedRequestName in class ExtendedRequest
      Returns:
      The user-friendly name for this extended request, or the OID if no user-friendly name is available.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this request to the provided buffer.
      Specified by:
      toString in interface ProtocolOp
      Specified by:
      toString in interface ReadOnlyLDAPRequest
      Overrides:
      toString in class ExtendedRequest
      Parameters:
      buffer - The buffer to which to append a string representation of this request.