Package org.forgerock.openig.handler.router

Class RoutesCollectionProvider

java.lang.Object

org.forgerock.openig.handler.router.RoutesCollectionProvider

All Implemented Interfaces:

CollectionResourceProvider

public class RoutesCollectionProvider
extends Object
implements CollectionResourceProvider

CREST handler used to manage the collection of routes deployed by a RouterHandler.

Method Summary

Modifier and Type	Method	Description
Promise<ResourceResponse,ResourceException>	createInstance(Context context, CreateRequest request)	Adds a new resource instance to the collection.
Promise<ResourceResponse,ResourceException>	deleteInstance(Context context, String resourceId, DeleteRequest request)	Removes a resource instance from the collection.
Promise<QueryResponse,ResourceException>	queryCollection(Context context, QueryRequest request, QueryResourceHandler resourceHandler)	Searches the collection for all resources which match the query request criteria.
Promise<ResourceResponse,ResourceException>	readInstance(Context context, String resourceId, ReadRequest request)	Reads an existing resource within the collection.
org.forgerock.openig.handler.router.RouteResourcesCollectionProvider	resources()	Returns the provider that manages the resources of a route.
Promise<ResourceResponse,ResourceException>	updateInstance(Context context, String resourceId, UpdateRequest request)	Updates an existing resource within the collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.json.resource.CollectionResourceProvider

actionCollection, actionInstance, patchInstance

Method Details

createInstance

public Promise<ResourceResponse,ResourceException> createInstance(Context context,
 CreateRequest request)

Description copied from interface: CollectionResourceProvider

Adds a new resource instance to the collection.

Create requests are targeted at the collection itself and may include a user-provided resource ID for the new resource as part of the request itself. The user-provider resource ID may be accessed using the method CreateRequest.getNewResourceId().

Specified by:

createInstance in interface CollectionResourceProvider

Parameters:

context - The request server context.

request - The create request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleCreate(Context, CreateRequest)
• CreateRequest.getNewResourceId()

deleteInstance

public Promise<ResourceResponse,ResourceException> deleteInstance(Context context,
 String resourceId,
 DeleteRequest request)

Description copied from interface: CollectionResourceProvider

Removes a resource instance from the collection.

Specified by:

deleteInstance in interface CollectionResourceProvider

Parameters:

context - The request server context.

resourceId - The ID of the targeted resource within the collection.

request - The delete request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleDelete(Context, DeleteRequest)

queryCollection

public Promise<QueryResponse,ResourceException> queryCollection(Context context,
 QueryRequest request,
 QueryResourceHandler resourceHandler)

Description copied from interface: CollectionResourceProvider

Searches the collection for all resources which match the query request criteria.

Implementations must invoke QueryResourceHandler.handleResource(ResourceResponse) for each resource which matches the query criteria. Once all matching resources have been returned implementations are required to return either a QueryResponse if the query has completed successfully, or ResourceException if the query did not complete successfully (even if some matching resources were returned).

Specified by:

queryCollection in interface CollectionResourceProvider

Parameters:

context - The request server context.

request - The query request.

resourceHandler - The query resource handler to be notified for each matching resource.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleQuery(Context, QueryRequest, QueryResourceHandler)

readInstance

public Promise<ResourceResponse,ResourceException> readInstance(Context context,
 String resourceId,
 ReadRequest request)

Description copied from interface: CollectionResourceProvider

Reads an existing resource within the collection.

Specified by:

readInstance in interface CollectionResourceProvider

Parameters:

context - The request server context.

resourceId - The ID of the targeted resource within the collection.

request - The read request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleRead(Context, ReadRequest)

updateInstance

public Promise<ResourceResponse,ResourceException> updateInstance(Context context,
 String resourceId,
 UpdateRequest request)

Description copied from interface: CollectionResourceProvider

Updates an existing resource within the collection.

Specified by:

updateInstance in interface CollectionResourceProvider

Parameters:

context - The request server context.

resourceId - The ID of the targeted resource within the collection.

request - The update request.

Returns:

A Promise containing the result of the operation.

See Also:

• RequestHandler.handleUpdate(Context, UpdateRequest)

resources

public org.forgerock.openig.handler.router.RouteResourcesCollectionProvider resources()

Returns the provider that manages the resources of a route. This method needs to be public to be picked up by the Path annotation.

Returns:

the provider that manages the resources of a route