org.apache.directory.server.core.api.interceptor.context

Class SearchOperationContext

java.lang.Object

org.apache.directory.server.core.api.interceptor.context.AbstractOperationContext

org.apache.directory.server.core.api.interceptor.context.FilteringOperationContext

org.apache.directory.server.core.api.interceptor.context.SearchOperationContext

All Implemented Interfaces:

OperationContext

public class SearchOperationContext
extends FilteringOperationContext

A Search context used for Interceptors. It contains all the informations needed for the search operation, and used by all the interceptors

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	abandoned A flag if the search operation is abandoned
private org.apache.directory.api.ldap.model.message.AliasDerefMode	aliasDerefMode A flag describing the way alias should be handled
private org.apache.directory.api.ldap.model.filter.ExprNode	filter The filter
private org.apache.directory.api.ldap.model.message.SearchScope	scope The scope for this search : default to One Level
private long	sizeLimit The sizeLimit for this search operation
private boolean	syncreplSearch flag to indicate if this search is done for replication
private int	timeLimit The timeLimit for this search operation

Fields inherited from class org.apache.directory.server.core.api.interceptor.context.FilteringOperationContext

LOG, returningAttributes, returningAttributesString, typesOnly

Fields inherited from class org.apache.directory.server.core.api.interceptor.context.AbstractOperationContext

authorizedPrincipal, byPassed, currentInterceptor, dn, EMPTY_CONTROLS, entry, interceptors, originalEntry, requestControls, responseControls, session, throwReferral

Constructor Summary

Constructors

Constructor and Description
SearchOperationContext(CoreSession session) Creates a new instance of SearchOperationContext.
SearchOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.filter.ExprNode filter, javax.naming.directory.SearchControls searchControls) Creates a new instance of SearchOperationContext.
SearchOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.message.SearchScope scope, org.apache.directory.api.ldap.model.filter.ExprNode filter, java.lang.String... returningAttributes) Creates a new instance of SearchOperationContext.
SearchOperationContext(CoreSession session, org.apache.directory.api.ldap.model.message.SearchRequest searchRequest) Creates a new instance of SearchOperationContext.

Method Summary

Modifier and Type	Method and Description
org.apache.directory.api.ldap.model.message.AliasDerefMode	getAliasDerefMode()
org.apache.directory.api.ldap.model.filter.ExprNode	getFilter()
java.lang.String	getName()
org.apache.directory.api.ldap.model.message.SearchScope	getScope()
long	getSizeLimit()
int	getTimeLimit()
boolean	hasManageDsaItControl() Checks whether or not the ManageDsaITControl is present.
boolean	isAbandoned()
boolean	isSyncreplSearch()
void	setAbandoned(boolean abandoned)
void	setAliasDerefMode(org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode) Set the Alias dereferencing mode
void	setFilter(org.apache.directory.api.ldap.model.filter.ExprNode filter) Set the filter into the context.
void	setScope(org.apache.directory.api.ldap.model.message.SearchScope scope)
void	setSizeLimit(long sizeLimit)
void	setSyncreplSearch(boolean syncreplSearch) sets the flag to indicate if this is a synrepl specific search or not
void	setTimeLimit(int timeLimit)
java.lang.String	toString()

Methods inherited from class org.apache.directory.server.core.api.interceptor.context.FilteringOperationContext

contains, contains, getReturningAttributes, getReturningAttributesString, isAllOperationalAttributes, isAllUserAttributes, isNoAttributes, isTypesOnly, setAllOperationalAttributes, setAllUserAttributes, setNoAttributes, setReturningAttributes, setTypesOnly

Methods inherited from class org.apache.directory.server.core.api.interceptor.context.AbstractOperationContext

