Index (Wren Security Commons REST - JSON Resource Core Library 23.0.0-SNAPSHOT Documentation)

A B C D E F G H I L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractAsynchronousConnection - Class in org.forgerock.json.resource: An abstract connection whose synchronous methods are implemented in terms of asynchronous methods.
AbstractAsynchronousConnection() - Constructor for class org.forgerock.json.resource.AbstractAsynchronousConnection: Creates a new abstract asynchronous connection.
AbstractConnectionWrapper<C extends Connection> - Class in org.forgerock.json.resource: An abstract base class from which connection wrappers may be easily implemented.
AbstractConnectionWrapper(C) - Constructor for class org.forgerock.json.resource.AbstractConnectionWrapper: Creates a new connection wrapper.
AbstractRequestHandler - Class in org.forgerock.json.resource: An abstract base class from which request handlersmay be easily implemented.
AbstractRequestHandler() - Constructor for class org.forgerock.json.resource.AbstractRequestHandler: Creates a new abstract request handler.
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.ActionRequest
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.CreateRequest
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.DeleteRequest
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.PatchRequest
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.QueryRequest
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.ReadRequest
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.Request: Applies a RequestVisitor to this Request.
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.UpdateRequest
action(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
action(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Performs an action against a specific resource, or set of resources.
action(Context, ActionRequest) - Method in interface org.forgerock.json.resource.Connection: Performs an action against a specific resource, or set of resources.
ACTION - Enum constant in enum org.forgerock.json.resource.RequestType: An action request.
ACTION_ID_CREATE - Static variable in interface org.forgerock.json.resource.ActionRequest: The name of the action which is reserved for performing "create" operations.
ACTION_ID_CREATE - Static variable in interface org.forgerock.json.resource.CreateRequest: The name of the action which is reserved for performing "create" operations.
actionAsync(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously performs an action against a specific resource, or set of resources.
actionAsync(Context, ActionRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously performs an action against a specific resource, or set of resources.
actionCollection(Context, ActionRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Performs the provided action against the resource collection.
actionCollection(Context, ActionRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Performs the provided action against the resource collection.
actionInstance(Context, String, ActionRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Performs the provided action against a resource within the collection.
actionInstance(Context, String, ActionRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Performs the provided action against a resource within the collection.
actionInstance(Context, ActionRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider: Performs the provided action against the single resource instance.
ActionRequest - Interface in org.forgerock.json.resource: An implementation specific action, or operation, upon a JSON resource.
ActionResponse - Interface in org.forgerock.json.resource: Response object for JSON responses.
add(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "add" patch operation which will add the provided value(s) to the specified field.
add(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "add" patch operation which will add the provided value(s) to the specified field.
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.FilterChain
addField(String...) - Method in interface org.forgerock.json.resource.ActionRequest
addField(String...) - Method in interface org.forgerock.json.resource.CreateRequest
addField(String...) - Method in interface org.forgerock.json.resource.DeleteRequest
addField(String...) - Method in interface org.forgerock.json.resource.PatchRequest
addField(String...) - Method in interface org.forgerock.json.resource.QueryRequest
addField(String...) - Method in interface org.forgerock.json.resource.ReadRequest
addField(String...) - Method in interface org.forgerock.json.resource.Request: Adds one or more fields which should be included with each JSON resource returned by this request.
addField(String...) - Method in interface org.forgerock.json.resource.UpdateRequest
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.ActionRequest
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.CreateRequest
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.DeleteRequest
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.PatchRequest
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.QueryRequest
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.ReadRequest
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.Request: Adds one or more fields which should be included with each JSON resource returned by this request.
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.ResourceResponse: Adds a field to the list of fields which should be included in this JSON resource after field filtering has occurred.
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.UpdateRequest
addPatchOperation(String, String, JsonValue) - Method in interface org.forgerock.json.resource.PatchRequest: Adds a single patch operation which should be performed against the targeted resource.
addPatchOperation(PatchOperation...) - Method in interface org.forgerock.json.resource.PatchRequest: Adds one or more patch operations which should be performed against the targeted resource.
addRoute(RoutingMode, Router.UriTemplate, RequestHandler) - Method in class org.forgerock.json.resource.Router: Adds a new route to this router for the provided request handler.
addRoute(Version, CollectionResourceProvider) - Method in class org.forgerock.json.resource.Router: Adds a new route to this router for the provided collection resource provider.
addRoute(Version, RequestHandler) - Method in class org.forgerock.json.resource.Router: Adds a new route to this router for the provided request handler.
addRoute(Version, SingletonResourceProvider) - Method in class org.forgerock.json.resource.Router: Adds a new route to this router for the provided singleton resource provider.
addRoute(Router.UriTemplate, CollectionResourceProvider) - Method in class org.forgerock.json.resource.Router: Adds a new route to this router for the provided collection resource provider.
addRoute(Router.UriTemplate, SingletonResourceProvider) - Method in class org.forgerock.json.resource.Router: Adds a new route to this router for the provided singleton resource provider.
addSortKey(String...) - Method in interface org.forgerock.json.resource.QueryRequest: Adds one or more sort keys which will be used for ordering the JSON resources returned by this query request.
addSortKey(SortKey...) - Method in interface org.forgerock.json.resource.QueryRequest: Adds one or more sort keys which will be used for ordering the JSON resources returned by this query request.
AdviceContext - Class in org.forgerock.json.resource: A Context containing information which should be returned to the user in some appropriate form to the user.
AdviceContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.json.resource.AdviceContext: Restore from JSON representation.
AdviceContext(Context, Collection<String>) - Constructor for class org.forgerock.json.resource.AdviceContext: Creates a new AdviceContext with the provided parent.
AdviceWarning - Class in org.forgerock.json.resource: WarningHeader implements RFC 2616 section 14.46 - Warning.
and(Collection<FilterCondition>) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests which match all the provided conditions.
and(FilterCondition...) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests which match all the provided conditions.
api(ApiProducer<ApiDescription>) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
api(ApiProducer<ApiDescription>) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
api(ApiProducer<ApiDescription>) - Method in class org.forgerock.json.resource.FilterChain
API - Enum constant in enum org.forgerock.json.resource.RequestType: An API Descriptor request.
Applications - Class in org.forgerock.json.resource: A utility class for dealing with CrestApplication instances.
ascendingOrder(String) - Static method in class org.forgerock.json.resource.SortKey: Creates a new ascending-order sort key for the provided JSON field.
ascendingOrder(JsonPointer) - Static method in class org.forgerock.json.resource.SortKey: Creates a new ascending-order sort key for the provided JSON field.
asPromise() - Method in interface org.forgerock.json.resource.ActionResponse: Return this response as a result Promise.
asPromise() - Method in interface org.forgerock.json.resource.QueryResponse: Return this response as a result Promise.
asPromise() - Method in exception org.forgerock.json.resource.ResourceException: Return this ResourceException as a Promise.
asPromise() - Method in interface org.forgerock.json.resource.ResourceResponse: Return this response as a result Promise.
asRequestHandler(SynchronousRequestHandler) - Static method in class org.forgerock.json.resource.Resources: Adapts the provided SynchronousRequestHandler as a RequestHandler.

B

BAD_REQUEST - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the request could not be understood by the resource due to malformed syntax.
BadRequestException - Exception in org.forgerock.json.resource: An exception that is thrown during a operation on a resource when the requested operation is malformed.
BadRequestException() - Constructor for exception org.forgerock.json.resource.BadRequestException: Constructs a new exception with null as its detail message.
BadRequestException(String) - Constructor for exception org.forgerock.json.resource.BadRequestException: Constructs a new exception with the specified detail message.
BadRequestException(String, Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException: Constructs a new exception with the specified detail message and cause.
BadRequestException(Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException: Constructs a new exception with the specified cause.

C

child(Object) - Method in class org.forgerock.json.resource.ResourcePath: Creates a new resource path which is a child of this resource path.
close() - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Releases any resources associated with this connection.
close() - Method in interface org.forgerock.json.resource.Connection: Releases any resources associated with this connection.
close() - Method in interface org.forgerock.json.resource.ConnectionFactory: Releases any resources associated with this connection factory.
CollectionResourceProvider - Interface in org.forgerock.json.resource: An implementation interface for resource providers which exposes a collection of resource instances.
compareTo(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath: Compares this resource path with the provided resource path.
concat(String) - Method in class org.forgerock.json.resource.ResourcePath: Creates a new resource path which is a descendant of this resource path.
concat(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath: Creates a new resource path which is a descendant of this resource path.
conditionalFilter(FilterCondition, Filter) - Static method in class org.forgerock.json.resource.Filters: Returns a Filter which will only invoke subFilter when the provided filter condition matches the request being processed.
CONFLICT - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates the request could not be completed due to a conflict with the current state of the resource.
ConflictException - Exception in org.forgerock.json.resource: An exception that is thrown during a operation on a resource when such an operation would result in a conflict.
ConflictException() - Constructor for exception org.forgerock.json.resource.ConflictException: Constructs a new exception with null as its detail message.
ConflictException(String) - Constructor for exception org.forgerock.json.resource.ConflictException: Constructs a new exception with the specified detail message.
ConflictException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ConflictException: Constructs a new exception with the specified detail message and cause.
ConflictException(Throwable) - Constructor for exception org.forgerock.json.resource.ConflictException: Constructs a new exception with the specified cause.
connection - Variable in class org.forgerock.json.resource.AbstractConnectionWrapper: The wrapped connection.
Connection - Interface in org.forgerock.json.resource: A client connection to a JSON resource provider over which read and update requests may be performed.
ConnectionFactory - Interface in org.forgerock.json.resource: A connection factory provides an interface for obtaining a connection to a JSON resource provider.
copy(String, String) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "copy" patch operation which will copy the value found at `from` to `path`.
copy(JsonPointer, JsonPointer) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "copy" patch operation which will copy the value found at `from` to `path`.
copyOf(PatchOperation) - Static method in class org.forgerock.json.resource.PatchOperation: Returns a deep copy of the provided patch operation.
copyOfActionRequest(ActionRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided action request.
copyOfApiRequest(Request) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided api request.
copyOfCreateRequest(CreateRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided create request.
copyOfDeleteRequest(DeleteRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided delete request.
copyOfPatchRequest(PatchRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided patch request.
copyOfQueryRequest(QueryRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided query request.
copyOfReadRequest(ReadRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided read request.
copyOfUpdateRequest(UpdateRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a copy of the provided update request.
CountPolicy - Enum in org.forgerock.json.resource: An enum of count policy types.
create(Context, CreateRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
create(Context, CreateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Adds a new JSON resource.
create(Context, CreateRequest) - Method in interface org.forgerock.json.resource.Connection: Adds a new JSON resource.
CREATE - Enum constant in enum org.forgerock.json.resource.RequestType: A create request.
createAsync(Context, CreateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously adds a new JSON resource.
createAsync(Context, CreateRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously adds a new JSON resource.
createInstance(Context, CreateRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Adds a new resource instance to the collection.
createInstance(Context, CreateRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Adds a new resource instance to the collection.
CreateNotSupportedException - Exception in org.forgerock.json.resource: A specific exception for when Create is not supported, but Upsert might be being attempted so distinguish from other BadRequestExceptions.
CreateNotSupportedException() - Constructor for exception org.forgerock.json.resource.CreateNotSupportedException: Constructor with default message.
CreateNotSupportedException(String) - Constructor for exception org.forgerock.json.resource.CreateNotSupportedException: Constructor with custom message.
CreateRequest - Interface in org.forgerock.json.resource: A request to create a new JSON resource.
CrestApplication - Interface in org.forgerock.json.resource: Declare a CREST Application.

D

delete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
delete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Deletes a JSON resource.
delete(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.Connection: Deletes a JSON resource.
DELETE - Enum constant in enum org.forgerock.json.resource.RequestType: A delete request.
deleteAsync(Context, DeleteRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously deletes a JSON resource.
deleteAsync(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously deletes a JSON resource.
deleteInstance(Context, String, DeleteRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Removes a resource instance from the collection.
deleteInstance(Context, String, DeleteRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Removes a resource instance from the collection.
DeleteRequest - Interface in org.forgerock.json.resource: A request to delete a JSON resource.
descendingOrder(String) - Static method in class org.forgerock.json.resource.SortKey: Creates a new descending-order sort key for the provided JSON field.
descendingOrder(JsonPointer) - Static method in class org.forgerock.json.resource.SortKey: Creates a new descending-order sort key for the provided JSON field.
DescribedSyncRequestHandlerAdapter - Class in org.forgerock.json.resource: Version of SynchronousRequestHandlerAdapter that exposes a described handler.
DISCONNECTED_OPERATION - Static variable in class org.forgerock.json.resource.AdviceWarning: 112 Disconnected operation SHOULD be included if the cache is intentionally disconnected from the rest of the network for a period of time.

E

empty() - Static method in class org.forgerock.json.resource.ResourcePath: Returns the empty resource path whose string representation is the empty string and which has zero path elements.
equals(Object) - Method in class org.forgerock.json.resource.ResourcePath: Returns true if obj is a resource path having the exact same elements as this resource path.
equals(Object) - Method in interface org.forgerock.json.resource.ResourceResponse: Returns true if the provided object is a resource having the same resource ID and revision as this resource.
equals(Object) - Method in class org.forgerock.json.resource.SortKey
ESTIMATE - Enum constant in enum org.forgerock.json.resource.CountPolicy: Estimated count may be used.
EXACT - Enum constant in enum org.forgerock.json.resource.CountPolicy: Exact count is required.

F

FIELD_ACTION - Static variable in interface org.forgerock.json.resource.ActionRequest: The name of the field which contains the action ID in the JSON representation.
FIELD_ADDITIONAL_PARAMETERS - Static variable in interface org.forgerock.json.resource.Request: The name of the field which contains the additional query parameters in the JSON representation.
FIELD_CAUSE - Static variable in exception org.forgerock.json.resource.ResourceException: The name of the JSON field used for the cause message.
FIELD_CODE - Static variable in exception org.forgerock.json.resource.ResourceException: The name of the JSON field used for the code.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.ActionRequest: The name of the field which contains the action content in the JSON representation.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.CreateRequest: The name of the field which contains the resource content in the JSON representation.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.ResourceResponse: The name of the field which contains the resource content in the JSON representation.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.UpdateRequest: The name of the field which contains the resource content in the JSON representation.
FIELD_CONTENT_ID - Static variable in interface org.forgerock.json.resource.ResourceResponse: The name of the field in the resource content which contains the resource ID.
FIELD_CONTENT_REVISION - Static variable in interface org.forgerock.json.resource.ResourceResponse: The name of the field in the resource content which contains the resource revision.
FIELD_DETAIL - Static variable in exception org.forgerock.json.resource.ResourceException: The name of the JSON field used for the detail.
FIELD_ERROR - Static variable in interface org.forgerock.json.resource.QueryResponse: The name of the field which contains the error in the JSON representation.
FIELD_FIELD - Static variable in class org.forgerock.json.resource.PatchOperation: The name of the field which contains the target field in the JSON representation.
FIELD_FIELDS - Static variable in interface org.forgerock.json.resource.Request: The name of the field which contains the fields in the JSON representation.
FIELD_FROM - Static variable in class org.forgerock.json.resource.PatchOperation: The name of the source field for copy and move operations.
FIELD_ID - Static variable in interface org.forgerock.json.resource.ResourceResponse: The name of the field which contains the resource ID in the JSON representation.
FIELD_MESSAGE - Static variable in exception org.forgerock.json.resource.ResourceException: The name of the JSON field used for the message.
FIELD_NEW_RESOURCE_ID - Static variable in interface org.forgerock.json.resource.CreateRequest: The name of the field which contains the new resource ID in the JSON representation.
FIELD_OPERATION - Static variable in class org.forgerock.json.resource.PatchOperation: The name of the field which contains the type of patch operation in the JSON representation.
FIELD_PAGE_SIZE - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the page size in the JSON representation.
FIELD_PAGED_RESULTS_COOKIE - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the paged results cookie in the JSON representation.
FIELD_PAGED_RESULTS_COOKIE - Static variable in interface org.forgerock.json.resource.QueryResponse: The name of the field which contains the paged results cookie in the JSON representation.
FIELD_PAGED_RESULTS_OFFSET - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the paged results offset in the JSON representation.
FIELD_PATCH - Static variable in interface org.forgerock.json.resource.PatchRequest: The name of the field which contains the patch content in the JSON representation.
FIELD_PATCH_OPERATIONS - Static variable in interface org.forgerock.json.resource.PatchRequest: The name of the field which contains the patch operations in the JSON representation.
FIELD_QUERY_EXPRESSION - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the query expression in the JSON representation.
FIELD_QUERY_FILTER - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the query filter in the JSON representation.
FIELD_QUERY_ID - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the query ID in the JSON representation.
FIELD_REASON - Static variable in exception org.forgerock.json.resource.ResourceException: The name of the JSON field used for the reason.
FIELD_REMAINING_PAGED_RESULTS - Static variable in interface org.forgerock.json.resource.QueryResponse: The name of the field which contains the remaining paged results in the JSON representation.
FIELD_RESOURCE_PATH - Static variable in interface org.forgerock.json.resource.Request: The name of the field which contains the resource name in the JSON representation.
FIELD_RESULT - Static variable in interface org.forgerock.json.resource.QueryResponse: The name of the field which contains the array of matching resources in the JSON representation.
FIELD_RESULT_COUNT - Static variable in interface org.forgerock.json.resource.QueryResponse: The name of the field which contains the result count in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.DeleteRequest: The name of the field which contains the resource version in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.PatchRequest: The name of the field which contains the resource version in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.ResourceResponse: The name of the field which contains the resource version in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.UpdateRequest: The name of the field which contains the resource version in the JSON representation.
FIELD_SORT_KEYS - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the sort keys in the JSON representation.
FIELD_TOTAL_PAGED_RESULTS - Static variable in interface org.forgerock.json.resource.QueryResponse: The name of the field which contains the total paged results in the JSON representation.
FIELD_TOTAL_PAGED_RESULTS_POLICY - Static variable in interface org.forgerock.json.resource.QueryRequest: The name of the field which contains the policy used for calculating the total number of paged results.
FIELD_TOTAL_PAGED_RESULTS_POLICY - Static variable in interface org.forgerock.json.resource.QueryResponse: The name of the field which contains the policy used for calculating the total number of paged results in the JSON representation.
FIELD_VALUE - Static variable in class org.forgerock.json.resource.PatchOperation: The name of the field which contains the operation value in the JSON representation.
Filter - Interface in org.forgerock.json.resource: An interface for implementing request handler filters.
filterAction(Context, ActionRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter: Filters an action request.
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
FilterChain - Class in org.forgerock.json.resource: A chain of filters terminated by a target request handler.
FilterChain(RequestHandler) - Constructor for class org.forgerock.json.resource.FilterChain: Creates an empty filter chain.
FilterChain(RequestHandler, Collection<Filter>) - Constructor for class org.forgerock.json.resource.FilterChain: Creates a filter chain containing the provided list of filters.
FilterChain(RequestHandler, Filter...) - Constructor for class org.forgerock.json.resource.FilterChain: Creates a filter chain containing the provided list of filters.
FilterCondition - Interface in org.forgerock.json.resource: A condition which controls whether or not a filter will be invoked or not.
filterCreate(Context, CreateRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter: Filters a create request.
filterCreate(Context, CreateRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
filterDelete(Context, DeleteRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter: Filters a delete request.
filterDelete(Context, DeleteRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
filterPatch(Context, PatchRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter: Filters a patch request.
filterPatch(Context, PatchRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
filterQuery(Context, QueryRequest, QueryResourceHandler, RequestHandler) - Method in interface org.forgerock.json.resource.Filter: Filters a query request.
filterQuery(Context, QueryRequest, QueryResourceHandler, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
filterRead(Context, ReadRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter: Filters a read request.
filterRead(Context, ReadRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
filterResource(JsonValue, Collection<JsonPointer>) - Static method in class org.forgerock.json.resource.Resources: Returns a JSON object containing only the specified fields from the provided JSON value.
filterResource(ResourceResponse, Collection<JsonPointer>) - Static method in class org.forgerock.json.resource.Resources: Returns a JSON object containing only the specified fields from the provided resource.
Filters - Class in org.forgerock.json.resource: This class contains methods for creating various kinds of Filter and FilterConditions.
filterUpdate(Context, UpdateRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter: Filters an update request.
filterUpdate(Context, UpdateRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
FORBIDDEN - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource understood the request, but is refusing to fulfill it.
ForbiddenException - Exception in org.forgerock.json.resource: An exception that is thrown when access to a resource is forbidden during an operation on an resource.
ForbiddenException() - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with null as its detail message.
ForbiddenException(String) - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with the specified detail message.
ForbiddenException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with the specified detail message and cause.
ForbiddenException(Throwable) - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with the specified cause.
format(String, Object...) - Static method in class org.forgerock.json.resource.ResourcePath: Creates a new resource path using the provided path template and unencoded path elements.

G

get(int) - Method in class org.forgerock.json.resource.ResourcePath: Returns the path element at the specified position in this resource path.
getAction() - Method in interface org.forgerock.json.resource.ActionRequest: Returns the ID of the action to be performed by this action request.
getActionAsEnum(Class<T>) - Method in interface org.forgerock.json.resource.ActionRequest: Returns the ID of the action to be performed by this action request as a enum constant of the specified enum type.
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.ActionRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.CreateRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.DeleteRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.PatchRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.QueryRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.ReadRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.Request: Returns the additional parameter which should be used to control the behavior of this action request.
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.UpdateRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.ActionRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.CreateRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.DeleteRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.PatchRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.QueryRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.ReadRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.Request: Returns the additional parameters which should be used to control the behavior of this action request.
getAdditionalParameters() - Method in interface org.forgerock.json.resource.UpdateRequest
getAdvices() - Method in class org.forgerock.json.resource.AdviceContext: Returns the advices contained within this context.
getApiId() - Method in interface org.forgerock.json.resource.CrestApplication: Get the API ID, that will be used in the ApiDescription.
getApiVersion() - Method in interface org.forgerock.json.resource.CrestApplication: Get the API Version, that will be used in the ApiDescription.
getCode() - Method in exception org.forgerock.json.resource.ResourceException: Returns the numeric code of the exception.
getConnection() - Method in interface org.forgerock.json.resource.ConnectionFactory: Returns a connection to the JSON resource provider associated with this connection factory.
getConnectionAsync() - Method in interface org.forgerock.json.resource.ConnectionFactory: Asynchronously obtains a connection to the JSON resource provider associated with this connection factory.
getConnectionFactory() - Method in interface org.forgerock.json.resource.CrestApplication: Get the connection factory for the application.
getContent() - Method in interface org.forgerock.json.resource.ActionRequest: Returns the content of this action request.
getContent() - Method in interface org.forgerock.json.resource.CreateRequest: Returns the content of the JSON resource to be created.
getContent() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the JSON content of this resource.
getContent() - Method in interface org.forgerock.json.resource.UpdateRequest: Returns the content of the JSON resource to be replaced.
getDetail() - Method in exception org.forgerock.json.resource.ResourceException: Returns the additional detail which can be evaluated by applications.
getException(int) - Static method in exception org.forgerock.json.resource.ResourceException: Deprecated.
in favor of ResourceException.newResourceException(int)
getException(int, String) - Static method in exception org.forgerock.json.resource.ResourceException: Deprecated.
in favor of ResourceException.newResourceException(int, String)
getException(int, String, Throwable) - Static method in exception org.forgerock.json.resource.ResourceException: Deprecated.
in favor of ResourceException.newResourceException(int, String, Throwable)
getField() - Method in class org.forgerock.json.resource.PatchOperation: Returns the field targeted by the patch operation.
getField() - Method in class org.forgerock.json.resource.SortKey: Returns the sort key field.
getFields() - Method in interface org.forgerock.json.resource.ActionRequest
getFields() - Method in interface org.forgerock.json.resource.CreateRequest
getFields() - Method in interface org.forgerock.json.resource.DeleteRequest
getFields() - Method in interface org.forgerock.json.resource.PatchRequest
getFields() - Method in interface org.forgerock.json.resource.QueryRequest
getFields() - Method in interface org.forgerock.json.resource.ReadRequest
getFields() - Method in interface org.forgerock.json.resource.Request: Returns the list of fields which should be included with each JSON resource returned by this request.
getFields() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the list of fields which should be included in this JSON resource after field filtering has occurred.
getFields() - Method in interface org.forgerock.json.resource.UpdateRequest
getFilters() - Method in class org.forgerock.json.resource.FilterChain: Returns a modifiable list containing the list of filters in this filter chain.
getFrom() - Method in class org.forgerock.json.resource.PatchOperation: Returns the source field for move and copy operations.
getId() - Method in class org.forgerock.json.resource.IdentifierQueryResourceHandler: Gets the identifier being queried for.
getId() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the ID of this resource, if applicable.
getJsonContent() - Method in interface org.forgerock.json.resource.ActionResponse: Gets the JsonValue content contained in the Response.
getNewResourceId() - Method in interface org.forgerock.json.resource.CreateRequest: Returns the client provided ID of the resource to be created.
getNotPresent(String, String) - Static method in class org.forgerock.json.resource.AdviceWarning: Convenience method to quickly generate frequently-used error type: 100.
getOperation() - Method in class org.forgerock.json.resource.PatchOperation: Returns the type of patch operation to be performed.
getPagedResultsCookie() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the opaque cookie which is used by the resource provider to track its position in the set of query results.
getPagedResultsCookie() - Method in interface org.forgerock.json.resource.QueryResponse: Returns the opaque cookie which can be used for the next cookie-based paged request.
getPagedResultsOffset() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the zero-based index of the first resource which should be included in the query results.
getPageSize() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the requested page results page size or 0 if paged results are not required.
getPatchOperations() - Method in interface org.forgerock.json.resource.PatchRequest: Returns the list of patch operations which should be performed against the targeted resource.
getPreferredLocales() - Method in interface org.forgerock.json.resource.ActionRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.CreateRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.DeleteRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.PatchRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.QueryRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.ReadRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.Request: Get the locale preference for the request.
getPreferredLocales() - Method in interface org.forgerock.json.resource.UpdateRequest
getQueryExpression() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the native query expression which will be used for processing the query request.
getQueryFilter() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the query filter which will be used for selecting which JSON resources will be returned.
getQueryId() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the query identifier for pre-defined queries.
getReason() - Method in exception org.forgerock.json.resource.ResourceException: Returns the short reason phrase of the exception.
getRemainingPagedResults() - Method in interface org.forgerock.json.resource.QueryResponse: Returns an estimate of the total number of remaining results to be returned in subsequent paged results query requests.
getRequestType() - Method in interface org.forgerock.json.resource.ActionRequest
getRequestType() - Method in interface org.forgerock.json.resource.CreateRequest
getRequestType() - Method in interface org.forgerock.json.resource.DeleteRequest
getRequestType() - Method in interface org.forgerock.json.resource.PatchRequest
getRequestType() - Method in interface org.forgerock.json.resource.QueryRequest
getRequestType() - Method in interface org.forgerock.json.resource.ReadRequest
getRequestType() - Method in interface org.forgerock.json.resource.Request: Returns the type of this request.
getRequestType() - Method in interface org.forgerock.json.resource.UpdateRequest
getResourceApiVersion() - Method in exception org.forgerock.json.resource.ResourceException
getResourceApiVersion() - Method in interface org.forgerock.json.resource.Response: Gets the API version of the resource that the request was routed to.
getResourcePath() - Method in interface org.forgerock.json.resource.ActionRequest
getResourcePath() - Method in interface org.forgerock.json.resource.CreateRequest: Returns the path of the JSON resource container beneath which the new resource should be created.
getResourcePath() - Method in interface org.forgerock.json.resource.DeleteRequest
getResourcePath() - Method in interface org.forgerock.json.resource.PatchRequest
getResourcePath() - Method in interface org.forgerock.json.resource.QueryRequest
getResourcePath() - Method in interface org.forgerock.json.resource.ReadRequest
getResourcePath() - Method in interface org.forgerock.json.resource.Request: Returns the non-null path of the JSON resource to which this request should be targeted.
getResourcePath() - Method in interface org.forgerock.json.resource.UpdateRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.ActionRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.CreateRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.DeleteRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.PatchRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.QueryRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.ReadRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.Request: Returns the non-null path of the JSON resource to which this request should be targeted.
getResourcePathObject() - Method in interface org.forgerock.json.resource.UpdateRequest
getResourceResponse() - Method in class org.forgerock.json.resource.IdentifierQueryResourceHandler: Gets the ResourceResponse query result.
getResourceVersion() - Method in interface org.forgerock.json.resource.ActionRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.CreateRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.DeleteRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.PatchRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.QueryRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.ReadRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.Request: Gets the requested API version of the resource.
getResourceVersion() - Method in interface org.forgerock.json.resource.UpdateRequest
getRevision() - Method in interface org.forgerock.json.resource.DeleteRequest: Returns the expected version information associated with the JSON resource to be deleted.
getRevision() - Method in interface org.forgerock.json.resource.PatchRequest: Returns the expected version information associated with the JSON resource to be patched.
getRevision() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the revision of this resource, if known.
getRevision() - Method in interface org.forgerock.json.resource.UpdateRequest: Returns the expected version information associated with the JSON resource to be updated.
getSelfApiHandler() - Method in class org.forgerock.json.resource.Router
getSortKeys() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the sort keys which should be used for ordering the JSON resources returned by this query request.
getTarget() - Method in class org.forgerock.json.resource.FilterChain: Returns the target request handler which will be invoked once processing has reached the end of the filter chain.
getThis() - Method in class org.forgerock.json.resource.Router
getTotalPagedResults() - Method in interface org.forgerock.json.resource.QueryResponse: Returns the total number of paged results in adherence with the QueryRequest.getTotalPagedResultsPolicy() in the request or QueryResponse.NO_COUNT if paged results were not requested, the count policy is NONE, or the total number of paged results is unknown.
getTotalPagedResultsPolicy() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the CountPolicy used to calculate QueryResponse.getTotalPagedResults().
getTotalPagedResultsPolicy() - Method in interface org.forgerock.json.resource.QueryResponse: Returns the policy that was used to calculate the totalPagedResults.
getValue() - Method in class org.forgerock.json.resource.PatchOperation: Returns the value for the patch operation.

H

handleAction(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractRequestHandler: Handles performing an action on a resource, and optionally returns an associated result.
handleAction(Context, ActionRequest) - Method in class org.forgerock.json.resource.FilterChain
handleAction(Context, ActionRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Handles performing an action on a resource, and optionally returns an associated result.
handleAction(Context, ActionRequest) - Method in class org.forgerock.json.resource.Router
handleAction(Context, ActionRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Handles performing an action on a resource, and optionally returns an associated result.
handleAction(Context, ActionRequest) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.FilterChain
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.Router
handleCreate(Context, CreateRequest) - Method in class org.forgerock.json.resource.AbstractRequestHandler: Adds a new JSON resource, returning a Promise that will be completed when the resource has been added.
handleCreate(Context, CreateRequest) - Method in class org.forgerock.json.resource.FilterChain
handleCreate(Context, CreateRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Adds a new JSON resource, returning a Promise that will be completed when the resource has been added.
handleCreate(Context, CreateRequest) - Method in class org.forgerock.json.resource.Router
handleCreate(Context, CreateRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Adds a new JSON resource.
handleCreate(Context, CreateRequest) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.AbstractRequestHandler: Deletes a JSON resource, returning a Promise that will be completed when the resource has been deleted.
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.FilterChain
handleDelete(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Deletes a JSON resource, returning a Promise that will be completed when the resource has been deleted.
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.Router
handleDelete(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Deletes a JSON resource.
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handlePatch(Context, PatchRequest) - Method in class org.forgerock.json.resource.AbstractRequestHandler: 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.
handlePatch(Context, PatchRequest) - Method in class org.forgerock.json.resource.FilterChain
handlePatch(Context, PatchRequest) - Method in interface org.forgerock.json.resource.RequestHandler: 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.
handlePatch(Context, PatchRequest) - Method in class org.forgerock.json.resource.Router
handlePatch(Context, PatchRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Updates a JSON resource by applying a set of changes to its existing content.
handlePatch(Context, PatchRequest) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handleQuery(Context, QueryRequest, Collection<ResourceResponse>) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Searches for all JSON resources matching a user specified set of criteria.
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractRequestHandler: Searches for all JSON resources matching a user specified set of criteria, returning a Promise that will be completed when the search has completed.
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.FilterChain
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.RequestHandler: Searches for all JSON resources matching a user specified set of criteria, returning a Promise that will be completed when the search has completed.
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.Router
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractRequestHandler: Reads a JSON resource, returning a Promise that will be completed when the resource has been read.
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.FilterChain
handleRead(Context, ReadRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Reads a JSON resource, returning a Promise that will be completed when the resource has been read.
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.Router
handleRead(Context, ReadRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Reads a JSON resource.
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handleResource(ResourceResponse) - Method in class org.forgerock.json.resource.IdentifierQueryResourceHandler
handleResource(ResourceResponse) - Method in interface org.forgerock.json.resource.QueryResourceHandler: Invoked each time a matching JSON resource is returned from a query request.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.json.resource.AbstractRequestHandler: 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.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.json.resource.FilterChain
handleUpdate(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.RequestHandler: 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.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.json.resource.Router
handleUpdate(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Updates a JSON resource by replacing its existing content with new content.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
hasFields() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns true if any fields have been added, indicating that the list of fields in this response should be included in this JSON resource after field filtering has occurred, otherwise returns false indicating that the original list of fields in the request should be used for filtering the response.
hashCode() - Method in class org.forgerock.json.resource.ResourcePath: Returns a hash code for this resource path.
hashCode() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the hash code for this resource.
hashCode() - Method in class org.forgerock.json.resource.SortKey
head(int) - Method in class org.forgerock.json.resource.ResourcePath: Returns a resource path which is a subsequence of the path elements contained in this resource path beginning with the first element (0) and ending with the element at position endIndex-1.
HEURISTIC_EXPIRATION - Static variable in class org.forgerock.json.resource.AdviceWarning: 113 Heuristic expiration MUST be included if the cache heuristically chose a freshness lifetime greater than 24 hours and the response's age is greater than 24 hours.

I

IdentifierQueryResourceHandler - Class in org.forgerock.json.resource: QueryResourceHandler that searches for a specific identifier value.
IdentifierQueryResourceHandler(String) - Constructor for class org.forgerock.json.resource.IdentifierQueryResourceHandler: Creates a new QueryResourceHandler for the given identifier.
includeCauseInJsonValue() - Method in exception org.forgerock.json.resource.ResourceException: Returns this ResourceException with the includeCause flag set to true so that toJsonValue() method will include the cause if there is one supplied.
increment(String, Number) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "increment" patch operation which will increment the value(s) of the specified field by the amount provided.
increment(JsonPointer, Number) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "increment" patch operation which will increment the value(s) of the specified field by the amount provided.
INTERNAL_ERROR - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that a resource encountered an unexpected condition which prevented it from fulfilling the request.
InternalServerErrorException - Exception in org.forgerock.json.resource: 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.
InternalServerErrorException() - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with null as its detail message.
InternalServerErrorException(String) - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with the specified detail message.
InternalServerErrorException(String, Throwable) - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with the specified detail message and cause.
InternalServerErrorException(Throwable) - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with the specified cause.
isAdd() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "add" patch operation.
isAscendingOrder() - Method in class org.forgerock.json.resource.SortKey: Returns true if this sort key is in ascending order, or false if it is in descending order.
isClosed() - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Indicates whether or not this connection has been explicitly closed by calling close.
isClosed() - Method in interface org.forgerock.json.resource.Connection: Indicates whether or not this connection has been explicitly closed by calling close.
isCopy() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is a "copy" patch operation.
isEmpty() - Method in class org.forgerock.json.resource.ResourcePath: Returns true if this resource path contains no path elements.
isIncrement() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "increment" patch operation.
isMove() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is a "move" patch operation.
isRemove() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "remove" patch operation.
isReplace() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "replace" patch operation.
isServerError() - Method in exception org.forgerock.json.resource.ResourceException: Returns true if the HTTP error code is in the 500 range.
isTransform() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is a "transform" patch operation.
isValid() - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Returns true if this connection has not been closed and no fatal errors have been detected.
isValid() - Method in interface org.forgerock.json.resource.Connection: Returns true if this connection has not been closed and no fatal errors have been detected.
iterator() - Method in class org.forgerock.json.resource.ResourcePath: Returns an iterator over the path elements in this resource path.

L

leaf() - Method in class org.forgerock.json.resource.ResourcePath: Returns the last path element in this resource path.

M

matches(Context, Request) - Method in interface org.forgerock.json.resource.FilterCondition: Returns true if the conditional filter should be invoked, or false if processing should continue directly to the next filter in the filter chain.
matchRequestType(Set<RequestType>) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose type is contained in types.
matchRequestType(RequestType...) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose type is contained in types.
matchResourcePath(String) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose resource path matches the provided regular expression.
matchResourcePath(Pattern) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose resource path matches the provided regular expression.
MemoryBackend - Class in org.forgerock.json.resource: A simple in-memory collection resource provider which uses a Map to store resources.
MemoryBackend() - Constructor for class org.forgerock.json.resource.MemoryBackend: Creates a new in-memory collection containing no resources.
MISCELLANEOUS_PERSISTENT_WARNING - Static variable in class org.forgerock.json.resource.AdviceWarning: 299 Miscellaneous persistent warning The warning text MAY include arbitrary information to be presented to a human user, or logged.
MISCELLANEOUS_WARNING - Static variable in class org.forgerock.json.resource.AdviceWarning: 199 Miscellaneous warning The warning text MAY include arbitrary information to be presented to a human user, or logged.
move(String, String) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "move" patch operation which will move the value found at `from` to `path`.
move(JsonPointer, JsonPointer) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "move" patch operation which will move the value found at `from` to `path`.

N

newActionRequest(String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource path and action ID.
newActionRequest(String, String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource container path, resource ID, and action ID.
newActionRequest(ResourcePath, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource path and action ID.
newActionRequest(ResourcePath, String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource container path, resource ID, and action ID.
newActionResponse(JsonValue) - Static method in class org.forgerock.json.resource.Responses: Returns a new JsonValue response with the provided JSON content.
newAdviceWarning(String, String, Object...) - Static method in class org.forgerock.json.resource.AdviceWarning: Generate a warning using the builder provided.
newAnnotatedRequestHandler(Object) - Static method in class org.forgerock.json.resource.Resources: Deprecated.
Use Resources.newHandler(Object) instead.
newApiRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new API request with the provided path.
newCollection(Object) - Static method in class org.forgerock.json.resource.Resources: Deprecated.
Use Resources.newHandler(Object) instead.
newCreateRequest(String, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, new resource ID, and JSON content.
newCreateRequest(String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, and JSON content.
newCreateRequest(ResourcePath, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, new resource ID, and JSON content.
newCreateRequest(ResourcePath, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, and JSON content.
newDeleteRequest(String) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource path.
newDeleteRequest(String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource container path, and resource ID.
newDeleteRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource path.
newDeleteRequest(ResourcePath, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource container path, and resource ID.
newHandler(Object) - Static method in class org.forgerock.json.resource.Resources: Creates a new RequestHandler backed by the supplied provider.
newInternalConnection(RequestHandler) - Static method in class org.forgerock.json.resource.Resources: Creates a new connection to a RequestHandler.
newInternalConnectionFactory(RequestHandler) - Static method in class org.forgerock.json.resource.Resources: Creates a new connection factory which binds internal client connections to RequestHandlers.
newPatchRequest(String, String, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource container path, resource ID, and JSON patch operations.
newPatchRequest(String, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource path and JSON patch operations.
newPatchRequest(ResourcePath, String, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource container path, resource ID, and JSON patch operations.
newPatchRequest(ResourcePath, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource path and JSON patch operations.
newQueryRequest(String) - Static method in class org.forgerock.json.resource.Requests: Returns a new query request with the provided resource container path.
newQueryRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new query request with the provided resource container path.
newQueryResponse() - Static method in class org.forgerock.json.resource.Responses: Creates a new query result with a null paged results cookie and no count of the total number of remaining results.
newQueryResponse(String) - Static method in class org.forgerock.json.resource.Responses: Creates a new query result with the provided paged results cookie and no count.
newQueryResponse(String, CountPolicy, int) - Static method in class org.forgerock.json.resource.Responses: Creates a new query result with the provided paged results cookie and a count of the total number of remaining results according to totalPagedResultsPolicy.
newReadRequest(String) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource path.
newReadRequest(String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource container path, and resource ID.
newReadRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource path.
newReadRequest(ResourcePath, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource container path, and resource ID.
newRemainingResultsResponse(String, int) - Static method in class org.forgerock.json.resource.Responses: Deprecated.
Use Responses.newQueryResponse(String, CountPolicy, int) instead.
newResourceApiVersionBehaviourManager() - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a new ResourceApiVersionBehaviourManager which is responsibly for managing whether warning headers are returned and the default version behaviour when the Accept-API-Version header is not present on the request.
newResourceException(int) - Static method in exception org.forgerock.json.resource.ResourceException: Returns an exception with the specified HTTP error code, but no detail message or cause, and a default reason phrase.
newResourceException(int, String) - Static method in exception org.forgerock.json.resource.ResourceException: Returns an exception with the specified HTTP error code and detail message, but no cause, and a default reason phrase.
newResourceException(int, String, Throwable) - Static method in exception org.forgerock.json.resource.ResourceException: Returns an exception with the specified HTTP error code, detail message, and cause, and a default reason phrase.
newResourceResponse(String, String, JsonValue) - Static method in class org.forgerock.json.resource.Responses: Returns a new Resource response with the provided Resource as content.
newSingleton(Object) - Static method in class org.forgerock.json.resource.Resources: Deprecated.
Use Resources.newHandler(Object) instead.
newUpdateRequest(String, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource container path, resource ID, and new JSON content.
newUpdateRequest(String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource path and new JSON content.
newUpdateRequest(ResourcePath, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource container path, resource ID, and new JSON content.
newUpdateRequest(ResourcePath, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource path and new JSON content.
NO_COUNT - Static variable in interface org.forgerock.json.resource.QueryResponse: The value provided when no count is known or can reasonably be supplied.
NONE - Enum constant in enum org.forgerock.json.resource.CountPolicy: There should be no count returned.
not(FilterCondition) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will match requests which do not match the provided condition.
NOT_FOUND - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource could not be found.
NOT_PRESENT - Static variable in class org.forgerock.json.resource.AdviceWarning: 100 Indicates that there is data missing from the request.
NOT_SUPPORTED - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource does not implement/support the feature to fulfill the request HTTP status: 501 Not Implemented.
NotFoundException - Exception in org.forgerock.json.resource: An exception that is thrown when a specified resource cannot be found.
NotFoundException() - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with null as its detail message.
NotFoundException(String) - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with the specified detail message.
NotFoundException(String, Throwable) - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with the specified detail message and cause.
NotFoundException(Throwable) - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with the specified cause.
NotSupportedException - Exception in org.forgerock.json.resource: An exception that is thrown during an operation on a resource when the resource does not implement/support the feature to fulfill the request.
NotSupportedException() - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with null as its detail message.
NotSupportedException(String) - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with the specified detail message.
NotSupportedException(String, Throwable) - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with the specified detail message and cause.
NotSupportedException(Throwable) - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with the specified cause.

O

operation(String, String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new patch operation having the specified operation type, field, and value(s).
operation(String, JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new patch operation having the specified operation type, field, and value(s).
OPERATION_ADD - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "add" operations.
OPERATION_COPY - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "copy" operations.
OPERATION_INCREMENT - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "increment" operations.
OPERATION_MOVE - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "move" operations.
OPERATION_REMOVE - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "remove" operations.
OPERATION_REPLACE - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "replace" operations.
OPERATION_TRANSFORM - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "transform" operations.
or(Collection<FilterCondition>) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will match requests which match any of the provided conditions.
or(FilterCondition...) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will match requests which match any of the provided conditions.
org.forgerock.json.resource - package org.forgerock.json.resource: Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.json.resource.annotations - package 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.

P

parent() - Method in class org.forgerock.json.resource.ResourcePath: Returns the resource path which is the immediate parent of this resource path, or null if this resource path is empty.
parse(String) - Static method in class org.forgerock.json.resource.QueryFilters: Parses the provided query string into a QueryFilter.
patch(Context, PatchRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
patch(Context, PatchRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Updates a JSON resource by applying a set of changes to its existing content.
patch(Context, PatchRequest) - Method in interface org.forgerock.json.resource.Connection: Updates a JSON resource by applying a set of changes to its existing content.
PATCH - Enum constant in enum org.forgerock.json.resource.RequestType: A patch request.
patchAsync(Context, PatchRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously updates a JSON resource by applying a set of changes to its existing content.
patchAsync(Context, PatchRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously updates a JSON resource by applying a set of changes to its existing content.
patchInstance(Context, String, PatchRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Patches an existing resource within the collection.
patchInstance(Context, String, PatchRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Patches an existing resource within the collection.
patchInstance(Context, PatchRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider: Patches the single resource instance.
PatchOperation - Class in org.forgerock.json.resource: An individual patch operation which is to be performed against a field within a resource.
PatchRequest - Interface in org.forgerock.json.resource: A request to update a JSON resource by applying a set of changes to its existing content.
PermanentException - Exception in org.forgerock.json.resource: An exception that indicates that a failure is permanent, i.e. that re-trying alone without addressing the cause is not expected to succeed.
PermanentException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.PermanentException: Constructs a new exception with the specified detail message and cause.
PreconditionFailedException - Exception in org.forgerock.json.resource: An exception that is thrown to indicate that a resource's current version does not match the version provided.
PreconditionFailedException() - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with null as its detail message.
PreconditionFailedException(String) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with the specified detail message.
PreconditionFailedException(String, Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with the specified detail message and cause.
PreconditionFailedException(Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with the specified cause.
PreconditionRequiredException - Exception in org.forgerock.json.resource: An exception that is thrown to indicate that a resource requires a version, but no version was supplied in the request.
PreconditionRequiredException() - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with null as its detail message.
PreconditionRequiredException(String) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with the specified detail message.
PreconditionRequiredException(String, Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with the specified detail message and cause.
PreconditionRequiredException(Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with the specified cause.
putAdvice(String, String...) - Method in class org.forgerock.json.resource.AdviceContext: Adds advice to the context, which can be retrieved and later returned to the user.

Q

query(Context, QueryRequest, Collection<? super ResourceResponse>) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
query(Context, QueryRequest, Collection<? super ResourceResponse>) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Searches for all JSON resources matching a user specified set of criteria, and places the results in the provided collection.
query(Context, QueryRequest, Collection<? super ResourceResponse>) - Method in interface org.forgerock.json.resource.Connection: Searches for all JSON resources matching a user specified set of criteria, and places the results in the provided collection.
query(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
query(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
query(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.Connection: Searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
QUERY - Enum constant in enum org.forgerock.json.resource.RequestType: A query request.
queryAsync(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
queryAsync(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.Connection: Asynchronously searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Searches the collection for all resources which match the query request criteria.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.MemoryBackend: Searches the collection for all resources which match the query request criteria.
QueryFilters - Class in org.forgerock.json.resource: Convenience methods to create QueryFilter that specify fields in terms of JsonPointer instances.
QueryRequest - Interface in org.forgerock.json.resource: A request to search for all JSON resources matching a user specified set of criteria.
QueryResourceHandler - Interface in org.forgerock.json.resource: A completion handler for consuming the results of a query request.
QueryResponse - Interface in org.forgerock.json.resource: The final result of a query request returned after all resources matching the request have been returned.

R

read(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
read(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Reads a JSON resource.
read(Context, ReadRequest) - Method in interface org.forgerock.json.resource.Connection: Reads a JSON resource.
READ - Enum constant in enum org.forgerock.json.resource.RequestType: A read request.
readAsync(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously reads a JSON resource.
readAsync(Context, ReadRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously reads a JSON resource.
readInstance(Context, String, ReadRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Reads an existing resource within the collection.
readInstance(Context, String, ReadRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Reads an existing resource within the collection.
readInstance(Context, ReadRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider: Reads the single resource instance.
ReadRequest - Interface in org.forgerock.json.resource: A request to read a single identified JSON resource.
remove(String) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the specified field.
remove(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the provided value(s) from the specified field.
remove(JsonPointer) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the specified field.
remove(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the provided value(s) from the specified field.
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.FilterChain
replace(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "replace" patch operation which will replace the value(s) of the specified field with the provided value(s).
replace(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "replace" patch operation which will replace the value(s) of the specified field with the provided value(s).
Request - Interface in org.forgerock.json.resource: Common attributes of all JSON resource requests.
RequestHandler - Interface in org.forgerock.json.resource: Represents the contract with a set of resources.
requestResourceApiVersionMatcher(Version) - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a RouteMatcher instance that matches the request resource API version with the provided version.
Requests - Class in org.forgerock.json.resource: A utility class containing various factory methods for creating and manipulating requests.
RequestType - Enum in org.forgerock.json.resource: An enumeration whose values represent the different types of request.
requestUriMatcher(RoutingMode, String) - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a RouteMatcher instance that matches Requests with the provided mode and template.
RequestVisitor<R,P> - Interface in org.forgerock.json.resource: A visitor of Requests, in the style of the visitor design pattern.
resourceApiVersionContextFilter(ResourceApiVersionBehaviourManager) - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a Filter which MUST be placed, in the route, before any API Version routing takes place.
ResourceApiVersionRoutingFilter - Class in org.forgerock.json.resource: 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 - Exception in org.forgerock.json.resource: An exception that is thrown during the processing of a JSON resource request.
ResourceException(int) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code, and null as its detail message.
ResourceException(int, String) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code and detail message.
ResourceException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code, reason phrase, detail message and cause.
ResourceException(int, Throwable) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code and detail message.
resourcePath(String) - Static method in class org.forgerock.json.resource.ResourcePath: Parses the provided string representation of a resource path.
ResourcePath - Class in org.forgerock.json.resource: A relative path, or URL, to a resource.
ResourcePath() - Constructor for class org.forgerock.json.resource.ResourcePath: Creates a new empty resource path whose string representation is the empty string and which has zero path elements.
ResourcePath(Object...) - Constructor for class org.forgerock.json.resource.ResourcePath: Creates a new resource path having the provided path elements.
ResourcePath(Collection<? extends Object>) - Constructor for class org.forgerock.json.resource.ResourcePath: Creates a new resource path having the provided path elements.
ResourceResponse - Interface in org.forgerock.json.resource: A resource, comprising of a resource ID, a revision (etag), and its JSON content.
Resources - Class in org.forgerock.json.resource: This class contains methods for creating and manipulating connection factories and connections.
Response - Interface in org.forgerock.json.resource: Common response object of all resource responses.
RESPONSE_STALE - Static variable in class org.forgerock.json.resource.AdviceWarning: 110 Response is stale MUST be included whenever the returned response is stale.
Responses - Class in org.forgerock.json.resource: A utility class containing various factory methods for creating and manipulating responses.
RetryableException - Exception in org.forgerock.json.resource: An exception that indicates that a failure may be temporary, and that retrying the same request may be able to succeed in the future.
RetryableException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.RetryableException: Constructs a new exception with the specified detail message and cause.
REVALIDATION_FAILED - Static variable in class org.forgerock.json.resource.AdviceWarning: 111 Revalidation failed MUST be included if a cache returns a stale response because an attempt to revalidate the response failed, due to an inability to reach the server.
reverseOrder(SortKey) - Static method in class org.forgerock.json.resource.SortKey: Creates a new sort key having the same field as the provided key, but in reverse sort order.
RouteMatchers - Class in org.forgerock.json.resource: A utility class that contains methods for creating route matchers.
Router - Class in org.forgerock.json.resource: A router which routes requests based on route predicates.
Router() - Constructor for class org.forgerock.json.resource.Router: Creates a new router with no routes defined.
Router(AbstractRouter<Router, Request, RequestHandler, ApiDescription>) - Constructor for class org.forgerock.json.resource.Router: Creates a new router containing the same routes and default route as the provided router.
Router.UriTemplate - Class in org.forgerock.json.resource: Represents a URI template string that will be used to match and route incoming requests.

S

ServiceUnavailableException - Exception in org.forgerock.json.resource: An exception that is thrown during an operation on a resource when the server is temporarily unable to handle the request.
ServiceUnavailableException() - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with null as its detail message.
ServiceUnavailableException(String) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with the specified detail message.
ServiceUnavailableException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with the specified detail message and cause.
ServiceUnavailableException(Throwable) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with the specified cause.
setAction(String) - Method in interface org.forgerock.json.resource.ActionRequest: Sets the ID of the action to be performed by this action request.
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.ActionRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.CreateRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.DeleteRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.PatchRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.QueryRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.ReadRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.Request: Sets an additional parameter which should be used to control the behavior of this action request.
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.UpdateRequest
setContent(JsonValue) - Method in interface org.forgerock.json.resource.ActionRequest: Sets the content of this action request.
setContent(JsonValue) - Method in interface org.forgerock.json.resource.CreateRequest: Sets the content of the JSON resource to be created.
setContent(JsonValue) - Method in interface org.forgerock.json.resource.UpdateRequest: Sets the content of the JSON resource to be replaced.
setDetail(JsonValue) - Method in exception org.forgerock.json.resource.ResourceException: Sets the additional detail which can be evaluated by applications.
setNewResourceId(String) - Method in interface org.forgerock.json.resource.CreateRequest: Sets the client provided ID of the resource to be created.
setPagedResultsCookie(String) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the opaque cookie which is used by the resource provider to track its position in the set of query results.
setPagedResultsOffset(int) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the zero-based index of the first resource which should be included in the query results.
setPageSize(int) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the requested page results page size or 0 if paged results are not required.
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.ActionRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.CreateRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.DeleteRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.PatchRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.QueryRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.ReadRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.Request: Set the locale preference for the request.
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.UpdateRequest
setQueryExpression(String) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the native query expression which will be used for processing the query request.
setQueryFilter(QueryFilter<JsonPointer>) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the query filter which will be used for selecting which JSON resources will be returned.
setQueryId(String) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the query identifier for pre-defined queries.
setReason(String) - Method in exception org.forgerock.json.resource.ResourceException: Sets/overrides the short reason phrase of the exception.
setResourceApiVersion(Version) - Method in exception org.forgerock.json.resource.ResourceException
setResourceApiVersion(Version) - Method in interface org.forgerock.json.resource.Response: Sets the API version of the resource that the request was routed to.
setResourcePath(String) - Method in interface org.forgerock.json.resource.ActionRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.CreateRequest: Sets the path of the JSON resource container beneath which the new resource should be created.
setResourcePath(String) - Method in interface org.forgerock.json.resource.DeleteRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.PatchRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.QueryRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.ReadRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.Request: Sets the non-null path of the JSON resource to which this request should be targeted.
setResourcePath(String) - Method in interface org.forgerock.json.resource.UpdateRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.ActionRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.CreateRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.DeleteRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.PatchRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.QueryRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.ReadRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.Request: Sets the non-null path of the JSON resource to which this request should be targeted.
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.UpdateRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.ActionRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.CreateRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.DeleteRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.PatchRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.QueryRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.ReadRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.Request: Sets the requested API version of the resource.
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.UpdateRequest
setRevision(String) - Method in interface org.forgerock.json.resource.DeleteRequest: Sets the expected version information associated with the JSON resource to be deleted.
setRevision(String) - Method in interface org.forgerock.json.resource.PatchRequest: Sets the expected version information associated with the JSON resource to be patched.
setRevision(String) - Method in interface org.forgerock.json.resource.UpdateRequest: Sets the expected version information associated with the JSON resource to be updated.
setTarget(RequestHandler) - Method in class org.forgerock.json.resource.FilterChain: Sets the target request handler which will be invoked once processing has reached the end of the filter chain.
setTotalPagedResultsPolicy(CountPolicy) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the policy for calculating the total number of paged results.
simpleCrestApplication(ConnectionFactory, String, String) - Static method in class org.forgerock.json.resource.Applications: Create a simple CrestApplication using the provided factory, id and version.
SingletonResourceProvider - Interface in org.forgerock.json.resource: An implementation interface for resource providers which exposes a single permanent resource instance.
size() - Method in class org.forgerock.json.resource.ResourcePath: Returns the number of elements in this resource path, or 0 if it is empty.
SortKey - Class in org.forgerock.json.resource: 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.
startsWith(String) - Method in class org.forgerock.json.resource.ResourcePath: Returns true if this resource path is equal to or begins with the provided resource resource path.
startsWith(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath: Returns true if this resource path is equal to or begins with the provided resource resource path.
subSequence(int, int) - Method in class org.forgerock.json.resource.ResourcePath: Returns a resource path which is a subsequence of the path elements contained in this resource path beginning with the element at position beginIndex and ending with the element at position endIndex-1.
SynchronousRequestHandler - Interface in org.forgerock.json.resource: An interface for implementing synchronous RequestHandlers.

T

tail(int) - Method in class org.forgerock.json.resource.ResourcePath: Returns a resource path which is a subsequence of the path elements contained in this resource path beginning with the element at position beginIndex and ending with the last element in this resource path.
toJsonValue() - Method in interface org.forgerock.json.resource.ActionRequest
toJsonValue() - Method in interface org.forgerock.json.resource.CreateRequest
toJsonValue() - Method in interface org.forgerock.json.resource.DeleteRequest
toJsonValue() - Method in class org.forgerock.json.resource.PatchOperation: Returns a JSON value representation of this patch operation.
toJsonValue() - Method in interface org.forgerock.json.resource.PatchRequest
toJsonValue() - Method in interface org.forgerock.json.resource.QueryRequest
toJsonValue() - Method in interface org.forgerock.json.resource.ReadRequest
toJsonValue() - Method in interface org.forgerock.json.resource.Request: Return a JsonValue representation of this request.
toJsonValue() - Method in exception org.forgerock.json.resource.ResourceException: Returns the exception in a JSON object structure, suitable for inclusion in the entity of an HTTP error response.
toJsonValue() - Method in interface org.forgerock.json.resource.UpdateRequest
toString() - Method in class org.forgerock.json.resource.AdviceWarning
toString() - Method in class org.forgerock.json.resource.FilterChain
toString() - Method in class org.forgerock.json.resource.PatchOperation
toString() - Method in class org.forgerock.json.resource.ResourcePath: Returns the URL path encoded string representation of this resource path.
toString() - Method in class org.forgerock.json.resource.Router.UriTemplate: Return the string representation of the UriTemplate.
toString() - Method in class org.forgerock.json.resource.SortKey: Returns the string representation of this sort key.
TRANFORMATION_APPLIED - Static variable in class org.forgerock.json.resource.AdviceWarning: 214 Transformation applied MUST be added by an intermediate cache or proxy if it applies any transformation changing the content-coding (as specified in the Content-Encoding header) or media-type (as specified in the Content-Type header) of the response, or the entity-body of the response, unless this Warning code already appears in the response.
transform(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "transform" patch operation which sets the value at field based on a transformation.
transform(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "transform" patch operation which sets the value at field based on a transformation.
transform(Context) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Optional Context-transformation function if the implementer has requirements to override the Context provided in the Connection's method invocations.

U

UNAVAILABLE - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource is temporarily unable to handle the request.
UncategorizedException - Exception in org.forgerock.json.resource: 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.
UncategorizedException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.UncategorizedException: Constructs a new exception with the specified detail message and cause.
uncloseable(Connection) - Static method in class org.forgerock.json.resource.Resources: Returns an uncloseable view of the provided connection.
uncloseable(ConnectionFactory) - Static method in class org.forgerock.json.resource.Resources: Returns an uncloseable view of the provided connection factory.
Unsupported - Annotation Type in org.forgerock.json.resource.annotations: Mark a method on a resource provider interface implementation as not supported.
update(Context, UpdateRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
update(Context, UpdateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Updates a JSON resource by replacing its existing content with new content.
update(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.Connection: Updates a JSON resource by replacing its existing content with new content.
UPDATE - Enum constant in enum org.forgerock.json.resource.RequestType: An update request.
updateAsync(Context, UpdateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously updates a JSON resource by replacing its existing content with new content.
updateAsync(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously updates a JSON resource by replacing its existing content with new content.
updateInstance(Context, String, UpdateRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Updates an existing resource within the collection.
updateInstance(Context, String, UpdateRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Updates an existing resource within the collection.
updateInstance(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider: Updates the single resource instance.
UpdateRequest - Interface in org.forgerock.json.resource: A request to update a JSON resource by replacing its existing content with new content.
uriMatcher(RoutingMode, String) - Method in class org.forgerock.json.resource.Router
uriTemplate(String) - Static method in class org.forgerock.json.resource.Router: Creates a Router.UriTemplate from a URI template string that will be used to match and route incoming requests.

V

valueOf(String) - Static method in enum org.forgerock.json.resource.CountPolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.resource.RequestType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.json.resource.ResourcePath: Parses the provided string representation of a resource path.
valueOf(String) - Static method in class org.forgerock.json.resource.SortKey: Parses the provided string as a sort key.
valueOf(JsonValue) - Static method in class org.forgerock.json.resource.PatchOperation: Parses the provided JSON content as a patch operation.
valueOfList(JsonValue) - Static method in class org.forgerock.json.resource.PatchOperation: Parses the provided JSON content as a list of patch operations.
values() - Static method in enum org.forgerock.json.resource.CountPolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.resource.RequestType: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_MISMATCH - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource's current version does not match the version provided.
VERSION_REQUIRED - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource requires a version, but no version was supplied in the request.
visitActionRequest(P, ActionRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits an action request.
visitCreateRequest(P, CreateRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a create request.
visitDeleteRequest(P, DeleteRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a delete request.
visitPatchRequest(P, PatchRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a patch request.
visitQueryRequest(P, QueryRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a query request.
visitReadRequest(P, ReadRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a read request.
visitUpdateRequest(P, UpdateRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits an update request.

A B C D E F G H I L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form