org.forgerock.json.resource.descriptor.examples.provider.version1

Class UserCollectionProviderV1

java.lang.Object

org.forgerock.json.resource.descriptor.examples.provider.version1.UserCollectionProviderV1

Direct Known Subclasses:

UserCollectionProviderV2

public class UserCollectionProviderV1
extends Object

Example collection provider class with API descriptor annotations.

Field Summary

Fields

Modifier and Type	Field and Description
protected MemoryBackend	memoryBackend The used provider base.

Constructor Summary

Constructors

Constructor and Description
UserCollectionProviderV1(MemoryBackend memoryBackend, DeviceCollectionProviderV1 deviceCollectionProvider) Default constructor.

Method Summary

Modifier and Type	Method and Description
Promise<ResourceResponse,ResourceException>	create(Context context, CreateRequest request) Performs a create operation on the resource.
Promise<ResourceResponse,ResourceException>	delete(Context context, String id, DeleteRequest request) Performs a delete operation on the resource.
DeviceCollectionProviderV1	devices() User devices provider.
Promise<ResourceResponse,ResourceException>	patch(Context context, String id, PatchRequest request) Performs a patch operation on the resource.
Promise<QueryResponse,ResourceException>	query(Context context, QueryRequest request, QueryResourceHandler handler) Performs a query operation on the resource.
Promise<ResourceResponse,ResourceException>	read(Context context, String id, ReadRequest request) Performs a read operation on the resource.
Promise<ActionResponse,ResourceException>	resetPasswd(Context context, String id, ActionRequest request) Performs a mark as stolen action operation on the resource.
Promise<ResourceResponse,ResourceException>	update(Context context, String id, UpdateRequest request) Performs an update operation on the resource.

Methods inherited from class java.lang.Object

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

Field Detail

memoryBackend

protected MemoryBackend memoryBackend

The used provider base.

Constructor Detail

UserCollectionProviderV1

public UserCollectionProviderV1(MemoryBackend memoryBackend,
                                DeviceCollectionProviderV1 deviceCollectionProvider)

Default constructor.

Parameters:

memoryBackend - The collection provider base

deviceCollectionProvider - The device collection provider

Method Detail

query

public Promise<QueryResponse,ResourceException> query(Context context,
                                                      QueryRequest request,
                                                      QueryResourceHandler handler)

Performs a query operation on the resource.

Parameters:

context - The request server context.

request - The action request.

handler - The action handler.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleAction(Context, ActionRequest)

create

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

Performs a create operation on the resource.

Parameters:

context - The request server context.

request - The action request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleAction(Context, ActionRequest)

read

public Promise<ResourceResponse,ResourceException> read(Context context,
                                                        String id,
                                                        ReadRequest request)

Performs a read operation on the resource.

Parameters:

context - The request server context.

id - The request id.

request - The action request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleAction(Context, ActionRequest)

update

public Promise<ResourceResponse,ResourceException> update(Context context,
                                                          String id,
                                                          UpdateRequest request)

Performs an update operation on the resource.

Parameters:

context - The request server context.

id - The request id.

request - The action request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleAction(Context, ActionRequest)

delete

public Promise<ResourceResponse,ResourceException> delete(Context context,
                                                          String id,
                                                          DeleteRequest request)

Performs a delete operation on the resource.

Parameters:

context - The request server context.

id - The action id.

request - The action request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleDelete(Context, DeleteRequest)

patch

public Promise<ResourceResponse,ResourceException> patch(Context context,
                                                         String id,
                                                         PatchRequest request)

Performs a patch operation on the resource.

Parameters:

context - The request server context.

id - The request id.

request - The patch request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handlePatch(Context, PatchRequest)

resetPasswd

public Promise<ActionResponse,ResourceException> resetPasswd(Context context,
                                                             String id,
                                                             ActionRequest request)

Performs a mark as stolen action operation on the resource.

Parameters:

context - The request server context.

id - The action id.

request - The action request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleAction(Context, ActionRequest)

devices

public DeviceCollectionProviderV1 devices()

User devices provider.

Returns:

User devices provider