org.forgerock.openam.sm.datalayer.impl.tasks

Class PartialQueryTask

java.lang.Object

org.forgerock.openam.sm.datalayer.api.AbstractTask

org.forgerock.openam.sm.datalayer.impl.tasks.PartialQueryTask

All Implemented Interfaces:

Task

public class PartialQueryTask
extends AbstractTask

Performs a partial query against the persistence layer. Partial queries operate like normal queries except that the results are not full Token instances. Instead they are a collection of Name/Value pairs which represent a subset of a Token.

See Also:

QueryTask

Field Summary

Fields inherited from class org.forgerock.openam.sm.datalayer.api.AbstractTask

handler, logger, sid2token

Constructor Summary

Constructors

Constructor and Description
PartialQueryTask(TokenFilter tokenFilter, ResultHandler<Collection<PartialToken>,?> handler)

Method Summary

Modifier and Type	Method and Description
void	performTask(TokenStorageAdapter adapter) Performs the partial query operation from the persistence store using the TokenStorageAdapter.
String	toString()

Methods inherited from class org.forgerock.openam.sm.datalayer.api.AbstractTask

execute, processError

Methods inherited from class java.lang.Object

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

Constructor Detail

PartialQueryTask

public PartialQueryTask(TokenFilter tokenFilter,
                        ResultHandler<Collection<PartialToken>,?> handler)

Parameters:

tokenFilter - Non null and must define at least one Return Attribute.

handler - Non null, required for asynchronous response.

Method Detail

performTask

public void performTask(TokenStorageAdapter adapter)
                 throws DataLayerException

Performs the partial query operation from the persistence store using the TokenStorageAdapter.

Specified by:

performTask in class AbstractTask

Parameters:

adapter - Utility functions to perform the task with.

Throws:

DataLayerException

IllegalArgumentException - If the TokenFilter did not define any return fields.

toString

public String toString()

Overrides:

toString in class Object