Index (Wren Security Commons HTTP - Core Library 23.0.0-SNAPSHOT Documentation)

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

A

AbstractContext - Class in org.forgerock.services.context: A base implementation of the Context interface.
AbstractContext(String, String, Context) - Constructor for class org.forgerock.services.context.AbstractContext: Constructs a new AbstractContext.
AbstractContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.AbstractContext: Creates a new context from the JSON representation of a previously persisted context.
AbstractContext(Context, String) - Constructor for class org.forgerock.services.context.AbstractContext: Constructs a new AbstractContext with a null id.
AbstractRouter<T extends AbstractRouter<T,R,H,D>,R,H,D> - Class in org.forgerock.services.routing: An abstract base class for implementing routers.
AbstractRouter() - Constructor for class org.forgerock.services.routing.AbstractRouter: Creates a new abstract router with no routes defined.
AbstractRouter(AbstractRouter<T, R, H, D>) - Constructor for class org.forgerock.services.routing.AbstractRouter: Creates a new router containing the same routes and default route as the provided router.
AcceptApiVersionHeader - Class in org.forgerock.http.header: Processes the Accept-API-Version message header.
AcceptApiVersionHeader(Version, Version) - Constructor for class org.forgerock.http.header.AcceptApiVersionHeader: Constructs a new header, initialized with the specified protocol and resource versions.
ACCEPTED - Static variable in class org.forgerock.http.protocol.Status: The 202 (Accepted) status code indicates that the request has been accepted for processing, but the processing has not been completed.
AcceptLanguageHeader - Class in org.forgerock.http.header: A header class representing the Accept-Language HTTP header.
add(int, String, String) - Method in class org.forgerock.http.header.WarningHeader: Constructs a new header with the warnings defined in this WarningHeader in addition to the provided warning.
add(int, String, String, Date) - Method in class org.forgerock.http.header.WarningHeader: Constructs a new header with the warnings defined in this WarningHeader in addition to the provided warning.
add(E) - Method in class org.forgerock.http.util.SetDecorator: Adds the specified element to the set if it is not already present (optional operation).
add(String) - Method in class org.forgerock.http.util.CaseInsensitiveSet
add(String, Object) - Method in class org.forgerock.http.protocol.Headers: A script compatible add method that will accept a Header, String, Collection<String> and String[] value.
add(K, V) - Method in class org.forgerock.http.util.MultiValueMap: Adds the specified value to the list for the specified key.
add(Warning) - Method in class org.forgerock.http.header.WarningHeader: Constructs a new header with the warnings defined in this WarningHeader in addition to the provided warning.
add(Header) - Method in class org.forgerock.http.protocol.Headers: An add method to add a particular Header instance.
addAll(Collection<? extends E>) - Method in class org.forgerock.http.util.SetDecorator: Adds all of the elements in the specified collection to the set if they're not already present (optional operation).
addAll(Collection<? extends String>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
addAll(Map<? extends String, ? extends Object>) - Method in class org.forgerock.http.protocol.Headers: A script compatible addAll method that will accept a Header, String, Collection<String> and String[] value.
addAll(Map<? extends K, Collection<? extends V>>) - Method in class org.forgerock.http.util.MultiValueMap: Adds the specified keys and values from the specified map into this map.
addAll(K, Collection<? extends V>) - Method in class org.forgerock.http.util.MultiValueMap: Adds the specified values to the list for the specified key.
addAll(MultiValueMap<K, V>) - Method in class org.forgerock.http.util.MultiValueMap: Adds the specified keys and values from the specified map into this map.
addAllRoutes(T) - Method in class org.forgerock.services.routing.AbstractRouter: Adds all of the routes defined in the provided router to this router.
addApiInfo(D) - Method in interface org.forgerock.http.ApiProducer: Add common API Info to the descriptor.
addApiInfo(Swagger) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
addDescriptorListener(Describable.Listener) - Method in interface org.forgerock.services.descriptor.Describable: Add a listener for API Descriptor changes.
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.services.routing.AbstractRouter
addLeadingSlash(String) - Static method in class org.forgerock.http.util.Paths: Add leading slash (if there is not already), returns the same value otherwise.
addRoute(RouteMatcher<R>, H) - Method in class org.forgerock.services.routing.AbstractRouter: Adds a new route to this router for the provided handler.
ALLOW_ALL - Enum constant in enum org.forgerock.http.handler.HttpClientHandler.HostnameVerifier: Accepts any host name (disables host name verification).
api - Variable in class org.forgerock.services.routing.AbstractRouter: Api of the current router.
api(ApiProducer<D>) - Method in interface org.forgerock.services.descriptor.Describable: Provide the API description for the component.
api(ApiProducer<D>) - Method in class org.forgerock.services.routing.AbstractRouter
API_PARAMETER - Static variable in class org.forgerock.http.swagger.OpenApiRequestFilter: Request parameter for the OpenAPI API Descriptor.
ApiProducer<D> - Interface in org.forgerock.http: A producer of API Descriptions.
ApiVersionRouterContext - Class in org.forgerock.http.routing: A Context which is created when a request is and has been routed based on resource API version.
ApiVersionRouterContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.routing.ApiVersionRouterContext: Restore from JSON representation.
ApiVersionRouterContext(Context, DefaultVersionBehaviour, boolean) - Constructor for class org.forgerock.http.routing.ApiVersionRouterContext: Creates a new resource API version routing context having the provided parent, default versioning behaviour and whether warnings will be issued.
append(byte) - Method in interface org.forgerock.http.io.Buffer: Appends a single byte to the end of the buffer.
append(byte[], int, int) - Method in interface org.forgerock.http.io.Buffer: Appends len bytes from the specified byte array starting at offset off to the end of the buffer.
appendRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form: Appends the form as additional query parameters on an existing request URI.
APPLICATION_JSON_CHARSET_UTF_8 - Static variable in class org.forgerock.http.protocol.Entity: The Content-Type used when setting the entity to JSON.
Applications - Class in org.forgerock.http: Utility methods to work with CHF Applications.
asArrayOrNull(List<String>) - Static method in class org.forgerock.http.util.Lists: Returns the given list content as an array, or null if the list is empty.
asContext(Class<T>) - Method in class org.forgerock.services.context.AbstractContext
asContext(Class<T>) - Method in interface org.forgerock.services.context.Context: Returns the first context in the chain whose type is a sub-type of the provided Context class.
asDescribableHandler(Handler) - Static method in class org.forgerock.http.handler.Handlers: Adapts a Handler to a DescribableHandler without adding support for API Descriptions if it is not already implemented.
asMapOfHeaders() - Method in class org.forgerock.http.protocol.Headers: The Headers class extends Map<String, Object> to support flexible parameters in scripting.
asURI() - Method in class org.forgerock.http.MutableUri: Returns the equivalent URI instance.
AttributesContext - Class in org.forgerock.services.context: An AttributesContext is a mechanism for transferring transient state between components when processing a single request.
AttributesContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.AttributesContext: Restore from JSON representation.
AttributesContext(Context) - Constructor for class org.forgerock.services.context.AttributesContext: Constructs a new AttributesContext.
AUTHZID_COMPONENT - Static variable in class org.forgerock.services.context.SecurityContext: The authorization ID name reserved for the name of the component in which a user's resource is located, e.g.
AUTHZID_DN - Static variable in class org.forgerock.services.context.SecurityContext: The authorization ID name reserved for the user's LDAP distinguished name.
AUTHZID_ID - Static variable in class org.forgerock.services.context.SecurityContext: The authorization ID principal name reserved for a user's unique identifier.
AUTHZID_REALM - Static variable in class org.forgerock.services.context.SecurityContext: The authorization ID name reserved for a user's realm.
AUTHZID_ROLES - Static variable in class org.forgerock.services.context.SecurityContext: The authorization ID name reserved for the array of roles associated with the user.

B

BAD_GATEWAY - Static variable in class org.forgerock.http.protocol.Status: The 502 (Bad Gateway) status code indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
BAD_REQUEST - Static variable in class org.forgerock.http.protocol.Status: The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
branch() - Method in class org.forgerock.http.io.BranchingInputStream: Creates a new branch at this stream's current position.
branch() - Method in class org.forgerock.http.io.FileBranchingStream
BranchingInputStream - Class in org.forgerock.http.io: An input stream that can branch into separate input streams to perform divergent reads.
BranchingInputStream(BranchingInputStream) - Constructor for class org.forgerock.http.io.BranchingInputStream: Initialise the BranchingInputStream with the specified parent.
Buffer - Interface in org.forgerock.http.io: A dynamically growing data buffer.
build() - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Returns a new UriRouterContext build from provided values.
build() - Method in class org.forgerock.services.context.ClientContext.Builder: Creates a ClientContext instance from the specified properties.
buildApi(ApiProducer<D>) - Method in class org.forgerock.services.routing.AbstractRouter: Build an api with a given ApiProducer.
buildExternalClientContext(Context) - Static method in class org.forgerock.services.context.ClientContext: Creates a ClientContext.Builder for creating an external ClientContext instance.

C

CaseInsensitiveMap<V> - Class in org.forgerock.http.util: An implementation of a map whose keys are case-insensitive strings.
CaseInsensitiveMap() - Constructor for class org.forgerock.http.util.CaseInsensitiveMap: Constructs a new empty case-insensitive map.
CaseInsensitiveMap(Map<String, V>) - Constructor for class org.forgerock.http.util.CaseInsensitiveMap: Wraps an existing map with a new case insensitive map.
CaseInsensitiveSet - Class in org.forgerock.http.util: An implementation of a set whose values are case-insensitive strings.
CaseInsensitiveSet() - Constructor for class org.forgerock.http.util.CaseInsensitiveSet: Constructs a new empty case-insensitive set.
CaseInsensitiveSet(int) - Constructor for class org.forgerock.http.util.CaseInsensitiveSet: Constructs a new, empty case-insensitive set; the backing HashSet instance has the specified initial capacity and default load factor.
CaseInsensitiveSet(int, float) - Constructor for class org.forgerock.http.util.CaseInsensitiveSet: Constructs a new, empty case-insensitive set; the backing HashSet instance has the specified initial capacity and the specified load factor.
CaseInsensitiveSet(Collection<String>) - Constructor for class org.forgerock.http.util.CaseInsensitiveSet: Constructs a new case-insensitive set containing the elements in the specified collection.
certificates(Certificate...) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's certificates.
certificates(List<Certificate>) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's certificates.
chainOf(List<Filter>) - Static method in class org.forgerock.http.filter.Filters: Creates a Filter which encapsulates the provided filters into a single Filter.
chainOf(Filter...) - Static method in class org.forgerock.http.filter.Filters: Creates a Filter which encapsulates the provided filters into a single Filter.
chainOf(Handler, List<Filter>) - Static method in class org.forgerock.http.handler.Handlers: Creates a Handler which wraps the provided filters around the provided target handler.
chainOf(Handler, Filter...) - Static method in class org.forgerock.http.handler.Handlers: Creates a Handler which wraps the provided filters around the provided target handler.
checkJsonCompatibility(String, Object) - Static method in class org.forgerock.http.util.Json: Verify that the given parameter object is of a JSON compatible type (recursively).
clear() - Method in class org.forgerock.http.protocol.Headers
clear() - Method in class org.forgerock.http.util.CaseInsensitiveMap
clear() - Method in class org.forgerock.http.util.CaseInsensitiveSet
clear() - Method in class org.forgerock.http.util.SetDecorator: Removes all of the elements from the set (optional operation).
Client - Class in org.forgerock.http: An HTTP client which forwards requests to a wrapped Handler.
Client(Handler) - Constructor for class org.forgerock.http.Client: Creates a new Client which will route HTTP requests to the provided Handler using a RootContext allocated during construction when none is provided.
Client(Handler, Context) - Constructor for class org.forgerock.http.Client: Creates a new Client which will route HTTP requests to the provided Handler using the specified Context if none is provided.
CLIENT_ERROR - Enum constant in enum org.forgerock.http.protocol.Status.Family: The 4xx (Client Error) class of status code indicates that the client seems to have erred.
ClientContext - Class in org.forgerock.services.context: Client context gives easy access to client-related information that are available into the request.
ClientContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.ClientContext: Restore from JSON representation.
ClientContext.Builder - Class in org.forgerock.services.context: Builder for creating ClientContext instances.
clone(Swagger) - Static method in class org.forgerock.http.swagger.SwaggerUtils: Clone a Swagger instance.
close() - Method in class org.forgerock.http.handler.HttpClientHandler: Completes all pending requests and release resources associated with underlying implementation.
close() - Method in class org.forgerock.http.io.BranchingInputStream: Closes this branching stream and all of the branches created from it.
close() - Method in interface org.forgerock.http.io.Buffer: Closes the buffer and releases any system resources associated with it.
close() - Method in class org.forgerock.http.io.FileBranchingStream
close() - Method in class org.forgerock.http.protocol.Entity: Closes all resources associated with this entity.
close() - Method in interface org.forgerock.http.protocol.Message: Closes all resources associated with the entity.
close() - Method in class org.forgerock.http.protocol.MessageImpl
close() - Method in interface org.forgerock.http.spi.HttpClient: Completes all pending requests and release resources associated with underlying implementation.
compareTo(MutableUri) - Method in class org.forgerock.http.MutableUri
compareTo(Version) - Method in class org.forgerock.http.routing.Version
CONFLICT - Static variable in class org.forgerock.http.protocol.Status: The 409 (Conflict) status code indicates that the request could not be completed due to a conflict with the current state of the target resource.
ConnectionHeader - Class in org.forgerock.http.header: Processes the Connection message header.
ConnectionHeader() - Constructor for class org.forgerock.http.header.ConnectionHeader: Constructs a new empty header.
ConnectionHeader(List<String>) - Constructor for class org.forgerock.http.header.ConnectionHeader: Constructs a new header with the provided connection tokens.
contains(Object) - Method in class org.forgerock.http.util.CaseInsensitiveSet
contains(Object) - Method in class org.forgerock.http.util.SetDecorator: Returns true if the set contains the specified element.
containsAll(Collection<?>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
containsAll(Collection<?>) - Method in class org.forgerock.http.util.SetDecorator: Returns true if the set contains all of the elements of the specified collection.
containsContext(Class<? extends Context>) - Method in class org.forgerock.services.context.AbstractContext
containsContext(Class<? extends Context>) - Method in interface org.forgerock.services.context.Context: Returns true if there is a context in the chain whose type is a sub-type of the provided Context class.
containsContext(String) - Method in class org.forgerock.services.context.AbstractContext
containsContext(String) - Method in interface org.forgerock.services.context.Context: Returns true if there is a context in the chain whose name matches the provided context name.
containsKey(Object) - Method in class org.forgerock.http.protocol.Headers
containsKey(Object) - Method in class org.forgerock.http.protocol.RequestCookies
containsKey(Object) - Method in class org.forgerock.http.util.CaseInsensitiveMap
containsValue(Object) - Method in class org.forgerock.http.protocol.Headers
containsValue(Object) - Method in class org.forgerock.http.protocol.RequestCookies
ContentApiVersionHeader - Class in org.forgerock.http.header: Processes the Content-API-Version message header.
ContentApiVersionHeader(Version, Version) - Constructor for class org.forgerock.http.header.ContentApiVersionHeader: Constructs a new header, initialized with the specified protocol and resource versions.
ContentEncodingHeader - Class in org.forgerock.http.header: Processes the Content-Encoding message header.
ContentEncodingHeader() - Constructor for class org.forgerock.http.header.ContentEncodingHeader: Constructs a new empty header.
ContentEncodingHeader(List<String>) - Constructor for class org.forgerock.http.header.ContentEncodingHeader: Constructs a new header with the provided content encodings.
ContentLengthHeader - Class in org.forgerock.http.header: Processes the Content-Length message header.
ContentLengthHeader() - Constructor for class org.forgerock.http.header.ContentLengthHeader: Constructs a new empty header whose length is set to -1.
ContentLengthHeader(long) - Constructor for class org.forgerock.http.header.ContentLengthHeader: Constructs a new header with the provided content length.
ContentTypeHeader - Class in org.forgerock.http.header: Processes the Content-Type message header.
ContentTypeHeader() - Constructor for class org.forgerock.http.header.ContentTypeHeader: Constructs a new empty header whose type, charset, and boundary are all null.
ContentTypeHeader(String, String, String) - Constructor for class org.forgerock.http.header.ContentTypeHeader: Constructs a new header based on message type, charset and boundary.
ContentTypeHeader(String, String, String, Map<String, String>) - Constructor for class org.forgerock.http.header.ContentTypeHeader: Constructs a new header based on message type, charset, boundary and any additional message parameters.
Context - Interface in org.forgerock.services.context: Type-safe contextual information associated with the processing of a request in an application.
CONTINUE - Static variable in class org.forgerock.http.protocol.Status: The 100 (Continue) status code indicates that the initial part of a request has been received and has not yet been rejected by the server.
Cookie - Class in org.forgerock.http.protocol: An HTTP cookie.
Cookie() - Constructor for class org.forgerock.http.protocol.Cookie: Creates a new uninitialized cookie.
CookieHeader - Class in org.forgerock.http.header: Processes the Cookie request message header.
CookieHeader() - Constructor for class org.forgerock.http.header.CookieHeader: Constructs a new empty header.
CookieHeader(List<Cookie>) - Constructor for class org.forgerock.http.header.CookieHeader: Constructs a new header with the provided cookies.
copy() - Method in class org.forgerock.http.io.BranchingInputStream: Creates a twin of this stream at this stream's current position.
copy() - Method in class org.forgerock.http.io.FileBranchingStream
copyAsMultiMapOfStrings() - Method in class org.forgerock.http.protocol.Headers: Returns a copy of these headers as a multi-valued map of strings.
copyDecodedContentTo(OutputStream) - Method in class org.forgerock.http.protocol.Entity: Copies the decoded content of this entity to the provided writer.
copyDecodedContentTo(Writer) - Method in class org.forgerock.http.protocol.Entity: Copies the decoded content of this entity to the provided writer.
copyRawContentTo(OutputStream) - Method in class org.forgerock.http.protocol.Entity: Copies the raw content of this entity to the provided output stream.
create(String, String, String, int, String, String, String) - Static method in class org.forgerock.http.util.Uris: Returns a hierarchical URI constructed from the given components.
createApiVersionRouterContext(Context) - Method in class org.forgerock.http.routing.ResourceApiVersionRoutingFilter: Creates a ApiVersionRouterContext using the default version behaviour and whether to issue warnings from the behaviourManager instance.
CREATED - Static variable in class org.forgerock.http.protocol.Status: The 201 (Created) status code indicates that the request has been fulfilled and has resulted in one or more new resources being created.
createNonStrict(String, String, String, int, String, String, String) - Static method in class org.forgerock.http.util.Uris: Returns a hierarchical URI constructed from the given components.
createSubTransactionId() - Method in class org.forgerock.services.TransactionId: Creates a new TransactionId, child of this one.

D

data - Variable in class org.forgerock.services.context.AbstractContext: The Context data.
decode(InputStream) - Method in interface org.forgerock.http.decoder.Decoder: Returns an instance of an input stream that decodes the specified input.
decode(InputStream) - Method in class org.forgerock.http.decoder.internal.DeflateDecoder
decode(InputStream) - Method in class org.forgerock.http.decoder.internal.GzipDecoder
decode(InputStream) - Method in class org.forgerock.http.header.ContentEncodingHeader: Returns an input stream that decodes the specified input stream, given the content-codings that are specified in the codings list.
Decoder - Interface in org.forgerock.http.decoder: Decodes an HTTP message entity input stream.
decorateContext(Context) - Method in interface org.forgerock.services.routing.RouteMatch: Decorates the given context with any routing information for the route.
DEFAULT_TMP_FILE_LIMIT - Static variable in class org.forgerock.http.io.IO: 1 GiB.
DEFAULT_TMP_INIT_LENGTH - Static variable in class org.forgerock.http.io.IO: 8 KiB.
DEFAULT_TMP_MEMORY_LIMIT - Static variable in class org.forgerock.http.io.IO: 64 KiB.
DefaultVersionBehaviour - Enum in org.forgerock.http.routing: The default routing behaviour to use when no Accept-API-Version is set on the request.
DeflateDecoder - Class in org.forgerock.http.decoder.internal: Decodes an entity encoded with deflate encoding.
DeflateDecoder() - Constructor for class org.forgerock.http.decoder.internal.DeflateDecoder
DelegatingRouteMatcher<R> - Class in org.forgerock.services.routing: A route matcher that delegates to a provided route matcher.
DelegatingRouteMatcher(RouteMatcher<R>) - Constructor for class org.forgerock.services.routing.DelegatingRouteMatcher: Create a new route matcher, delegating to the provided delegate.
Describable<D,R> - Interface in org.forgerock.services.descriptor: A routing component (a CHF Handler or CREST RequestHandler) can describe its API by implementing this interface.
Describable.Listener - Interface in org.forgerock.services.descriptor: Interface for listener instances.
DescribableHandler - Interface in org.forgerock.http.handler: A handler that both handles Requests, and also supports querying for API Descriptors.
describedHttpApplication(Handler, Factory<Buffer>, ApiProducer<Swagger>) - Static method in class org.forgerock.http.Applications: Create a simple DescribedHttpApplication that just returns the provided arguments from the appropriate methods.
DescribedHttpApplication - Interface in org.forgerock.http: An HttpApplication that produces OpenAPI API Descriptors.
DISCONNECTED_OPERATION - Static variable in class org.forgerock.http.header.WarningHeader: 112 Disconnected operation SHOULD be included if the cache is intentionally disconnected from the rest of the network for a period of time.

E

Entity - Class in org.forgerock.http.protocol: Message content.
entrySet() - Method in class org.forgerock.http.protocol.Headers
entrySet() - Method in class org.forgerock.http.protocol.RequestCookies
equals(Object) - Method in class org.forgerock.http.header.Warning
equals(Object) - Method in class org.forgerock.http.header.WarningHeader
equals(Object) - Method in class org.forgerock.http.MutableUri
equals(Object) - Method in class org.forgerock.http.protocol.Cookie
equals(Object) - Method in class org.forgerock.http.protocol.Header
equals(Object) - Method in class org.forgerock.http.routing.Version
equals(Object) - Method in class org.forgerock.http.util.SetDecorator: Compares the specified object with the set for equality.
equals(Object) - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
equals(Object) - Method in class org.forgerock.services.routing.RouteMatcher
EQUALS - Enum constant in enum org.forgerock.http.routing.RoutingMode: The URI template must exactly match a request's resource name in order for the route to be selected.
evaluate(Context, R) - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
evaluate(Context, R) - Method in class org.forgerock.services.routing.RouteMatcher: Evaluates the request and determines whether it matches the route.
EXPECTATION_FAILED - Static variable in class org.forgerock.http.protocol.Status: The 417 (Expectation Failed) status code indicates that the expectation given in the request's Expect header field (Section 5.1.1) could not be met by at least one of the inbound servers.

F

FACTORIES - Static variable in class org.forgerock.http.header.HeaderFactory: A map of header names to known HeaderFactory implementations.
FileBranchingStream - Class in org.forgerock.http.io: A BranchingInputStream for reading from files.
FileBranchingStream(File) - Constructor for class org.forgerock.http.io.FileBranchingStream: Creates a new stream for the specified file.
filter(Context, Request, Handler) - Method in interface org.forgerock.http.Filter: Filters the request and/or response of an exchange.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.OptionsFilter: Handles all OPTION requests to CREST resources, all other request methods are handled by the Handler.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.TransactionIdInboundFilter
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.TransactionIdOutboundFilter
filter(Context, Request, Handler) - Method in class org.forgerock.http.routing.ResourceApiVersionRoutingFilter
filter(Context, Request, Handler) - Method in class org.forgerock.http.swagger.OpenApiRequestFilter
Filter - Interface in org.forgerock.http: Filters the request and/or response of an HTTP exchange.
filtered(Handler, Filter) - Static method in class org.forgerock.http.handler.Handlers: Creates a "filtered handler" instance.
Filters - Class in org.forgerock.http.filter: Utility methods for creating common types of filters.
FORBIDDEN - Static variable in class org.forgerock.http.protocol.Status: The 403 (Forbidden) status code indicates that the server understood the request but refuses to authorize it.
Form - Class in org.forgerock.http.protocol: Form fields, a case-sensitive multi-string-valued map.
Form() - Constructor for class org.forgerock.http.protocol.Form: Constructs a new, empty form object.
formatDate(Date) - Static method in class org.forgerock.http.header.HeaderUtil: Formats a HTTP-date using RFC 1123 format as specified in RFC 2616.
formDecodeParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided form encoded parameter name or value as per application/x-www-form-urlencoded.
formEncodeParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: Form encodes the provided parameter name or value as per application/x-www-form-urlencoded.
FOUND - Static variable in class org.forgerock.http.protocol.Status: The 302 (Found) status code indicates that the target resource resides temporarily under a different URI.
fromFormString(String) - Method in class org.forgerock.http.protocol.Form: Parses a form URL-encoded string containing form parameters and stores them in this object.
fromQueryString(String) - Method in class org.forgerock.http.protocol.Form: Parses a URL-encoded query string containing form parameters and stores them in this object.
fromRequestEntity(Request) - Method in class org.forgerock.http.protocol.Form: Parses the URL-encoded form entity of a request and stores them in this object.
fromRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form: Parses the query parameters of a request and stores them in this object.
fromString(String) - Method in class org.forgerock.http.protocol.Form: Deprecated.
use Form.fromFormString(String) instead.

G

GATEWAY_TIMEOUT - Static variable in class org.forgerock.http.protocol.Status: The 504 (Gateway Timeout) status code indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.
GenericHeader - Class in org.forgerock.http.header: An undecoded HTTP message header.
GenericHeader(String, String) - Constructor for class org.forgerock.http.header.GenericHeader: Constructs a new header with the provided name and value.
GenericHeader(String, List<String>) - Constructor for class org.forgerock.http.header.GenericHeader: Constructs a new header with the provided name and values.
get(Class<H>) - Method in class org.forgerock.http.protocol.Headers: Returns the specified Header or {code null} if the header is not included in the message.
get(Object) - Method in class org.forgerock.http.protocol.Headers: Rich-type friendly get method.
get(Object) - Method in class org.forgerock.http.protocol.RequestCookies
get(Object) - Method in class org.forgerock.http.util.CaseInsensitiveMap
getAdditionalParameters() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns any additional parameters in the message or an empty map if none specified.
getAgent() - Method in class org.forgerock.http.header.Warning: Gets the warning's agent name.
getApiProducer() - Method in interface org.forgerock.http.DescribedHttpApplication: Provides the OpenAPI descriptor producer with which to produce the API.
getAttributes() - Method in class org.forgerock.services.context.AttributesContext: Returns the attributes associated with the current request.
getAuthenticationId() - Method in class org.forgerock.services.context.SecurityContext: Returns the principal that the client used during authentication.
getAuthority() - Method in class org.forgerock.http.MutableUri: Returns the authority compound element.
getAuthorization() - Method in class org.forgerock.services.context.SecurityContext: Returns an unmodifiable map containing additional principals associated with the client which MAY be used when performing authorization decisions.
getBaseUri() - Method in class org.forgerock.http.routing.UriRouterContext: Returns the portion of the request URI which has been routed so far.
getBestApiRoute(Context, R) - Method in class org.forgerock.services.routing.AbstractRouter: Get the best route for an API request.
getBestRoute(Context, R) - Method in class org.forgerock.services.routing.AbstractRouter: Finds the best route that matches the given request based on the route matchers of the registered routes.
getBoundary() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns the encapsulation boundary or null if none specified.
getBufferFactory() - Method in interface org.forgerock.http.HttpApplication: Gets the Factory that will create temporary storage Buffers to handle the processing of requests.
getBytes() - Method in class org.forgerock.http.protocol.Entity: Returns a byte array containing a copy of the decoded content of this entity.
getCause() - Method in class org.forgerock.http.protocol.Response: Returns the (possibly null) cause of this error message (assuming it is a 4xx or a 5xx).
getCertificates() - Method in class org.forgerock.services.context.ClientContext: Returns the collection (possibly empty) of certificate(s) provided by the client.
getCharset() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns the character set encoding used to encode the message, or null if no character set was specified.
getClass(String) - Static method in class org.forgerock.http.util.Loader: Returns the Class object associated with the class or interface with the given name, or null if the class could not be returned for any reason.
getClassLoader() - Static method in class org.forgerock.http.util.Loader: Returns the class loader that should be used consistently throughout the application.
getCode() - Method in class org.forgerock.http.header.Warning: Gets the warning's three digit code.
getCode() - Method in class org.forgerock.http.protocol.Status: Returns the three-digit integer code giving the result of the attempt to understand and satisfy the request.
getCodings() - Method in class org.forgerock.http.header.ContentEncodingHeader: Returns the list of content codings.
getComment() - Method in class org.forgerock.http.protocol.Cookie: Returns the intended use of a cookie.
getCommentURL() - Method in class org.forgerock.http.protocol.Cookie: Returns the URL identifying the intended use of a cookie.
getContext(String) - Method in class org.forgerock.services.context.AbstractContext
getContext(String) - Method in interface org.forgerock.services.context.Context: Returns the first context in the chain whose context name matches the provided name.
getContextName() - Method in class org.forgerock.services.context.AbstractContext
getContextName() - Method in interface org.forgerock.services.context.Context: Get this Context's name.
getCookies() - Method in class org.forgerock.http.header.CookieHeader: Returns the cookies' request list.
getCookies() - Method in class org.forgerock.http.header.SetCookieHeader: Returns the cookies.
getCookies() - Method in class org.forgerock.http.protocol.Request: Returns the incoming request cookies.
getDate() - Method in class org.forgerock.http.header.Warning: Gets the warning's date.
getDefaultVersionBehaviour() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets the default version behaviour if the request does not contain a resource API version.
getDefaultVersionBehaviour() - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Gets the default routing behaviour to use when the request does not contain the Accept-API-Version header.
getDiscard() - Method in class org.forgerock.http.protocol.Cookie: Returns true if the user agent should discard the cookie unconditionally when it terminates.
getDomain() - Method in class org.forgerock.http.protocol.Cookie: Returns the domain for which the cookie is valid.
getEntity() - Method in interface org.forgerock.http.protocol.Message: Returns the entity.
getEntity() - Method in class org.forgerock.http.protocol.MessageImpl
getExpires() - Method in class org.forgerock.http.protocol.Cookie: Returns the lifetime of the cookie, expressed as the date and time of expiration.
getFamily() - Method in class org.forgerock.http.protocol.Status: Returns the class of response of this status code.
getFirst(Class<? extends Header>) - Method in class org.forgerock.http.protocol.Headers: Gets the first value of the header, or null if the header does not exist.
getFirst(String) - Method in class org.forgerock.http.protocol.Headers: Gets the first value of the header, or null if the header does not exist.
getFirst(K) - Method in class org.forgerock.http.util.MultiValueMap: Returns the first value in the list of values for the matching key, or null if no such value exists.
getFirstValue() - Method in class org.forgerock.http.protocol.Header: Gets the first value of this header instance.
getForm() - Method in class org.forgerock.http.protocol.Request: Returns a copy of the query parameters and application/x-www-form-urlencoded entity decoded as a form.
getFragment() - Method in class org.forgerock.http.MutableUri: Returns the fragment element.
getHeaders() - Method in interface org.forgerock.http.protocol.Message: Returns the headers.
getHeaders() - Method in class org.forgerock.http.protocol.MessageImpl
getHost() - Method in class org.forgerock.http.MutableUri: Returns the host element.
getId() - Method in class org.forgerock.services.context.AbstractContext
getId() - Method in interface org.forgerock.services.context.Context: Returns the unique ID identifying this context, usually a UUID.
getIn() - Method in class org.forgerock.http.io.PipeBufferedStream: Returns the output stream which writes to the pipe.
getJson() - Method in class org.forgerock.http.protocol.Entity: Returns the content of this entity decoded as a JSON object.
getKey() - Method in interface org.forgerock.http.decoder.Decoder: Returns the coding that the decoder supports, as it would appear in the Content-Encoding header.
getKey() - Method in class org.forgerock.http.decoder.internal.DeflateDecoder
getKey() - Method in class org.forgerock.http.decoder.internal.GzipDecoder
getKey() - Method in interface org.forgerock.http.util.Indexed: Returns the unique key to index the object by.
getLength() - Method in class org.forgerock.http.header.ContentLengthHeader: Returns the content length, or -1 if no content length has been set.
getLocalAddress() - Method in class org.forgerock.services.context.ClientContext: Returns the IP address of the interface that received the request.
getLocales() - Method in class org.forgerock.http.header.AcceptLanguageHeader: Returns the PreferredLocales instance that represents this header.
getLocalPort() - Method in class org.forgerock.services.context.ClientContext: Returns the port of the interface that received the request.
getLocationUri() - Method in class org.forgerock.http.header.LocationHeader: Returns the location URI or null if empty.
getMajor() - Method in class org.forgerock.http.routing.Version: Returns the major version number.
getMatchedUri() - Method in class org.forgerock.http.routing.UriRouterContext: Returns the portion of the request URI which matched the URI template.
getMaxAge() - Method in class org.forgerock.http.protocol.Cookie: Returns the lifetime of the cookie, expressed in seconds.
getMethod() - Method in class org.forgerock.http.protocol.Request: Returns the method to be performed on the resource.
getMinor() - Method in class org.forgerock.http.routing.Version: Returns the minor version number.
getName() - Method in class org.forgerock.http.header.AcceptApiVersionHeader
getName() - Method in class org.forgerock.http.header.AcceptLanguageHeader
getName() - Method in class org.forgerock.http.header.ConnectionHeader
getName() - Method in class org.forgerock.http.header.ContentApiVersionHeader
getName() - Method in class org.forgerock.http.header.ContentEncodingHeader
getName() - Method in class org.forgerock.http.header.ContentLengthHeader
getName() - Method in class org.forgerock.http.header.ContentTypeHeader
getName() - Method in class org.forgerock.http.header.CookieHeader
getName() - Method in class org.forgerock.http.header.GenericHeader
getName() - Method in class org.forgerock.http.header.LocationHeader
getName() - Method in class org.forgerock.http.header.SetCookieHeader
getName() - Method in class org.forgerock.http.header.TransactionIdHeader
getName() - Method in class org.forgerock.http.header.WarningHeader
getName() - Method in class org.forgerock.http.protocol.Cookie: Returns name of the cookie.
getName() - Method in class org.forgerock.http.protocol.Header: Returns the name of the header, as it would canonically appear within an HTTP message.
getOriginalUri() - Method in class org.forgerock.http.routing.UriRouterContext: Get the original URI.
getOut() - Method in class org.forgerock.http.io.PipeBufferedStream: Returns the input stream which reads from the pipe.
getParent() - Method in class org.forgerock.services.context.AbstractContext
getParent() - Method in interface org.forgerock.services.context.Context: Returns the parent of this context.
getPath() - Method in class org.forgerock.http.MutableUri: Returns the path element.
getPath() - Method in class org.forgerock.http.protocol.Cookie: Returns the subset of URLs on the origin server to which this cookie applies.
getPathElements() - Method in class org.forgerock.http.MutableUri: Return the URI path elements as an immutable List.
getPathElements(String) - Static method in class org.forgerock.http.util.Paths: Converts a path into a list of URL-decoded path elements.
getPaths() - Method in class org.forgerock.http.swagger.SwaggerExtended
getPort() - Method in class org.forgerock.http.MutableUri: Returns the port element.
getPort() - Method in class org.forgerock.http.protocol.Cookie: Returns the restricted list of port(s) to which a cookie may be returned.
getProtocolVersion() - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Gets the acceptable protocol version.
getProtocolVersion() - Method in class org.forgerock.http.header.ContentApiVersionHeader: Gets the protocol version of the content of the returned content.
getProtocolVersion() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets the protocol API version of the framework used to handle the request.
getQuery() - Method in class org.forgerock.http.MutableUri: Returns the path element.
getRawAuthority() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) authority compound element.
getRawContentInputStream() - Method in class org.forgerock.http.protocol.Entity: Returns an input stream representing the raw content of this entity.
getRawFragment() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) fragment element.
getRawPath() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) path element.
getRawQuery() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) query element.
getRawUserInfo() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) user info element.
getReasonPhrase() - Method in class org.forgerock.http.protocol.Status: Returns the reason phrase associated with the status code.
getRemainingUri() - Method in class org.forgerock.http.routing.UriRouterContext: Returns the portion of the request URI which is remaining to be matched be the next router.
getRemoteAddress() - Method in class org.forgerock.services.context.ClientContext: Returns the IP address of the client (or last proxy) that sent the request or an empty string if the client is internal.
getRemotePort() - Method in class org.forgerock.services.context.ClientContext: Returns the source port of the client (or last proxy) that sent the request or -1 if the client is internal.
getRemoteUser() - Method in class org.forgerock.services.context.ClientContext: Returns the login of the user making this request or an empty string if not known.
getRequestReceivedTime() - Method in class org.forgerock.services.context.RequestAuditContext: Get the time in milliseconds since the epoch that the request was received.
getResource(String) - Static method in class org.forgerock.http.util.Loader: Finds the resource with the given name.
getResourceVersion() - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Gets the acceptable resource version.
getResourceVersion() - Method in class org.forgerock.http.header.ContentApiVersionHeader: Gets the resource version of the returned content.
getResourceVersion() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets the API version of the resource that the request was routed to.
getResponse() - Method in exception org.forgerock.http.protocol.ResponseException: Returns the response associated to this exception.
getRoutes() - Method in class org.forgerock.services.routing.AbstractRouter: Gets all registered routes on this router.
getScheme() - Method in class org.forgerock.http.MutableUri: Returns the scheme name.
getSelfApiHandler() - Method in class org.forgerock.http.routing.Router
getSelfApiHandler() - Method in class org.forgerock.services.routing.AbstractRouter: Return a Describable handler that returns this AbstractRouter's internal api description from the Describable.handleApiRequest(Context, Object) method.
getSession() - Method in class org.forgerock.http.session.SessionContext: Returns the Session associated with the remote client.
getStatus() - Method in class org.forgerock.http.protocol.Response: Returns the response status.
getString() - Method in class org.forgerock.http.protocol.Entity: Returns the content of this entity decoded as a string.
getText() - Method in class org.forgerock.http.header.Warning: Gets the warning's text description.
getThis() - Method in class org.forgerock.http.routing.Router
getThis() - Method in class org.forgerock.services.routing.AbstractRouter: Returns this AbstractRouter instance, typed correctly.
getTokens() - Method in class org.forgerock.http.header.ConnectionHeader: Returns the list of connection tokens.
getTransactionId() - Method in class org.forgerock.http.header.TransactionIdHeader: Returns the transaction id.
getTransactionId() - Method in class org.forgerock.services.context.TransactionIdContext: Returns the transaction id.
getType() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns the media type of the underlying data or null if none specified.
getUri() - Method in class org.forgerock.http.protocol.Request: Returns the fully-qualified URI of the resource being accessed.
getUriTemplateVariables() - Method in class org.forgerock.http.routing.UriRouterContext: Returns an unmodifiable Map containing the parsed URI template variables, keyed on the URI template variable name.
getUserAgent() - Method in class org.forgerock.services.context.ClientContext: Returns the value of the User-Agent HTTP Header (if any, returns an empty string otherwise).
getUserInfo() - Method in class org.forgerock.http.MutableUri: Returns the user info element.
getValue() - Method in class org.forgerock.http.protocol.Cookie: Returns the value of the cookie.
getValue() - Method in class org.forgerock.services.TransactionId: Returns the value of this TransactionId.
getValues() - Method in class org.forgerock.http.header.AcceptApiVersionHeader
getValues() - Method in class org.forgerock.http.header.AcceptLanguageHeader
getValues() - Method in class org.forgerock.http.header.ConnectionHeader
getValues() - Method in class org.forgerock.http.header.ContentApiVersionHeader
getValues() - Method in class org.forgerock.http.header.ContentEncodingHeader
getValues() - Method in class org.forgerock.http.header.ContentLengthHeader
getValues() - Method in class org.forgerock.http.header.ContentTypeHeader
getValues() - Method in class org.forgerock.http.header.CookieHeader
getValues() - Method in class org.forgerock.http.header.GenericHeader: Returns the header as a list of strings.
getValues() - Method in class org.forgerock.http.header.LocationHeader
getValues() - Method in class org.forgerock.http.header.SetCookieHeader
getValues() - Method in class org.forgerock.http.header.TransactionIdHeader
getValues() - Method in class org.forgerock.http.header.WarningHeader
getValues() - Method in class org.forgerock.http.protocol.Header: Returns the header as a list of strings.
getVersion() - Method in class org.forgerock.http.protocol.Cookie: Returns the version of the state management mechanism to which this cookie conforms.
getVersion() - Method in interface org.forgerock.http.protocol.Message: Returns the protocol version.
getVersion() - Method in class org.forgerock.http.protocol.MessageImpl
getWarnings() - Method in class org.forgerock.http.header.WarningHeader: Gets all Warnings.
GONE - Static variable in class org.forgerock.http.protocol.Status: The 410 (Gone) status code indicates that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent.
GzipDecoder - Class in org.forgerock.http.decoder.internal: Decodes an entity encoded with gzip encoding.
GzipDecoder() - Constructor for class org.forgerock.http.decoder.internal.GzipDecoder

