Package com.soklet

package com.soklet

Core Soklet contracts and functionality.

Full documentation is available at https://www.soklet.com.

Author:

Mark Allen

Related Packages

Package	Description
com.soklet.annotation	Annotations applicable to Resource Methods and their parameters.
com.soklet.converter	Utilities which handle converting objects from one type to another.
com.soklet.exception	Exceptions thrown during HTTP request processing.

Class	Description
ConnectionRejectionReason	Reasons a connection attempt was rejected before a request or SSE connection could be established.
Cors	Encapsulates non-preflight CORS HTTP request data.
CorsAuthorizer	Contract for types that authorize CORS requests.
CorsPreflight	Encapsulates CORS preflight-related HTTP request data.
CorsPreflightResponse	Response headers to send over the wire for CORS preflight requests.
CorsPreflightResponse.Builder	Builder used to construct instances of CorsPreflightResponse via CorsPreflightResponse.withAccessControlAllowOrigin(String).
CorsPreflightResponse.Copier	Builder used to copy instances of CorsPreflightResponse via CorsPreflightResponse.copy().
CorsResponse	Response headers to send over the wire for non-preflight CORS requests.
CorsResponse.Builder	Builder used to construct instances of CorsResponse via CorsResponse.withAccessControlAllowOrigin(String).
CorsResponse.Copier	Builder used to copy instances of CorsResponse via CorsResponse.copy().
HandshakeResult	Represents the result of a ServerSentEventSource "handshake".
HandshakeResult.Accepted	Type which indicates a successful Server-Sent Event handshake.
HandshakeResult.Accepted.Builder	Builder used to construct instances of HandshakeResult.Accepted.
HandshakeResult.Rejected	Type which indicates a rejected Server-Sent Event handshake.
HttpMethod	Typesafe representation of HTTP request methods.
IdGenerator<T>	Contract for generating Request identifiers of a particular type (for example, sequential Long values, random UUIDs, etc.)
InstanceProvider	Contract for concrete instance generation given type information.
LifecycleObserver	Read-only hook methods for observing system and request lifecycle events.
LogEvent	An informational "loggable" event that occurs during Soklet's internal processing - for example, if an error occurs while handling a request.
LogEvent.Builder	Builder used to construct instances of LogEvent via LogEvent.with(LogEventType, String).
LogEvent.Copier	Builder used to copy instances of LogEvent via LogEvent.copy().
LogEventType	Kinds of LogEvent instances that Soklet can produce.
MarshaledResponse	A finalized representation of a Response, suitable for sending to clients over the wire.
MarshaledResponse.Builder	Builder used to construct instances of MarshaledResponse via MarshaledResponse.withResponse(Response) or MarshaledResponse.withStatusCode(Integer).
MarshaledResponse.Copier	Builder used to copy instances of MarshaledResponse via MarshaledResponse.copy().
MetricsCollector	Contract for collecting operational metrics from Soklet.
MetricsCollector.Histogram	A thread-safe histogram with fixed bucket boundaries.
MetricsCollector.HistogramSnapshot	Immutable snapshot of a MetricsCollector.Histogram.
MetricsCollector.MetricsFormat	Text format to use for MetricsCollector.snapshotText(SnapshotTextOptions).
MetricsCollector.RequestReadFailureKey	Key for request read failures grouped by reason.
MetricsCollector.RequestRejectionKey	Key for request rejections grouped by reason.
MetricsCollector.RouteType	Indicates whether a request was matched to a ResourcePathDeclaration.
MetricsCollector.ServerRouteKey	Key for metrics grouped by HTTP method and route match information.
MetricsCollector.ServerRouteStatusKey	Key for metrics grouped by HTTP method, route match information, and status class (e.g. 2xx).
MetricsCollector.ServerSentEventCommentRouteDropKey	Key for metrics grouped by Server-Sent Event comment type, route match information, and drop reason.
MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey	Key for metrics grouped by Server-Sent Event comment type, route match information, and enqueue outcome.
MetricsCollector.ServerSentEventCommentRouteKey	Key for metrics grouped by Server-Sent Event comment type and route match information.
MetricsCollector.ServerSentEventDropReason	Reasons a Server-Sent Event payload or comment was dropped before it could be written.
MetricsCollector.ServerSentEventEnqueueOutcome	Outcomes for a Server-Sent Event enqueue attempt.
MetricsCollector.ServerSentEventRouteDropKey	Key for metrics grouped by Server-Sent Event route match information and drop reason.
MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey	Key for metrics grouped by Server-Sent Event route match information and enqueue outcome.
MetricsCollector.ServerSentEventRouteHandshakeFailureKey	Key for metrics grouped by Server-Sent Event route match information and handshake failure reason.
MetricsCollector.ServerSentEventRouteKey	Key for metrics grouped by Server-Sent Event route match information.
MetricsCollector.ServerSentEventRouteTerminationKey	Key for metrics grouped by Server-Sent Event route match information and termination reason.
MetricsCollector.Snapshot	Immutable snapshot of collected metrics.
MetricsCollector.Snapshot.Builder	Builder used to construct instances of MetricsCollector.Snapshot.
MetricsCollector.SnapshotTextOptions	Options for rendering a textual metrics snapshot.
MetricsCollector.SnapshotTextOptions.Builder	Builder for MetricsCollector.SnapshotTextOptions.
MetricsCollector.SnapshotTextOptions.HistogramFormat	Supported histogram rendering strategies.
MetricsCollector.SnapshotTextOptions.MetricSample	A single text-format sample with its label set.
MultipartField	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.
MultipartField.Builder	Builder used to construct instances of MultipartField via MultipartField.withName(String) or MultipartField.with(String, byte[]).
MultipartField.Copier	Builder used to copy instances of MultipartField via MultipartField.copy().
MultipartParser	Contract for parsing HTML form fields encoded according to the multipart/form-data specification.
ParameterizedHeaderValue	Represents a single HTTP header field value that includes a name and may include semicolon-delimited parameters - encoding rules per RFC specifications are strictly enforced.
ParameterizedHeaderValue.Builder	Builder used to construct instances of ParameterizedHeaderValue via ParameterizedHeaderValue.withName(String).
ParameterizedHeaderValue.Parameter	A single header-value parameter: given a header value like attachment; filename="resume.pdf"; filename*=UTF-8''r%C3%A9sum%C3%A9.pdf, there are two filename parameter name-value pairs.
ParameterizedHeaderValue.ParameterType	What type of header-value parameter this is: ParameterizedHeaderValue.ParameterType.TOKEN, ParameterizedHeaderValue.ParameterType.QUOTED, or ParameterizedHeaderValue.ParameterType.RFC_8187.
QueryFormat	Strategies for encoding/decoding query strings: Content-Type: application/x-www-form-urlencoded (supports "+" for spaces) or "strict" RFC 3986 (percent-decoding only).
RedirectType	Typesafe representation of HTTP Redirect types (301, 302, 303, 307, 308).
Request	Encapsulates information specified in an HTTP request.
Request.Copier	Builder used to copy instances of Request via Request.copy().
Request.PathBuilder	Builder used to construct instances of Request via Request.withPath(HttpMethod, String).
Request.RawBuilder	Builder used to construct instances of Request via Request.withRawUrl(HttpMethod, String).
RequestBodyMarshaler	Contract for converting request body bytes into a corresponding Java type.
RequestInterceptor	Hook methods that can adjust Soklet's request processing flow.
RequestReadFailureReason	Reasons a request could not be read or parsed into a valid Request.
RequestRejectionReason	Reasons an HTTP or SSE request was rejected before application-level handling began.
RequestResult	Encapsulates the results of a request that would normally be handled by your Server (both logical response and bytes to be sent over the wire), used for integration testing via Simulator.performRequest(Request).
RequestResult.Builder	Builder used to construct instances of RequestResult via RequestResult.withMarshaledResponse(MarshaledResponse).
RequestResult.Copier	Builder used to copy instances of RequestResult via RequestResult.copy().
ResourceMethod	Represents a Resource Method, which is a Java Method invoked by Soklet to handle an HTTP request.
ResourceMethodParameterProvider	Contract for determining parameter values to inject when invoking Resource Methods.
ResourceMethodResolver	Contract for matching incoming HTTP requests with appropriate Resource Methods (Java methods to invoke to handle requests).
ResourcePath	An HTTP URL path used to resolve a Resource Method at runtime, such as /users/123.
ResourcePathDeclaration	A compile-time HTTP URL path declaration associated with an annotated Resource Method, such as /users/{userId}.
ResourcePathDeclaration.Component	Represents a /-delimited part of a ResourcePathDeclaration.
ResourcePathDeclaration.ComponentType	How to interpret a ResourcePathDeclaration.Component of a ResourcePathDeclaration - is it literal text or a placeholder?
Response	Represents a logical HTTP response returned by a Resource Method.
Response.Builder	Builder used to construct instances of Response via Response.withStatusCode(Integer) or Response.withRedirect(RedirectType, String).
Response.Copier	Builder used to copy instances of Response via Response.copy().
ResponseCookie	HTTP "response" Cookie representation which supports Set-Cookie header encoding.
ResponseCookie.Builder	Builder used to construct instances of ResponseCookie via ResponseCookie.withName(String) or ResponseCookie.with(String, String).
ResponseCookie.Copier	Builder used to copy instances of ResponseCookie via ResponseCookie.copy().
ResponseCookie.Priority	Represents the Priority response cookie attribute.
ResponseCookie.SameSite	Values which control whether a response cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).
ResponseMarshaler	Prepares responses for each request scenario Soklet supports (Resource Method, exception, CORS preflight, etc.)
ResponseMarshaler.Builder	Builder used to construct a standard implementation of ResponseMarshaler.
ResponseMarshaler.Builder.ContentTooLargeHandler	Function used to support pluggable implementations of ResponseMarshaler.forContentTooLarge(Request, ResourceMethod).
ResponseMarshaler.Builder.CorsAllowedHandler	Function used to support pluggable implementations of ResponseMarshaler.forCorsAllowed(Request, Cors, CorsResponse, MarshaledResponse).
ResponseMarshaler.Builder.CorsPreflightAllowedHandler	Function used to support pluggable implementations of ResponseMarshaler.forCorsPreflightAllowed(Request, CorsPreflight, CorsPreflightResponse).
ResponseMarshaler.Builder.CorsPreflightRejectedHandler	Function used to support pluggable implementations of ResponseMarshaler.forCorsPreflightRejected(Request, CorsPreflight).
ResponseMarshaler.Builder.HeadHandler	Function used to support pluggable implementations of ResponseMarshaler.forHead(Request, MarshaledResponse).
ResponseMarshaler.Builder.MethodNotAllowedHandler	Function used to support pluggable implementations of ResponseMarshaler.forMethodNotAllowed(Request, Set).
ResponseMarshaler.Builder.NotFoundHandler	Function used to support pluggable implementations of ResponseMarshaler.forNotFound(Request).
ResponseMarshaler.Builder.OptionsHandler	Function used to support pluggable implementations of ResponseMarshaler.forOptions(Request, Set).
ResponseMarshaler.Builder.OptionsSplatHandler	Function used to support pluggable implementations of ResponseMarshaler.forOptionsSplat(Request).
ResponseMarshaler.Builder.PostProcessor	Function used to support a pluggable "post-process" hook for any final customization or processing before data goes over the wire.
ResponseMarshaler.Builder.ResourceMethodHandler	Function used to support pluggable implementations of ResponseMarshaler.forResourceMethod(Request, Response, ResourceMethod).
ResponseMarshaler.Builder.ServiceUnavailableHandler	Function used to support pluggable implementations of ResponseMarshaler.forServiceUnavailable(Request, ResourceMethod).
ResponseMarshaler.Builder.ThrowableHandler	Function used to support pluggable implementations of ResponseMarshaler.forThrowable(Request, Throwable, ResourceMethod).
Server	Contract for HTTP server implementations that are designed to be managed by a Soklet instance.
Server.Builder	Builder used to construct a standard implementation of Server.
Server.RequestHandler	Request/response processing contract for Server implementations.
ServerSentEvent	Encapsulates a Server-Sent Event payload that can be sent across the wire to a client.
ServerSentEvent.Builder	Builder used to construct instances of ServerSentEvent via ServerSentEvent.withEvent(String), ServerSentEvent.withData(String), or ServerSentEvent.builder().
ServerSentEventBroadcaster	Broadcasts a Server-Sent Event payload to all clients listening on a ResourcePath.
ServerSentEventComment	Encapsulates a Server-Sent Event comment payload and its comment type.
ServerSentEventComment.CommentType	Types of Server-Sent Event comments.
ServerSentEventConnection	Represents characteristics of a long-running connection that has been established with a ServerSentEventServer.
ServerSentEventConnection.HandshakeFailureReason	Categorizes why a Server-Sent Event handshake failed.
ServerSentEventConnection.TerminationReason	Categorizes why a Server-Sent Event connection terminated.
ServerSentEventRequestResult	Sealed interface used by Simulator.performServerSentEventRequest(Request) during integration tests, which encapsulates the 3 logical outcomes for SSE connections: accepted handshake, rejected handshake, and general request failure.
ServerSentEventRequestResult.HandshakeAccepted	Represents the result of an SSE accepted handshake (connection stays open) when simulated by Simulator.performServerSentEventRequest(Request).
ServerSentEventRequestResult.HandshakeRejected	Represents the result of an SSE rejected handshake (explicit rejection; connection closed) when simulated by Simulator.performServerSentEventRequest(Request).
ServerSentEventRequestResult.RequestFailed	Represents the result of an SSE request failure (implicit rejection, e.g. an exception occurred; connection closed) when simulated by Simulator.performServerSentEventRequest(Request).
ServerSentEventServer	A special HTTP server whose only purpose is to provide Server-Sent Event functionality.
ServerSentEventServer.Builder	Builder used to construct a standard implementation of ServerSentEventServer.
ServerSentEventServer.RequestHandler	Request/response processing contract for ServerSentEventServer implementations.
ServerSentEventUnicaster	Unicasts a Server-Sent Event or comment payload to a specific client listening on a ResourcePath.
ServerType	Types of servers supported by Soklet - currently ServerType.STANDARD_HTTP and ServerType.SERVER_SENT_EVENT.
ShutdownTrigger	Events that might trigger a Soklet instance to shut down.
Simulator	Simulates server behavior of accepting a request and returning a response without touching the network, useful for writing integration tests.
Soklet	Soklet's main class - manages a Server (and optionally a ServerSentEventServer) using the provided system configuration.
SokletConfig	Defines how a Soklet system is configured.
SokletConfig.Builder	Builder used to construct instances of SokletConfig.
SokletConfig.Copier	Builder used to copy instances of SokletConfig.
SokletProcessor	Soklet's standard Annotation Processor which is used to generate lookup tables of Resource Method definitions at compile time as well as prevent usage errors that are detectable by static analysis.
StatusCode	Formal enumeration of valid HTTP status codes.
Utilities	A non-instantiable collection of utility methods.
Utilities.EffectiveOriginResolver	Builder for Utilities.extractEffectiveOrigin(EffectiveOriginResolver).
Utilities.EffectiveOriginResolver.TrustPolicy	Forwarded header trust policy.