com.unboundid.ldap.sdk.unboundidds.extensions
Class MissingChangelogEntriesIntermediateResponse

java.lang.Object
  extended by com.unboundid.ldap.sdk.IntermediateResponse
      extended by com.unboundid.ldap.sdk.unboundidds.extensions.MissingChangelogEntriesIntermediateResponse
All Implemented Interfaces:
LDAPResponse, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class MissingChangelogEntriesIntermediateResponse
extends IntermediateResponse

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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. 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:
Serialized Form

Field Summary
static java.lang.String MISSING_CHANGELOG_ENTRIES_INTERMEDIATE_RESPONSE_OID
          The OID (1.3.6.1.4.1.30221.2.6.12) for the get stream directory values intermediate response.
 
Fields inherited from class com.unboundid.ldap.sdk.IntermediateResponse
TYPE_INTERMEDIATE_RESPONSE_OID, TYPE_INTERMEDIATE_RESPONSE_VALUE
 
Constructor Summary
MissingChangelogEntriesIntermediateResponse(IntermediateResponse r)
          Creates a new missing changelog entries intermediate response from the provided generic intermediate response.
MissingChangelogEntriesIntermediateResponse(java.lang.String message, Control... controls)
          Creates a new missing changelog entries intermediate response with the provided information.
 
Method Summary
 java.lang.String getIntermediateResponseName()
          Retrieves the user-friendly name for the intermediate response, if available.
 java.lang.String getMessage()
          Retrieves a message which may provide additional information about the missing changes.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this intermediate response to the provided buffer.
 java.lang.String valueToString()
          Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate.
 
Methods inherited from class com.unboundid.ldap.sdk.IntermediateResponse
getControl, getControls, getMessageID, getOID, getValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MISSING_CHANGELOG_ENTRIES_INTERMEDIATE_RESPONSE_OID

public static final java.lang.String MISSING_CHANGELOG_ENTRIES_INTERMEDIATE_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.6.12) for the get stream directory values intermediate response.

See Also:
Constant Field Values
Constructor Detail

MissingChangelogEntriesIntermediateResponse

public MissingChangelogEntriesIntermediateResponse(java.lang.String message,
                                                   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(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 Detail

getMessage

public java.lang.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

public java.lang.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

public java.lang.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(java.lang.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.