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

Class SearchImpl

java.lang.Object

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

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

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

All Implemented Interfaces:

APIOperation, SearchApiOp

public class SearchImpl
extends ConnectorAPIOperationRunner
implements SearchApiOp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchImpl.AttributesToGetSearchResultsHandler Simple results handler that can reduce attributes to only the set of attribute to get.

Field Summary

Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation

NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
SearchImpl(ConnectorOperationalContext context, Connector connector) Initializes the operation works.

Method Summary

Methods

Modifier and Type	Method and Description
static void	rawSearch(SearchOp<?> search, ObjectClass objectClass, Filter filter, SearchResultsHandler handler, OperationOptions options) Public because it is used by TestHelpersImpl.
SearchResult	search(ObjectClass objectClass, Filter originalFilter, ResultsHandler handler, OperationOptions options) Call the SPI search routines to return the results to the ResultsHandler.

Methods inherited from class org.identityconnectors.framework.impl.api.local.operations.ConnectorAPIOperationRunner

getConnector, getNormalizer, getOperationalContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchImpl

public SearchImpl(ConnectorOperationalContext context,
          Connector connector)

Initializes the operation works.

Method Detail

search

public SearchResult search(ObjectClass objectClass,
                  Filter originalFilter,
                  ResultsHandler handler,
                  OperationOptions options)

Call the SPI search routines to return the results to the ResultsHandler.

Specified by:

search in interface SearchApiOp

Parameters:

objectClass - reduces the number of entries to only those that match the ObjectClass provided.

originalFilter - Reduces the number of entries to only those that match the Filter provided, if any. May be null.

handler - class responsible for working with the objects returned from the search.

options - additional options that impact the way this operation is run. May be null.

Returns:

The query result or null.

See Also:

SearchOp.executeQuery(org.identityconnectors.framework.common.objects.ObjectClass, T, org.identityconnectors.framework.common.objects.ResultsHandler, org.identityconnectors.framework.common.objects.OperationOptions)

rawSearch

public static void rawSearch(SearchOp<?> search,
             ObjectClass objectClass,
             Filter filter,
             SearchResultsHandler handler,
             OperationOptions options)

Public because it is used by TestHelpersImpl. Raw, SPI-level search.

Parameters:

search - The underlying implementation of search (generally the connector itself)

objectClass - The object class

filter - The filter

handler - The handler

options - The options