Package org.ldaptive
Class AbstractSearchOperationFactory
java.lang.Object
org.ldaptive.AbstractSearchOperationFactory
- All Implemented Interfaces:
ConnectionFactoryManager
- Direct Known Subclasses:
AbstractSearchEntryResolver
,PagedResultsClient
,SearchDnResolver
,SearchRoleResolver
,VirtualListViewClient
public abstract class AbstractSearchOperationFactory
extends Object
implements ConnectionFactoryManager
Base class for classes that perform searches.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate LdapEntryHandler[]
Functions to handle entries.private ExceptionHandler
Functions to handle exceptions.private ConnectionFactory
Connection factory.protected final org.slf4j.Logger
Logger for this class.private ResultHandler[]
Functions to handle response results.private SearchResultHandler[]
Functions to handle search response results. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected SearchOperation
Creates a new search operation configured with the properties on this factory.protected SearchOperation
Creates a new search operation configured with the properties on this factory.Returns the connection factory.Returns the search entry handlers.Returns the search exception handler.Returns the search result handlers.Returns the search result handlers.void
Sets the connection factory.void
setEntryHandlers
(LdapEntryHandler... handlers) Sets the search entry handlers.void
setExceptionHandler
(ExceptionHandler handler) Sets the search exception handler.void
setResultHandlers
(ResultHandler... handlers) Sets the search result handlers.void
setSearchResultHandlers
(SearchResultHandler... handlers) Sets the search result handlers.
-
Field Details
-
logger
protected final org.slf4j.Logger loggerLogger for this class. -
factory
Connection factory. -
entryHandlers
Functions to handle entries. -
exceptionHandler
Functions to handle exceptions. -
resultHandlers
Functions to handle response results. -
searchResultHandlers
Functions to handle search response results.
-
-
Constructor Details
-
AbstractSearchOperationFactory
public AbstractSearchOperationFactory()
-
-
Method Details
-
getConnectionFactory
Returns the connection factory.- Specified by:
getConnectionFactory
in interfaceConnectionFactoryManager
- Returns:
- connection factory
-
setConnectionFactory
Sets the connection factory.- Specified by:
setConnectionFactory
in interfaceConnectionFactoryManager
- Parameters:
cf
- connection factory
-
getEntryHandlers
Returns the search entry handlers.- Returns:
- search entry handlers
-
setEntryHandlers
Sets the search entry handlers.- Parameters:
handlers
- search entry handlers
-
getExceptionHandler
Returns the search exception handler.- Returns:
- search exception handler
-
setExceptionHandler
Sets the search exception handler.- Parameters:
handler
- search exception handler
-
getResultHandlers
Returns the search result handlers.- Returns:
- search result handlers
-
setResultHandlers
Sets the search result handlers.- Parameters:
handlers
- search result handlers
-
getSearchResultHandlers
Returns the search result handlers.- Returns:
- search result handlers
-
setSearchResultHandlers
Sets the search result handlers.- Parameters:
handlers
- search result handlers
-
createSearchOperation
Creates a new search operation configured with the properties on this factory.- Returns:
- search operation
-
createSearchOperation
Creates a new search operation configured with the properties on this factory.- Parameters:
cf
- connection factory to set on the search operation- Returns:
- search operation
-