Package org.forgerock.json.resource
package org.forgerock.json.resource
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
-
ClassDescriptionAn 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.Deprecated.An implementation specific action, or operation, upon a JSON resource.Response object for JSON responses.A
Contextcontaining information which should be returned to the user in some appropriate form to the user.WarningHeader implements RFC 2616 section 14.46 - Warning.A utility class for dealing withCrestApplicationinstances.An exception that is thrown during a operation on a resource when the requested operation is malformed.An implementation interface for resource providers which exposes a collection of resource instances.An exception that is thrown during a operation on a resource when such an operation would result in a conflict.A client connection to a JSON resource provider over which read and update requests may be performed.A connection factory provides an interface for obtaining a connection to a JSON resource provider.An enum of count policy types.A specific exception for when Create is not supported, but Upsert might be being attempted so distinguish from otherBadRequestExceptions.A request to create a new JSON resource.Declare a CREST Application.A request to delete a JSON resource.Version ofSynchronousRequestHandlerAdapterthat exposes a described handler.An interface for implementing request handler filters.A chain of filters terminated by a target request handler.A condition which controls whether or not a filter will be invoked or not.This class contains methods for creating various kinds ofFilterandFilterConditions.An exception that is thrown when access to a resource is forbidden during an operation on an resource.QueryResourceHandlerthat searches for a specific identifier value.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.This class contains the utility functions to convert aJsonValueto CREST (json-resource) types.A simple in-memory collection resource provider which uses aMapto store resources.An exception that is thrown when a specified resource cannot be found.An exception that is thrown during an operation on a resource when the resource does not implement/support the feature to fulfill the request.An individual patch operation which is to be performed against a field within a resource.A request to update a JSON resource by applying a set of changes to its existing content.An exception that indicates that a failure is permanent, i.e.An exception that is thrown to indicate that a resource's current version does not match the version provided.An exception that is thrown to indicate that a resource requires a version, but no version was supplied in the request.Convenience methods to createQueryFilterthat specify fields in terms ofJsonPointerinstances.A request to search for all JSON resources matching a user specified set of criteria.A completion handler for consuming the results of a query request.The final result of a query request returned after all resources matching the request have been returned.A request to read a single identified JSON resource.Common attributes of all JSON resource requests.Represents the contract with a set of resources.A utility class containing various factory methods for creating and manipulating requests.An enumeration whose values represent the different types of request.RequestVisitor<R,P> A visitor ofRequests, in the style of the visitor design pattern.API Version routing filter which creates aApiVersionRouterContextwhich contains the default routing behaviour when the Accept-API-Version header is set on the request.AFiltersupporting 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.Handler allowing products to extend behaviour when a request has no resource API version supplied.Class representing a mapping between aResourcePathand aVersion.ResourceApiVersionSpecificationFilter.VersionSpecificationsupporting specification of a request's resource version based on its resource path.Mechanism supporting specification of a version on the request.An exception that is thrown during the processing of a JSON resource request.A relative path, or URL, to a resource.A resource, comprising of a resource ID, a revision (etag), and its JSON content.This class contains methods for creating and manipulating connection factories and connections.Common response object of all resource responses.Indicates whether a response can be cached and under what conditions.A utility class containing various factory methods for creating and manipulating responses.An exception that indicates that a failure may be temporary, and that retrying the same request may be able to succeed in the future.A utility class that contains methods for creating route matchers.A router which routes requests based on route predicates.Represents a URI template string that will be used to match and route incoming requests.An exception that is thrown during an operation on a resource when the server is temporarily unable to handle the request.An implementation interface for resource providers which exposes a single permanent resource instance.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.This comparator iterates through the provided sortKeys and finds the first comparative difference between the left and right side JsonValues.Defines possible positions for JsonValue that wraps anullobject.An interface for implementing synchronousRequestHandlers.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.Indicates a 415 Unsupported Media Type response that the Content-Type of the request was not acceptable.A request to update a JSON resource by replacing its existing content with new content.
RequestHandlernow has default methods which implement the not-supported behavior.