Package org.identityconnectors.framework.impl.api.local.operations

Class FilteredResultsHandler

java.lang.Object

org.identityconnectors.framework.impl.api.local.operations.FilteredResultsHandler

All Implemented Interfaces:

ResultsHandler, SearchResultsHandler

public final class FilteredResultsHandler
extends Object
implements SearchResultsHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilteredResultsHandler.PassThroughFilter	Use a pass through filter to use if a null filter is provided.

Constructor Summary

Constructors

Constructor	Description
FilteredResultsHandler(ResultsHandler handler, Filter filter)	Filter chain for producers.
FilteredResultsHandler(ResultsHandler handler, Filter filter, boolean inValidationMode)

Method Summary

Modifier and Type	Method	Description
boolean	handle(ConnectorObject object)	Invoked each time a matching ConnectorObject is returned from a query request.
void	handleResult(SearchResult result)	Invoked when the request has completed successfully.

Methods inherited from class java.lang.Object

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

Constructor Details

FilteredResultsHandler

public FilteredResultsHandler(ResultsHandler handler,
 Filter filter)

Filter chain for producers.

Parameters:

handler - Producer to filter.

filter - Filter to use to accept objects.

FilteredResultsHandler

public FilteredResultsHandler(ResultsHandler handler,
 Filter filter,
 boolean inValidationMode)

Method Details

handleResult

public void handleResult(SearchResult result)

Description copied from interface: SearchResultsHandler

Invoked when the request has completed successfully.

Specified by:

handleResult in interface SearchResultsHandler

Parameters:

result - The query result indicating that no more resources are to be returned and, if applicable, including information which should be used for subsequent paged results query requests.

handle

public boolean handle(ConnectorObject object)

Description copied from interface: ResultsHandler

Invoked each time a matching ConnectorObject is returned from a query request.

Specified by:

handle in interface ResultsHandler

Parameters:

object - The matching ConnectorObject.

Returns:

true if this handler should continue to be notified of any remaining matching ConnectorObjects, or false if the remaining ConnectorObjects should be skipped for some reason (e.g. a client side size limit has been reached or the failed to handle the last item). If returns false the last items should be considers unhandled and in next page request it should be the first item.