org.apache.directory.api.ldap.model.message.controls

Class PersistentSearchImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.controls.AbstractControl

org.apache.directory.api.ldap.model.message.controls.PersistentSearchImpl

All Implemented Interfaces:

Control, PersistentSearch

public class PersistentSearchImpl
extends AbstractControl
implements PersistentSearch

A persistence search object

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	changesOnly If changesOnly is TRUE, the server MUST NOT return any existing entries that match the search criteria.
private int	changeTypes As changes are made to the server, the effected entries MUST be returned to the client if they match the standard search criteria and if the operation that caused the change is included in the changeTypes field.
private boolean	returnECs If returnECs is TRUE, the server MUST return an Entry Change Notification control with each entry returned as the result of changes.

Fields inherited from interface org.apache.directory.api.ldap.model.message.controls.PersistentSearch

CHANGE_TYPES_MAX, CHANGE_TYPES_MIN, OID

Constructor Summary

Constructors

Constructor and Description
PersistentSearchImpl() Default constructor

Method Summary

Modifier and Type	Method and Description
void	enableNotification(ChangeType changeType)
int	getChangeTypes()
boolean	isChangesOnly()
boolean	isNotificationEnabled(ChangeType changeType)
boolean	isReturnECs()
void	setChangesOnly(boolean changesOnly)
void	setChangeTypes(int changeTypes)
void	setReturnECs(boolean returnECs)
java.lang.String	toString() Return a String representing this PSearchControl.

Methods inherited from class org.apache.directory.api.ldap.model.message.controls.AbstractControl

equals, getOid, hashCode, isCritical, setCritical

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control

getOid, isCritical, setCritical

Field Detail

changesOnly

private boolean changesOnly

If changesOnly is TRUE, the server MUST NOT return any existing entries that match the search criteria. Entries are only returned when they are changed (added, modified, deleted, or subject to a modifyDN operation).

returnECs

private boolean returnECs

If returnECs is TRUE, the server MUST return an Entry Change Notification control with each entry returned as the result of changes.

changeTypes

private int changeTypes

As changes are made to the server, the effected entries MUST be returned to the client if they match the standard search criteria and if the operation that caused the change is included in the changeTypes field. The changeTypes field is the logical OR of one or more of these values: add (1), delete (2), modify (4), modDN (8).

Constructor Detail

PersistentSearchImpl

public PersistentSearchImpl()

Default constructor

Method Detail

setChangesOnly

public void setChangesOnly(boolean changesOnly)

Specified by:

setChangesOnly in interface PersistentSearch

isChangesOnly

public boolean isChangesOnly()

Specified by:

isChangesOnly in interface PersistentSearch

setReturnECs

public void setReturnECs(boolean returnECs)

Specified by:

setReturnECs in interface PersistentSearch

isReturnECs

public boolean isReturnECs()

Specified by:

isReturnECs in interface PersistentSearch

setChangeTypes

public void setChangeTypes(int changeTypes)

Specified by:

setChangeTypes in interface PersistentSearch

getChangeTypes

public int getChangeTypes()

Specified by:

getChangeTypes in interface PersistentSearch

isNotificationEnabled

public boolean isNotificationEnabled(ChangeType changeType)

Specified by:

isNotificationEnabled in interface PersistentSearch

enableNotification

public void enableNotification(ChangeType changeType)

Specified by:

enableNotification in interface PersistentSearch

toString

public java.lang.String toString()

Return a String representing this PSearchControl.

Overrides:

toString in class AbstractControl