All Classes and Interfaces
Class
Description
Convenience superclass which provides default implementations of
ValueConverter methods.Encapsulates non-preflight CORS HTTP request data.
Contract for types that authorize CORS requests.
Encapsulates CORS preflight-related HTTP request data.
Response headers to send over the wire for CORS preflight requests.
Builder used to construct instances of
CorsPreflightResponse via CorsPreflightResponse.withAccessControlAllowOrigin(String).Builder used to copy instances of
CorsPreflightResponse via CorsPreflightResponse.copy().Response headers to send over the wire for non-preflight CORS requests.
Builder used to construct instances of
CorsResponse via CorsResponse.withAccessControlAllowOrigin(String).Builder used to copy instances of
CorsResponse via CorsResponse.copy().Builder used to construct instances of
DefaultServer.Builder used to construct instances of
DefaultServerSentEventServer.Apply to Resource Methods to support the HTTP
DELETE method.Allows multiple
DELETE annotations to be applied to the same Resource Method.Apply to Resource Method parameters to enable HTML form parameter injection.
Convenience superclass which provides default implementations of
ValueConverter methods that convert from String to other types.Apply to Resource Methods to support the HTTP
GET method.Allows multiple
GET annotations to be applied to the same Resource Method.Apply to Resource Methods to support the HTTP
HEAD method.Allows multiple
HEAD annotations to be applied to the same Resource Method.Typesafe representation of HTTP request methods.
Contract for types that generate identifiers: sequential integers, UUIDs, etc.
Contract for concrete instance generation given type information.
"Hook" methods for customizing behavior in response to system lifecycle events -
server started, request received, response written, and so on.
An informational "loggable" event that occurs during Soklet's internal processing - for example, if an error occurs while handling a request.
Builder used to construct instances of
LogEvent via LogEvent.with(LogEventType, String).Builder used to copy instances of
LogEvent via LogEvent.copy().Kinds of
LogEvent instances that Soklet can produce.A finalized representation of a
Response, suitable for sending to clients over the wire.Builder used to construct instances of
MarshaledResponse via MarshaledResponse.withStatusCode(Integer).Builder used to copy instances of
MarshaledResponse via MarshaledResponse.copy().Apply to Resource Method parameters to enable HTML multipart form parameter injection.
Encapsulates an HTML form element name, binary and
String representations of its value, and other attributes as encoded according to the multipart/form-data specification.Builder used to construct instances of
MultipartField via MultipartField.withName(String)
or MultipartField.with(String, byte[]).Builder used to copy instances of
MultipartField via MultipartField.copy().Contract for parsing HTML form fields encoded according to the
multipart/form-data specification.Apply to Resource Methods to support the HTTP
OPTIONS method.Allows multiple
OPTIONS annotations to be applied to the same Resource Method.Apply to Resource Methods to support the HTTP
PATCH method.Allows multiple
PATCH annotations to be applied to the same Resource Method.Apply to Resource Method parameters to enable URL path parameter (for example,
/widgets/{widgetId}) injection.Apply to Resource Methods to support the HTTP
POST method.Allows multiple
POST annotations to be applied to the same Resource Method.Apply to Resource Methods to support the HTTP
PUT method.Allows multiple
PUT annotations to be applied to the same Resource Method.Apply to Resource Method parameters to enable HTTP query parameter injection.
Typesafe representation of HTTP Redirect types (
301, 302, 303, 307, 308).Encapsulates information specified in an HTTP request.
Builder used to construct instances of
Request via Request.with(HttpMethod, String).Builder used to copy instances of
Request via Request.copy().Apply to Resource Method parameters to enable HTTP request body injection.
Contract for converting request body bytes into a corresponding Java type.
Apply to Resource Method parameters to enable HTTP request cookie injection.
Apply to Resource Method parameters to enable HTTP request header injection.
Encapsulates the results of a request (both logical response and bytes to be sent over the wire),
useful for integration testing via
Simulator.performRequest(Request).Builder used to construct instances of
RequestResult via RequestResult.withMarshaledResponse(MarshaledResponse).Builder used to copy instances of
RequestResult via RequestResult.copy().This annotation must be present on a class for Resource Methods to be detected.
Represents a Resource Method, which is a Java
Method invoked by Soklet to handle an HTTP request.Contract for determining parameter values to inject when invoking Resource Methods.
Contract for matching incoming HTTP requests with appropriate Resource Methods (Java methods to invoke to handle requests).
An HTTP URL path used to resolve a Resource Method at runtime, such as
/users/123.A compile-time HTTP URL path declaration associated with an annotated Resource Method, such as
/users/{userId}.Represents a
/-delimited part of a ResourcePathDeclaration.How to interpret a
ResourcePathDeclaration.Component of a ResourcePathDeclaration - is it literal text or a placeholder?Represents a logical HTTP response returned by a Resource Method.
Builder used to construct instances of
Response via Response.withStatusCode(Integer)
or Response.withRedirect(RedirectType, String).Builder used to copy instances of
Response via Response.copy().HTTP "response" Cookie representation which supports
Set-Cookie header encoding.Builder used to construct instances of
ResponseCookie via ResponseCookie.withName(String)
or ResponseCookie.with(String, String).Builder used to copy instances of
ResponseCookie via ResponseCookie.copy().Values which control whether or not a response cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).
Prepares responses for each request scenario Soklet supports (happy path, exception, CORS preflight, etc.)
Contract for HTTP server implementations that are designed to be managed by a
Soklet instance.Request/response processing contract for
Server implementations.Encapsulates a Server-Sent Event payload that can be sent across the wire to a client.
Builder used to construct instances of
ServerSentEvent via ServerSentEvent.withEvent(String) or ServerSentEvent.withData(String).Broadcasts a Server-Sent Event payload to all clients listening on a
ResourcePath.A special HTTP server whose only purpose is to provide Server-Sent Event functionality.
Request/response processing contract for
ServerSentEventServer implementations.Apply to Resource Methods to make them function as Server-Sent Event Sources.
Allows multiple
ServerSentEventSource annotations to be applied to the same Resource Method.Simulates server behavior of accepting a request and returning a response, useful for writing integration tests.
Soklet's main class - manages a
Server (and optionally a ServerSentEventServer) using the provided system configuration.Defines how a Soklet system is configured.
Builder used to construct instances of
SokletConfiguration.Builder used to copy instances of
SokletConfiguration.Soklet's standard Annotation Processor which is used to generate lookup tables of Resource Method definitions at compile time.
Formal enumeration of valid HTTP status codes.
Construct for creating type tokens that represent generic types.
A non-instantiable collection of utility methods.
Thrown if an error occurs during value conversion.
Contract for converting objects from one type to another.
A collection of
ValueConverter instances, supplemented with quality-of-life features that most applications need.Non-instantiable utility class that exists to vend a set of default
ValueConverter instances via ValueConverters.defaultValueConverters().