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

Class SearchOperationContext

java.lang.Object

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

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

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

All Implemented Interfaces:

OperationContext

public class SearchOperationContext
extends SearchingOperationContext

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

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

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

abandoned, aliasDerefMode, allOperationalAttributes, allUserAttributes, noAttributes, returningAttributes, scope, sizeLimit, timeLimit, typesOnly

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

authorizedPrincipal, byPassed, dn, EMPTY_CONTROLS, entry, next, previous, 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.shared.ldap.name.DN dn, org.apache.directory.shared.ldap.filter.ExprNode filter, SearchControls searchControls) Creates a new instance of SearchOperationContext.
SearchOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.DN dn, org.apache.directory.shared.ldap.filter.SearchScope scope, org.apache.directory.shared.ldap.filter.ExprNode filter, Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes) Creates a new instance of SearchOperationContext.
SearchOperationContext(CoreSession session, org.apache.directory.shared.ldap.message.internal.InternalSearchRequest searchRequest) Creates a new instance of SearchOperationContext.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.directory.shared.ldap.filter.ExprNode	getFilter()
String	getName()
boolean	hasManageDsaItControl() Checks whether or not the ManageDsaITControl is present.
void	setFilter(org.apache.directory.shared.ldap.filter.ExprNode filter) Set the filter into the context.
String	toString()

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

getAliasDerefMode, getReturningAttributes, getScope, getSearchControls, getSearchControls, getSizeLimit, getTimeLimit, isAbandoned, isAllOperationalAttributes, isAllUserAttributes, isNoAttributes, isTypesOnly, setAbandoned, setAliasDerefMode, setAllOperationalAttributes, setAllUserAttributes, setNoAttributes, setReturningAttributes, setReturningAttributes, setReturningAttributes, setScope, setSizeLimit, setTimeLimit, setTypesOnly

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

add, addRequestControl, addRequestControls, addResponseControl, delete, getByPassed, getDn, getEffectivePrincipal, getEntry, getFirstOperation, getLastOperation, getNextOperation, getPreviousOperation, getRequestControl, getResponseControl, getResponseControlCount, getResponseControls, getSession, hasBypass, hasEntry, hasRequestControl, hasRequestControls, hasResponseControl, hasResponseControls, ignoreReferral, isBypassed, isFirstOperation, isReferralIgnored, isReferralThrown, lookup, lookup, modify, newLookupContext, setAuthorizedPrincipal, setByPassed, setDn, setEntry, setNextOperation, setPreviousOperation, setRequestControls, setSession, throwReferral

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOperationContext

public SearchOperationContext(CoreSession session)

Creates a new instance of SearchOperationContext.

SearchOperationContext

public SearchOperationContext(CoreSession session,
                      org.apache.directory.shared.ldap.message.internal.InternalSearchRequest searchRequest)
                       throws Exception

Creates a new instance of SearchOperationContext.

Throws:

Exception

SearchOperationContext

public SearchOperationContext(CoreSession session,
                      org.apache.directory.shared.ldap.name.DN dn,
                      org.apache.directory.shared.ldap.filter.ExprNode filter,
                      SearchControls searchControls)
                       throws Exception

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:

Exception

SearchOperationContext

public SearchOperationContext(CoreSession session,
                      org.apache.directory.shared.ldap.name.DN dn,
                      org.apache.directory.shared.ldap.filter.SearchScope scope,
                      org.apache.directory.shared.ldap.filter.ExprNode filter,
                      Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> 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.shared.ldap.filter.ExprNode getFilter()

Returns:

The filter

setFilter

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

Set the filter into the context.

Parameters:

filter - The filter to set

toString

public String toString()

Overrides:

toString in class SearchingOperationContext

See Also:

Object.toString()

getName

public String getName()

Specified by:

getName in interface OperationContext

Specified by:

getName in class AbstractOperationContext

Returns:

the operation name