org.opends.server.controls

Class EntryChangelogNotificationControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.EntryChangelogNotificationControl

public class EntryChangelogNotificationControl
extends Control

This class implements the ECL cookie control. It may be included in entries returned in response to a search or persistent search operation.

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<EntryChangelogNotificationControl>	DECODER The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors

Constructor and Description
EntryChangelogNotificationControl(boolean isCritical, String cookie) Creates a new entry change notification control with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCookie() Retrieves the change type for this entry change notification control.
void	toString(StringBuilder buffer) Appends a string representation of this entry change notification control to the provided buffer.
void	writeValue(org.forgerock.opendj.io.ASN1Writer writer) Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control

getOID, isCritical, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

DECODER

public static final ControlDecoder<EntryChangelogNotificationControl> DECODER

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

Constructor Detail

EntryChangelogNotificationControl

public EntryChangelogNotificationControl(boolean isCritical,
                                 String cookie)

Creates a new entry change notification control with the provided information.

Parameters:

isCritical - Indicates whether this control should be considered critical in processing the request.

cookie - The provided cookie value.

Method Detail

writeValue

public void writeValue(org.forgerock.opendj.io.ASN1Writer writer)
                throws IOException

Writes this control's value to an ASN.1 writer. The value (if any) must be written as an ASN1OctetString.

Specified by:

writeValue in class Control

Parameters:

writer - The ASN.1 output stream to write to.

Throws:

IOException - If a problem occurs while writing to the stream.

getCookie

public String getCookie()

Retrieves the change type for this entry change notification control.

Returns:

The change type for this entry change notification control.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this entry change notification control to the provided buffer.

Overrides:

toString in class Control

Parameters:

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