Class FetchChangelogUpdatesControl

java.lang.Object

org.forgerock.opendj.server.leaderbasedreplication.FetchChangelogUpdatesControl

All Implemented Interfaces:

Control

public final class FetchChangelogUpdatesControl
extends Object
implements Control

This class implements the request control used to fetch updates from another server, in order to replicate those updates.

Field Summary

Fields

Modifier and Type	Field	Description
static final ControlDecoder<FetchChangelogUpdatesControl>	DECODER	The Control Decoder that can be used to decode this control.
static final String	OID_FETCH_CHANGELOG_UPDATES_CONTROL	The OID for the fetch changelog updates control.

Constructor Summary

Constructors

Constructor	Description
FetchChangelogUpdatesControl(boolean isCritical, ReplicaId replicaId, Map<Domain, ReplicaState> replicaStateByDomain)	Creates a new instance of ReplicationRequestControl.

Method Summary

Modifier and Type	Method	Description
String	getAlias()	Returns the control "friendly name" alias for the control.
String	getOid()	Returns the numeric OID associated with this control.
ReplicaState	getReplicaStateOrEmpty(Domain domain)	Returns the replica state of the given domain.
ByteString	getValue()	Returns the value, if any, associated with this control.
boolean	hasValue()	Returns true if this control has a value.
boolean	isCritical()	Returns true if it is unacceptable to perform the operation without applying the semantics of this control.
String	toString()

Methods inherited from class Object

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

Field Details

OID_FETCH_CHANGELOG_UPDATES_CONTROL

public static final String OID_FETCH_CHANGELOG_UPDATES_CONTROL

The OID for the fetch changelog updates control.

See Also:

• Constant Field Values

DECODER

public static final ControlDecoder<FetchChangelogUpdatesControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Details

FetchChangelogUpdatesControl

public FetchChangelogUpdatesControl(boolean isCritical,
 ReplicaId replicaId,
 Map<Domain, ReplicaState> replicaStateByDomain)

Creates a new instance of ReplicationRequestControl.

Parameters:

isCritical - Specifies whether the control is critical.

replicaId - The replica id.

replicaStateByDomain - The replica state by domain map.

Method Details

getOid

public String getOid()

Description copied from interface: Control

Returns the numeric OID associated with this control.

Specified by:

getOid in interface Control

Returns:

the numeric OID associated with this control

getReplicaStateOrEmpty

public ReplicaState getReplicaStateOrEmpty(Domain domain)

Returns the replica state of the given domain.

Parameters:

domain - the domain for which to return the replica state.

Returns:

the replica state of the given domain

isCritical

public boolean isCritical()

Description copied from interface: Control

Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

Specified by:

isCritical in interface Control

Returns:

true if this control must be processed by the Directory Server, or false if it can be ignored.

getAlias

public String getAlias()

Description copied from interface: Control

Returns the control "friendly name" alias for the control.

Specified by:

getAlias in interface Control

Returns:

"Friendly name" alias for the control.

hasValue

public boolean hasValue()

Description copied from interface: Control

Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface Control

Returns:

true if this control has a value, or false if there is no value.

getValue

public ByteString getValue()

Description copied from interface: Control

Returns the value, if any, associated with this control. Its format is defined by the specification of this control.

Specified by:

getValue in interface Control

Returns:

The value associated with this control, or null if there is no value.

toString

public String toString()

Overrides:

toString in class Object