H

handle(Context, Request) - Method in interface org.forgerock.http.Handler: Returns a Promise representing the asynchronous Response of the given request.
handle(Context, Request) - Method in class org.forgerock.http.handler.HttpClientHandler: Sends an HTTP request to a remote server and returns a Promise representing the asynchronous response.
handle(Context, Request) - Method in class org.forgerock.http.routing.Router
handleApiRequest(Context, R) - Method in interface org.forgerock.services.descriptor.Describable: Handle a request for the API Descriptor.
handleApiRequest(Context, R) - Method in class org.forgerock.services.routing.AbstractRouter
Handler - Interface in org.forgerock.http: Asynchronously handles an HTTP Request by producing an associated Response.
Handlers - Class in org.forgerock.http.handler: Utility methods for creating common types of handlers.
hashCode() - Method in class org.forgerock.http.header.Warning
hashCode() - Method in class org.forgerock.http.header.WarningHeader
hashCode() - Method in class org.forgerock.http.MutableUri
hashCode() - Method in class org.forgerock.http.protocol.Cookie
hashCode() - Method in class org.forgerock.http.protocol.Header
hashCode() - Method in class org.forgerock.http.routing.Version
hashCode() - Method in class org.forgerock.http.util.SetDecorator
hashCode() - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
hashCode() - Method in class org.forgerock.services.routing.RouteMatcher
Header - Class in org.forgerock.http.protocol: An HTTP message header.
Header() - Constructor for class org.forgerock.http.protocol.Header
HEADER_NAMES - Static variable in class org.forgerock.http.header.HeaderFactory: A map of Header types to the names of the headers they implement.
HeaderFactory<H extends Header> - Class in org.forgerock.http.header: Creates instances of Header classes from String representation.
HeaderFactory() - Constructor for class org.forgerock.http.header.HeaderFactory
Headers - Class in org.forgerock.http.protocol: Message headers, a case-insensitive multiple-value map.
Headers() - Constructor for class org.forgerock.http.protocol.Headers: Constructs a Headers object that is case-insensitive for header names.
HeaderUtil - Class in org.forgerock.http.header: Utility class for processing values in HTTP header fields.
HEURISTIC_EXPIRATION - Static variable in class org.forgerock.http.header.WarningHeader: 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.
HTTP_VERSION_NOT_SUPPORTED - Static variable in class org.forgerock.http.protocol.Status: The 505 (HTTP Version Not Supported) status code indicates that the server does not support, or refuses to support, the major version of HTTP that was used in the request message.
HttpApplication - Interface in org.forgerock.http: Configuration class to configure the HttpApplication instance.
HttpApplicationException - Exception in org.forgerock.http: An exception that is thrown during a Http Application start up when the start up of the application fails.
HttpApplicationException(String) - Constructor for exception org.forgerock.http.HttpApplicationException: Constructs a new exception with the specified detail message.
HttpApplicationException(String, Throwable) - Constructor for exception org.forgerock.http.HttpApplicationException: Constructs a new exception with the specified detail message and cause.
HttpApplicationException(Throwable) - Constructor for exception org.forgerock.http.HttpApplicationException: Constructs a new exception with the specified cause.
HttpClient - Interface in org.forgerock.http.spi: An SPI interface for HTTP Client implementations.
HttpClientHandler - Class in org.forgerock.http.handler: An HTTP client for sending requests to remote servers.
HttpClientHandler() - Constructor for class org.forgerock.http.handler.HttpClientHandler: Creates a new HTTP client using default client options.
HttpClientHandler(Options) - Constructor for class org.forgerock.http.handler.HttpClientHandler: Creates a new HTTP client using the provided client options.
HttpClientHandler.HostnameVerifier - Enum in org.forgerock.http.handler: SSL host name verification policies.
HttpClientProvider - Interface in org.forgerock.http.spi: A provider interface for obtaining HttpClient instances.

