com.unboundid.ldap.sdk.unboundidds.extensions

Class ResumeWithTokenStartingPoint

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.extensions.ChangelogBatchStartingPoint

com.unboundid.ldap.sdk.unboundidds.extensions.ResumeWithTokenStartingPoint

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ResumeWithTokenStartingPoint
extends ChangelogBatchStartingPoint

This class provides an implementation of a changelog batch starting point which may be used to start a batch of changes at a point where a previous batch ended. The first change of the batch will be the change immediately after the change associated with the provided token.

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResumeWithTokenStartingPoint(ASN1OctetString resumeToken) Creates a new instance of this changelog batch starting point using the provided resume token.

Method Summary

Modifier and Type	Method and Description
ASN1Element	encode() Encodes this starting point value to an ASN.1 element suitable for inclusion in a changelog batch extended request.
ASN1OctetString	getResumeToken() Retrieves the token which may be used to resume changelog access at the point where it previously ended.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this changelog batch starting point to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.extensions.ChangelogBatchStartingPoint

decode, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResumeWithTokenStartingPoint

public ResumeWithTokenStartingPoint(@NotNull
                                    ASN1OctetString resumeToken)

Creates a new instance of this changelog batch starting point using the provided resume token.

Parameters:

resumeToken - The token which may be used to resume changelog access at the point where it previously ended. It must not be null.

Method Detail

getResumeToken

@NotNull
public ASN1OctetString getResumeToken()

Retrieves the token which may be used to resume changelog access at the point where it previously ended.

Returns:

The token which may be used to resume changelog access at the point where it previously ended.

encode

@NotNull
public ASN1Element encode()

Encodes this starting point value to an ASN.1 element suitable for inclusion in a changelog batch extended request.

Specified by:

encode in class ChangelogBatchStartingPoint

Returns:

The encoded representation of this starting point value.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this changelog batch starting point to the provided buffer.

Specified by:

toString in class ChangelogBatchStartingPoint

Parameters:

buffer - The buffer to which the information should be appended.