oracle.oud.controls

Interface PersistentSearchRequestControl

All Superinterfaces:

Control

public interface PersistentSearchRequestControl
extends Control

The persistent search request control as defined in draft-ietf-ldapext-psearch. This control allows a client to receive notification of changes that occur in an LDAP server.

See Also:

EntryChangeNotificationResponseControl, PersistentSearchChangeType, draft-ietf-ldapext-psearch - Persistent Search: A Simple LDAP Change Notification Mechanism

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<PersistentSearchRequestControl>	DECODER A decoder which can be used for decoding the persistent search request control.

Method Summary

Modifier and Type	Method and Description
java.util.Set<PersistentSearchChangeType>	getChangeTypes() Returns an unmodifiable set containing the types of update operation for which change notifications should be returned.
boolean	isChangesOnly() Returns true if only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation), otherwise false if the search will initially return all the existing entries which match the filter.
boolean	isReturnECs() Returns true if the entry change notification control should be included in updated entries that match the associated search criteria.

Methods inherited from interface oracle.oud.controls.Control

getAPIValue, getOID, hasValue, isCritical

Field Detail

DECODER

static final ControlDecoder<PersistentSearchRequestControl> DECODER

A decoder which can be used for decoding the persistent search request control.

Method Detail

getChangeTypes

java.util.Set<PersistentSearchChangeType> getChangeTypes()

Returns an unmodifiable set containing the types of update operation for which change notifications should be returned.

Returns:

An unmodifiable set containing the types of update operation for which change notifications should be returned.

isChangesOnly

boolean isChangesOnly()

Returns true if only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation), otherwise false if the search will initially return all the existing entries which match the filter.

Returns:

true if only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation), otherwise false if the search will initially return all the existing entries which match the filter.

isReturnECs

boolean isReturnECs()

Returns true if the entry change notification control should be included in updated entries that match the associated search criteria.

Returns:

true if the entry change notification control should be included in updated entries that match the associated search criteria.