addRequestControl, addRequestControls, addResponseControl, delete, getCurrentInterceptor, getDn, getEffectivePrincipal, getEntry, getNextInterceptor, getOriginalEntry, getRequestControl, getResponseControl, getResponseControlCount, getResponseControls, getSession, hasRequestControl, hasRequestControls, hasResponseControl, hasResponseControls, ignoreReferral, isReferralIgnored, isReferralThrown, lookup, newLookupContext, setAuthorizedPrincipal, setCurrentInterceptor, setDn, setEntry, setInterceptors, setOriginalEntry, setRequestControls, setSession, throwReferral

Methods inherited from class java.lang.Object

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

Field Detail

aliasDerefMode

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

A flag describing the way alias should be handled

sizeLimit

private long sizeLimit

The sizeLimit for this search operation

timeLimit

private int timeLimit

The timeLimit for this search operation

scope

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

The scope for this search : default to One Level

abandoned

protected boolean abandoned

A flag if the search operation is abandoned

filter

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

The filter

syncreplSearch

private boolean syncreplSearch

flag to indicate if this search is done for replication

Constructor Detail

SearchOperationContext

public SearchOperationContext(CoreSession session)

Creates a new instance of SearchOperationContext.

SearchOperationContext

public SearchOperationContext(CoreSession session,
                              org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a new instance of SearchOperationContext.

Throws:

java.lang.Exception

org.apache.directory.api.ldap.model.exception.LdapException

SearchOperationContext

public SearchOperationContext(CoreSession session,
                              org.apache.directory.api.ldap.model.name.Dn dn,
                              org.apache.directory.api.ldap.model.filter.ExprNode filter,
                              javax.naming.directory.SearchControls searchControls)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a new instance of SearchOperationContext.

Parameters:

dn - the dn of the search base

filter - the filter AST to use for the search

searchControls - the search controls

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

SearchOperationContext

public SearchOperationContext(CoreSession session,
                              org.apache.directory.api.ldap.model.name.Dn dn,
                              org.apache.directory.api.ldap.model.message.SearchScope scope,
                              org.apache.directory.api.ldap.model.filter.ExprNode filter,
                              java.lang.String... returningAttributes)

Creates a new instance of SearchOperationContext.

Parameters:

session - the session this operation is associated with

dn - the search base

scope - the search scope

filter - the filter AST to use for the search

aliasDerefMode - the alias dereferencing mode

returningAttributes - the attributes to return

Method Detail

hasManageDsaItControl

public boolean hasManageDsaItControl()

Checks whether or not the ManageDsaITControl is present. If not present then the filter is modified to force the return of all referral entries regardless of whether or not the filter matches the referral entry.

getFilter

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

Returns:

The filter

setFilter

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

Set the filter into the context.

Parameters:

filter - The filter to set

getName

public java.lang.String getName()

Specified by:

getName in interface OperationContext

Specified by:

getName in class AbstractOperationContext

Returns:

the operation name

isSyncreplSearch

public boolean isSyncreplSearch()

Returns:

true if this is a syncrepl specific search

setSyncreplSearch

public void setSyncreplSearch(boolean syncreplSearch)

sets the flag to indicate if this is a synrepl specific search or not

Parameters:

syncreplSearch -

getAliasDerefMode

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

Returns:

The alias dereferencing mode

setAliasDerefMode

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

Set the Alias dereferencing mode

Parameters:

aliasDerefMode - Th erequested mode

getSizeLimit

public long getSizeLimit()

Returns:

the sizeLimit

setSizeLimit

public void setSizeLimit(long sizeLimit)

Parameters:

sizeLimit - the sizeLimit to set

getTimeLimit

public int getTimeLimit()

Returns:

the timeLimit

setTimeLimit

public void setTimeLimit(int timeLimit)

Parameters:

timeLimit - the timeLimit to set

getScope

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

Returns:

the scope

setScope

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

Parameters:

scope - the scope to set

isAbandoned

public boolean isAbandoned()

Returns:

the abandoned

setAbandoned

public void setAbandoned(boolean abandoned)

Parameters:

abandoned - the abandoned to set

toString

public java.lang.String toString()

Overrides:

toString in class FilteringOperationContext

See Also:

Object.toString()