Package org.forgerock.json.resource

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

Interface Summary

Interface	Description
ActionRequest	An implementation specific action, or operation, upon a JSON resource.
ActionResponse	Response object for JSON responses.
CollectionResourceProvider	An implementation interface for resource providers which exposes a collection of resource instances.
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.
CreateRequest	A request to create a new JSON resource.
CrestApplication	Declare a CREST Application.
DeleteRequest	A request to delete a JSON resource.
Filter	An interface for implementing request handler filters.
FilterCondition	A condition which controls whether or not a filter will be invoked or not.
PatchRequest	A request to update a JSON resource by applying a set of changes to its existing content.
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.
RequestVisitor<R,P>	A visitor of Requests, in the style of the visitor design pattern.
ResourceApiVersionSpecificationFilter.NoApiVersionHandler	Handler allowing products to extend behaviour when a request has no resource API version supplied.
ResourceApiVersionSpecificationFilter.VersionSpecification	Mechanism supporting specification of a version on the request.
ResourceResponse	A resource, comprising of a resource ID, a revision (etag), and its JSON content.
Response	Common response object of all resource responses.
SingletonResourceProvider	An implementation interface for resource providers which exposes a single permanent resource instance.
SynchronousRequestHandler	An interface for implementing synchronous RequestHandlers.
UpdateRequest	A request to update a JSON resource by replacing its existing content with new content.

Class Summary

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	Deprecated. RequestHandler now has default methods which implement the not-supported behavior.
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.
DescribedSyncRequestHandlerAdapter	Version of SynchronousRequestHandlerAdapter that exposes a described handler.
FilterChain	A chain of filters terminated by a target request handler.
Filters	This class contains methods for creating various kinds of Filter and FilterConditions.
IdentifierQueryResourceHandler	QueryResourceHandler that searches for a specific identifier value.
JsonValueFunctions	This class contains the utility functions to convert a JsonValue to CREST (json-resource) types.
MemoryBackend	A simple in-memory collection resource provider which uses a Map to store resources.
PatchOperation	An individual patch operation which is to be performed against a field within a resource.
QueryFilters	Convenience methods to create QueryFilter that specify fields in terms of JsonPointer instances.
Requests	A utility class containing various factory methods for creating and manipulating requests.
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.
ResourceApiVersionSpecificationFilter	A Filter supporting the specification of resource API version configuration to be used when a request on a specific endpoint does not contain an Accept-API-Version header.
ResourceApiVersionSpecificationFilter.ResourcePathAndVersion	Class representing a mapping between a ResourcePath and a Version.
ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification	ResourceApiVersionSpecificationFilter.VersionSpecification supporting specification of a request's resource version based on its resource path.
ResourcePath	A relative path, or URL, to a resource.
Resources	This class contains methods for creating and manipulating connection factories and connections.
ResponseCacheControl	Indicates whether a response can be cached and under what conditions.
Responses	A utility class containing various factory methods for creating and manipulating responses.
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.
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.
SortKeyComparator	This comparator iterates through the provided sortKeys and finds the first comparative difference between the left and right side JsonValues.

Enum Summary

Enum	Description
CountPolicy	An enum of count policy types.
RequestType	An enumeration whose values represent the different types of request.
SortKeyComparator.NullPosition	Defines possible positions for JsonValue that wraps a null object.

Exception Summary

Exception	Description
BadRequestException	An exception that is thrown during a operation on a resource when the requested operation is malformed.
ConflictException	An exception that is thrown during a operation on a resource when such an operation would result in a conflict.
CreateNotSupportedException	A specific exception for when Create is not supported, but Upsert might be being attempted so distinguish from other BadRequestExceptions.
ForbiddenException	An exception that is thrown when access to a resource is forbidden during an operation on an resource.
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.
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.
PermanentException	An exception that indicates that a failure is permanent, i.e.
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.
ResourceException	An exception that is thrown during the processing of a JSON resource request.
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.
ServiceUnavailableException	An exception that is thrown during an operation on a resource when the server is temporarily unable to handle the request.
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.
UnsupportedMediaTypeException	Indicates a 415 Unsupported Media Type response that the Content-Type of the request was not acceptable.