org.forgerock.json.resource

Class IdentifierQueryResourceHandler

java.lang.Object

org.forgerock.json.resource.IdentifierQueryResourceHandler

All Implemented Interfaces:

QueryResourceHandler

public class IdentifierQueryResourceHandler
extends Object
implements QueryResourceHandler

QueryResourceHandler that searches for a specific identifier value.

Constructor Summary

Constructors

Constructor and Description
IdentifierQueryResourceHandler(String id) Creates a new QueryResourceHandler for the given identifier.

Method Summary

Modifier and Type	Method and Description
String	getId() Gets the identifier being queried for.
ResourceResponse	getResourceResponse() Gets the ResourceResponse query result.
boolean	handleResource(ResourceResponse resource) Invoked each time a matching JSON resource is returned from a query request.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentifierQueryResourceHandler

public IdentifierQueryResourceHandler(String id)

Creates a new QueryResourceHandler for the given identifier.

Parameters:

id - Identifier to query for

Method Detail

handleResource

public boolean handleResource(ResourceResponse resource)

Description copied from interface: QueryResourceHandler

Invoked each time a matching JSON resource is returned from a query request. More specifically, if a query request matches 10 resources, then this method will be invoked 10 times, once for each matching resource.

Refer to RequestHandler.handleQuery(org.forgerock.services.context.Context, QueryRequest, QueryResourceHandler) for information regarding the concurrency and the order in which events are processed.

Specified by:

handleResource in interface QueryResourceHandler

Parameters:

resource - The matching JSON resource.

Returns:

true if this handler should continue to be notified of any remaining matching JSON resources, or false if the remaining JSON resources should be skipped for some reason (e.g. a client side size limit has been reached).

getId

public String getId()

Gets the identifier being queried for.

Returns:

Identifier

getResourceResponse

public ResourceResponse getResourceResponse()

Gets the ResourceResponse query result.

Returns:

ResourceResponse or null if not yet found