org.forgerock.openam.scripting.rest.batch.helpers

Class Requester

java.lang.Object

org.forgerock.openam.scripting.rest.batch.helpers.Requester

public class Requester
extends Object

Helper class for performing requests to endpoints via an internal router. The intention is for this to be utilised by the Script components of the REST SDK, however it exists as a general purpose internal router helper. todo : support patch operation

Constructor Summary

Constructors

Constructor and Description
Requester(javax.inject.Provider<org.forgerock.json.resource.Router> router)

Method Summary

Modifier and Type	Method and Description
org.forgerock.json.JsonValue	action(String location, String resourceId, String actionId, org.forgerock.json.JsonValue payload, org.forgerock.services.context.Context context) Request to perform an action at a specified endpoint.
org.forgerock.json.JsonValue	create(String location, String resourceId, org.forgerock.json.JsonValue payload, org.forgerock.services.context.Context context) Request to create a resource at a specified endpoint.
org.forgerock.json.JsonValue	delete(String location, String resourceId, org.forgerock.services.context.Context context) Request to delete a specified resource at a specified endpoint.
org.forgerock.json.JsonValue	query(String location, String queryId, org.forgerock.services.context.Context context) Request to perform a query at a specified endpoint.
org.forgerock.json.JsonValue	read(String location, String resourceId, org.forgerock.services.context.Context context) Request to read a specified resource at a specified endpoint.
org.forgerock.json.JsonValue	update(String location, String resourceId, org.forgerock.json.JsonValue payload, org.forgerock.services.context.Context context) Request to update a specified resource at a specified endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

Requester

@Inject
public Requester(@Named(value="CrestRootRouter")
                         javax.inject.Provider<org.forgerock.json.resource.Router> router)

Method Detail

create

public org.forgerock.json.JsonValue create(String location,
                                           String resourceId,
                                           org.forgerock.json.JsonValue payload,
                                           org.forgerock.services.context.Context context)
                                    throws org.forgerock.json.resource.ResourceException

Request to create a resource at a specified endpoint.

Parameters:

location - Endpoint destination of this request. May not be null.

resourceId - Resource ID to be created. May be null.

payload - Payload of the resource to generate. May not be null.

context - Context of this request.

Returns:

The JsonValue returned from the endpoint.

Throws:

org.forgerock.json.resource.ResourceException - If any exception occurred during processing.

read

public org.forgerock.json.JsonValue read(String location,
                                         String resourceId,
                                         org.forgerock.services.context.Context context)
                                  throws org.forgerock.json.resource.ResourceException

Request to read a specified resource at a specified endpoint.

Parameters:

location - Endpoint destination of this request. May not be null.

resourceId - Resource ID to read. May not be null.

context - Context of this request.

Returns:

The JsonValue returned from the endpoint.

Throws:

org.forgerock.json.resource.ResourceException - If any exception occurred during processing.

update

public org.forgerock.json.JsonValue update(String location,
                                           String resourceId,
                                           org.forgerock.json.JsonValue payload,
                                           org.forgerock.services.context.Context context)
                                    throws org.forgerock.json.resource.ResourceException

Request to update a specified resource at a specified endpoint.

Parameters:

location - Endpoint destination of this request. May not be null.

resourceId - Resource ID to update. May not be null.

payload - Payload of the updated resource. May not be null.

context - Context of this request.

Returns:

The JsonValue returned from the endpoint.

Throws:

org.forgerock.json.resource.ResourceException - If any exception occurred during processing.

delete

public org.forgerock.json.JsonValue delete(String location,
                                           String resourceId,
                                           org.forgerock.services.context.Context context)
                                    throws org.forgerock.json.resource.ResourceException

Request to delete a specified resource at a specified endpoint.

Parameters:

location - Endpoint destination of this request. May not be null.

resourceId - Resource ID to delete. May not be null.

context - Context of this request.

Returns:

The JsonValue returned from the endpoint.

Throws:

org.forgerock.json.resource.ResourceException - If any exception occurred during processing.

action

public org.forgerock.json.JsonValue action(String location,
                                           String resourceId,
                                           String actionId,
                                           org.forgerock.json.JsonValue payload,
                                           org.forgerock.services.context.Context context)
                                    throws org.forgerock.json.resource.ResourceException

Request to perform an action at a specified endpoint.

Parameters:

location - Endpoint destination of this request. May not be null.

resourceId - Specific resource ID to perform action on. May be null.

actionId - act ID to delete. May not be null.

context - Context of this request.

Returns:

The JsonValue returned from the endpoint.

Throws:

org.forgerock.json.resource.ResourceException - If any exception occurred during processing.

query

public org.forgerock.json.JsonValue query(String location,
                                          String queryId,
                                          org.forgerock.services.context.Context context)
                                   throws org.forgerock.json.resource.ResourceException

Request to perform a query at a specified endpoint.

Parameters:

location - Endpoint destination of this request. May not be null.

queryId - Specific query ID to perform. May be null.

context - Context of this request.

Returns:

The JsonValue returned from the endpoint.

Throws:

org.forgerock.json.resource.ResourceException - If any exception occurred during processing.