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

Interface PersistentSearch

All Superinterfaces:

Control

All Known Implementing Classes:

PersistentSearchImpl

public interface PersistentSearch
extends Control

A persistence search object, as defined in https://tools.ietf.org/html/draft-ietf-ldapext-psearch-03

  PersistentSearch ::= SEQUENCE {
         changeTypes INTEGER,
         changesOnly BOOLEAN,
         returnECs BOOLEAN
 }

 

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANGE_TYPES_MAX The maximum value for the possible combined changes type
static int	CHANGE_TYPES_MIN Min and Max values for the possible combined change types
static String	OID This control OID

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
int	getChangeTypes()
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

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

getOid, isCritical, setCritical

Field Detail

OID

static final String OID

This control OID

See Also:

Constant Field Values

CHANGE_TYPES_MIN

static final int CHANGE_TYPES_MIN

Min and Max values for the possible combined change types

CHANGE_TYPES_MAX

static final int CHANGE_TYPES_MAX

The maximum value for the possible combined changes type

Method Detail

setChangesOnly

void setChangesOnly(boolean changesOnly)

Sets the ChangesOnly flag

Parameters:

changesOnly - The ChangesOnly flag

isChangesOnly

boolean isChangesOnly()

Returns:

TRUE if the changesOnly flag is set

setReturnECs

void setReturnECs(boolean returnECs)

Sets the return entry changes flag

Parameters:

returnECs - the return entry changes flag

isReturnECs

boolean isReturnECs()

Returns:

TRUE if the return entry changes flag is set

setChangeTypes

void setChangeTypes(int changeTypes)

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

Parameters:

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

getChangeTypes

int getChangeTypes()

Returns:

The changeTypes value

isNotificationEnabled

boolean isNotificationEnabled(ChangeType changeType)

For each changeType, tells if the notification is enabled

Parameters:

changeType - The ChnageType we are interested in

Returns:

TRUE if the notification is set for this ChangeType

enableNotification

void enableNotification(ChangeType changeType)

Sets the notification for a given changeType

Parameters:

changeType - The chnageType we want some notification to be set

disableNotification

void disableNotification(ChangeType changeType)

Unsets the notification for a given changeType

Parameters:

changeType - The chnageType we want some notification to be unset