Class ChangeSequenceNumberRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.forgerockds.controls.ChangeSequenceNumberRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ChangeSequenceNumberRequestControl extends Control
This class provides an implementation of a control that may be used to request that the server return the replication change sequence number (CSN) that it has assigned to the associated add, delete, modify, or modify DN operation.
This request control has an OID of 1.3.6.1.4.1.42.2.27.9.5.9, the criticality may be either true or false, and it does not have a value.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CHANGE_SEQUENCE_NUMBER_REQUEST_OID
The OID (1.3.6.1.4.1.42.2.27.9.5.9) for the change sequence number request control.
-
Constructor Summary
Constructors Constructor Description ChangeSequenceNumberRequestControl()
Creates a new change sequence number request control.ChangeSequenceNumberRequestControl(boolean isCritical)
Creates a new change sequence number request control with the specified criticality.ChangeSequenceNumberRequestControl(Control control)
Creates a new change sequence number request control that is decoded from the provided generic control.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toJSONControl, toString, writeTo
-
-
-
-
Field Detail
-
CHANGE_SEQUENCE_NUMBER_REQUEST_OID
@NotNull public static final java.lang.String CHANGE_SEQUENCE_NUMBER_REQUEST_OID
The OID (1.3.6.1.4.1.42.2.27.9.5.9) for the change sequence number request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ChangeSequenceNumberRequestControl
public ChangeSequenceNumberRequestControl()
Creates a new change sequence number request control. It will not be marked critical.
-
ChangeSequenceNumberRequestControl
public ChangeSequenceNumberRequestControl(boolean isCritical)
Creates a new change sequence number request control with the specified criticality.- Parameters:
isCritical
- Indicates whether the control should be marked critical.
-
ChangeSequenceNumberRequestControl
public ChangeSequenceNumberRequestControl(@NotNull Control control) throws LDAPException
Creates a new change sequence number request control that is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a change sequence number request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a change sequence number request control.
-
-
Method Detail
-
getControlName
@NotNull public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getControlName
in classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
-