Package | Description |
---|---|
org.forgerock.json.resource |
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
|
org.forgerock.openam.rest.resource |
This package contains classes for the handling of REST request to CREST Resource endpoints with the concept of realms
in OpenAM built in.
|
org.forgerock.selfservice.core |
This package contains the core implementation for the anonymous process service.
|
Modifier and Type | Method and Description |
---|---|
ResourceResponse |
Connection.create(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.create(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.create(Context context,
CreateRequest request) |
ResourceResponse |
Connection.delete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.delete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.delete(Context context,
DeleteRequest request) |
static ResourceResponse |
Resources.filterResource(ResourceResponse resource,
Collection<JsonPointer> fields)
Returns a JSON object containing only the specified fields from the
provided resource.
|
ResourceResponse |
IdentifierQueryResourceHandler.getResourceResponse()
Gets the
ResourceResponse query result. |
ResourceResponse |
SynchronousRequestHandler.handleCreate(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handlePatch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
SynchronousRequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handleUpdate(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
static ResourceResponse |
Responses.newResourceResponse(String id,
String revision,
JsonValue content)
Returns a new
Resource response with the provided Resource as
content. |
ResourceResponse |
Connection.patch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractConnectionWrapper.patch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractAsynchronousConnection.patch(Context context,
PatchRequest request) |
ResourceResponse |
Connection.read(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.read(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.read(Context context,
ReadRequest request) |
ResourceResponse |
Connection.update(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractConnectionWrapper.update(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractAsynchronousConnection.update(Context context,
UpdateRequest request) |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
ResourceResponse.asPromise()
Return this response as a result Promise.
|
Promise<ResourceResponse,ResourceException> |
Connection.createAsync(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.createAsync(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.deleteInstance(Context context,
String id,
DeleteRequest request)
Removes a resource instance from the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.deleteInstance(Context context,
String resourceId,
DeleteRequest request)
Removes a resource instance from the collection. |
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterCreate(Context context,
CreateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterCreate(Context context,
CreateRequest request,
RequestHandler next)
Filters a create request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next)
Filters a delete request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterPatch(Context context,
PatchRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterPatch(Context context,
PatchRequest request,
RequestHandler next)
Filters a patch request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterRead(Context context,
ReadRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterRead(Context context,
ReadRequest request,
RequestHandler next)
Filters a read request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next)
Filters an update request.
|
Promise<ResourceResponse,ResourceException> |
Router.handleCreate(Context context,
CreateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleCreate(Context context,
CreateRequest request)
Adds a new JSON resource, returning a
Promise that will be
completed when the resource has been added. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleCreate(Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleDelete(Context context,
DeleteRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource, returning a
Promise that will be
completed when the resource has been deleted. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleDelete(Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handlePatch(Context context,
PatchRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handlePatch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handlePatch(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleRead(Context context,
ReadRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource, returning a
Promise that will be
completed when the resource has been read. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleRead(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleUpdate(Context context,
UpdateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleUpdate(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleUpdate(Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.patchInstance(Context context,
PatchRequest request)
Patches the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.patchInstance(Context context,
String id,
PatchRequest request)
Patches an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.patchInstance(Context context,
String resourceId,
PatchRequest request)
Patches an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.readInstance(Context context,
ReadRequest request)
Reads the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.readInstance(Context context,
String id,
ReadRequest request)
Reads an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.readInstance(Context context,
String resourceId,
ReadRequest request)
Reads an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.updateInstance(Context context,
String id,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.updateInstance(Context context,
String resourceId,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.updateInstance(Context context,
UpdateRequest request)
Updates the single resource instance. |
Modifier and Type | Method and Description |
---|---|
static ResourceResponse |
Resources.filterResource(ResourceResponse resource,
Collection<JsonPointer> fields)
Returns a JSON object containing only the specified fields from the
provided resource.
|
boolean |
QueryResourceHandler.handleResource(ResourceResponse resource)
Invoked each time a matching JSON resource is returned from a query
request.
|
boolean |
IdentifierQueryResourceHandler.handleResource(ResourceResponse resource) |
Modifier and Type | Method and Description |
---|---|
QueryResponse |
SynchronousRequestHandler.handleQuery(Context context,
QueryRequest request,
Collection<ResourceResponse> resources)
Searches for all JSON resources matching a user specified set of
criteria.
|
QueryResponse |
Connection.query(Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
AbstractConnectionWrapper.query(Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
AbstractAsynchronousConnection.query(Context context,
QueryRequest request,
Collection<? super ResourceResponse> results) |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
RestrictedTokenContextFilter.filterCreate(Context context,
CreateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
RestrictedTokenContextFilter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
RestrictedTokenContextFilter.filterPatch(Context context,
PatchRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
RestrictedTokenContextFilter.filterRead(Context context,
ReadRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
RestrictedTokenContextFilter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next) |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
AnonymousProcessService.handleRead(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
UserUpdateService.patchInstance(Context context,
String resourceId,
PatchRequest request) |
Copyright © 2010-2018, ForgeRock All Rights Reserved.