Index (Wren Security Commons REST - JSON Resource HTTP Binding 23.0.0-SNAPSHOT Documentation)

A C D G H N O P S
All Classes and Interfaces|All Packages|Constant Field Values

A

ATTR_HEADERS - Static variable in class org.forgerock.json.resource.http.HttpContext: Attribute in the serialized JSON form that holds the request headers.
ATTR_METHOD - Static variable in class org.forgerock.json.resource.http.HttpContext: Attribute in the serialised JSON form that holds the HTTP method of the request.
ATTR_PARAMETERS - Static variable in class org.forgerock.json.resource.http.HttpContext: Attribute in the serialized JSON form that holds the query and/or form parameters.
ATTR_PATH - Static variable in class org.forgerock.json.resource.http.HttpContext: Attribute in the serialised JSON form that holds the full URI of the request, excluding anything beyond the path component (i.e., no query parameters).
ATTRIBUTE_AUTHCID - Static variable in class org.forgerock.json.resource.http.SecurityContextFactory: Deprecated.

The name of the HTTP Request attribute where this factory expects to find the authenticated user's authentication ID.
ATTRIBUTE_AUTHZID - Static variable in class org.forgerock.json.resource.http.SecurityContextFactory: Deprecated.

The name of the HTTP Request attribute where this factory expects to find the authenticated user's authorization ID.

C

CONTENT_DISPOSITION - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP header for Content-Disposition.
createContext(Context) - Method in class org.forgerock.json.resource.http.SecurityContextFactory: Deprecated.

Creates a new SecurityContext using the attributes contained in the provided HTTP request.
createContext(Context, Request) - Method in interface org.forgerock.json.resource.http.HttpContextFactory: Returns the context which should be used for the provided HTTP request.
createContext(Context, Request) - Method in class org.forgerock.json.resource.http.SecurityContextFactory: Deprecated.

Creates a new SecurityContext using the attributes contained in the provided HTTP request.
CrestHttp - Class in org.forgerock.json.resource.http: A CREST HTTP utility class which creates instances of the HttpAdapter to handle CREST HTTP requests.

D

DEFAULT_PROTOCOL_VERSION - Static variable in class org.forgerock.json.resource.http.HttpUtils: The default version of the named protocol.
determineRequestType(Request) - Static method in class org.forgerock.json.resource.http.HttpUtils: Determines which CREST operation (CRUDPAQ) of the incoming request.

G

getHeader(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable list containing the values of the named HTTP request header.
getHeaderAsString(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns the first value of the named HTTP request header.
getHeaders() - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable map of the HTTP request headers.
getHttpServletContextFactory() - Static method in class org.forgerock.json.resource.http.SecurityContextFactory: Deprecated.

Returns the singleton security context factory which can be used for obtaining context information from a HTTP request.
getMethod() - Method in class org.forgerock.json.resource.http.HttpContext: Returns the effective HTTP method, taking into account presence of the X-HTTP-Method-Override header.
getParameter(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable list containing the values of the named HTTP request parameter.
getParameterAsString(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns the first value of the named HTTP request parameter.
getParameters() - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable map of the HTTP request parameters.
getPath() - Method in class org.forgerock.json.resource.http.HttpContext: Returns the HTTP request path.

H

HttpContext - Class in org.forgerock.json.resource.http: A Context containing information relating to the originating HTTP request.
HttpContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.json.resource.http.HttpContext: Restore from JSON representation.
HttpContextFactory - Interface in org.forgerock.json.resource.http: A factory which is responsible for creating new request Contexts for each JSON request.
HttpUtils - Class in org.forgerock.json.resource.http: HTTP utility methods and constants.

N

newConnectionFactory(Handler, URI) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new ConnectionFactory that map back and forth JSON resource objects to CHF objects.
newHttpHandler(ConnectionFactory) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newHttpHandler(ConnectionFactory, HttpContextFactory) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newHttpHandler(ConnectionFactory, Context) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newHttpHandler(CrestApplication) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new JSON resource HTTP handler with the provided CREST request handler.
newHttpHandler(CrestApplication, HttpContextFactory) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new JSON resource HTTP handler with the provided CREST request handler.
newHttpHandler(CrestApplication, Context) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new JSON resource HTTP handler with the provided CREST request handler.
newHttpHandler(RequestHandler) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newRequestHandler(Handler, URI) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new RequestHandler that map back and forth JSON resource objects to CHF objects.

O

org.forgerock.json.resource.http - package org.forgerock.json.resource.http: JSON resource Commons HTTP Framework integration.

P

PARAM_ACTION - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter for an action.
PARAM_CREST_API - Static variable in class org.forgerock.json.resource.http.HttpUtils: Request the CREST API Descriptor.
PARAM_FIELDS - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify which fields to return.
PARAM_MIME_TYPE - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to request a certain mimetype for a filed.
PARAM_PAGE_SIZE - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to request a certain page size.
PARAM_PAGED_RESULTS_COOKIE - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a paged results cookie.
PARAM_PAGED_RESULTS_OFFSET - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a paged results offset.
PARAM_PRETTY_PRINT - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to request pretty printing.
PARAM_QUERY_EXPRESSION - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a query expression.
PARAM_QUERY_FILTER - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a query filter.
PARAM_QUERY_ID - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a query id.
PARAM_SORT_KEYS - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify the sort keys.
PARAM_TOTAL_PAGED_RESULTS_POLICY - Static variable in class org.forgerock.json.resource.http.HttpUtils: The policy used for counting total paged results.
PROTOCOL_VERSION_1 - Static variable in class org.forgerock.json.resource.http.HttpUtils: Protocol Version 1.
PROTOCOL_VERSION_2 - Static variable in class org.forgerock.json.resource.http.HttpUtils: Protocol Version 2 - supports upsert on PUT.
PROTOCOL_VERSION_2_1 - Static variable in class org.forgerock.json.resource.http.HttpUtils: Protocol Version 2.1 - supports defacto standard for create requests when the ID of the created resource is to be allocated by the server, which are represented as a POST to the collection endpoint without an _action query parameter.

S

SecurityContextFactory - Class in org.forgerock.json.resource.http: Deprecated.
This class will be removed once CAF has been migrated fully to CHF, at which point components should create SecurityContexts directly rather than via request attributes.

A C D G H N O P S
All Classes and Interfaces|All Packages|Constant Field Values