org.opends.server.controls

Class EntryChangeNotificationControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.EntryChangeNotificationControl

public class EntryChangeNotificationControl
extends Control

This class implements the entry change notification control defined in draft-ietf-ldapext-psearch. It may be included in entries returned in response to a persistent search operation.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EntryChangeNotificationControl(boolean isCritical, PersistentSearchChangeType changeType, DN previousDN, long changeNumber) Creates a new entry change notification control with the provided information.
EntryChangeNotificationControl(boolean isCritical, PersistentSearchChangeType changeType, long changeNumber) Creates a new entry change notification control with the provided information.
EntryChangeNotificationControl(PersistentSearchChangeType changeType, DN previousDN, long changeNumber) Creates a new entry change notification control with the provided information.
EntryChangeNotificationControl(PersistentSearchChangeType changeType, long changeNumber) Creates a new entry change notification control with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
long	getChangeNumber() Retrieves the change number for this entry change notification control.
PersistentSearchChangeType	getChangeType() Retrieves the change type for this entry change notification control.
DN	getPreviousDN() Retrieves the previous DN 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 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<EntryChangeNotificationControl> DECODER

The ControlDecoder that can be used to decode this control.

Constructor Detail

EntryChangeNotificationControl

public EntryChangeNotificationControl(boolean isCritical,
                              PersistentSearchChangeType changeType,
                              long changeNumber)

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.

changeType - The change type for this change notification control.

changeNumber - The change number for the associated change, or a negative value if no change number is available.

EntryChangeNotificationControl

public EntryChangeNotificationControl(boolean isCritical,
                              PersistentSearchChangeType changeType,
                              DN previousDN,
                              long changeNumber)

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.

changeType - The change type for this change notification control.

previousDN - The DN that the entry had prior to a modify DN operation, or null if the operation was not a modify DN.

changeNumber - The change number for the associated change, or a negative value if no change number is available.

EntryChangeNotificationControl

public EntryChangeNotificationControl(PersistentSearchChangeType changeType,
                              long changeNumber)

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

Parameters:

changeType - The change type for this change notification control.

changeNumber - The change number for the associated change, or a negative value if no change number is available.

EntryChangeNotificationControl

public EntryChangeNotificationControl(PersistentSearchChangeType changeType,
                              DN previousDN,
                              long changeNumber)

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

Parameters:

changeType - The change type for this change notification control.

previousDN - The DN that the entry had prior to a modify DN operation, or null if the operation was not a modify DN.

changeNumber - The change number for the associated change, or a negative value if no change number is available.

Method Detail

writeValue

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

Writes this control 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.

getChangeType

public PersistentSearchChangeType getChangeType()

Retrieves the change type for this entry change notification control.

Returns:

The change type for this entry change notification control.

getPreviousDN

public DN getPreviousDN()

Retrieves the previous DN for this entry change notification control.

Returns:

The previous DN for this entry change notification control, or null if there is none.

getChangeNumber

public long getChangeNumber()

Retrieves the change number for this entry change notification control.

Returns:

The change number for this entry change notification control, or a negative value if no change number is available.

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.