|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.sync.types.SetStartpointOptions
public final class SetStartpointOptions
Used to identify how to set the starting point for synchronization (beginning
of changelog, end of changelog, based on a change sequence number, etc).
Different startpoint types require different supporting values; for example
if the type is RESUME_AT_CHANGE_NUMBER, the value must be a long
that represents a change number to start at. Some of the startpoint types
require a server name to be specified as well.
These objects will be constructed by the realtime-sync
CLI and
passed down into the SetStartpointTask, which will then delegate to the
specific Sync Pipe and finally the Sync Source implementation for that pipe.
Not all Sync Source implementations will support all the startpoint types. If
an unsupported type is specified, the underlying implementation is free to
throw a RuntimeException
stating that the startpoint type is
unsupported.
Nested Class Summary | |
---|---|
static class |
SetStartpointOptions.StartpointType
The possible startpoint types. |
Method Summary | |
---|---|
static SetStartpointOptions |
createBeginningOfChangelogOptions()
Creates a SetStartpointOptions instance with the BEGINNING_OF_CHANGELOG startpoint type. |
static SetStartpointOptions |
createEndOfChangelogOptions()
Creates a SetStartpointOptions instance with the END_OF_CHANGELOG startpoint type. |
static SetStartpointOptions |
createResumeAtChangeNumberOptions(long changeNumber,
java.lang.String serverName)
Creates a SetStartpointOptions instance with the RESUME_AT_CHANGE_NUMBER startpoint type. |
static SetStartpointOptions |
createResumeAtChangeTimeOptions(java.util.Date changeTime,
java.lang.String serverName)
Creates a SetStartpointOptions instance with the RESUME_AT_CHANGE_TIME startpoint type. |
static SetStartpointOptions |
createResumeAtCSNOptions(java.lang.String csn)
Creates a SetStartpointOptions instance with the RESUME_AT_CSN
startpoint type. |
static SetStartpointOptions |
createResumeAtSerializableOptions(java.io.Serializable startpointValue)
Creates a SetStartpointOptions instance with the RESUME_AT_SERIALIZABLE startpoint type. |
long |
getChangeNumber()
Gets the change number value if one was specified. |
java.util.Date |
getChangeTime()
Gets the change time value if one was specified. |
java.lang.String |
getCSN()
Gets the CSN value if one was specified. |
java.io.Serializable |
getSerializableValue()
Gets the generic (serializable) startpoint value if one was specified. |
java.lang.String |
getServerName()
Gets the server name if one was specified, representing the External Server at which to set the start point. |
SetStartpointOptions.StartpointType |
getStartpointType()
Gets the startpointType (i.e. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static SetStartpointOptions createBeginningOfChangelogOptions()
BEGINNING_OF_CHANGELOG
startpoint type.
public static SetStartpointOptions createEndOfChangelogOptions()
END_OF_CHANGELOG
startpoint type.
public static SetStartpointOptions createResumeAtCSNOptions(java.lang.String csn)
RESUME_AT_CSN
startpoint type.
csn
- the change sequence number of the first change to synchronize
public static SetStartpointOptions createResumeAtChangeNumberOptions(long changeNumber, java.lang.String serverName)
RESUME_AT_CHANGE_NUMBER
startpoint type.
changeNumber
- the change number of the first change to synchronizeserverName
- the name of the External Server to which the change number
applies. The CLI
requires this parameter to be non-null, because a given change
number may
correspond to different changes on different replicas.
public static SetStartpointOptions createResumeAtChangeTimeOptions(java.util.Date changeTime, java.lang.String serverName)
RESUME_AT_CHANGE_TIME
startpoint type. Changes
made prior to the specified change time will be ignored.
changeTime
- the cut-off time at which synchronization will resumeserverName
- the name of the External Server to which the change time applies.
The CLI allows
this parameter to be null, but some underlying sync source
implementations
may require it (such as DSEESyncSource).
public static SetStartpointOptions createResumeAtSerializableOptions(java.io.Serializable startpointValue)
RESUME_AT_SERIALIZABLE
startpoint type. Changes made prior to
the specified state will be ignored.
startpointValue
- a Serializable object which can be passed to the sync source as a
valid
indicator of where to start synchronization
public SetStartpointOptions.StartpointType getStartpointType()
SetStartpointOptions.StartpointType
instancepublic java.lang.String getCSN()
RESUME_AT_CSN
public long getChangeNumber()
RESUME_AT_CHANGE_NUMBER
public java.util.Date getChangeTime()
Date
, or null if the startpoint type is not
RESUME_AT_CHANGE_TIME
public java.io.Serializable getSerializableValue()
Serializable
instance, or null if the startpoint type is
not RESUME_AT_SERIALIZABLE
public java.lang.String getServerName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |