All Classes and Interfaces
Class
Description
A base implementation of the
Context
interface.An abstract base class for implementing routers.
Processes the
Accept-API-Version
message header.A header class representing the Accept-Language HTTP header.
A producer of API Descriptions.
A
Context
which is created when a request is and has been routed
based on resource API version.Utility methods to work with CHF Applications.
An
AttributesContext
is a mechanism for transferring transient state between components when processing a
single request.An input stream that can branch into separate input streams to perform
divergent reads.
A dynamically growing data buffer.
An implementation of a map whose keys are case-insensitive strings.
An implementation of a set whose values are case-insensitive strings.
An HTTP client which forwards requests to a wrapped
Handler
.Client context gives easy access to client-related information that are available into the request.
Builder for creating
ClientContext
instances.Processes the
Connection
message header.Processes the
Content-API-Version
message header.Processes the
Content-Encoding
message header.Processes the
Content-Length
message header.Processes the
Content-Type
message header.Type-safe contextual information associated with the processing of a request in an application.
An HTTP cookie.
Processes the
Cookie
request message header.Decodes an HTTP message entity input stream.
The default routing behaviour to use when no Accept-API-Version
is set on the request.
Decodes an entity encoded with
deflate
encoding.A route matcher that delegates to a provided route matcher.
A routing component (a CHF
Handler
or CREST RequestHandler
) can describe its API
by implementing this interface.Interface for listener instances.
A handler that both handles
Request
s, and also supports querying for API Descriptors.An
HttpApplication
that produces OpenAPI API Descriptors.Message content.
A
BranchingInputStream
for reading from files.Filters the request and/or response of an HTTP exchange.
Utility methods for creating common types of filters.
Form fields, a case-sensitive multi-string-valued map.
An undecoded HTTP message header.
Decodes an entity encoded with
gzip
encoding.Utility methods for creating common types of handlers.
An HTTP message header.
Creates instances of
Header
classes from String representation.Message headers, a case-insensitive multiple-value map.
Utility class for processing values in HTTP header fields.
Configuration class to configure the
HttpApplication
instance.An exception that is thrown during a Http Application start up when the start up of the application fails.
An SPI interface for HTTP
Client
implementations.An HTTP client for sending requests to remote servers.
SSL host name verification policies.
A provider interface for obtaining
HttpClient
instances.An exception which is thrown when two incompatible
RouteMatch
instances are attempted to be compared.Interface of an object that can be indexed with a unique key.
Utility class that can stream to and from streams.
Provides read and write JSON capabilities.
Jackson Module that uses a mixin to make sure that a
JsonValue
instance is
serialized using its #getObject()
value only.Jackson Module that adds a serializer for
LocalizableString
.Provides helper methods for
List
.An SPI interface for implementing alternative service loading strategies.
Provides methods for dynamically loading classes.
Processes the
Location
message header.Thrown when a header string cannot be parsed to a rich
Header
implementation.Elements common to requests and responses.
Abstract message base class.
Wraps a map for which the values are lists, providing a set of convenience methods for
handling list values.
A MutableUri is a modifiable
URI
substitute.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.
Filter
which handles OPTION HTTP requests to CREST resources.An exception that is thrown if a buffer would overflow as a result of a write operation.
Utilities for manipulating paths.
Represents a pipe for transferring bytes from an
OutputStream
to a
BranchingInputStream
.A request message.
A context for audit information for an incoming request.
Exposes incoming request cookies.
Implementations of this interface will be responsible for maintaining the
behaviour of API Version 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.A response message.
An HTTP Framework Exception that can be used by filters/handlers to simplify
control-flow inside async call-backs.
Provide out-of-the-box, pre-configured
Response
objects.A
Context
which has an a globally unique ID but no parent.Contains the result of routing to a particular route.
A matcher for evaluating whether a route matches the incoming request.
A utility class that contains methods for creating route matchers.
A router which routes requests based on route matchers.
The algorithm which should be used when matching URI templates against
request resource names.
A
Context
containing information about the client performing the
request which may be used when performing authorization decisions.An interface for managing attributes across multiple requests from the same user agent.
A
SessionContext
is a mechanism for maintaining state between components when processing a successive
requests from the same logical client or end-user.A SessionFactory is responsible to create a new type of
Session
.Processes the
Set-Cookie
request message header.Contains another set, which is uses as its basic source of data, possibly transforming the
data along the way.
The status-code element is a three-digit integer code giving the
result of the attempt to understand and satisfy the request.
The first digit of the status-code defines the class of response.
An API Producer for APIs that use the Swagger model implementation of the OpenAPI specification.
Extension of
Swagger
to override some of its behaviors.Swagger utility.
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.
This context aims to hold the
TransactionId
.Processes the transactionId header used mainly for audit purpose.
This filter is responsible to create the
TransactionIdContext
in the context's chain.This filter aims to create a sub-transaction's id and inserts that value as a header of the request.
An marker interface for tagging collection implementations as read-only.
A
Context
which is created when a request has been routed.Ease
UriRouterContext
construction.Utility class for performing operations on universal resource identifiers.
Represents some version in the form majorNumber.minorNumber,
for instance 2.4.
WarningHeader
entry.Processes the
Warning
message header.