Uses of Package
com.soklet.core
Packages that use com.soklet.core
Package
Description
Top-level types
Soklet and SokletConfiguration.Core Soklet contracts and functionality.
Default implementations of Soklet contracts.
Exceptions thrown during HTTP request processing.
-
Classes in com.soklet.core used by com.sokletClassDescriptionContract for types that authorize CORS requests.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.Contract for converting request body bytes into a corresponding Java type.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).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
Sokletinstance.A special HTTP server whose only purpose is to provide Server-Sent Event functionality.Simulates server behavior of accepting a request and returning a response, useful for writing integration tests. -
Classes in com.soklet.core used by com.soklet.coreClassDescriptionEncapsulates non-preflight CORS HTTP request data.Encapsulates CORS preflight-related HTTP request data.Response headers to send over the wire for CORS preflight requests.Builder used to construct instances of
CorsPreflightResponseviaCorsPreflightResponse.withAccessControlAllowOrigin(String).Builder used to copy instances ofCorsPreflightResponseviaCorsPreflightResponse.copy().Response headers to send over the wire for non-preflight CORS requests.Builder used to construct instances ofCorsResponseviaCorsResponse.withAccessControlAllowOrigin(String).Builder used to copy instances ofCorsResponseviaCorsResponse.copy().Typesafe representation of HTTP request methods.Contract for types that generate identifiers: sequential integers, UUIDs, etc.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 ofLogEventviaLogEvent.with(LogEventType, String).Builder used to copy instances ofLogEventviaLogEvent.copy().Kinds ofLogEventinstances that Soklet can produce.A finalized representation of aResponse, suitable for sending to clients over the wire.Builder used to construct instances ofMarshaledResponseviaMarshaledResponse.withStatusCode(Integer).Builder used to copy instances ofMarshaledResponseviaMarshaledResponse.copy().Encapsulates an HTML form element name, binary andStringrepresentations of its value, and other attributes as encoded according to themultipart/form-dataspecification.Builder used to construct instances ofMultipartFieldviaMultipartField.withName(String)orMultipartField.with(String, byte[]).Builder used to copy instances ofMultipartFieldviaMultipartField.copy().Contract for parsing HTML form fields encoded according to themultipart/form-dataspecification.Typesafe representation of HTTP Redirect types (301, 302, 303, 307, 308).Encapsulates information specified in an HTTP request.Builder used to construct instances ofRequestviaRequest.with(HttpMethod, String).Builder used to copy instances ofRequestviaRequest.copy().Encapsulates the results of a request (both logical response and bytes to be sent over the wire), useful for integration testing viaSimulator.performRequest(Request).Builder used to construct instances ofRequestResultviaRequestResult.withMarshaledResponse(MarshaledResponse).Builder used to copy instances ofRequestResultviaRequestResult.copy().Represents a Resource Method, which is a JavaMethodinvoked by Soklet to handle an HTTP request.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 aResourcePathDeclaration.How to interpret aResourcePathDeclaration.Componentof aResourcePathDeclaration- is it literal text or a placeholder?Represents a logical HTTP response returned by a Resource Method.Builder used to construct instances ofResponseviaResponse.withStatusCode(Integer)orResponse.withRedirect(RedirectType, String).Builder used to copy instances ofResponseviaResponse.copy().HTTP "response" Cookie representation which supportsSet-Cookieheader encoding.Builder used to construct instances ofResponseCookieviaResponseCookie.withName(String)orResponseCookie.with(String, String).Builder used to copy instances ofResponseCookieviaResponseCookie.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).Contract for HTTP server implementations that are designed to be managed by aSokletinstance.Request/response processing contract forServerimplementations.Encapsulates a Server-Sent Event payload that can be sent across the wire to a client.Builder used to construct instances ofServerSentEventviaServerSentEvent.withEvent(String)orServerSentEvent.withData(String).Broadcasts a Server-Sent Event payload to all clients listening on aResourcePath.A special HTTP server whose only purpose is to provide Server-Sent Event functionality.Request/response processing contract forServerSentEventServerimplementations.Formal enumeration of valid HTTP status codes. -
Classes in com.soklet.core used by com.soklet.core.implClassDescriptionEncapsulates 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.Response headers to send over the wire for non-preflight CORS requests.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.A finalized representation of a
Response, suitable for sending to clients over the wire.Encapsulates an HTML form element name, binary andStringrepresentations of its value, and other attributes as encoded according to themultipart/form-dataspecification.Contract for parsing HTML form fields encoded according to themultipart/form-dataspecification.Encapsulates information specified in an HTTP request.Contract for converting request body bytes into a corresponding Java type.Represents a Resource Method, which is a JavaMethodinvoked 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 logical HTTP response returned by a Resource Method.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 aSokletinstance.Request/response processing contract forServerimplementations.Broadcasts a Server-Sent Event payload to all clients listening on aResourcePath.A special HTTP server whose only purpose is to provide Server-Sent Event functionality.Request/response processing contract forServerSentEventServerimplementations. -
Classes in com.soklet.core used by com.soklet.exceptionClassDescriptionEncapsulates an HTML form element name, binary and
Stringrepresentations of its value, and other attributes as encoded according to themultipart/form-dataspecification.