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
Fields Modifier and Type Field Description private LdapEntryHandler[]
entryHandlers
Functions to handle entries.private ExceptionHandler
exceptionHandler
Functions to handle exceptions.private ConnectionFactory
factory
Connection factory.protected Logger
logger
Logger for this class.private ResultHandler[]
resultHandlers
Functions to handle response results.private SearchResultHandler[]
searchResultHandlers
Functions to handle search response results.
-
Constructor Summary
Constructors Constructor Description AbstractSearchOperationFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected SearchOperation
createSearchOperation()
Creates a new search operation configured with the properties on this factory.protected SearchOperation
createSearchOperation(ConnectionFactory cf)
Creates a new search operation configured with the properties on this factory.ConnectionFactory
getConnectionFactory()
Returns the connection factory.LdapEntryHandler[]
getEntryHandlers()
Returns the search entry handlers.ExceptionHandler
getExceptionHandler()
Returns the search exception handler.ResultHandler[]
getResultHandlers()
Returns the search result handlers.SearchResultHandler[]
getSearchResultHandlers()
Returns the search result handlers.void
setConnectionFactory(ConnectionFactory cf)
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 Detail
-
logger
protected final Logger logger
Logger for this class.
-
factory
private ConnectionFactory factory
Connection factory.
-
entryHandlers
private LdapEntryHandler[] entryHandlers
Functions to handle entries.
-
exceptionHandler
private ExceptionHandler exceptionHandler
Functions to handle exceptions.
-
resultHandlers
private ResultHandler[] resultHandlers
Functions to handle response results.
-
searchResultHandlers
private SearchResultHandler[] searchResultHandlers
Functions to handle search response results.
-
-
Method Detail
-
getConnectionFactory
public ConnectionFactory getConnectionFactory()
Returns the connection factory.- Specified by:
getConnectionFactory
in interfaceConnectionFactoryManager
- Returns:
- connection factory
-
setConnectionFactory
public void setConnectionFactory(ConnectionFactory cf)
Sets the connection factory.- Specified by:
setConnectionFactory
in interfaceConnectionFactoryManager
- Parameters:
cf
- connection factory
-
getEntryHandlers
public LdapEntryHandler[] getEntryHandlers()
Returns the search entry handlers.- Returns:
- search entry handlers
-
setEntryHandlers
public void setEntryHandlers(LdapEntryHandler... handlers)
Sets the search entry handlers.- Parameters:
handlers
- search entry handlers
-
getExceptionHandler
public ExceptionHandler getExceptionHandler()
Returns the search exception handler.- Returns:
- search exception handler
-
setExceptionHandler
public void setExceptionHandler(ExceptionHandler handler)
Sets the search exception handler.- Parameters:
handler
- search exception handler
-
getResultHandlers
public ResultHandler[] getResultHandlers()
Returns the search result handlers.- Returns:
- search result handlers
-
setResultHandlers
public void setResultHandlers(ResultHandler... handlers)
Sets the search result handlers.- Parameters:
handlers
- search result handlers
-
getSearchResultHandlers
public SearchResultHandler[] getSearchResultHandlers()
Returns the search result handlers.- Returns:
- search result handlers
-
setSearchResultHandlers
public void setSearchResultHandlers(SearchResultHandler... handlers)
Sets the search result handlers.- Parameters:
handlers
- search result handlers
-
createSearchOperation
protected SearchOperation createSearchOperation()
Creates a new search operation configured with the properties on this factory.- Returns:
- search operation
-
createSearchOperation
protected SearchOperation createSearchOperation(ConnectionFactory cf)
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
-
-