Package org.forgerock.json.resource

package org.forgerock.json.resource

Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.

Related Packages

Package	Description
org.forgerock.json.resource.annotations	The annotations are made available to allow a POJO annotated with RequestHandler to be used as a CREST resource, with the necessary methods then being annotated to indicate which operations are available, and the method that handles them.

Class	Description
AbstractAsynchronousConnection	An abstract connection whose synchronous methods are implemented in terms of asynchronous methods.
AbstractConnectionWrapper<C extends Connection>	An abstract base class from which connection wrappers may be easily implemented.
AbstractRequestHandler	An abstract base class from which request handlersmay be easily implemented.
ActionRequest	An implementation specific action, or operation, upon a JSON resource.
ActionResponse	Response object for JSON responses.
AdviceContext	A Context containing information which should be returned to the user in some appropriate form to the user.
AdviceWarning	WarningHeader implements RFC 2616 section 14.46 - Warning.
Applications	A utility class for dealing with CrestApplication instances.
BadRequestException	An exception that is thrown during a operation on a resource when the requested operation is malformed.
CollectionResourceProvider	An implementation interface for resource providers which exposes a collection of resource instances.
ConflictException	An exception that is thrown during a operation on a resource when such an operation would result in a conflict.
Connection	A client connection to a JSON resource provider over which read and update requests may be performed.
ConnectionFactory	A connection factory provides an interface for obtaining a connection to a JSON resource provider.
CountPolicy	An enum of count policy types.
CreateNotSupportedException	A specific exception for when Create is not supported, but Upsert might be being attempted so distinguish from other BadRequestExceptions.
CreateRequest	A request to create a new JSON resource.
CrestApplication	Declare a CREST Application.
DeleteRequest	A request to delete a JSON resource.
DescribedSyncRequestHandlerAdapter	Version of SynchronousRequestHandlerAdapter that exposes a described handler.
Filter	An interface for implementing request handler filters.
FilterChain	A chain of filters terminated by a target request handler.
FilterCondition	A condition which controls whether or not a filter will be invoked or not.
Filters	This class contains methods for creating various kinds of Filter and FilterConditions.
ForbiddenException	An exception that is thrown when access to a resource is forbidden during an operation on an resource.
IdentifierQueryResourceHandler	QueryResourceHandler that searches for a specific identifier value.
InternalServerErrorException	An exception that is thrown during an operation on a resource when the server encountered an unexpected condition which prevented it from fulfilling the request.
MemoryBackend	A simple in-memory collection resource provider which uses a Map to store resources.
NotFoundException	An exception that is thrown when a specified resource cannot be found.
NotSupportedException	An exception that is thrown during an operation on a resource when the resource does not implement/support the feature to fulfill the request.
PatchOperation	An individual patch operation which is to be performed against a field within a resource.
PatchRequest	A request to update a JSON resource by applying a set of changes to its existing content.
PermanentException	An exception that indicates that a failure is permanent, i.e. that re-trying alone without addressing the cause is not expected to succeed.
PreconditionFailedException	An exception that is thrown to indicate that a resource's current version does not match the version provided.
PreconditionRequiredException	An exception that is thrown to indicate that a resource requires a version, but no version was supplied in the request.
QueryFilters	Convenience methods to create QueryFilter that specify fields in terms of JsonPointer instances.
QueryRequest	A request to search for all JSON resources matching a user specified set of criteria.
QueryResourceHandler	A completion handler for consuming the results of a query request.
QueryResponse	The final result of a query request returned after all resources matching the request have been returned.
ReadRequest	A request to read a single identified JSON resource.
Request	Common attributes of all JSON resource requests.
RequestHandler	Represents the contract with a set of resources.
Requests	A utility class containing various factory methods for creating and manipulating requests.
RequestType	An enumeration whose values represent the different types of request.
RequestVisitor<R,P>	A visitor of Requests, in the style of the visitor design pattern.
ResourceApiVersionRoutingFilter	API Version routing filter which creates a ApiVersionRouterContext which contains the default routing behaviour when the Accept-API-Version header is set on the request.
ResourceException	An exception that is thrown during the processing of a JSON resource request.
ResourcePath	A relative path, or URL, to a resource.
ResourceResponse	A resource, comprising of a resource ID, a revision (etag), and its JSON content.
Resources	This class contains methods for creating and manipulating connection factories and connections.
Response	Common response object of all resource responses.
Responses	A utility class containing various factory methods for creating and manipulating responses.
RetryableException	An exception that indicates that a failure may be temporary, and that retrying the same request may be able to succeed in the future.
RouteMatchers	A utility class that contains methods for creating route matchers.
Router	A router which routes requests based on route predicates.
Router.UriTemplate	Represents a URI template string that will be used to match and route incoming requests.
ServiceUnavailableException	An exception that is thrown during an operation on a resource when the server is temporarily unable to handle the request.
SingletonResourceProvider	An implementation interface for resource providers which exposes a single permanent resource instance.
SortKey	A sort key which can be used to specify the order in which JSON resources should be included in the results of a query request.
SynchronousRequestHandler	An interface for implementing synchronous RequestHandlers.
UncategorizedException	An exception that indicates that a failure is not directly known to the system, and hence requires out-of-band knowledge or enhancements to determine if a failure should be categorized as temporary or permanent.
UpdateRequest	A request to update a JSON resource by replacing its existing content with new content.