org.apache.directory.server.ldap.handlers.request

Class SearchRequestHandler

java.lang.Object

org.apache.directory.server.ldap.handlers.LdapRequestHandler<org.apache.directory.api.ldap.model.message.SearchRequest>

org.apache.directory.server.ldap.handlers.request.SearchRequestHandler

All Implemented Interfaces:

org.apache.mina.handler.demux.MessageHandler<org.apache.directory.api.ldap.model.message.SearchRequest>

public class SearchRequestHandler
extends LdapRequestHandler<org.apache.directory.api.ldap.model.message.SearchRequest>

A MessageReceived handler for processing search requests.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG The logger
protected ReplicationRequestHandler	replicationReqHandler The replication handler
private static org.slf4j.Logger	SEARCH_TIME_LOG

Fields inherited from class org.apache.directory.server.ldap.handlers.LdapRequestHandler

ldapServer

Fields inherited from interface org.apache.mina.handler.demux.MessageHandler

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchRequestHandler()

Method Summary

Modifier and Type	Method and Description
private org.apache.directory.api.ldap.model.message.SearchResultDone	abandonPagedSearch(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Manage the abandoned Paged Search (when paged size = 0).
private org.apache.directory.api.ldap.model.message.SearchResultDone	doPagedSearch(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.codec.controls.search.pagedSearch.PagedResultsDecorator control) Handle a Paged Search request.
private org.apache.directory.api.ldap.model.message.SearchResultDone	doSimpleSearch(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Conducts a simple search across the result set returning each entry back except for the search response done.
private org.apache.directory.api.ldap.model.message.Response	generateResponse(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.model.entry.Entry entry) Generates a response for an entry retrieved from the server core based on the nature of the request with respect to referral handling.
static org.apache.directory.api.ldap.model.entry.Entry	getFarthestReferralAncestor(LdapSession session, org.apache.directory.api.ldap.model.name.Dn target) Searches up the ancestry of a Dn searching for the farthest referral ancestor.
org.apache.directory.api.ldap.model.message.Referral	getReferralOnAncestor(LdapSession session, org.apache.directory.api.ldap.model.name.Dn reqTargetDn, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.model.entry.Entry referralAncestor) Handles processing with referrals without ManageDsaIT decorator and with an ancestor that is a referral.
org.apache.directory.api.ldap.model.message.Referral	getReferralOnAncestorForSearch(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.model.entry.Entry referralAncestor) Handles processing with referrals without ManageDsaIT decorator and with an ancestor that is a referral.
private long	getServerSizeLimit(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest request) Return the server size limit
void	handle(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Handle a Ldap message associated with a session
void	handleException(LdapSession session, org.apache.directory.api.ldap.model.message.ResultResponseRequest req, java.lang.Exception e) Handles processing with referrals without ManageDsaIT decorator.
private void	handleIgnoringReferrals(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Main message handing method for search requests.
private void	handleLookup(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Handles a simple lookup, or a RootDSE lookup.
private boolean	handleLookupAndRootDse(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Handles the RootDSE and lookups searches
private void	handlePersistentSearch(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.model.message.controls.PersistentSearch psearch) Handles search requests containing the persistent search decorator but delegates to doSimpleSearch() if the changesOnly parameter of the decorator is set to false.
private void	handleReferralEntryForSearch(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.model.entry.Entry entry) Handles processing a referral response on a target entry which is a referral.
private void	handleReplication(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest searchRequest) Handle the replication request.
private void	handleWithReferrals(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Handles processing with referrals without ManageDsaIT decorator.
private boolean	isSubSchemaSubEntrySearch(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Determines if a search request is a subSchemaSubEntry search.
private void	modifyFilter(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req) Alters the filter expression based on the presence of the ManageDsaIT decorator.
private org.apache.directory.api.ldap.model.filter.EqualityNode<java.lang.String>	newIsReferralEqualityNode(LdapSession session) Constructs a new filter EqualityNode asserting that a candidate objectClass is a referral.
private void	readPagedResults(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.model.message.LdapResult ldapResult, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor, long sizeLimit, int pagedLimit, PagedSearchContext pagedContext, org.apache.directory.api.ldap.codec.controls.search.pagedSearch.PagedResultsDecorator pagedResultsControl)
private PagedSearchContext	removeContext(LdapSession session, PagedSearchContext cookieInstance) Remove a cookie instance from the session, if it exists.
void	setReplicationReqHandler(ReplicationRequestHandler replicationReqHandler) Install the replication handler when it's allowed by this server
private void	setTimeLimitsOnCursor(org.apache.directory.api.ldap.model.message.SearchRequest req, LdapSession session, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor) Based on the server maximum time limits configured for search and the requested time limits this method determines if at all to replace the default ClosureMonitor of the result set Cursor with one that closes the Cursor when either server mandated or request mandated time limits are reached.
private void	writeResults(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req, org.apache.directory.api.ldap.model.message.LdapResult ldapResult, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor, long sizeLimit)

Methods inherited from class org.apache.directory.server.ldap.handlers.LdapRequestHandler

getLdapServer, handleMessage, isConfidentialityRequirementSatisfied, rejectWithoutConfidentiality, setLdapServer

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger

SEARCH_TIME_LOG

private static final org.slf4j.Logger SEARCH_TIME_LOG

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

replicationReqHandler

protected ReplicationRequestHandler replicationReqHandler

The replication handler

Constructor Detail

SearchRequestHandler

public SearchRequestHandler()

Method Detail

newIsReferralEqualityNode

private org.apache.directory.api.ldap.model.filter.EqualityNode<java.lang.String> newIsReferralEqualityNode(LdapSession session)
                                                                                                     throws java.lang.Exception

Constructs a new filter EqualityNode asserting that a candidate objectClass is a referral.

Parameters:

session - the LdapSession to construct the node for

Returns:

the EqualityNode (objectClass=referral) non-normalized

Throws:

java.lang.Exception - in the highly unlikely event of schema related failures

handlePersistentSearch

private void handlePersistentSearch(LdapSession session,
                                    org.apache.directory.api.ldap.model.message.SearchRequest req,
                                    org.apache.directory.api.ldap.model.message.controls.PersistentSearch psearch)
                             throws java.lang.Exception

Handles search requests containing the persistent search decorator but delegates to doSimpleSearch() if the changesOnly parameter of the decorator is set to false.

Parameters:

session - the LdapSession for which this search is conducted

req - the search request containing the persistent search decorator

psearchDecorator - the persistent search decorator extracted

Throws:

java.lang.Exception - if failures are encountered while searching

handle

public final void handle(LdapSession session,
                         org.apache.directory.api.ldap.model.message.SearchRequest req)
                  throws java.lang.Exception

Handle a Ldap message associated with a session

Specified by:

handle in class LdapRequestHandler<org.apache.directory.api.ldap.model.message.SearchRequest>

Parameters:

session - The associated session

req - The message we have to handle

Throws:

java.lang.Exception - If there is an error during the processing of this message

handleReplication

private void handleReplication(LdapSession session,
                               org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)
                        throws org.apache.directory.api.ldap.model.exception.LdapException

Handle the replication request.

Throws:

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

handleLookup

private void handleLookup(LdapSession session,
                          org.apache.directory.api.ldap.model.message.SearchRequest req)
                   throws java.lang.Exception

Handles a simple lookup, or a RootDSE lookup.

Parameters:

session - the LdapSession for which this search is conducted

req - the search request on the RootDSE

Throws:

java.lang.Exception - if failures are encountered while searching

setTimeLimitsOnCursor

private void setTimeLimitsOnCursor(org.apache.directory.api.ldap.model.message.SearchRequest req,
                                   LdapSession session,
                                   org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor)

Based on the server maximum time limits configured for search and the requested time limits this method determines if at all to replace the default ClosureMonitor of the result set Cursor with one that closes the Cursor when either server mandated or request mandated time limits are reached.

Parameters:

req - the SearchRequest issued

session - the LdapSession on which search was requested

cursor - the EntryFilteringCursor over the search results

getServerSizeLimit

private long getServerSizeLimit(LdapSession session,
                                org.apache.directory.api.ldap.model.message.SearchRequest request)

Return the server size limit

writeResults

private void writeResults(LdapSession session,
                          org.apache.directory.api.ldap.model.message.SearchRequest req,
                          org.apache.directory.api.ldap.model.message.LdapResult ldapResult,
                          org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor,
                          long sizeLimit)
                   throws java.lang.Exception

Throws:

java.lang.Exception

readPagedResults

private void readPagedResults(LdapSession session,
                              org.apache.directory.api.ldap.model.message.SearchRequest req,
                              org.apache.directory.api.ldap.model.message.LdapResult ldapResult,
                              org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor,
                              long sizeLimit,
                              int pagedLimit,
                              PagedSearchContext pagedContext,
                              org.apache.directory.api.ldap.codec.controls.search.pagedSearch.PagedResultsDecorator pagedResultsControl)
                       throws java.lang.Exception

Throws:

java.lang.Exception

abandonPagedSearch

private org.apache.directory.api.ldap.model.message.SearchResultDone abandonPagedSearch(LdapSession session,
                                                                                        org.apache.directory.api.ldap.model.message.SearchRequest req)
                                                                                 throws java.lang.Exception

Manage the abandoned Paged Search (when paged size = 0). We have to remove the cookie and its associated cursor from the session.

Throws:

java.lang.Exception

removeContext

private PagedSearchContext removeContext(LdapSession session,
                                         PagedSearchContext cookieInstance)

Remove a cookie instance from the session, if it exists.

doPagedSearch

private org.apache.directory.api.ldap.model.message.SearchResultDone doPagedSearch(LdapSession session,
                                                                                   org.apache.directory.api.ldap.model.message.SearchRequest req,
                                                                                   org.apache.directory.api.ldap.codec.controls.search.pagedSearch.PagedResultsDecorator control)
                                                                            throws java.lang.Exception

Handle a Paged Search request.

Throws:

java.lang.Exception

doSimpleSearch

private org.apache.directory.api.ldap.model.message.SearchResultDone doSimpleSearch(LdapSession session,
                                                                                    org.apache.directory.api.ldap.model.message.SearchRequest req)
                                                                             throws java.lang.Exception

Conducts a simple search across the result set returning each entry back except for the search response done. This is calculated but not returned so the persistent search mechanism can leverage this method along with standard search.

Parameters:

session - the LDAP session object for this request

req - the search request

Returns:

the result done

Throws:

java.lang.Exception - if there are failures while processing the request

generateResponse

private org.apache.directory.api.ldap.model.message.Response generateResponse(LdapSession session,
                                                                              org.apache.directory.api.ldap.model.message.SearchRequest req,
                                                                              org.apache.directory.api.ldap.model.entry.Entry entry)
                                                                       throws java.lang.Exception

Generates a response for an entry retrieved from the server core based on the nature of the request with respect to referral handling. This method will either generate a SearchResponseEntry or a SearchResponseReference depending on if the entry is a referral or if the ManageDSAITControl has been enabled.

Parameters:

req - the search request

entry - the entry to be handled

Returns:

the response for the entry

Throws:

java.lang.Exception - if there are problems in generating the response

modifyFilter

private void modifyFilter(LdapSession session,
                          org.apache.directory.api.ldap.model.message.SearchRequest req)
                   throws java.lang.Exception

Alters the filter expression based on the presence of the ManageDsaIT decorator. If the decorator is not present, the search filter will be altered to become a disjunction with two terms. The first term is the original filter. The second term is a (objectClass=referral) assertion. When OR'd together these will make sure we get all referrals so we can process continuations properly without having the filter remove them from the result set. NOTE: original filter is first since most entries are not referrals so it has a higher probability on average of accepting and shorting evaluation before having to waste cycles trying to evaluate if the entry is a referral.

Parameters:

session - the session to use to construct the filter (schema access)

req - the request to get the original filter from

Throws:

java.lang.Exception - if there are schema access problems

handleLookupAndRootDse

private boolean handleLookupAndRootDse(LdapSession session,
                                       org.apache.directory.api.ldap.model.message.SearchRequest req)
                                throws java.lang.Exception

Handles the RootDSE and lookups searches

Throws:

java.lang.Exception

handleIgnoringReferrals

private void handleIgnoringReferrals(LdapSession session,
                                     org.apache.directory.api.ldap.model.message.SearchRequest req)

Main message handing method for search requests. This will be called even if the ManageDsaIT decorator is present because the super class does not know that the search operation has more to do after finding the base. The call to this means that finding the base can ignore referrals.

Parameters:

session - the associated session

req - the received SearchRequest

handleWithReferrals

private void handleWithReferrals(LdapSession session,
                                 org.apache.directory.api.ldap.model.message.SearchRequest req)
                          throws org.apache.directory.api.ldap.model.exception.LdapException

Handles processing with referrals without ManageDsaIT decorator.

Throws:

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

handleReferralEntryForSearch

private void handleReferralEntryForSearch(LdapSession session,
                                          org.apache.directory.api.ldap.model.message.SearchRequest req,
                                          org.apache.directory.api.ldap.model.entry.Entry entry)
                                   throws java.lang.Exception

Handles processing a referral response on a target entry which is a referral. It will for any request that returns an LdapResult in it's response.

Parameters:

session - the session to use for processing

req - the request

entry - the entry associated with the request

Throws:

java.lang.Exception

isSubSchemaSubEntrySearch

private boolean isSubSchemaSubEntrySearch(LdapSession session,
                                          org.apache.directory.api.ldap.model.message.SearchRequest req)
                                   throws java.lang.Exception

Determines if a search request is a subSchemaSubEntry search.

It is a schema search if: - the base Dn is the Dn of the subSchemaSubEntry of the root DSE - and the scope is BASE OBJECT - and the filter is (objectClass=subschema) (RFC 4512, 4.4,)

However in this method we only check the first condition to avoid performance issues.

Parameters:

session - the LDAP session

req - the request issued

Returns:

true if the search is on the subSchemaSubEntry, false otherwise

Throws:

java.lang.Exception - the exception

getReferralOnAncestorForSearch

public org.apache.directory.api.ldap.model.message.Referral getReferralOnAncestorForSearch(LdapSession session,
                                                                                           org.apache.directory.api.ldap.model.message.SearchRequest req,
                                                                                           org.apache.directory.api.ldap.model.entry.Entry referralAncestor)
                                                                                    throws java.lang.Exception

Handles processing with referrals without ManageDsaIT decorator and with an ancestor that is a referral. The original entry was not found and the walk of the ancestry returned a referral.

Parameters:

referralAncestor - the farthest referral ancestor of the missing entry

Throws:

java.lang.Exception

getReferralOnAncestor

public org.apache.directory.api.ldap.model.message.Referral getReferralOnAncestor(LdapSession session,
                                                                                  org.apache.directory.api.ldap.model.name.Dn reqTargetDn,
                                                                                  org.apache.directory.api.ldap.model.message.SearchRequest req,
                                                                                  org.apache.directory.api.ldap.model.entry.Entry referralAncestor)
                                                                           throws java.lang.Exception

Handles processing with referrals without ManageDsaIT decorator and with an ancestor that is a referral. The original entry was not found and the walk of the ancestry returned a referral.

Parameters:

referralAncestor - the farthest referral ancestor of the missing entry

Throws:

java.lang.Exception

handleException

public void handleException(LdapSession session,
                            org.apache.directory.api.ldap.model.message.ResultResponseRequest req,
                            java.lang.Exception e)

Handles processing with referrals without ManageDsaIT decorator.

Overrides:

handleException in class LdapRequestHandler<org.apache.directory.api.ldap.model.message.SearchRequest>

getFarthestReferralAncestor

public static final org.apache.directory.api.ldap.model.entry.Entry getFarthestReferralAncestor(LdapSession session,
                                                                                                org.apache.directory.api.ldap.model.name.Dn target)
                                                                                         throws java.lang.Exception

Searches up the ancestry of a Dn searching for the farthest referral ancestor. This is required to properly handle referrals. Note that this function is quite costly since it attempts to lookup all the ancestors up the hierarchy just to see if they represent referrals. Techniques can be employed later to improve this performance hit by having an intelligent referral cache.

Returns:

the farthest referral ancestor or null

Throws:

java.lang.Exception - if there are problems during this search

setReplicationReqHandler

public void setReplicationReqHandler(ReplicationRequestHandler replicationReqHandler)

Install the replication handler when it's allowed by this server

Parameters:

replicationReqHandler - The replication handler provider