Package com.unboundid.ldap.sdk.forgerockds.controls

Class ChangeSequenceNumberResponseControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.forgerockds.controls.ChangeSequenceNumberResponseControl

All Implemented Interfaces:

DecodeableControl, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ChangeSequenceNumberResponseControl
extends Control
implements DecodeableControl

This class provides an implementation of a control that may be used to provide the replication change sequence number (CSN) in the response to an add, delete, modify, or modify DN request that included the change sequence number request control.
This response control has an OID of 1.3.6.1.4.1.42.2.27.9.5.9, and the value is the string representation of the change sequence number. As with all response controls, the criticality should be false.

See Also:

ChangeSequenceNumberRequestControl, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CHANGE_SEQUENCE_NUMBER_RESPONSE_OID	The OID (1.3.6.1.4.1.42.2.27.9.5.9) for the change sequence number response control.

Constructor Summary

Constructors

Constructor	Description
ChangeSequenceNumberResponseControl(java.lang.String csn)	Creates a new change sequence number response control with the provided CSN.
ChangeSequenceNumberResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)	Creates a new change sequence number response control with the provided information.

Method Summary

Modifier and Type	Method	Description
ChangeSequenceNumberResponseControl	decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)	Creates a new instance of this decodeable control from the provided information.
static ChangeSequenceNumberResponseControl	get(LDAPResult result)	Extracts a change sequence number response control from the provided result.
java.lang.String	getControlName()	Retrieves the user-friendly name for this control, if available.
java.lang.String	getCSN()	Retrieves the CSN returned by the server.
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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CHANGE_SEQUENCE_NUMBER_RESPONSE_OID

@NotNull
public static final java.lang.String CHANGE_SEQUENCE_NUMBER_RESPONSE_OID

The OID (1.3.6.1.4.1.42.2.27.9.5.9) for the change sequence number response control.

See Also:

Constant Field Values

Constructor Detail

ChangeSequenceNumberResponseControl

public ChangeSequenceNumberResponseControl(@NotNull
                                           java.lang.String csn)

Creates a new change sequence number response control with the provided CSN.

Parameters:

csn - The change sequence number returned by the server. It must not be null.

ChangeSequenceNumberResponseControl

public ChangeSequenceNumberResponseControl(@NotNull
                                           java.lang.String oid,
                                           boolean isCritical,
                                           @Nullable
                                           ASN1OctetString value)
                                    throws LDAPException

Creates a new change sequence number response control with the provided information.

Parameters:

oid - The OID for the control.

isCritical - Indicates whether the control should be marked critical.

value - The encoded value for the control. This may be null if no value was provided.

Throws:

LDAPException - If the provided control cannot be decoded as a change sequence number response control.

Method Detail

decodeControl

@NotNull
public ChangeSequenceNumberResponseControl decodeControl(@NotNull
                                                         java.lang.String oid,
                                                         boolean isCritical,
                                                         @Nullable
                                                         ASN1OctetString value)
                                                  throws LDAPException

Creates a new instance of this decodeable control from the provided information.

Specified by:

decodeControl in interface DecodeableControl

Parameters:

oid - The OID for the control.

isCritical - Indicates whether the control should be marked critical.

value - The encoded value for the control. This may be null if no value was provided.

Returns:

The decoded representation of this control.

Throws:

LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

get

@Nullable
public static ChangeSequenceNumberResponseControl get(@NotNull
                                                      LDAPResult result)
                                               throws LDAPException

Extracts a change sequence number response control from the provided result.

Parameters:

result - The result from which to retrieve the change sequence number response control.

Returns:

The change sequence number response control contained in the provided result, or null if the result did not contain a change sequence number response control.

Throws:

LDAPException - If a problem is encountered while attempting to decode the change sequence number response control contained in the provided result.

getCSN

@NotNull
public java.lang.String getCSN()

Retrieves the CSN returned by the server.

Returns:

The CSN returned by the server.

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 class Control

Returns:

The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

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

Appends a string representation of this LDAP control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which to append the string representation of this buffer.