Package com.soklet.core

package com.soklet.core

Core Soklet contracts and functionality.

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

Author:

Mark Allen

Related Packages

Package	Description
com.soklet	Top-level types Soklet and SokletConfiguration.
com.soklet.core.impl	Default implementations of Soklet contracts.
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
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().
HttpMethod	Typesafe representation of HTTP request methods.
IdGenerator	Contract for types that generate identifiers: sequential integers, 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.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.
RedirectType	Typesafe representation of HTTP Redirect types (301, 302, 303, 307, 308).
Request	Encapsulates information specified in an HTTP request.
Request.Builder	Builder used to construct instances of Request via Request.with(HttpMethod, String).
Request.Copier	Builder used to copy instances of Request via Request.copy().
RequestBodyMarshaler	Contract for converting request body bytes into a corresponding Java type.
RequestResult	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).
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 or not 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 (happy path, exception, CORS preflight, etc.)
Server	Contract for HTTP server implementations that are designed to be managed by a Soklet instance.
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) or ServerSentEvent.withData(String).
ServerSentEventBroadcaster	Broadcasts a Server-Sent Event payload to all clients listening on a ResourcePath.
ServerSentEventServer	A special HTTP server whose only purpose is to provide Server-Sent Event functionality.
ServerSentEventServer.RequestHandler	Request/response processing contract for ServerSentEventServer implementations.
Simulator	Simulates server behavior of accepting a request and returning a response, useful for writing integration tests.
StatusCode	Formal enumeration of valid HTTP status codes.
Utilities	A non-instantiable collection of utility methods.