Uses of Package
com.soklet

Packages that use com.soklet

Package	Description
com.soklet	Core Soklet contracts and functionality.
com.soklet.exception	Exceptions thrown during HTTP request processing.

Classes in com.soklet used by com.soklet

Class	Description
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	Contract for generating identifiers of a particular type (for example, sequential Long values, random UUIDs, etc.)
InstanceProvider	Contract for concrete instance generation given type information.
LifecycleInterceptor	"Hook" methods for customizing behavior in response to system lifecycle events - server started, request received, response written, and so on.
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().
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.
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.
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.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.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.withDefaults().
ServerSentEventBroadcaster	Broadcasts a Server-Sent Event payload to all clients listening on a ResourcePath.
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.
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.
StatusCode	Formal enumeration of valid HTTP status codes.

Classes in com.soklet used by com.soklet.exception

Class	Description
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.