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

Class MissingChangelogEntriesIntermediateResponse

java.lang.Object
com.unboundid.ldap.sdk.IntermediateResponse
com.unboundid.ldap.sdk.unboundidds.extensions.MissingChangelogEntriesIntermediateResponse
All Implemented Interfaces:
LDAPResponse, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MissingChangelogEntriesIntermediateResponse extends IntermediateResponse
This class provides an implementation of an intermediate response which indicates that the Directory Server may have already purged information about one or more changes.
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.

The missing changelog entries intermediate response value may be present, and if it is then it will have the following encoding: 
   MissingEntriesIntermediateResponse ::= SEQUENCE {
        message     [0] OCTET STRING OPTIONAL,
        ... }
See Also:

  • Field Details

  • Constructor Details

    • MissingChangelogEntriesIntermediateResponse

      public MissingChangelogEntriesIntermediateResponse(@Nullable String message, @Nullable Control... controls)
      Creates a new missing changelog entries intermediate response with the provided information.
      Parameters:
      message - A message which may provide additional information about the missing changes. It may be null if no message is available.
      controls - The set of controls to include in the intermediate response. It may be null or empty if no controls should be included.

    • MissingChangelogEntriesIntermediateResponse

      public MissingChangelogEntriesIntermediateResponse(@NotNull IntermediateResponse r) throws LDAPException
      Creates a new missing changelog entries intermediate response from the provided generic intermediate response.
      Parameters:
      r - The generic intermediate response to be decoded.
      Throws:
      LDAPException - If the provided intermediate response cannot be decoded as a missing changelog entries response.

  • Method Details

    • getMessage

      @Nullable public String getMessage()
      Retrieves a message which may provide additional information about the missing changes.
      Returns:
      A message which may provide additional information about the missing changes, or null if none is available.

    • getIntermediateResponseName

      @NotNull public String getIntermediateResponseName()
      Retrieves the user-friendly name for the intermediate response, 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:
      getIntermediateResponseName in class IntermediateResponse
      Returns:
      The user-friendly name for this intermediate response, 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.

    • valueToString

      @Nullable public String valueToString()
      Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate. If one is provided, then it should be a relatively compact single-line representation of the most important elements of the value.
      Overrides:
      valueToString in class IntermediateResponse
      Returns:
      A human-readable string representation for the contents of the value for this intermediate response, or null if there is no value or no string representation is available.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this intermediate response to the provided buffer.
      Specified by:
      toString in interface LDAPResponse
      Overrides:
      toString in class IntermediateResponse
      Parameters:
      buffer - The buffer to which the string representation should be appended.