Package org.ldaptive

Class AbstractSearchOperationFactory

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.AbstractOperationFactory<SearchRequest,SearchResponse>

org.ldaptive.AbstractSearchOperationFactory

All Implemented Interfaces:

ConnectionFactoryManager, Freezable

Direct Known Subclasses:

AbstractSearchEntryResolver, PagedResultsClient, SearchDnResolver, SearchRoleResolver, VirtualListViewClient

public abstract class AbstractSearchOperationFactory
extends AbstractOperationFactory<SearchRequest,SearchResponse>

Base class for classes that need to configure a search operation.

Field Summary

Fields

Modifier and Type	Field	Description
private LdapEntryHandler[]	entryHandlers	Functions to handle entries.
private SearchReferenceHandler[]	referenceHandlers	Functions to handle response references.
private SearchResultHandler[]	searchResultHandlers	Functions to handle search response results.

Fields inherited from class org.ldaptive.AbstractOperationFactory

logger

Constructor Summary

Constructors

Constructor	Description
AbstractSearchOperationFactory()

Method Summary

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.
void	freeze()	Freezes this object, making it immutable.
LdapEntryHandler[]	getEntryHandlers()	Returns the search entry handlers.
SearchReferenceHandler[]	getReferenceHandlers()	Returns the search reference handlers.
SearchResultHandler[]	getSearchResultHandlers()	Returns the search result handlers.
void	setEntryHandlers(LdapEntryHandler... handlers)	Sets the search entry handlers.
void	setReferenceHandlers(SearchReferenceHandler... handlers)	Sets the search reference handlers.
void	setSearchResultHandlers(SearchResultHandler... handlers)	Sets the search result handlers.
String	toString()

Methods inherited from class org.ldaptive.AbstractOperationFactory

getConnectionFactory, getControlHandlers, getExceptionHandler, getIntermediateResponseHandlers, getReferralHandlers, getRequestHandlers, getResultHandlers, getThrowCondition, getUnsolicitedNotificationHandlers, initializeOperation, setConnectionFactory, setControlHandlers, setExceptionHandler, setIntermediateResponseHandlers, setReferralHandlers, setRequestHandlers, setResultHandlers, setThrowCondition, setUnsolicitedNotificationHandlers

Methods inherited from class org.ldaptive.AbstractFreezable

assertMutable, freeze, freeze, isFrozen

Methods inherited from class java.lang.Object

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

Field Detail

entryHandlers

private LdapEntryHandler[] entryHandlers

Functions to handle entries.

referenceHandlers

private SearchReferenceHandler[] referenceHandlers

Functions to handle response references.

searchResultHandlers

private SearchResultHandler[] searchResultHandlers

Functions to handle search response results.

Constructor Detail

AbstractSearchOperationFactory

public AbstractSearchOperationFactory()

Method Detail

freeze

public void freeze()

Description copied from interface: Freezable

Freezes this object, making it immutable.

Specified by:

freeze in interface Freezable

Overrides:

freeze in class AbstractOperationFactory<SearchRequest,SearchResponse>

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

getReferenceHandlers

public SearchReferenceHandler[] getReferenceHandlers()

Returns the search reference handlers.

Returns:

search reference handlers

setReferenceHandlers

public void setReferenceHandlers(SearchReferenceHandler... handlers)

Sets the search reference handlers.

Parameters:

handlers - search reference 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

toString

public String toString()

Overrides:

toString in class AbstractOperationFactory<SearchRequest,SearchResponse>