com.unboundid.ldap.sdk.unboundidds.extensions

Class ChangelogEntryIntermediateResponse

java.lang.Object

com.unboundid.ldap.sdk.IntermediateResponse

com.unboundid.ldap.sdk.unboundidds.extensions.ChangelogEntryIntermediateResponse

All Implemented Interfaces:

LDAPResponse, java.io.Serializable

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

This class provides an implementation of an intermediate response which provides information about a changelog entry returned from a Directory Server.

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 changelog entry intermediate response value is encoded as follows:

   ChangelogEntryIntermediateResponse ::= SEQUENCE {
        resumeToken                  OCTET STRING,
        serverID                     OCTET STRING,
        changelogEntryDN             LDAPDN,
        changelogEntryAttributes     PartialAttributeList,
        ... }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGELOG_ENTRY_INTERMEDIATE_RESPONSE_OID The OID (1.3.6.1.4.1.30221.2.6.11) 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

Constructors

Constructor and Description
ChangelogEntryIntermediateResponse(ChangeLogEntry changeLogEntry, java.lang.String serverID, ASN1OctetString resumeToken, Control... controls) Creates a new changelog entry intermediate response with the provided information.
ChangelogEntryIntermediateResponse(IntermediateResponse r) Creates a new changelog entry intermediate response from the provided generic intermediate response.

Method Summary

Modifier and Type	Method and Description
UnboundIDChangeLogEntry	getChangeLogEntry() Retrieves the changelog entry contained in this intermediate response.
java.lang.String	getIntermediateResponseName() Retrieves the user-friendly name for the intermediate response, if available.
ASN1OctetString	getResumeToken() Retrieves a token that may be used to resume the process of retrieving changes at the point immediately after this change.
java.lang.String	getServerID() Retrieves the server ID for the server from which the changelog entry was retrieved.
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

CHANGELOG_ENTRY_INTERMEDIATE_RESPONSE_OID

@NotNull
public static final java.lang.String CHANGELOG_ENTRY_INTERMEDIATE_RESPONSE_OID

The OID (1.3.6.1.4.1.30221.2.6.11) for the get stream directory values intermediate response.

See Also:

Constant Field Values

Constructor Detail

ChangelogEntryIntermediateResponse

public ChangelogEntryIntermediateResponse(@NotNull
                                          ChangeLogEntry changeLogEntry,
                                          @NotNull
                                          java.lang.String serverID,
                                          @NotNull
                                          ASN1OctetString resumeToken,
                                          @Nullable
                                          Control... controls)

Creates a new changelog entry intermediate response with the provided information.

Parameters:

changeLogEntry - The changelog entry included in this intermediate response. It must not be null.

serverID - The server ID for the server from which the changelog entry was received. It must not be null.

resumeToken - A token that may be used to resume the process of retrieving changes at the point immediately after this change. It must not be null.

controls - The set of controls to include in the response. It may be null or empty if no controls should be included.

ChangelogEntryIntermediateResponse

public ChangelogEntryIntermediateResponse(@NotNull
                                          IntermediateResponse r)
                                   throws LDAPException

Creates a new changelog entry 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 changelog entry response.

Method Detail

getChangeLogEntry

@NotNull
public UnboundIDChangeLogEntry getChangeLogEntry()

Retrieves the changelog entry contained in this intermediate response.

Returns:

The changelog entry contained in this intermediate response.

getServerID

@NotNull
public java.lang.String getServerID()

Retrieves the server ID for the server from which the changelog entry was retrieved.

Returns:

The server ID for the server from which the changelog entry was retrieved.

getResumeToken

@NotNull
public ASN1OctetString getResumeToken()

Retrieves a token that may be used to resume the process of retrieving changes at the point immediately after this change.

Returns:

A token that may be used to resume the process of retrieving changes at the point immediately after this change.

getIntermediateResponseName

@NotNull
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

@NotNull
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(@NotNull
                     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.