I

idFragment() - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
idFragment() - Method in class org.forgerock.services.routing.RouteMatcher: The fragment of an API ID that this matcher provides.
IncomparableRouteMatchException - Exception in org.forgerock.services.routing: An exception which is thrown when two incompatible RouteMatch instances are attempted to be compared.
IncomparableRouteMatchException(RouteMatch, RouteMatch) - Constructor for exception org.forgerock.services.routing.IncomparableRouteMatchException: Constructs a IncomparableRouteMatchException with the two RouteMatch instance that caused the exception.
Indexed<T> - Interface in org.forgerock.http.util: Interface of an object that can be indexed with a unique key.
INFORMATIONAL - Enum constant in enum org.forgerock.http.protocol.Status.Family: The 1xx (Informational) class of status code indicates an interim response for communicating connection status or request progress prior to completing the requested action and sending a final response.
INTERNAL_SERVER_ERROR - Static variable in class org.forgerock.http.protocol.Status: The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
internalServerError() - Static method in class org.forgerock.http.protocol.Responses: Utility method returning an async function that creates a Response with status Status.INTERNAL_SERVER_ERROR and the exception set as the cause.
internalServerErrorHandler(Exception) - Static method in class org.forgerock.http.handler.Handlers: A common HTTP Framework Handler responding 500 Internal Server Error.
IO - Class in org.forgerock.http.io: Utility class that can stream to and from streams.
isBetterMatchThan(RouteMatch) - Method in interface org.forgerock.services.routing.RouteMatch: Determines whether this route match is better than the given rout match.
isClientError() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.CLIENT_ERROR one ?
isCompatibleWith(Version) - Method in class org.forgerock.http.routing.Version: Returns false if: the MAJOR version numbers are not the same.
isDecodedContentEmpty() - Method in class org.forgerock.http.protocol.Entity: Returns true if this entity's decoded content is empty.
isEmpty() - Method in class org.forgerock.http.protocol.Headers
isEmpty() - Method in class org.forgerock.http.protocol.RequestCookies
isEmpty() - Method in class org.forgerock.http.util.SetDecorator
isExternal() - Method in class org.forgerock.services.context.ClientContext: Returns true if this client is external.
isHttpOnly() - Method in class org.forgerock.http.protocol.Cookie: Returns true if the user agent should make the cookie inaccessible to client side script.
isInformational() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.INFORMATIONAL one ?
isRawContentEmpty() - Method in class org.forgerock.http.protocol.Entity: Returns true if this entity's raw content is empty.
isRedirection() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.REDIRECTION one ?
isRootContext() - Method in class org.forgerock.services.context.AbstractContext
isRootContext() - Method in interface org.forgerock.services.context.Context: Returns true if this context is a root context.
isSecure() - Method in class org.forgerock.http.protocol.Cookie: Returns true if the user agent should use only secure means to send back this cookie.
isSecure() - Method in class org.forgerock.services.context.ClientContext: Returns true if this client connection is secure.
isServerError() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.SERVER_ERROR one ?
isSuccessful() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.SUCCESSFUL one ?
isWarningEnabled() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets whether a warning should be issued to the calling client if the request does not contain a resource API version.
isWarningEnabled() - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Returns true if warning headers should be set on the response if no Accept-API-Version header is present on the request.
iterator() - Method in class org.forgerock.http.util.SetDecorator

