org.apache.directory.server.core.api.event

Class NotificationCriteria

java.lang.Object

org.apache.directory.server.core.api.event.NotificationCriteria

public class NotificationCriteria
extends java.lang.Object

Contains the set of notification criteria required for triggering the delivery of change notifications notifications to DirectoryListeners.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.message.AliasDerefMode	aliasDerefMode The AliasderefMode to use (default to DEREF_ALWAYS)
private org.apache.directory.api.ldap.model.name.Dn	base The Base DN to search from (default to null)
private int	eventMask The event mask to use (default to everything)
private org.apache.directory.api.ldap.model.filter.ExprNode	filter The filter to use (default to '(ObjectClass=*)')
private org.apache.directory.api.ldap.model.message.SearchScope	scope The scope to use (default to ONE_LEVEL)

Constructor Summary

Constructors

Constructor and Description
NotificationCriteria() Create a new instance of a NotiticationCriteria
NotificationCriteria(org.apache.directory.api.ldap.model.message.SearchRequest req) Create a new instance of a NotiticationCriteria initialized with a search request

Method Summary

Modifier and Type	Method and Description
org.apache.directory.api.ldap.model.message.AliasDerefMode	getAliasDerefMode()
org.apache.directory.api.ldap.model.name.Dn	getBase()
int	getEventMask()
org.apache.directory.api.ldap.model.filter.ExprNode	getFilter()
org.apache.directory.api.ldap.model.message.SearchScope	getScope()
void	setAliasDerefMode(org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode)
void	setBase(org.apache.directory.api.ldap.model.name.Dn base)
void	setEventMask(EventType... eventTypes)
void	setEventMask(int eventMask)
void	setFilter(org.apache.directory.api.ldap.model.filter.ExprNode filter)
void	setFilter(java.lang.String filter)
void	setScope(org.apache.directory.api.ldap.model.message.SearchScope scope)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

scope

private org.apache.directory.api.ldap.model.message.SearchScope scope

The scope to use (default to ONE_LEVEL)

aliasDerefMode

private org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode

The AliasderefMode to use (default to DEREF_ALWAYS)

base

private org.apache.directory.api.ldap.model.name.Dn base

The Base DN to search from (default to null)

filter

private org.apache.directory.api.ldap.model.filter.ExprNode filter

The filter to use (default to '(ObjectClass=*)')

eventMask

private int eventMask

The event mask to use (default to everything)

Constructor Detail

NotificationCriteria

public NotificationCriteria()

Create a new instance of a NotiticationCriteria

NotificationCriteria

public NotificationCriteria(org.apache.directory.api.ldap.model.message.SearchRequest req)

Create a new instance of a NotiticationCriteria initialized with a search request

Method Detail

setScope

public void setScope(org.apache.directory.api.ldap.model.message.SearchScope scope)

Parameters:

scope - the scope to set

getScope

public org.apache.directory.api.ldap.model.message.SearchScope getScope()

Returns:

the scope

setAliasDerefMode

public void setAliasDerefMode(org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode)

Parameters:

aliasDerefMode - the aliasDerefMode to set

getAliasDerefMode

public org.apache.directory.api.ldap.model.message.AliasDerefMode getAliasDerefMode()

Returns:

the aliasDerefMode

setBase

public void setBase(org.apache.directory.api.ldap.model.name.Dn base)

Parameters:

base - the base to set

getBase

public org.apache.directory.api.ldap.model.name.Dn getBase()

Returns:

the base

setFilter

public void setFilter(org.apache.directory.api.ldap.model.filter.ExprNode filter)

Parameters:

filter - the filter to set

setFilter

public void setFilter(java.lang.String filter)
               throws java.lang.Exception

Parameters:

filter - the filter to set

Throws:

java.lang.Exception

getFilter

public org.apache.directory.api.ldap.model.filter.ExprNode getFilter()

Returns:

the filter

setEventMask

public void setEventMask(int eventMask)

Parameters:

eventMask - the eventMask to set

setEventMask

public void setEventMask(EventType... eventTypes)

Parameters:

eventTypes - the eventTypes to set

getEventMask

public int getEventMask()

Returns:

the eventMask

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object