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

Author:

Apache Directory Project

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	disableNotification(ChangeType changeType) Unsets the notification for a given changeType
void	enableNotification(ChangeType changeType) Sets the notification for a given changeType
boolean	equals(Object other)
int	getChangeTypes()
int	hashCode()
boolean	isChangesOnly()
boolean	isNotificationEnabled(ChangeType changeType) For each changeType, tells if the notification is enabled
boolean	isReturnECs()
void	setChangesOnly(boolean changesOnly) Sets the ChangesOnly flag
void	setChangeTypes(int changeTypes) Set the changeType value we want to get back ( a combinaison of Add, Delete, Modify and ModifyDN)
void	setReturnECs(boolean returnECs) Sets the return entry changes flag
String	toString() Return a String representing this PSearchControl.

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

getOid, 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)

Sets the ChangesOnly flag

Specified by:

setChangesOnly in interface PersistentSearch

Parameters:

changesOnly - The ChangesOnly flag

isChangesOnly

public boolean isChangesOnly()

Specified by:

isChangesOnly in interface PersistentSearch

Returns:

TRUE if the changesOnly flag is set

setReturnECs

public void setReturnECs(boolean returnECs)

Sets the return entry changes flag

Specified by:

setReturnECs in interface PersistentSearch

Parameters:

returnECs - the return entry changes flag

isReturnECs

public boolean isReturnECs()

Specified by:

isReturnECs in interface PersistentSearch

Returns:

TRUE if the return entry changes flag is set

setChangeTypes

public void setChangeTypes(int changeTypes)

Set the changeType value we want to get back ( a combinaison of Add, Delete, Modify and ModifyDN)

Specified by:

setChangeTypes in interface PersistentSearch

Parameters:

changeTypes - The changeType values (Add, Modify, Delete and ModifyDn)

getChangeTypes

public int getChangeTypes()

Specified by:

getChangeTypes in interface PersistentSearch

Returns:

The changeTypes value

isNotificationEnabled

public boolean isNotificationEnabled(ChangeType changeType)

For each changeType, tells if the notification is enabled

Specified by:

isNotificationEnabled in interface PersistentSearch

Parameters:

changeType - The ChnageType we are interested in

Returns:

TRUE if the notification is set for this ChangeType

enableNotification

public void enableNotification(ChangeType changeType)

Sets the notification for a given changeType

Specified by:

enableNotification in interface PersistentSearch

Parameters:

changeType - The chnageType we want some notification to be set

disableNotification

public void disableNotification(ChangeType changeType)

Unsets the notification for a given changeType

Specified by:

disableNotification in interface PersistentSearch

Parameters:

changeType - The chnageType we want some notification to be unset

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractControl

See Also:

Object.hashCode()

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractControl

See Also:

Object.equals(Object)

toString

public String toString()

Return a String representing this PSearchControl.

Overrides:

toString in class AbstractControl