J

join(Collection<String>, char) - Static method in class org.forgerock.http.header.HeaderUtil: Joins a collection of header values into a single header value, with a specified specified separator.
joinPath(List<String>) - Static method in class org.forgerock.http.util.Paths: Joins a list of URL-decoded path elements into a url-encoded path.
Json - Class in org.forgerock.http.util: Provides read and write JSON capabilities.
Json.JsonValueModule - Class in org.forgerock.http.util: Jackson Module that uses a mixin to make sure that a JsonValue instance is serialized using its #getObject() value only.
Json.LocalizableStringModule - Class in org.forgerock.http.util: Jackson Module that adds a serializer for LocalizableString.
JsonValueModule() - Constructor for class org.forgerock.http.util.Json.JsonValueModule

K

keySet() - Method in class org.forgerock.http.protocol.Headers
keySet() - Method in class org.forgerock.http.protocol.RequestCookies

L

LATEST - Enum constant in enum org.forgerock.http.routing.DefaultVersionBehaviour: Will route to the latest version of the resource.
length() - Method in interface org.forgerock.http.io.Buffer: Returns the current length of the buffer.
LENGTH_REQUIRED - Static variable in class org.forgerock.http.protocol.Status: The 411 (Length Required) status code indicates that the server refuses to accept the request without a defined Content-Length (Section 3.3.2 of [RFC7230]).
Lists - Class in org.forgerock.http.util: Provides helper methods for List.
load(Class<S>, Options) - Method in interface org.forgerock.http.spi.Loader: Loads a service of the specified type.
load(Request) - Method in interface org.forgerock.http.session.SessionManager: Loads a new Session for the given Request.
Loader - Class in org.forgerock.http.util: Provides methods for dynamically loading classes.
Loader - Interface in org.forgerock.http.spi: An SPI interface for implementing alternative service loading strategies.
loadList(Class<E>) - Static method in class org.forgerock.http.util.Loader: Loads services of a particular type into a list.
loadMap(Class<K>, Class<V>) - Static method in class org.forgerock.http.util.Loader: Loads services of a particular type into a map.
localAddress(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the local server's address.
LocalizableStringModule() - Constructor for class org.forgerock.http.util.Json.LocalizableStringModule: Default constructor.
localPort(int) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the local server's port.
LocationHeader - Class in org.forgerock.http.header: Processes the Location message header.
LocationHeader() - Constructor for class org.forgerock.http.header.LocationHeader: Constructs a new empty header whose location is null.
LocationHeader(String) - Constructor for class org.forgerock.http.header.LocationHeader: Constructs a new header with the provided location URI.

M

makeLocalizingObjectWriter(ObjectMapper, Request) - Static method in class org.forgerock.http.util.Json: Make an object writer that contains the locales from the request for serialization of LocalizableString instances.
makeLocalizingObjectWriter(ObjectMapper, PreferredLocales) - Static method in class org.forgerock.http.util.Json: Make an object writer that contains the provided locales for serialization of LocalizableString instances.
MalformedHeaderException - Exception in org.forgerock.http.header: Thrown when a header string cannot be parsed to a rich Header implementation.
MalformedHeaderException(Exception) - Constructor for exception org.forgerock.http.header.MalformedHeaderException: Constructs a new exception with the given cause.
MalformedHeaderException(String) - Constructor for exception org.forgerock.http.header.MalformedHeaderException: Constructs a new exception with the given message.
MalformedHeaderException(String, Exception) - Constructor for exception org.forgerock.http.header.MalformedHeaderException: Constructs a new exception with the given message and cause.
matchedUri(String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the matchedUri value.
merge(List<D>) - Method in interface org.forgerock.http.ApiProducer: Merge the provided descriptors into a single descriptor.
merge(List<Swagger>) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
Message - Interface in org.forgerock.http.protocol: Elements common to requests and responses.
MessageImpl<T extends MessageImpl<T>> - Class in org.forgerock.http.protocol: Abstract message base class.
METHOD_DELETE - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP DELETE method.
METHOD_GET - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP GET method.
METHOD_HEAD - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP HEAD method.
METHOD_NOT_ALLOWED - Static variable in class org.forgerock.http.protocol.Status: The 405 (Method Not Allowed) status code indicates that the method received in the request-line is known by the origin server but not supported by the target resource.
METHOD_OPTIONS - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP OPTIONS method.
METHOD_PATCH - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP PATCH method.
METHOD_POST - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP POST method.
METHOD_PUT - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP PUT method.
METHOD_TRACE - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP TRACE method.
MISCELLANEOUS_PERSISTENT_WARNING - Static variable in class org.forgerock.http.header.WarningHeader: 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.http.header.WarningHeader: 199 Miscellaneous warning The warning text MAY include arbitrary information to be presented to a human user, or logged.
MOVED_PERMANENTLY - Static variable in class org.forgerock.http.protocol.Status: The 301 (Moved Permanently) status code indicates that the target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs.
MULTIPLE_CHOICES - Static variable in class org.forgerock.http.protocol.Status: The 300 (Multiple Choices) status code indicates that the target resource has more than one representation, each with its own more specific identifier, and information about the alternatives is being provided so that the user (or user agent) can select a preferred representation by redirecting its request to one or more of those identifiers.
MultiValueMap<K,V> - Class in org.forgerock.http.util: Wraps a map for which the values are lists, providing a set of convenience methods for handling list values.
MultiValueMap(Map<K, List<V>>) - Constructor for class org.forgerock.http.util.MultiValueMap: Creates a new multi-value map, wrapping an existing map with list values.
MutableUri - Class in org.forgerock.http: A MutableUri is a modifiable URI substitute.
MutableUri(String) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri using the given URL encoded String URI.
MutableUri(String, String, String, int, String, String, String) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri using the given fields values (decoded values).
MutableUri(URI) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri using the given URI.
MutableUri(MutableUri) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri with deep copy.

N

NAME - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.AcceptLanguageHeader: The name of the header.
NAME - Static variable in class org.forgerock.http.header.ConnectionHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentApiVersionHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentEncodingHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentLengthHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentTypeHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.CookieHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.LocationHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.SetCookieHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.TransactionIdHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.WarningHeader: The name of this header.
newBranchingInputStream(byte[]) - Static method in class org.forgerock.http.io.IO: Creates a new branching input stream that wraps a byte array.
newBranchingInputStream(InputStream, Factory<Buffer>) - Static method in class org.forgerock.http.io.IO: Creates a new branching input stream to wrap another input stream.
newChildProducer(String) - Method in interface org.forgerock.http.ApiProducer: Create a child producer with the same type, but with the extra ID fragment.
newChildProducer(String) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
newDecodedContentInputStream() - Method in class org.forgerock.http.protocol.Entity: Returns a branched input stream representing the decoded content of this entity.
newDecodedContentReader(Charset) - Method in class org.forgerock.http.protocol.Entity: Returns a branched reader representing the decoded content of this entity.
newFileBuffer(File, int) - Static method in class org.forgerock.http.io.IO: Creates a new file buffer that uses a local file for data storage.
newHttpClient(Options) - Method in interface org.forgerock.http.spi.HttpClientProvider: Returns a new HttpClient configured using the provided set of options.
newInstance(String) - Static method in class org.forgerock.http.util.Loader: Creates a new instance of a named class.
newInstance(String, Class<T>) - Static method in class org.forgerock.http.util.Loader: Creates a new instance of a named class.
newInternalClientContext(Context) - Static method in class org.forgerock.services.context.ClientContext: Creates an internal ClientContext instance.
newInternalServerError() - Static method in class org.forgerock.http.protocol.Responses: Generates an empty Internal Server Error response (500).
newInternalServerError(Exception) - Static method in class org.forgerock.http.protocol.Responses: Generates an Internal Server Error response (500) containing the cause of the error response.
newMemoryBuffer(int, int) - Static method in class org.forgerock.http.io.IO: Creates a new buffer that uses a byte array for data storage.
newNotFound() - Static method in class org.forgerock.http.protocol.Responses: Generates an empty Not Found response (404).
newOptionsFilter(String...) - Static method in class org.forgerock.http.filter.Filters: Creates a Filter which handles HTTP OPTIONS method requests.
newResourceApiVersionBehaviourManager() - Static method in class org.forgerock.http.routing.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.
newResponsePromise(Response) - Static method in class org.forgerock.http.protocol.Response: Returns a Promise representing the Response for an asynchronous Request which has already completed.
newResponsePromiseImpl() - Static method in class org.forgerock.http.protocol.Response: Creates a new pending Promise implementation representing the Response for an asynchronous Request.
newSessionFilter(SessionManager) - Static method in class org.forgerock.http.filter.Filters: Creates a session Filter that will use the provided SessionManager to manage the users session.
newTemporaryBuffer(int, int, int, File) - Static method in class org.forgerock.http.io.IO: Creates a new temporary buffer that first uses memory, then a temporary file for data storage.
newTemporaryStorage() - Static method in class org.forgerock.http.io.IO: Creates a new storage using the system dependent default temporary directory and default sizes.
newTemporaryStorage(File) - Static method in class org.forgerock.http.io.IO: Builds a storage using the given directory (may be null) and default sizes.
newTemporaryStorage(File, int, int, int) - Static method in class org.forgerock.http.io.IO: Builds a storage using the given directory (may be null) and provided sizes.
newWarning(String, String, Object...) - Static method in class org.forgerock.http.header.WarningHeader: Constructs a new warning header with the frequently-used error type: 100.
NO_CONTENT - Static variable in class org.forgerock.http.protocol.Status: The 204 (No Content) status code indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
NON_AUTHORITATIVE_INFO - Static variable in class org.forgerock.http.protocol.Status: The 203 (Non-Authoritative Information) status code indicates that the request was successful but the enclosed payload has been modified from that of the origin server's 200 (OK) response by a transforming proxy (Section 5.7.2 of [RFC7230]).
NONE - Enum constant in enum org.forgerock.http.routing.DefaultVersionBehaviour: Will not attempt to route to any version of the resource, instead will return an error to the client.
noopExceptionFunction() - Static method in class org.forgerock.http.protocol.Responses: Utility method returning an empty function, whose goal is to ease the transformation of a Promise type.
NOT_ACCEPTABLE - Static variable in class org.forgerock.http.protocol.Status: The 406 (Not Acceptable) status code indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request (Section 5.3), and the server is unwilling to supply a default representation.
NOT_FOUND - Static variable in class org.forgerock.http.protocol.Status: The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
NOT_IMPLEMENTED - Static variable in class org.forgerock.http.protocol.Status: The 501 (Not Implemented) status code indicates that the server does not support the functionality required to fulfill the request.
NOT_PRESENT - Static variable in class org.forgerock.http.header.WarningHeader: 100 Indicates that there is data missing from the request.
notifyDescriptorChange() - Method in interface org.forgerock.services.descriptor.Describable.Listener: Implement this method to handle changes to API Descriptors.
notifyDescriptorChange() - Method in class org.forgerock.services.routing.AbstractRouter
nullInputStream() - Static method in class org.forgerock.http.io.IO: Returns an input stream that holds no data.
nullOutputStream() - Static method in class org.forgerock.http.io.IO: Returns an output stream that discards all data written to it.

O

OK - Static variable in class org.forgerock.http.protocol.Status: The 200 (OK) status code indicates that the request has succeeded.
OLDEST - Enum constant in enum org.forgerock.http.routing.DefaultVersionBehaviour: Will route to the oldest version of the resource.
onExceptionInternalServerError() - Static method in class org.forgerock.http.protocol.Responses: Utility function that returns a Response whose status is Status.INTERNAL_SERVER_ERROR and the exception attached to the response as the cause.
OpenApiRequestFilter - Class in org.forgerock.http.swagger: This filter looks for the query parameter {code _api} : if present then it returns the API description of the downstream handlers, otherwise the request is processed as expected.
OpenApiRequestFilter() - Constructor for class org.forgerock.http.swagger.OpenApiRequestFilter
OPTION_CONNECT_TIMEOUT - Static variable in class org.forgerock.http.handler.HttpClientHandler: The TCP connect timeout for new HTTP connections.
OPTION_HOSTNAME_VERIFIER - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the SSL host name verification policy.
OPTION_KEY_MANAGERS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the list of key managers that should be used when configuring SSL/TLS connections.
OPTION_LOADER - Static variable in class org.forgerock.http.handler.HttpClientHandler: The strategy which should be used for loading the HttpClientProvider.
OPTION_MAX_CONNECTIONS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the maximum number of connections that should be pooled by the HTTP client.
OPTION_RETRY_REQUESTS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies whether requests should be retried if a failure is detected.
OPTION_REUSE_CONNECTIONS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies whether HTTP connections should be kept alive an reused for additional requests.
OPTION_SO_TIMEOUT - Static variable in class org.forgerock.http.handler.HttpClientHandler: The TCP socket timeout when waiting for HTTP responses.
OPTION_SSL_CIPHER_SUITES - Static variable in class org.forgerock.http.handler.HttpClientHandler: List of JSSE ciphers to be enabled on the HttpClient.
OPTION_SSL_ENABLED_PROTOCOLS - Static variable in class org.forgerock.http.handler.HttpClientHandler: List of SSL protocols to be enabled on the HttpClient.
OPTION_SSLCONTEXT_ALGORITHM - Static variable in class org.forgerock.http.handler.HttpClientHandler: SSLContext algorithm to be used when making SSL/TLS connections.
OPTION_TEMPORARY_STORAGE - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the temporary storage that should be used for storing HTTP responses.
OPTION_TRUST_MANAGERS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the list of trust managers that should be used when configuring SSL/TLS connections.
OptionsFilter - Class in org.forgerock.http.filter: Filter which handles OPTION HTTP requests to CREST resources.
org.forgerock.http - package org.forgerock.http: Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.decoder - package org.forgerock.http.decoder: Decodes HTTP entities that are compressed or encoded.
org.forgerock.http.decoder.internal - package org.forgerock.http.decoder.internal: Provides built-in Decoder implementations (gzip and deflate are currently supported).
org.forgerock.http.filter - package org.forgerock.http.filter: Core Filter implementations.
org.forgerock.http.handler - package org.forgerock.http.handler: Core Handler implementations.
org.forgerock.http.header - package org.forgerock.http.header: Processes HTTP message header fields.
org.forgerock.http.io - package org.forgerock.http.io: Provides stream buffering, branching, and storage functions.
org.forgerock.http.protocol - package org.forgerock.http.protocol: Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.routing - package org.forgerock.http.routing: Provides routing functionality for HTTP requests.
org.forgerock.http.session - package org.forgerock.http.session: Provides interfaces for managing and interacting with HTTP Sessions.
org.forgerock.http.spi - package org.forgerock.http.spi: HTTP service provider API.
org.forgerock.http.swagger - package org.forgerock.http.swagger: Classes to support OpenAPI API Descriptions using Swagger.
org.forgerock.http.util - package org.forgerock.http.util: Miscellaneous utility classes.
org.forgerock.services - package org.forgerock.services: This package contains the classes classes and interfaces used in the services' implementations.
org.forgerock.services.context - package org.forgerock.services.context: This package contains the Context interface and various common protocol independent implementations.
org.forgerock.services.descriptor - package org.forgerock.services.descriptor: Classes that allow services to be described.
org.forgerock.services.routing - package org.forgerock.services.routing: This package provides a simple framework for implementing routers.
originalUri(URI) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the originalUri value (only first UriRouterContext is expected to have that value set).
OverflowException - Exception in org.forgerock.http.io: An exception that is thrown if a buffer would overflow as a result of a write operation.
OverflowException() - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with null as its detail message.
OverflowException(String) - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with the specified detail message.
OverflowException(String, Throwable) - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with the specified detail message and cause.
OverflowException(Throwable) - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with the specified cause.

P

parent() - Method in class org.forgerock.http.io.BranchingInputStream: Returns the parent branching input stream from which this branch was created, or null if this is the trunk.
parse(Object) - Method in class org.forgerock.http.header.HeaderFactory: Create a header instance from a provided object representation.
parse(String) - Method in class org.forgerock.http.header.HeaderFactory: Create a header instance from String representation, which may contain multiple values if the header supports them.
parse(List<String>) - Method in class org.forgerock.http.header.HeaderFactory: Create a header instance from a list of String representations, each of which may in turn contain multiple values if the header supports them.
parseDate(String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the supported HTTP-date formats as specified in RFC 2616.
parseMultiValuedHeader(String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the header content as a multi-valued comma separated value.
parseMultiValuedHeader(Message, String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the named header from the message as a multi-valued comma separated value.
parseParameter(String) - Static method in class org.forgerock.http.header.HeaderUtil: Splits a single HTTP header parameter name and value from an input string value.
parseParameters(Collection<String>) - Static method in class org.forgerock.http.header.HeaderUtil: Parses a set of HTTP header parameters from a collection of values.
parseSingleValuedHeader(Message, String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the named single-valued header from the message.
Paths - Class in org.forgerock.http.util: Utilities for manipulating paths.
PAYLOAD_TOO_LARGE - Static variable in class org.forgerock.http.protocol.Status: The 413 (Payload Too Large) status code indicates that the server is refusing to process a request because the request payload is larger than the server is willing or able to process.
PAYMENT_REQUIRED - Static variable in class org.forgerock.http.protocol.Status: The 402 (Payment Required) status code is reserved for future use.
PipeBufferedStream - Class in org.forgerock.http.io: Represents a pipe for transferring bytes from an OutputStream to a BranchingInputStream.
PipeBufferedStream() - Constructor for class org.forgerock.http.io.PipeBufferedStream: Constructs a new PipeBufferedStream with a default Factory.
PipeBufferedStream(Factory<Buffer>) - Constructor for class org.forgerock.http.io.PipeBufferedStream: Constructs a new PipeBufferedStream with the given Factory.
pop() - Method in class org.forgerock.http.protocol.Entity: Restores the underlying input stream to the state it had immediately before the last call to Entity.push().
PROTOCOL - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader: The name of the protocol value component.
push() - Method in class org.forgerock.http.protocol.Entity: Saves the current position of the underlying input stream and creates a new buffered input stream.
put(String, Object) - Method in class org.forgerock.http.protocol.Headers: A script compatible put method that will accept a Header, String, Collection<String> and String[] value.
put(String, V) - Method in class org.forgerock.http.util.CaseInsensitiveMap
put(Header) - Method in class org.forgerock.http.protocol.Headers: A put method to add a particular Header instance.
putAll(Map<? extends String, ? extends Object>) - Method in class org.forgerock.http.protocol.Headers: A script compatible putAll method that will accept Header, String, Collection<String> and String[] values.
putAll(Map<? extends String, ? extends V>) - Method in class org.forgerock.http.util.CaseInsensitiveMap
putSingle(K, V) - Method in class org.forgerock.http.util.MultiValueMap: Maps a single value to the specified key, replacing any value(s) that are already mapped to that key.

Q

quote(String) - Static method in class org.forgerock.http.header.HeaderUtil: Encloses a string in quotation marks.

R

read() - Method in class org.forgerock.http.io.FileBranchingStream
read(int) - Method in interface org.forgerock.http.io.Buffer: Reads a single byte of data from the buffer.
read(int, byte[], int, int) - Method in interface org.forgerock.http.io.Buffer: Reads up to len bytes of data from the buffer into an array of bytes.
readJson(Reader) - Static method in class org.forgerock.http.util.Json: Parses to json the provided reader.
readJson(String) - Static method in class org.forgerock.http.util.Json: Parses to json the provided data.
readJsonLenient(InputStream) - Static method in class org.forgerock.http.util.Json: This function it's only used to read our configuration files and allows JSON files to contain non strict JSON such as comments or single quotes.
readJsonLenient(Reader) - Static method in class org.forgerock.http.util.Json: This function it's only used to read our configuration files and allows JSON files to contain non strict JSON such as comments or single quotes.
rebase(URI) - Method in class org.forgerock.http.MutableUri: Changes the base scheme, host and port of this MutableUri to that specified in a base URI, or leaves them unchanged if the base URI is null.
rebase(URI, URI) - Static method in class org.forgerock.http.util.Uris: Changes the base scheme, host and port of a request to that specified in a base URI, or leaves them unchanged if the base URI is null.
rebase(MutableUri) - Method in class org.forgerock.http.MutableUri: Changes the base scheme, host and port of this MutableUri to that specified in a base URI, or leaves them unchanged if the base URI is null.
REDIRECTION - Enum constant in enum org.forgerock.http.protocol.Status.Family: The 3xx (Redirection) class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request.
relativize(MutableUri) - Method in class org.forgerock.http.MutableUri: Relativizes the given URI against this URI.
remainingUri(String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the remainingUri value.
remoteAddress(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's remote address.
remotePort(int) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's remote port.
remoteUser(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's remote user.
remove(Object) - Method in class org.forgerock.http.protocol.Headers: Rich-type friendly remove method.
remove(Object) - Method in class org.forgerock.http.util.CaseInsensitiveMap
remove(Object) - Method in class org.forgerock.http.util.CaseInsensitiveSet
remove(Object) - Method in class org.forgerock.http.util.SetDecorator: Removes the specified element from the set if it is present (optional operation).
removeAll(Collection<?>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
removeAll(Collection<?>) - Method in class org.forgerock.http.util.SetDecorator: Removes from the set all of its elements that are contained in the specified collection (optional operation).
removeAllRoutes() - Method in class org.forgerock.services.routing.AbstractRouter: Removes all of the routes from this router.
removeDescriptorListener(Describable.Listener) - Method in interface org.forgerock.services.descriptor.Describable: Remove a listener from API Descriptor changes.
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.services.routing.AbstractRouter
removeRoute(RouteMatcher<R>...) - Method in class org.forgerock.services.routing.AbstractRouter: Removes one or more routes from this router.
removeTrailingSlash(String) - Static method in class org.forgerock.http.util.Paths: Removes trailing slash (if there is any), returns the same value otherwise.
Request - Class in org.forgerock.http.protocol: A request message.
Request() - Constructor for class org.forgerock.http.protocol.Request: Creates a new request message.
Request(Request) - Constructor for class org.forgerock.http.protocol.Request: Creates a defensive copy of the given request message.
REQUEST_TIMEOUT - Static variable in class org.forgerock.http.protocol.Status: The 408 (Request Timeout) status code indicates that the server did not receive a complete request message within the time that it was prepared to wait.
RequestAuditContext - Class in org.forgerock.services.context: A context for audit information for an incoming request.
RequestAuditContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.RequestAuditContext: Restores a saved context.
RequestAuditContext(Context) - Constructor for class org.forgerock.services.context.RequestAuditContext: Constructs a new context using the specified parent and the current time as the request received time.
RequestAuditContext(Context, TimeService) - Constructor for class org.forgerock.services.context.RequestAuditContext: Constructs a new context using the specified parent and the current time as the request received time.
RequestCookies - Class in org.forgerock.http.protocol: Exposes incoming request cookies.
RequestCookies(Request) - Constructor for class org.forgerock.http.protocol.RequestCookies: Constructs a new request cookies object that reads cookies from the specified request.
requestResourceApiVersionMatcher(Version) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches the request resource API version with the provided version.
requestUriMatcher(RoutingMode, String) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches Requests with the provided mode and template.
RESET_CONTENT - Static variable in class org.forgerock.http.protocol.Status: The 205 (Reset Content) status code indicates that the server has fulfilled the request and desires that the user agent reset the "document view", which caused the request to be sent, to its original state as received from the origin server.
resolve(MutableUri) - Method in class org.forgerock.http.MutableUri: Resolves the given URI against this URI.
RESOURCE - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader: The name of the resource value component.
ResourceApiVersionBehaviourManager - Interface in org.forgerock.http.routing: Implementations of this interface will be responsible for maintaining the behaviour of API Version routing.
resourceApiVersionContextFilter(ResourceApiVersionBehaviourManager) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a Filter which MUST be placed, in the route, before any API Version routing takes place.
resourceApiVersionMatcher(Version) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches the request resource API version with the provided version.
ResourceApiVersionRoutingFilter - Class in org.forgerock.http.routing: 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.
ResourceApiVersionRoutingFilter(ResourceApiVersionBehaviourManager) - Constructor for class org.forgerock.http.routing.ResourceApiVersionRoutingFilter: Constructs a new ResourceApiVersionRoutingFilter instance.
Response - Class in org.forgerock.http.protocol: A response message.
Response(Response) - Constructor for class org.forgerock.http.protocol.Response: Creates a defensive copy of the given response message.
Response(Status) - Constructor for class org.forgerock.http.protocol.Response: Creates a new response with a default status.
RESPONSE_STALE - Static variable in class org.forgerock.http.header.WarningHeader: 110 Response is stale MUST be included whenever the returned response is stale.
ResponseException - Exception in org.forgerock.http.protocol: An HTTP Framework Exception that can be used by filters/handlers to simplify control-flow inside async call-backs.
ResponseException(String) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given message.
ResponseException(String, Throwable) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given message and parent cause.
ResponseException(Response) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given response.
ResponseException(Response, String, Throwable) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given response, message and parent cause.
Responses - Class in org.forgerock.http.protocol: Provide out-of-the-box, pre-configured Response objects.
retainAll(Collection<?>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
retainAll(Collection<?>) - Method in class org.forgerock.http.util.SetDecorator: Retains only the elements in the set that are contained in the specified collection (optional operation).
REVALIDATION_FAILED - Static variable in class org.forgerock.http.header.WarningHeader: 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.
RootContext - Class in org.forgerock.services.context: A Context which has an a globally unique ID but no parent.
RootContext() - Constructor for class org.forgerock.services.context.RootContext: Construct a new RootContext with the default IdGenerator.
RootContext(String) - Constructor for class org.forgerock.services.context.RootContext: Construct a new RootContext with the given id (uniqueness is not verified).
RootContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.RootContext: Restore from JSON representation.
RouteMatch - Interface in org.forgerock.services.routing: Contains the result of routing to a particular route.
RouteMatcher<R> - Class in org.forgerock.services.routing: A matcher for evaluating whether a route matches the incoming request.
RouteMatcher() - Constructor for class org.forgerock.services.routing.RouteMatcher
RouteMatchers - Class in org.forgerock.http.routing: A utility class that contains methods for creating route matchers.
Router - Class in org.forgerock.http.routing: A router which routes requests based on route matchers.
Router() - Constructor for class org.forgerock.http.routing.Router: Creates a new router with no routes defined.
Router(Router) - Constructor for class org.forgerock.http.routing.Router: Creates a new router containing the same routes and default route as the provided router.
RoutingMode - Enum in org.forgerock.http.routing: The algorithm which should be used when matching URI templates against request resource names.

S

save(Response) - Method in interface org.forgerock.http.session.Session: Save the session state to the response.
save(Session, Response) - Method in interface org.forgerock.http.session.SessionManager: Saves the session into the provided response.
secure(boolean) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets whether if the client connection is secure.
SecurityContext - Class in org.forgerock.services.context: A Context containing information about the client performing the request which may be used when performing authorization decisions.
SecurityContext(String, Context, String, Map<String, Object>) - Constructor for class org.forgerock.services.context.SecurityContext: Creates a new security context having the provided ID, and parent.
SecurityContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.SecurityContext: Restore from JSON representation.
SecurityContext(Context, String, Map<String, Object>) - Constructor for class org.forgerock.services.context.SecurityContext: Creates a new security context having the provided parent and an ID automatically generated using UUID.randomUUID().
SEE_OTHER - Static variable in class org.forgerock.http.protocol.Status: The 303 (See Other) status code indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request.
selfApiMatcher() - Static method in class org.forgerock.http.routing.RouteMatchers: A matcher to check if the request is for all versions of the API descriptor of the current path.
send(Request) - Method in class org.forgerock.http.Client: Sends an HTTP request and returns a Promise representing the pending HTTP response.
send(Context, Request) - Method in class org.forgerock.http.Client: Sends an HTTP request and returns a Promise representing the pending HTTP response.
sendAsync(Request) - Method in interface org.forgerock.http.spi.HttpClient: Returns a Promise representing the asynchronous Response of the given request.
SERVER_ERROR - Enum constant in enum org.forgerock.http.protocol.Status.Family: The 5xx (Server Error) class of status code indicates that the server is aware that it has erred or is incapable of performing the requested method.
SERVICE_LOADER - Static variable in interface org.forgerock.http.spi.Loader: The default Loader implementation used throughout the HTTP framework.
SERVICE_UNAVAILABLE - Static variable in class org.forgerock.http.protocol.Status: The 503 (Service Unavailable) status code indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
SERVICES - Static variable in interface org.forgerock.http.decoder.Decoder: Mapping of supported codings to associated decoders.
Session - Interface in org.forgerock.http.session: An interface for managing attributes across multiple requests from the same user agent.
SessionContext - Class in org.forgerock.http.session: A SessionContext is a mechanism for maintaining state between components when processing a successive requests from the same logical client or end-user.
SessionContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.session.SessionContext: Restore from JSON representation.
SessionContext(Context, Session) - Constructor for class org.forgerock.http.session.SessionContext: Constructs a new SessionContext.
SessionManager - Interface in org.forgerock.http.session: A SessionFactory is responsible to create a new type of Session.
set - Variable in class org.forgerock.http.util.SetDecorator: The set wrapped by this decorator.
setBytes(byte[]) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the raw data contained in the provided byte array.
setCause(Exception) - Method in class org.forgerock.http.protocol.Response: Link a 'caused by' exception to this response.
setComment(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the intended use of a cookie.
setCommentURL(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the URL identifying the intended use of a cookie.
SetCookieHeader - Class in org.forgerock.http.header: Processes the Set-Cookie request message header.
SetCookieHeader(List<Cookie>) - Constructor for class org.forgerock.http.header.SetCookieHeader: Constructs a new header with the provided cookies.
SetDecorator<E> - Class in org.forgerock.http.util: Contains another set, which is uses as its basic source of data, possibly transforming the data along the way.
SetDecorator(Set<E>) - Constructor for class org.forgerock.http.util.SetDecorator: Constructs a new set decorator, wrapping the specified set.
setDefaultRoute(H) - Method in class org.forgerock.services.routing.AbstractRouter: Sets the handler to be used as the default route for requests which do not match any of the other defined routes.
setDefaultVersionBehaviour(DefaultVersionBehaviour) - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Sets the default routing behaviour to use when the request does not contain the Accept-API-Version header.
setDiscard(Boolean) - Method in class org.forgerock.http.protocol.Cookie: Sets the value indicating whether the user agent should discard the cookie unconditionally when it terminates.
setDomain(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the domain for which the cookie is valid.
setEmpty() - Method in class org.forgerock.http.protocol.Entity: Mark this entity as being empty.
setEntity(Object) - Method in interface org.forgerock.http.protocol.Message: Sets the content of the entity to the provided value.
setEntity(Object) - Method in class org.forgerock.http.protocol.Request
setEntity(Object) - Method in class org.forgerock.http.protocol.Response
setExpires(Date) - Method in class org.forgerock.http.protocol.Cookie: Sets the lifetime of the cookie, expressed as the date and time of expiration.
setFragment(String) - Method in class org.forgerock.http.MutableUri: Update the fragment (not encoded) of this MutableUri.
setHost(String) - Method in class org.forgerock.http.MutableUri: Update the host name of this MutableUri.
setHttpOnly(Boolean) - Method in class org.forgerock.http.protocol.Cookie: Sets the value indicating whether the user agent should make the cookie inaccessible to client side script.
setJson(Object) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the JSON representation of the provided object.
setMaxAge(Integer) - Method in class org.forgerock.http.protocol.Cookie: Sets the lifetime of the cookie, expressed in seconds.
setMethod(String) - Method in class org.forgerock.http.protocol.Request: Sets the method to be performed on the resource.
setName(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the name of the cookie.
setPath(String) - Method in class org.forgerock.http.MutableUri: Update the path (not encoded) of this MutableUri.
setPath(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the subset of URLs on the origin server to which this cookie applies.
setPort(int) - Method in class org.forgerock.http.MutableUri: Update the port of this MutableUri.
setProtocolVersion(Version) - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Sets the protocol API version of the framework used to handle the request.
setQuery(String) - Method in class org.forgerock.http.MutableUri: Update the query string (not encoded) of this MutableUri.
setRawContentInputStream(BranchingInputStream) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the provided input stream.
setRawFragment(String) - Method in class org.forgerock.http.MutableUri: Update the fragment (encoded) of this MutableUri.
setRawPath(String) - Method in class org.forgerock.http.MutableUri: Update the pah (encoded) of this MutableUri.
setRawQuery(String) - Method in class org.forgerock.http.MutableUri: Update the query (encoded) of this MutableUri.
setRawUserInfo(String) - Method in class org.forgerock.http.MutableUri: Update the user info (encoded) of this MutableUri.
setScheme(String) - Method in class org.forgerock.http.MutableUri: Update the scheme of this MutableUri.
setSecure(Boolean) - Method in class org.forgerock.http.protocol.Cookie: Sets the value indicating whether the user agent should use only secure means to send back this cookie.
setSession(Session) - Method in class org.forgerock.http.session.SessionContext: Sets the Session associated with the remote client.
setStatus(Status) - Method in class org.forgerock.http.protocol.Response: Sets the response status code.
setString(String) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the provided string.
setupModule(Module.SetupContext) - Method in class org.forgerock.http.util.Json.JsonValueModule
setUri(String) - Method in class org.forgerock.http.protocol.Request: Sets the fully-qualified string URI of the resource being accessed.
setUri(URI) - Method in class org.forgerock.http.protocol.Request: Sets the fully-qualified URI of the resource being accessed.
setUriDetailsIfNotPresent(Request, Context, Swagger) - Method in class org.forgerock.http.swagger.OpenApiRequestFilter: Deduce and set the base URI of the request for the OpenAPI descriptor from the request context.
setUserInfo(String) - Method in class org.forgerock.http.MutableUri: Update the user info (not encoded) of this MutableUri.
setValue(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the value of the cookie.
setVersion(Integer) - Method in class org.forgerock.http.protocol.Cookie: Sets the version of the state management mechanism to which this cookie conforms.
setVersion(String) - Method in interface org.forgerock.http.protocol.Message: Sets the protocol version.
setVersion(String) - Method in class org.forgerock.http.protocol.Request
setVersion(String) - Method in class org.forgerock.http.protocol.Response
setWarningEnabled(boolean) - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Sets if warning headers should be set on the response if no Accept-API-Version header is present on the request.
simpleHttpApplication(Handler, Factory<Buffer>) - Static method in class org.forgerock.http.Applications: Create a simple HttpApplication that just returns the provided arguments from the appropriate methods.
size() - Method in class org.forgerock.http.protocol.Headers
size() - Method in class org.forgerock.http.protocol.RequestCookies
size() - Method in class org.forgerock.http.util.SetDecorator
split(String, char) - Static method in class org.forgerock.http.header.HeaderUtil: Parses an HTTP header value, splitting it into multiple values around the specified separator.
start() - Method in interface org.forgerock.http.HttpApplication: Gets the root Handler that will handle all HTTP requests.
STARTS_WITH - Enum constant in enum org.forgerock.http.routing.RoutingMode: The URI template must match the beginning of a request's resource name in order for the route to be selected.
Status - Class in org.forgerock.http.protocol: The status-code element is a three-digit integer code giving the result of the attempt to understand and satisfy the request.
Status.Family - Enum in org.forgerock.http.protocol: The first digit of the status-code defines the class of response.
stop() - Method in interface org.forgerock.http.HttpApplication: Called when HTTP application is shutdown.
stream(InputStream, OutputStream) - Static method in class org.forgerock.http.io.IO: Streams all data from an input stream to an output stream.
stream(InputStream, OutputStream, int) - Static method in class org.forgerock.http.io.IO: Streams data from an input stream to an output stream, up to a specified length.
stream(Reader, Writer) - Static method in class org.forgerock.http.io.IO: Streams all characters from a reader to a writer.
STRICT - Enum constant in enum org.forgerock.http.handler.HttpClientHandler.HostnameVerifier: Requires that the host name matches the host name presented in the certificate.
SUCCESSFUL - Enum constant in enum org.forgerock.http.protocol.Status.Family: The 2xx (Successful) class of status code indicates that the client's $ request was successfully received, understood, and accepted.
SwaggerApiProducer - Class in org.forgerock.http.swagger: An API Producer for APIs that use the Swagger model implementation of the OpenAPI specification.
SwaggerApiProducer(Info) - Constructor for class org.forgerock.http.swagger.SwaggerApiProducer: Create a new API Description Producer with null as basePath, host and no scheme.
SwaggerApiProducer(Info, String, String, Scheme...) - Constructor for class org.forgerock.http.swagger.SwaggerApiProducer: Create a new API Description Producer.
SwaggerApiProducer(Info, String, String, List<Scheme>) - Constructor for class org.forgerock.http.swagger.SwaggerApiProducer: Create a new API Description Producer.
SwaggerExtended - Class in org.forgerock.http.swagger: Extension of Swagger to override some of its behaviors.
SwaggerExtended() - Constructor for class org.forgerock.http.swagger.SwaggerExtended
SwaggerUtils - Class in org.forgerock.http.swagger: Swagger utility.
SWITCHING_PROTOCOLS - Static variable in class org.forgerock.http.protocol.Status: The 101 (Switching Protocols) status code indicates that the server understands and is willing to comply with the client's request, via the Upgrade header field (Section 6.7 of [RFC7230]), for a change in the application protocol being used on this connection.
sync() - Method in class org.forgerock.http.util.CaseInsensitiveMap: Synchronizes the keys of this case insensitive map and those of the map it is wrapping.
SYSPROP_TRUST_TRANSACTION_HEADER - Static variable in class org.forgerock.http.filter.TransactionIdInboundFilter: The system property to allow to trust the HTTP header X-ForgeRock-TransactionId.

T

TEAPOT - Static variable in class org.forgerock.http.protocol.Status: Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot".
templateVariable(String, String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Add the given name:value pair in the variables map.
templateVariables(Map<String, String>) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the variables value.
TEMPORARY_REDIRECT - Static variable in class org.forgerock.http.protocol.Status: The 307 (Temporary Redirect) status code indicates that the target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI.
thisRouterUriMatcher - Variable in class org.forgerock.services.routing.AbstractRouter: Matches the current route.
toArray() - Method in class org.forgerock.http.util.SetDecorator
toArray(T[]) - Method in class org.forgerock.http.util.SetDecorator: Returns an array containing all of the elements in the set; the runtime type of the returned array is that of the specified array.
toASCIIString() - Method in class org.forgerock.http.MutableUri: Returns the content of this URI as a US-ASCII string.
toFormString() - Method in class org.forgerock.http.protocol.Form: Returns this form in a form URL-encoded string.
toJson() - Method in class org.forgerock.services.TransactionId: Returns a representation of this TransactionId as a JsonValue.
toJsonValue() - Method in class org.forgerock.services.context.AbstractContext
toJsonValue() - Method in interface org.forgerock.services.context.Context: Return this Context as a JsonValue (for persistence).
toJsonValue() - Method in class org.forgerock.services.context.TransactionIdContext: Updates the data object to have the current transactionId state.
TOO_MANY_REQUESTS - Static variable in class org.forgerock.http.protocol.Status: The 429 status code indicates that the user has sent too many requests in a given amount of time ("rate limiting").
toQueryString() - Method in class org.forgerock.http.protocol.Form: Returns this form in a URL-encoded query string.
toRequestEntity(Request) - Method in class org.forgerock.http.protocol.Form: Populates a request with the necessary headers and entity for the form to be submitted as a POST with application/x-www-form-urlencoded content type.
toRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form: Sets a request URI with query parameters.
toString() - Method in class org.forgerock.http.header.Warning: Formats a Warning header value, according to RFC 2616 14.46.
toString() - Method in class org.forgerock.http.MutableUri
toString() - Method in class org.forgerock.http.protocol.Cookie
toString() - Method in class org.forgerock.http.protocol.Entity: Returns the content of this entity decoded as a string.
toString() - Method in class org.forgerock.http.protocol.Form: Deprecated.
use Form.toFormString() instead.
toString() - Method in class org.forgerock.http.protocol.Header
toString() - Method in class org.forgerock.http.protocol.RequestCookies
toString() - Method in class org.forgerock.http.protocol.Status
toString() - Method in class org.forgerock.http.routing.Version
toString() - Method in class org.forgerock.services.context.AbstractContext
toString() - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
toString() - Method in class org.forgerock.services.routing.RouteMatcher: Returns a String representation of the route matcher.
toWarnings(List<String>) - Static method in class org.forgerock.http.header.WarningHeader: Matches warning-headers from a List of header-values.
TRANFORMATION_APPLIED - Static variable in class org.forgerock.http.header.WarningHeader: 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.
TransactionId - Class in org.forgerock.services: TransactionId value should be unique per request coming from an external agent so that all events occurring in response to the same external stimulus can be tied together.
TransactionId() - Constructor for class org.forgerock.services.TransactionId: Construct a TransactionId with a random value.
TransactionId(String) - Constructor for class org.forgerock.services.TransactionId: Construct a TransactionId with the specified value.
TransactionIdContext - Class in org.forgerock.services.context: This context aims to hold the TransactionId.
TransactionIdContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.TransactionIdContext: Restores a saved context.
TransactionIdContext(Context, TransactionId) - Constructor for class org.forgerock.services.context.TransactionIdContext: Constructs a new TransactionIdContext.
TransactionIdHeader - Class in org.forgerock.http.header: Processes the transactionId header used mainly for audit purpose.
TransactionIdHeader(String) - Constructor for class org.forgerock.http.header.TransactionIdHeader: Constructs a new header with the provided value for the transaction id.
TransactionIdInboundFilter - Class in org.forgerock.http.filter: This filter is responsible to create the TransactionIdContext in the context's chain.
TransactionIdInboundFilter() - Constructor for class org.forgerock.http.filter.TransactionIdInboundFilter
TransactionIdOutboundFilter - Class in org.forgerock.http.filter: This filter aims to create a sub-transaction's id and inserts that value as a header of the request.
TransactionIdOutboundFilter() - Constructor for class org.forgerock.http.filter.TransactionIdOutboundFilter
transformApi(D, ApiProducer<D>) - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
transformApi(D, ApiProducer<D>) - Method in class org.forgerock.services.routing.RouteMatcher: Transform the API Descriptor as appropriate for the parent router's view of the child routes.

U

UNAUTHORIZED - Static variable in class org.forgerock.http.protocol.Status: The request requires user authentication.
UNKNOWN - Enum constant in enum org.forgerock.http.protocol.Status.Family: This class of status code is for all status code above 600, that are not classified in the specification.
UnmodifiableCollection - Interface in org.forgerock.http.util: An marker interface for tagging collection implementations as read-only.
unquote(String) - Static method in class org.forgerock.http.header.HeaderUtil: Unquotes a string following the logic of HeaderUtil.quote(String).
UNSUPPORTED_MEDIA_TYPE - Static variable in class org.forgerock.http.protocol.Status: The 415 (Unsupported Media Type) status code indicates that the origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.
UNUSED - Static variable in class org.forgerock.http.protocol.Status: The 306 status code was defined in a previous version of this specification, is no longer used, and the code is reserved.
UPGRADE_REQUIRED - Static variable in class org.forgerock.http.protocol.Status: The 426 (Upgrade Required) status code indicates that the server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
uri(String) - Static method in class org.forgerock.http.MutableUri: Factory method for avoiding typing new MutableUri("http://...").
URI_TOO_LONG - Static variable in class org.forgerock.http.protocol.Status: The 414 (URI Too Long) status code indicates that the server is refusing to service the request because the request-target (Section 5.3 of [RFC7230]) is longer than the server is willing to interpret.
uriMatcher(RoutingMode, String) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches ResourcePaths with the provided mode and template.
uriMatcher(RoutingMode, String) - Method in class org.forgerock.http.routing.Router
uriMatcher(RoutingMode, String) - Method in class org.forgerock.services.routing.AbstractRouter: Create a URI matcher suitable for the request type <R>.
uriRouterContext(Context) - Static method in class org.forgerock.http.routing.UriRouterContext: Return a builder for a new UriRouterContext.
UriRouterContext - Class in org.forgerock.http.routing: A Context which is created when a request has been routed.
UriRouterContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.routing.UriRouterContext: Restore from JSON representation.
UriRouterContext(Context, String, String, Map<String, String>) - Constructor for class org.forgerock.http.routing.UriRouterContext: Creates a new routing context having the provided parent, URI template variables, and an ID automatically generated using UUID.randomUUID().
UriRouterContext(Context, String, String, Map<String, String>, URI) - Constructor for class org.forgerock.http.routing.UriRouterContext: Creates a new routing context having the provided parent, URI template variables, and an ID automatically generated using UUID.randomUUID().
UriRouterContext.Builder - Class in org.forgerock.http.routing: Ease UriRouterContext construction.
Uris - Class in org.forgerock.http.util: Utility class for performing operations on universal resource identifiers.
urlDecode(Object) - Static method in class org.forgerock.http.util.Paths: Returns the URL path decoding of the provided object's string representation.
urlDecodeFragment(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded fragment as per RFC 3986.
urlDecodePathElement(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded path element as per RFC 3986.
urlDecodeQueryParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded query parameter name or value as per RFC 3986.
urlDecodeUserInfo(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded userInfo as per RFC 3986.
urlEncode(Object) - Static method in class org.forgerock.http.util.Paths: Returns the URL path encoding of the provided object's string representation.
urlEncodeFragment(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided fragment as per RFC 3986.
urlEncodePathElement(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided path element as per RFC 3986.
urlEncodeQueryParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided query parameter name or value as per RFC 3986.
urlEncodeUserInfo(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided userInfo as per RFC 3986.
USE_PROXY - Static variable in class org.forgerock.http.protocol.Status: The 305 (Use Proxy) status code was defined in a previous version of this specification and is now deprecated (Appendix B).
userAgent(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's user agent.

V

valueOf(int) - Static method in enum org.forgerock.http.protocol.Status.Family: Find the class of the given status code.
valueOf(int) - Static method in class org.forgerock.http.protocol.Status: Get a Status from the given integer.
valueOf(int, String) - Static method in class org.forgerock.http.protocol.Status: Get a Status from the given integer.
valueOf(String) - Static method in enum org.forgerock.http.handler.HttpClientHandler.HostnameVerifier: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.http.header.AcceptApiVersionHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ConnectionHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ContentApiVersionHeader: Constructs a new header, initialized from the specified string.
valueOf(String) - Static method in class org.forgerock.http.header.ContentEncodingHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ContentLengthHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ContentTypeHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.CookieHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.LocationHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.SetCookieHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.TransactionIdHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.Warning: Parses a warning-header value (part after Warning:).
valueOf(String) - Static method in class org.forgerock.http.header.WarningHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in enum org.forgerock.http.protocol.Status.Family: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.http.routing.DefaultVersionBehaviour: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.http.routing.RoutingMode: Returns the enum constant of this type with the specified name.
valueOf(String...) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Create a header from a list of preferred Locale language tags.
valueOf(List<String>) - Static method in class org.forgerock.http.header.SetCookieHeader: Constructs a new header, initialized from the specified list of Set-Cookie values.
valueOf(List<Locale>) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Create a header from a list of preferred Locale instances.
valueOf(Set<String>) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Create a header from a list of header values.
valueOf(Message) - Static method in class org.forgerock.http.header.AcceptApiVersionHeader: Constructs a new header, initialized from the specified message.
valueOf(Message) - Static method in class org.forgerock.http.header.ConnectionHeader: Constructs a new header, initialized from the specified message.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentApiVersionHeader: Constructs a new header, initialized from the specified message.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentEncodingHeader: Constructs a new header, initialized from the specified message.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentLengthHeader: Constructs a new header, initialized from the specified message.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentTypeHeader: Constructs a new header, initialized from the specified message.
valueOf(Message) - Static method in class org.forgerock.http.header.LocationHeader: Constructs a new header, initialized from the specified message.
valueOf(Message) - Static method in class org.forgerock.http.header.WarningHeader: Constructs a new header, initialized from the specified message.
valueOf(Request) - Static method in class org.forgerock.http.header.CookieHeader: Constructs a new header, initialized from the specified request message.
valueOf(Request) - Static method in class org.forgerock.http.header.TransactionIdHeader: Constructs a new header, initialized from the specified request.
valueOf(Response) - Static method in class org.forgerock.http.header.SetCookieHeader: Constructs a new header, initialized from the specified response message.
valueOf(JsonValue) - Static method in class org.forgerock.services.TransactionId: Creates a TransactionId from a JsonValue.
valueOf(PreferredLocales) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Creates an accept language header representation for a PreferredLocales instance.
values() - Static method in enum org.forgerock.http.handler.HttpClientHandler.HostnameVerifier: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.forgerock.http.protocol.Headers
values() - Method in class org.forgerock.http.protocol.RequestCookies
values() - Static method in enum org.forgerock.http.protocol.Status.Family: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.routing.DefaultVersionBehaviour: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.routing.RoutingMode: Returns an array containing the constants of this enum type, in the order they are declared.
version(int) - Static method in class org.forgerock.http.routing.Version: Creates a new version using the provided version information and a minor.
version(int, int) - Static method in class org.forgerock.http.routing.Version: Creates a new version using the provided version information.
version(String) - Static method in class org.forgerock.http.routing.Version: Parses the string argument as a version.
Version - Class in org.forgerock.http.routing: Represents some version in the form majorNumber.minorNumber, for instance 2.4.

W

Warning - Class in org.forgerock.http.header: WarningHeader entry.
Warning(int, String, String) - Constructor for class org.forgerock.http.header.Warning: Creates a new instance without optional date.
Warning(int, String, String, Date) - Constructor for class org.forgerock.http.header.Warning: Creates a new instance with optional date.
WarningHeader - Class in org.forgerock.http.header: Processes the Warning message header.
WarningHeader(List<Warning>) - Constructor for class org.forgerock.http.header.WarningHeader: Constructor for multiple Warnings.
WarningHeader(Warning) - Constructor for class org.forgerock.http.header.WarningHeader: Constructor for single Warning.
withDefaultProtocolVersion(Version) - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Will set the accepted protocol version, if not provided in the Accept-API-Version header.
withDefaultResourceVersion(Version) - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Will set the accepted resource version, if not provided in the Accept-API-Version header.
withoutQueryAndFragment(URI) - Static method in class org.forgerock.http.util.Uris: Returns a new URI having the same scheme, authority and path, but no query nor fragment.
withPath(D, String) - Method in interface org.forgerock.http.ApiProducer: Mutate the provided descriptor to add the specified path.
withPath(Swagger, String) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
withQuery(URI, Form) - Static method in class org.forgerock.http.util.Uris: Returns a new URI having the provided query parameters.
withVersion(D, Version) - Method in interface org.forgerock.http.ApiProducer: Mutate the provided descriptor to add the specified version.
withVersion(Swagger, Version) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
writeJson(Object) - Static method in class org.forgerock.http.util.Json: Writes the JSON content of the object passed in parameter.

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