Index

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractValueConverter<F,T> - Class in com.soklet.converter

Convenience superclass which provides default implementations of ValueConverter methods.

AbstractValueConverter() - Constructor for class com.soklet.converter.AbstractValueConverter

Supports subclasses that have both 'from' and 'to' generic types.

AbstractValueConverter(Type) - Constructor for class com.soklet.converter.AbstractValueConverter

Supports subclasses that have only a 'to' generic type, like FromStringValueConverter.

accessControlAllowCredentials(Boolean) - Method in class com.soklet.core.CorsPreflightResponse.Builder

accessControlAllowCredentials(Boolean) - Method in class com.soklet.core.CorsPreflightResponse.Copier

accessControlAllowCredentials(Boolean) - Method in class com.soklet.core.CorsResponse.Builder

accessControlAllowCredentials(Boolean) - Method in class com.soklet.core.CorsResponse.Copier

accessControlAllowHeaders(Consumer<Set<String>>) - Method in class com.soklet.core.CorsPreflightResponse.Copier

accessControlAllowHeaders(Set<String>) - Method in class com.soklet.core.CorsPreflightResponse.Builder

accessControlAllowHeaders(Set<String>) - Method in class com.soklet.core.CorsPreflightResponse.Copier

accessControlAllowMethods(Consumer<Set<HttpMethod>>) - Method in class com.soklet.core.CorsPreflightResponse.Copier

accessControlAllowMethods(Set<HttpMethod>) - Method in class com.soklet.core.CorsPreflightResponse.Builder

accessControlAllowMethods(Set<HttpMethod>) - Method in class com.soklet.core.CorsPreflightResponse.Copier

accessControlAllowOrigin(String) - Method in class com.soklet.core.CorsPreflightResponse.Builder

accessControlAllowOrigin(String) - Method in class com.soklet.core.CorsPreflightResponse.Copier

accessControlAllowOrigin(String) - Method in class com.soklet.core.CorsResponse.Builder

accessControlAllowOrigin(String) - Method in class com.soklet.core.CorsResponse.Copier

accessControlExposeHeaders(Consumer<Set<String>>) - Method in class com.soklet.core.CorsResponse.Copier

accessControlExposeHeaders(Set<String>) - Method in class com.soklet.core.CorsResponse.Builder

accessControlExposeHeaders(Set<String>) - Method in class com.soklet.core.CorsResponse.Copier

accessControlMaxAge(Duration) - Method in class com.soklet.core.CorsPreflightResponse.Builder

accessControlMaxAge(Duration) - Method in class com.soklet.core.CorsPreflightResponse.Copier

acquireBroadcaster(ResourcePath) - Method in class com.soklet.core.impl.DefaultServerSentEventServer

acquireBroadcaster(ResourcePath) - Method in interface com.soklet.core.ServerSentEventServer

Given a ResourcePath that corresponds to a Resource Method annotated with ServerSentEventSource, acquire a ServerSentEventBroadcaster which is capable of "pushing" messages to all connected Server-Sent Event clients.

acquireServerSentEventBroadcaster(ResourcePath) - Method in interface com.soklet.core.Simulator

Acquires a Server-Sent Event broadcaster for the given ResourcePath.

AllOriginsCorsAuthorizer - Class in com.soklet.core.impl

AllOriginsCorsAuthorizer() - Constructor for class com.soklet.core.impl.AllOriginsCorsAuthorizer

authorize(Request, Cors) - Method in interface com.soklet.core.CorsAuthorizer

Authorizes a non-preflight CORS request.

authorize(Request, Cors) - Method in class com.soklet.core.impl.AllOriginsCorsAuthorizer

authorize(Request, Cors) - Method in class com.soklet.core.impl.NoOriginsCorsAuthorizer

authorize(Request, Cors) - Method in class com.soklet.core.impl.WhitelistedOriginsCorsAuthorizer

authorizePreflight(Request, CorsPreflight, Map<HttpMethod, ResourceMethod>) - Method in interface com.soklet.core.CorsAuthorizer

Authorizes a CORS preflight request.

authorizePreflight(Request, CorsPreflight, Map<HttpMethod, ResourceMethod>) - Method in class com.soklet.core.impl.AllOriginsCorsAuthorizer

authorizePreflight(Request, CorsPreflight, Map<HttpMethod, ResourceMethod>) - Method in class com.soklet.core.impl.NoOriginsCorsAuthorizer

authorizePreflight(Request, CorsPreflight, Map<HttpMethod, ResourceMethod>) - Method in class com.soklet.core.impl.WhitelistedOriginsCorsAuthorizer

B

BadRequestException - Exception Class in com.soklet.exception

BadRequestException(String) - Constructor for exception class com.soklet.exception.BadRequestException

BadRequestException(String, Throwable) - Constructor for exception class com.soklet.exception.BadRequestException

body(byte[]) - Method in class com.soklet.core.MarshaledResponse.Builder

body(byte[]) - Method in class com.soklet.core.MarshaledResponse.Copier

body(byte[]) - Method in class com.soklet.core.Request.Builder

body(byte[]) - Method in class com.soklet.core.Request.Copier

body(Object) - Method in class com.soklet.core.Response.Builder

body(Object) - Method in class com.soklet.core.Response.Copier

broadcast(ServerSentEvent) - Method in interface com.soklet.core.ServerSentEventBroadcaster

Broadcasts a Server-Sent Event payload to all clients listening to this broadcaster's ResourcePath.

build() - Method in class com.soklet.core.CorsPreflightResponse.Builder

build() - Method in class com.soklet.core.CorsResponse.Builder

build() - Method in class com.soklet.core.impl.DefaultServer.Builder

build() - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

build() - Method in class com.soklet.core.LogEvent.Builder

build() - Method in class com.soklet.core.MarshaledResponse.Builder

build() - Method in class com.soklet.core.MultipartField.Builder

build() - Method in class com.soklet.core.Request.Builder

build() - Method in class com.soklet.core.RequestResult.Builder

build() - Method in class com.soklet.core.Response.Builder

build() - Method in class com.soklet.core.ResponseCookie.Builder

build() - Method in class com.soklet.core.ServerSentEvent.Builder

build() - Method in class com.soklet.SokletConfiguration.Builder

builder() - Static method in class com.soklet.core.ServerSentEvent

Acquires an "empty" builder for ServerSentEvent instances.

C

charset(Charset) - Method in class com.soklet.core.MultipartField.Builder

close() - Method in interface com.soklet.core.Server

AutoCloseable-enabled synonym for Server.stop().

close() - Method in interface com.soklet.core.ServerSentEventServer

AutoCloseable-enabled synonym for ServerSentEventServer.stop().

close() - Method in class com.soklet.Soklet

Synonym for Soklet.stop().

com.soklet - package com.soklet

Top-level types Soklet and SokletConfiguration.

com.soklet.annotation - package com.soklet.annotation

Annotations applicable to Resource Methods and their parameters.

com.soklet.converter - package com.soklet.converter

Utilities which handle converting objects from one type to another.

com.soklet.core - package com.soklet.core

Core Soklet contracts and functionality.

com.soklet.core.impl - package com.soklet.core.impl

Default implementations of Soklet contracts.

com.soklet.exception - package com.soklet.exception

Exceptions thrown during HTTP request processing.

Component(String, ResourcePathDeclaration.ComponentType) - Constructor for class com.soklet.core.ResourcePathDeclaration.Component

concurrency(Integer) - Method in class com.soklet.core.impl.DefaultServer.Builder

concurrentConnectionLimit(Integer) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

contentTooLarge(Boolean) - Method in class com.soklet.core.Request.Builder

contentTooLarge(Boolean) - Method in class com.soklet.core.Request.Copier

contentType(String) - Method in class com.soklet.core.MultipartField.Builder

contentType(String) - Method in class com.soklet.core.MultipartField.Copier

contentType(Charset) - Method in class com.soklet.core.MultipartField.Copier

convert(F) - Method in class com.soklet.converter.AbstractValueConverter

convert(F) - Method in interface com.soklet.converter.ValueConverter

Converts from to an instance of T.

cookies(Consumer<Set<ResponseCookie>>) - Method in class com.soklet.core.MarshaledResponse.Copier

cookies(Consumer<Set<ResponseCookie>>) - Method in class com.soklet.core.Response.Copier

cookies(Set<ResponseCookie>) - Method in class com.soklet.core.MarshaledResponse.Builder

cookies(Set<ResponseCookie>) - Method in class com.soklet.core.MarshaledResponse.Copier

cookies(Set<ResponseCookie>) - Method in class com.soklet.core.Response.Builder

cookies(Set<ResponseCookie>) - Method in class com.soklet.core.Response.Copier

copy() - Method in class com.soklet.core.CorsPreflightResponse

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.CorsResponse

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.LogEvent

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.MarshaledResponse

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.MultipartField

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.Request

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.RequestResult

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.Response

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.core.ResponseCookie

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

copy() - Method in class com.soklet.SokletConfiguration

Vends a mutable copy of this instance's configuration, suitable for building new instances.

Cors - Class in com.soklet.core

Encapsulates non-preflight CORS HTTP request data.

Cors(HttpMethod, String) - Constructor for class com.soklet.core.Cors

Constructs a CORS non-preflight request representation for the given HTTP request data.

corsAuthorizer(CorsAuthorizer) - Method in class com.soklet.SokletConfiguration.Builder

corsAuthorizer(CorsAuthorizer) - Method in class com.soklet.SokletConfiguration.Copier

CorsAuthorizer - Interface in com.soklet.core

Contract for types that authorize CORS requests.

CorsPreflight - Class in com.soklet.core

Encapsulates CORS preflight-related HTTP request data.

CorsPreflight(String, HttpMethod) - Constructor for class com.soklet.core.CorsPreflight

Constructs a CORS preflight request representation for the given HTTP request data.

CorsPreflight(String, HttpMethod, Set<String>) - Constructor for class com.soklet.core.CorsPreflight

Constructs a CORS preflight request representation for the given HTTP request data.

corsPreflightResponse(CorsPreflightResponse) - Method in class com.soklet.core.RequestResult.Builder

corsPreflightResponse(CorsPreflightResponse) - Method in class com.soklet.core.RequestResult.Copier

CorsPreflightResponse - Class in com.soklet.core

Response headers to send over the wire for CORS preflight requests.

CorsPreflightResponse.Builder - Class in com.soklet.core

Builder used to construct instances of CorsPreflightResponse via CorsPreflightResponse.withAccessControlAllowOrigin(String).

CorsPreflightResponse.Copier - Class in com.soklet.core

Builder used to copy instances of CorsPreflightResponse via CorsPreflightResponse.copy().

CorsResponse - Class in com.soklet.core

Response headers to send over the wire for non-preflight CORS requests.

CorsResponse.Builder - Class in com.soklet.core

Builder used to construct instances of CorsResponse via CorsResponse.withAccessControlAllowOrigin(String).

CorsResponse.Copier - Class in com.soklet.core

Builder used to copy instances of CorsResponse via CorsResponse.copy().

createVirtualThreadsNewThreadPerTaskExecutor(String, Thread.UncaughtExceptionHandler) - Static method in class com.soklet.core.Utilities

Provides a virtual-thread-per-task executor service if supported by the runtime.

D

data(byte[]) - Method in class com.soklet.core.MultipartField.Builder

data(byte[]) - Method in class com.soklet.core.MultipartField.Copier

data(String) - Method in class com.soklet.core.ServerSentEvent.Builder

DefaultIdGenerator - Class in com.soklet.core.impl

DefaultIdGenerator() - Constructor for class com.soklet.core.impl.DefaultIdGenerator

DefaultIdGenerator(Long, Long) - Constructor for class com.soklet.core.impl.DefaultIdGenerator

DefaultIdGenerator(Long, Long, String) - Constructor for class com.soklet.core.impl.DefaultIdGenerator

DefaultInstanceProvider - Class in com.soklet.core.impl

DefaultInstanceProvider() - Constructor for class com.soklet.core.impl.DefaultInstanceProvider

DefaultLifecycleInterceptor - Class in com.soklet.core.impl

DefaultLifecycleInterceptor() - Constructor for class com.soklet.core.impl.DefaultLifecycleInterceptor

DefaultMultipartParser - Class in com.soklet.core.impl

DefaultMultipartParser() - Constructor for class com.soklet.core.impl.DefaultMultipartParser

DefaultRequestBodyMarshaler - Class in com.soklet.core.impl

DefaultRequestBodyMarshaler() - Constructor for class com.soklet.core.impl.DefaultRequestBodyMarshaler

DefaultRequestBodyMarshaler(ValueConverterRegistry) - Constructor for class com.soklet.core.impl.DefaultRequestBodyMarshaler

DefaultResourceMethodParameterProvider - Class in com.soklet.core.impl

DefaultResourceMethodParameterProvider() - Constructor for class com.soklet.core.impl.DefaultResourceMethodParameterProvider

DefaultResourceMethodParameterProvider(InstanceProvider, ValueConverterRegistry, RequestBodyMarshaler) - Constructor for class com.soklet.core.impl.DefaultResourceMethodParameterProvider

DefaultResourceMethodResolver - Class in com.soklet.core.impl

DefaultResourceMethodResolver() - Constructor for class com.soklet.core.impl.DefaultResourceMethodResolver

DefaultResourceMethodResolver(Set<Class<?>>) - Constructor for class com.soklet.core.impl.DefaultResourceMethodResolver

DefaultResourceMethodResolver(Set<Class<?>>, Set<Method>) - Constructor for class com.soklet.core.impl.DefaultResourceMethodResolver

DefaultResponseMarshaler - Class in com.soklet.core.impl

DefaultResponseMarshaler() - Constructor for class com.soklet.core.impl.DefaultResponseMarshaler

DefaultResponseMarshaler(Charset) - Constructor for class com.soklet.core.impl.DefaultResponseMarshaler

DefaultServer - Class in com.soklet.core.impl

DefaultServer.Builder - Class in com.soklet.core.impl

Builder used to construct instances of DefaultServer.

DefaultServerSentEventServer - Class in com.soklet.core.impl

DefaultServerSentEventServer.Builder - Class in com.soklet.core.impl

Builder used to construct instances of DefaultServerSentEventServer.

defaultValueConverters() - Static method in class com.soklet.converter.ValueConverters

Vends the system default set of ValueConverter instances.

DELETE - Enum constant in enum class com.soklet.core.HttpMethod

The HTTP DELETE request method.

DELETE - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to support the HTTP DELETE method.

DELETEs - Annotation Interface in com.soklet.annotation

Allows multiple DELETE annotations to be applied to the same Resource Method.

didEstablishServerSentEventConnection(Request, ResourceMethod) - Method in interface com.soklet.core.LifecycleInterceptor

Called immediately after a Server-Sent Event connection of indefinite duration to the client is opened.

didFinishRequestHandling(Request, ResourceMethod, MarshaledResponse, Duration, List<Throwable>) - Method in interface com.soklet.core.LifecycleInterceptor

Called after a request has fully completed processing and a response has been sent to the client.

didFinishResponseWriting(Request, ResourceMethod, MarshaledResponse, Duration, Throwable) - Method in interface com.soklet.core.LifecycleInterceptor

Called after the response is sent to the client.

didFinishServerSentEventWriting(Request, ResourceMethod, ServerSentEvent, Duration, Throwable) - Method in interface com.soklet.core.LifecycleInterceptor

Called after a Server-Sent Event is sent to the client.

didReceiveLogEvent(LogEvent) - Method in interface com.soklet.core.LifecycleInterceptor

Called when an event suitable for logging occurs during processing (generally, an exception).

didStartRequestHandling(Request, ResourceMethod) - Method in interface com.soklet.core.LifecycleInterceptor

Called as soon as a request is received and a Resource Method has been resolved to handle it.

didStartServer(Server) - Method in interface com.soklet.core.LifecycleInterceptor

Called after the server starts.

didStartServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.core.LifecycleInterceptor

Called after the Server-Sent Event server starts.

didStopServer(Server) - Method in interface com.soklet.core.LifecycleInterceptor

Called after the server stops.

didStopServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.core.LifecycleInterceptor

Called after the Server-Sent Event server stops.

didTerminateServerSentEventConnection(Request, ResourceMethod, Duration, Throwable) - Method in interface com.soklet.core.LifecycleInterceptor

Called immediately after a Server-Sent Event connection to the client is terminated.

domain(String) - Method in class com.soklet.core.ResponseCookie.Builder

domain(String) - Method in class com.soklet.core.ResponseCookie.Copier

E

emptyByteArray() - Static method in class com.soklet.core.Utilities

equals(Object) - Method in class com.soklet.converter.TypeReference

equals(Object) - Method in class com.soklet.core.Cors

equals(Object) - Method in class com.soklet.core.CorsPreflight

equals(Object) - Method in class com.soklet.core.CorsPreflightResponse

equals(Object) - Method in class com.soklet.core.CorsResponse

equals(Object) - Method in class com.soklet.core.LogEvent

equals(Object) - Method in class com.soklet.core.MultipartField

equals(Object) - Method in class com.soklet.core.Request

equals(Object) - Method in class com.soklet.core.RequestResult

equals(Object) - Method in class com.soklet.core.ResourceMethod

equals(Object) - Method in class com.soklet.core.ResourcePath

equals(Object) - Method in class com.soklet.core.ResourcePathDeclaration.Component

equals(Object) - Method in class com.soklet.core.ResourcePathDeclaration

equals(Object) - Method in class com.soklet.core.Response

equals(Object) - Method in class com.soklet.core.ResponseCookie

event(String) - Method in class com.soklet.core.ServerSentEvent.Builder

extractCharsetFromHeaders(Map<String, Set<String>>) - Static method in class com.soklet.core.Utilities

extractCharsetFromHeaderValue(String) - Static method in class com.soklet.core.Utilities

extractClientUrlPrefixFromHeaders(Map<String, Set<String>>) - Static method in class com.soklet.core.Utilities

Best-effort attempt to determine a client's URL prefix by examining request headers.

extractContentTypeFromHeaders(Map<String, Set<String>>) - Static method in class com.soklet.core.Utilities

extractContentTypeFromHeaderValue(String) - Static method in class com.soklet.core.Utilities

extractCookiesFromHeaders(Map<String, Set<String>>) - Static method in class com.soklet.core.Utilities

extractMultipartFields(Request) - Method in class com.soklet.core.impl.DefaultMultipartParser

extractMultipartFields(Request) - Method in interface com.soklet.core.MultipartParser

Given a request, detect all HTML form fields with multipart/form-data encoding and parse their values.

extractPlaceholders(ResourcePath) - Method in class com.soklet.core.ResourcePathDeclaration

What is the mapping between this resource path declaration's placeholder names to the given resource path's placeholder values?

extractPlaceholders(ResourcePathDeclaration) - Method in class com.soklet.core.ResourcePath

What is the mapping between this resource path's placeholder values to the given resource path declaration's placeholder names?

extractQueryParametersFromQuery(String) - Static method in class com.soklet.core.Utilities

extractQueryParametersFromUrl(String) - Static method in class com.soklet.core.Utilities

F

filename(String) - Method in class com.soklet.core.MultipartField.Builder

filename(String) - Method in class com.soklet.core.MultipartField.Copier

finish() - Method in class com.soklet.core.CorsPreflightResponse.Copier

finish() - Method in class com.soklet.core.CorsResponse.Copier

finish() - Method in class com.soklet.core.LogEvent.Copier

finish() - Method in class com.soklet.core.MarshaledResponse.Copier

finish() - Method in class com.soklet.core.MultipartField.Copier

finish() - Method in class com.soklet.core.Request.Copier

finish() - Method in class com.soklet.core.RequestResult.Copier

finish() - Method in class com.soklet.core.Response.Copier

finish() - Method in class com.soklet.core.ResponseCookie.Copier

finish() - Method in class com.soklet.SokletConfiguration.Copier

forContentTooLarge(Request, ResourceMethod) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forContentTooLarge(Request, ResourceMethod) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for a request that triggers an HTTP 413 Content Too Large.

forCorsAllowed(Request, Cors, CorsResponse, MarshaledResponse) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forCorsAllowed(Request, Cors, CorsResponse, MarshaledResponse) - Method in interface com.soklet.core.ResponseMarshaler

Applies "CORS is permitted for this request" data to a response.

forCorsPreflightAllowed(Request, CorsPreflight, CorsPreflightResponse) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forCorsPreflightAllowed(Request, CorsPreflight, CorsPreflightResponse) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for "CORS preflight allowed" scenario when your CorsAuthorizer approves a preflight request.

forCorsPreflightRejected(Request, CorsPreflight) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forCorsPreflightRejected(Request, CorsPreflight) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for "CORS preflight rejected" scenario when your CorsAuthorizer denies a preflight request.

forHappyPath(Request, Response, ResourceMethod) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forHappyPath(Request, Response, ResourceMethod) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a "happy path" response - the request was matched to a Resource Method and executed non-exceptionally.

forHead(Request, MarshaledResponse) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forHead(Request, MarshaledResponse) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for an HTTP HEAD request.

forHeartbeat() - Static method in class com.soklet.core.ServerSentEvent

Acquires a reference to the shared "heartbeat" event.

forMethodNotAllowed(Request, Set<HttpMethod>) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forMethodNotAllowed(Request, Set<HttpMethod>) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for a request that triggers an HTTP 405 Method Not Allowed.

FormParameter - Annotation Interface in com.soklet.annotation

Apply to Resource Method parameters to enable HTML form parameter injection.

forNotFound(Request) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forNotFound(Request) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for a request that triggers an HTTP 404 Not Found.

forOptions(Request, Set<HttpMethod>) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forOptions(Request, Set<HttpMethod>) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for an HTTP OPTIONS request.

forTesting() - Static method in class com.soklet.SokletConfiguration

Vends a configuration builder with mock servers, suitable for unit and integration testing.

forThrowable(Request, Throwable, ResourceMethod) - Method in class com.soklet.core.impl.DefaultResponseMarshaler

forThrowable(Request, Throwable, ResourceMethod) - Method in interface com.soklet.core.ResponseMarshaler

Prepares a response for scenarios in which an uncaught exception is encountered.

fromHeaderRepresentation(String) - Static method in enum class com.soklet.core.ResponseCookie.SameSite

Returns the ResponseCookie.SameSite enum value that matches the corresponding SameSite response header value representation (one of Strict, Lax, or None - case-insensitive).

fromHeaders(HttpMethod, Map<String, Set<String>>) - Static method in class com.soklet.core.Cors

Extracts a CORS non-preflight request representation from the given HTTP request data.

fromHeaders(Map<String, Set<String>>) - Static method in class com.soklet.core.CorsPreflight

Extracts a CORS preflight request representation from the given HTTP request data.

fromSetCookieHeaderRepresentation(String) - Static method in class com.soklet.core.ResponseCookie

Given a Set-Cookie header representation, provide a ResponseCookie that matches it.

fromStatusCode(Integer) - Static method in enum class com.soklet.core.StatusCode

Given an HTTP status code, return the corresponding enum value.

FromStringValueConverter<T> - Class in com.soklet.converter

Convenience superclass which provides default implementations of ValueConverter methods that convert from String to other types.

FromStringValueConverter() - Constructor for class com.soklet.converter.FromStringValueConverter

Ensures that the 'from' type of this converter is String.

G

generateId() - Method in interface com.soklet.core.IdGenerator

Vends an identifier, not necessarily unique.

generateId() - Method in class com.soklet.core.impl.DefaultIdGenerator

get(TypeReference<F>, TypeReference<T>) - Method in class com.soklet.converter.ValueConverterRegistry

Obtains a ValueConverter that matches the 'from' and 'to' type references specified.

get(Type, Type) - Method in class com.soklet.converter.ValueConverterRegistry

Obtain a ValueConverter that matches the 'from' and 'to' types specified.

GET - Enum constant in enum class com.soklet.core.HttpMethod

The HTTP GET request method.

GET - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to support the HTTP GET method.

getAccessControlAllowCredentials() - Method in class com.soklet.core.CorsPreflightResponse

Value for the Access-Control-Allow-Credentials response header.

getAccessControlAllowCredentials() - Method in class com.soklet.core.CorsResponse

Value for the Access-Control-Allow-Credentials response header.

getAccessControlAllowHeaders() - Method in class com.soklet.core.CorsPreflightResponse

Set of values for the Access-Control-Allow-Headers response header.

getAccessControlAllowMethods() - Method in class com.soklet.core.CorsPreflightResponse

Set of values for the Access-Control-Allow-Methods response header.

getAccessControlAllowOrigin() - Method in class com.soklet.core.CorsPreflightResponse

Value for the Access-Control-Allow-Origin response header.

getAccessControlAllowOrigin() - Method in class com.soklet.core.CorsResponse

Value for the Access-Control-Allow-Origin response header.

getAccessControlExposeHeaders() - Method in class com.soklet.core.CorsResponse

Value for the Access-Control-Expose-Headers response header.

getAccessControlMaxAge() - Method in class com.soklet.core.CorsPreflightResponse

Value for the Access-Control-Max-Age response header.

getAccessControlRequestHeaders() - Method in class com.soklet.core.CorsPreflight

Returns the set of values for the HTTP Access-Control-Request-Headers request header.

getAccessControlRequestMethod() - Method in class com.soklet.core.CorsPreflight

The HTTP Access-Control-Request-Method request header value.

getBody() - Method in class com.soklet.core.MarshaledResponse

The HTTP response body to write, if available.

getBody() - Method in class com.soklet.core.Request

The raw bytes of the request body.

getBody() - Method in class com.soklet.core.Response

The "logical" body content to be written to the response, if present.

getBodyAsString() - Method in class com.soklet.core.Request

Convenience method that provides the Request.getBody() bytes as a String encoded using the client-specified character set per Request.getCharset().

getCharset() - Method in class com.soklet.core.MultipartField

The charset used to encode this field, if applicable.

getCharset() - Method in class com.soklet.core.Request

The request's character encoding, as specified by the client in the Content-Type header value.

getClientCount() - Method in interface com.soklet.core.ServerSentEventBroadcaster

Approximately how many clients are listening to this broadcaster's ResourcePath?

getComponents() - Method in class com.soklet.core.ResourcePath

What are the /-delimited components of this resource path?

getComponents() - Method in class com.soklet.core.ResourcePathDeclaration

What are the /-delimited components of this resource path declaration?

getContentType() - Method in class com.soklet.core.MultipartField

The content type for this field, if available (for example, image/png for an image file).

getContentType() - Method in class com.soklet.core.Request

The Content-Type header value, as specified by the client.

getCookie(String) - Method in class com.soklet.core.Request

Convenience method to access a cookie's value when at most one is expected for the given name.

getCookies() - Method in class com.soklet.core.MarshaledResponse

The HTTP cookies to write for this response.

getCookies() - Method in class com.soklet.core.Request

The cookies provided by the client for this request.

getCookies() - Method in class com.soklet.core.Response

The cookies to be written to the client for this response.

getCors() - Method in class com.soklet.core.Request

Non-preflight CORS request data.

getCorsAuthorizer() - Method in class com.soklet.SokletConfiguration

How Soklet handles Cross-Origin Resource Sharing (CORS).

getCorsPreflight() - Method in class com.soklet.core.Request

CORS preflight-related request data.

getCorsPreflightResponse() - Method in class com.soklet.core.RequestResult

The CORS preflight logical response, if applicable for the request.

getData() - Method in class com.soklet.core.MultipartField

The binary value of this field, if available.

getData() - Method in class com.soklet.core.ServerSentEvent

The data payload for this Server-Sent Event.

getDataAsString() - Method in class com.soklet.core.MultipartField

The value of this field represented as a string, if available.

getDomain() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's Domain value, if present.

getEvent() - Method in class com.soklet.core.ServerSentEvent

The event value for this Server-Sent Event.

getFilename() - Method in class com.soklet.core.MultipartField

The filename associated with this field, if available.

getFormParameter(String) - Method in class com.soklet.core.Request

Convenience method to access a form parameter's value when at most one is expected for the given name.

getFormParameterName() - Method in exception class com.soklet.exception.IllegalFormParameterException

getFormParameterName() - Method in exception class com.soklet.exception.MissingFormParameterException

getFormParameters() - Method in class com.soklet.core.Request

The HTML form parameters provided by the client for this request.

getFormParameterValue() - Method in exception class com.soklet.exception.IllegalFormParameterException

getFromType() - Method in class com.soklet.converter.AbstractValueConverter

getFromType() - Method in exception class com.soklet.converter.ValueConversionException

The 'from' type of the failed ValueConverter.

getFromType() - Method in interface com.soklet.converter.ValueConverter

The 'converting from' type.

getFromValue() - Method in exception class com.soklet.converter.ValueConversionException

The 'from' value of the failed ValueConverter.

getHeader(String) - Method in class com.soklet.core.Request

Convenience method to access a header's value when at most one is expected for the given name.

getHeaderRepresentation() - Method in enum class com.soklet.core.ResponseCookie.SameSite

The HTTP header value that corresponds to this enum value - one of Strict, Lax, or None.

getHeaders() - Method in class com.soklet.core.MarshaledResponse

The HTTP headers to write for this response.

getHeaders() - Method in class com.soklet.core.Request

The headers provided by the client for this request.

getHeaders() - Method in class com.soklet.core.Response

The headers to be written to the client for this response.

getHttpMethod() - Method in class com.soklet.core.Cors

The HTTP method for this request.

getHttpMethod() - Method in class com.soklet.core.Request

The HTTP method for this request.

getHttpMethod() - Method in class com.soklet.core.ResourceMethod

Returns the HTTP method for this Resource Method.

getHttpMethodResourcePathDeclarationsByMethod() - Method in class com.soklet.core.impl.DefaultResourceMethodResolver

getHttpOnly() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's HttpOnly flag, if present.

getId() - Method in class com.soklet.core.Request

An application-specific identifier for this request.

getId() - Method in class com.soklet.core.ServerSentEvent

The id for this Server-Sent Event, used by clients to populate the Last-Event-ID request header should a reconnect occur.

getInstanceProvider() - Method in class com.soklet.SokletConfiguration

How Soklet will perform instance creation.

getLifecycleInterceptor() - Method in class com.soklet.SokletConfiguration

How Soklet will perform custom behavior during server and request lifecycle events.

getLocales() - Method in class com.soklet.core.Request

Locale information for this request as specified by Accept-Language header value[s] and ordered by weight as defined by RFC 7231, Section 5.3.5.

getLogEventType() - Method in class com.soklet.core.LogEvent

The type of log event this is.

getMarshaledResponse() - Method in class com.soklet.core.LogEvent

The response associated with this log event, if available.

getMarshaledResponse() - Method in class com.soklet.core.RequestResult

The final representation of the response to be written over the wire.

getMaxAge() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's Max-Age value expressed as a Duration, if present.

getMessage() - Method in class com.soklet.core.LogEvent

The message for this log event.

getMethod() - Method in class com.soklet.core.ResourceMethod

Returns the Java method to invoke for the combination of HTTP method and resource path.

getMethods() - Method in class com.soklet.core.impl.DefaultResourceMethodResolver

getMultipartField() - Method in exception class com.soklet.exception.IllegalMultipartFieldException

getMultipartField(String) - Method in class com.soklet.core.Request

Convenience method to access a multipart field when at most one is expected for the given name.

getMultipartFieldName() - Method in exception class com.soklet.exception.MissingMultipartFieldException

getMultipartFields() - Method in class com.soklet.core.Request

The HTML multipart/form-data fields provided by the client for this request.

getName() - Method in class com.soklet.core.MultipartField

The name of this field.

getName() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's name.

getName() - Method in exception class com.soklet.exception.IllegalRequestCookieException

getOrigin() - Method in class com.soklet.core.Cors

The HTTP Origin header value for this request.

getOrigin() - Method in class com.soklet.core.CorsPreflight

Returns the HTTP Origin request header value.

getPath() - Method in class com.soklet.core.Request

The path component of this request, which is a representation of the value returned by Request.getUri() with the query string (if any) removed.

getPath() - Method in class com.soklet.core.ResourcePath

What is the string representation of this resource path?

getPath() - Method in class com.soklet.core.ResourcePathDeclaration

What is the string representation of this resource path declaration?

getPath() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's Path value, if present.

getPathParameterName() - Method in exception class com.soklet.exception.IllegalPathParameterException

getPathParameterValue() - Method in exception class com.soklet.exception.IllegalPathParameterException

getQueryParameter(String) - Method in class com.soklet.core.Request

Convenience method to access a query parameter's value when at most one is expected for the given name.

getQueryParameterName() - Method in exception class com.soklet.exception.IllegalQueryParameterException

getQueryParameterName() - Method in exception class com.soklet.exception.MissingQueryParameterException

getQueryParameters() - Method in class com.soklet.core.Request

The query parameters provided by the client for this request.

getQueryParameterValue() - Method in exception class com.soklet.exception.IllegalQueryParameterException

getReasonPhrase() - Method in enum class com.soklet.core.StatusCode

An English-language description for this HTTP status code.

getRequest() - Method in class com.soklet.core.LogEvent

The request associated with this log event, if available.

getRequestBodyMarshaler() - Method in class com.soklet.SokletConfiguration

How Soklet will marshal request bodies to Java types.

getRequestCookieName() - Method in exception class com.soklet.exception.MissingRequestCookieException

getRequestHeaderName() - Method in exception class com.soklet.exception.IllegalRequestHeaderException

getRequestHeaderName() - Method in exception class com.soklet.exception.MissingRequestHeaderException

getRequestHeaderValue() - Method in exception class com.soklet.exception.IllegalRequestHeaderException

getResourceMethod() - Method in class com.soklet.core.LogEvent

The Resource Method associated with this log event, if available.

getResourceMethod() - Method in class com.soklet.core.RequestResult

The Resource Method that handled the request, if available.

getResourceMethodParameterProvider() - Method in class com.soklet.SokletConfiguration

How Soklet performs Resource Method parameter injection (experts only!)

getResourceMethodResolver() - Method in class com.soklet.SokletConfiguration

How Soklet performs Resource Method resolution (experts only!)

getResourceMethods() - Method in class com.soklet.core.impl.DefaultResourceMethodResolver

getResourceMethods() - Method in interface com.soklet.core.ResourceMethodResolver

Vends the set of all Resource Methods registered in the system.

getResourceMethodsByResourcePathDeclaration() - Method in class com.soklet.core.impl.DefaultServerSentEventServer

getResourcePath() - Method in class com.soklet.core.Request

Convenience method to acquire a ResourcePath representation of Request.getPath().

getResourcePath() - Method in class com.soklet.core.ResourceMethod

Returns the HTTP path for this Resource Method, which might contain placeholders - for example, /example/{exampleId}.

getResourcePath() - Method in interface com.soklet.core.ServerSentEventBroadcaster

The runtime Resource Path with which this broadcaster is associated.

getResponse() - Method in class com.soklet.core.RequestResult

The logical response, determined by the return value of the Resource Method (if available).

getResponseMarshaler() - Method in class com.soklet.SokletConfiguration

How Soklet will marshal response bodies to bytes suitable for transmission over the wire.

getRetry() - Method in class com.soklet.core.ServerSentEvent

The retry duration for this Server-Sent Event.

GETs - Annotation Interface in com.soklet.annotation

Allows multiple GET annotations to be applied to the same Resource Method.

getSameSite() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's SameSite value, if present.

getSecure() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's Secure flag, if present.

getServer() - Method in class com.soklet.SokletConfiguration

The server managed by Soklet.

getServerSentEventServer() - Method in class com.soklet.SokletConfiguration

The SSE server managed by Soklet, if configured.

getStatusCode() - Method in class com.soklet.core.MarshaledResponse

The HTTP status code for this response.

getStatusCode() - Method in enum class com.soklet.core.RedirectType

The HTTP status code for this redirect type.

getStatusCode() - Method in class com.soklet.core.Response

The HTTP status code to be written to the client for this response.

getStatusCode() - Method in enum class com.soklet.core.StatusCode

The HTTP status code that corresponds to this enum value.

getThrowable() - Method in class com.soklet.core.LogEvent

The throwable for this log event, if available.

getToType() - Method in class com.soklet.converter.AbstractValueConverter

getToType() - Method in exception class com.soklet.converter.ValueConversionException

The 'to' type of the failed ValueConverter.

getToType() - Method in interface com.soklet.converter.ValueConverter

The 'converting to' type.

getType() - Method in class com.soklet.converter.TypeReference

getType() - Method in class com.soklet.core.ResourcePathDeclaration.Component

What type of resource path declaration component is this?

getUri() - Method in class com.soklet.core.Request

The URI for this request, which must start with a / character and might include query parameters, such as /example/123 or /one?two=three.

getValue() - Method in class com.soklet.core.ResourcePathDeclaration.Component

What is the value of this resource path declaration component?

getValue() - Method in class com.soklet.core.ResponseCookie

Gets the cookie's value, if present.

getValue() - Method in exception class com.soklet.exception.IllegalRequestCookieException

getValueConverterRegistry() - Method in class com.soklet.SokletConfiguration

How Soklet will perform conversions from one Java type to another, like a String to a LocalDate.

H

handleRequest(Request, Consumer<RequestResult>) - Method in interface com.soklet.core.Server.RequestHandler

Callback to be invoked by a Server implementation after it has received an HTTP request but prior to writing an HTTP response.

handleRequest(Request, Consumer<RequestResult>) - Method in interface com.soklet.core.ServerSentEventServer.RequestHandler

Callback to be invoked by a ServerSentEventServer implementation after it has received a Server-Sent Event Source HTTP request but prior to writing initial data to the HTTP response.

hashCode() - Method in class com.soklet.converter.TypeReference

hashCode() - Method in class com.soklet.core.Cors

hashCode() - Method in class com.soklet.core.CorsPreflight

hashCode() - Method in class com.soklet.core.CorsPreflightResponse

hashCode() - Method in class com.soklet.core.CorsResponse

hashCode() - Method in class com.soklet.core.LogEvent

hashCode() - Method in class com.soklet.core.MultipartField

hashCode() - Method in class com.soklet.core.Request

hashCode() - Method in class com.soklet.core.RequestResult

hashCode() - Method in class com.soklet.core.ResourceMethod

hashCode() - Method in class com.soklet.core.ResourcePath

hashCode() - Method in class com.soklet.core.ResourcePathDeclaration.Component

hashCode() - Method in class com.soklet.core.ResourcePathDeclaration

hashCode() - Method in class com.soklet.core.Response

hashCode() - Method in class com.soklet.core.ResponseCookie

HEAD - Enum constant in enum class com.soklet.core.HttpMethod

The HTTP HEAD request method.

HEAD - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to support the HTTP HEAD method.

headers(Consumer<Map<String, Set<String>>>) - Method in class com.soklet.core.MarshaledResponse.Copier

headers(Consumer<Map<String, Set<String>>>) - Method in class com.soklet.core.Request.Copier

headers(Consumer<Map<String, Set<String>>>) - Method in class com.soklet.core.Response.Copier

headers(Map<String, Set<String>>) - Method in class com.soklet.core.MarshaledResponse.Builder

headers(Map<String, Set<String>>) - Method in class com.soklet.core.MarshaledResponse.Copier

headers(Map<String, Set<String>>) - Method in class com.soklet.core.Request.Builder

headers(Map<String, Set<String>>) - Method in class com.soklet.core.Request.Copier

headers(Map<String, Set<String>>) - Method in class com.soklet.core.Response.Builder

headers(Map<String, Set<String>>) - Method in class com.soklet.core.Response.Copier

HEADs - Annotation Interface in com.soklet.annotation

Allows multiple HEAD annotations to be applied to the same Resource Method.

host(String) - Method in class com.soklet.core.impl.DefaultServer.Builder

host(String) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

HTTP_100 - Enum constant in enum class com.soklet.core.StatusCode

This interim response indicates that the client should continue the request or ignore the response if the request is already finished.

HTTP_101 - Enum constant in enum class com.soklet.core.StatusCode

This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to.

HTTP_102 - Enum constant in enum class com.soklet.core.StatusCode

This code was used in WebDAV contexts to indicate that a request has been received by the server, but no status was available at the time of the response.

HTTP_103 - Enum constant in enum class com.soklet.core.StatusCode

This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources.

HTTP_200 - Enum constant in enum class com.soklet.core.StatusCode

The request succeeded.

HTTP_201 - Enum constant in enum class com.soklet.core.StatusCode

The request succeeded, and a new resource was created as a result.

HTTP_202 - Enum constant in enum class com.soklet.core.StatusCode

The request has been received but not yet acted upon.

HTTP_203 - Enum constant in enum class com.soklet.core.StatusCode

This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy.

HTTP_204 - Enum constant in enum class com.soklet.core.StatusCode

There is no content to send for this request, but the headers are useful.

HTTP_205 - Enum constant in enum class com.soklet.core.StatusCode

Tells the user agent to reset the document which sent this request.

HTTP_206 - Enum constant in enum class com.soklet.core.StatusCode

This response code is used in response to a range request when the client has requested a part or parts of a resource.

HTTP_207 - Enum constant in enum class com.soklet.core.StatusCode

(WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate.

HTTP_208 - Enum constant in enum class com.soklet.core.StatusCode

(WebDAV) Used inside a <dav:propstat> response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.

HTTP_226 - Enum constant in enum class com.soklet.core.StatusCode

(HTTP Delta encoding) The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.

HTTP_300 - Enum constant in enum class com.soklet.core.StatusCode

In agent-driven content negotiation, the request has more than one possible response and the user agent or user should choose one of them.

HTTP_301 - Enum constant in enum class com.soklet.core.StatusCode

The URL of the requested resource has been changed permanently.

HTTP_301_MOVED_PERMANENTLY - Enum constant in enum class com.soklet.core.RedirectType

Represents 301 Moved Permanently.

HTTP_302 - Enum constant in enum class com.soklet.core.StatusCode

This response code means that the URI of requested resource has been changed temporarily.

HTTP_302_FOUND - Enum constant in enum class com.soklet.core.RedirectType

Represents 302 Found.

HTTP_303 - Enum constant in enum class com.soklet.core.StatusCode

The server sent this response to direct the client to get the requested resource at another URI with a GET request.

HTTP_303_SEE_OTHER - Enum constant in enum class com.soklet.core.RedirectType

Represents 303 See Other.

HTTP_304 - Enum constant in enum class com.soklet.core.StatusCode

This is used for caching purposes.

HTTP_305 - Enum constant in enum class com.soklet.core.StatusCode

Deprecated.

HTTP_306 - Enum constant in enum class com.soklet.core.StatusCode

Deprecated.

HTTP_307 - Enum constant in enum class com.soklet.core.StatusCode

The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request.

HTTP_307_TEMPORARY_REDIRECT - Enum constant in enum class com.soklet.core.RedirectType

Represents 307 Temporary Redirect.

HTTP_308 - Enum constant in enum class com.soklet.core.StatusCode

This means that the resource is now permanently located at another URI, specified by the Location response header.

HTTP_308_PERMANENT_REDIRECT - Enum constant in enum class com.soklet.core.RedirectType

Represents 308 Permanent Redirect.

HTTP_400 - Enum constant in enum class com.soklet.core.StatusCode

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

HTTP_401 - Enum constant in enum class com.soklet.core.StatusCode

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".

HTTP_402 - Enum constant in enum class com.soklet.core.StatusCode

The initial purpose of this code was for digital payment systems, however this status code is rarely used and no standard convention exists.

HTTP_403 - Enum constant in enum class com.soklet.core.StatusCode

The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.

HTTP_404 - Enum constant in enum class com.soklet.core.StatusCode

The server cannot find the requested resource.

HTTP_405 - Enum constant in enum class com.soklet.core.StatusCode

The request method is known by the server but is not supported by the target resource.

HTTP_406 - Enum constant in enum class com.soklet.core.StatusCode

This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent.

HTTP_407 - Enum constant in enum class com.soklet.core.StatusCode

This is similar to 401 Unauthorized but authentication is needed to be done by a proxy.

HTTP_408 - Enum constant in enum class com.soklet.core.StatusCode

This response is sent on an idle connection by some servers, even without any previous request by the client.

HTTP_409 - Enum constant in enum class com.soklet.core.StatusCode

This response is sent when a request conflicts with the current state of the server.

HTTP_410 - Enum constant in enum class com.soklet.core.StatusCode

This response is sent when the requested content has been permanently deleted from server, with no forwarding address.

HTTP_411 - Enum constant in enum class com.soklet.core.StatusCode

Server rejected the request because the Content-Length header field is not defined and the server requires it.

HTTP_412 - Enum constant in enum class com.soklet.core.StatusCode

In conditional requests, the client has indicated preconditions in its headers which the server does not meet.

HTTP_413 - Enum constant in enum class com.soklet.core.StatusCode

The request body is larger than limits defined by server.

HTTP_414 - Enum constant in enum class com.soklet.core.StatusCode

The URI requested by the client is longer than the server is willing to interpret.

HTTP_415 - Enum constant in enum class com.soklet.core.StatusCode

The media format of the requested data is not supported by the server, so the server is rejecting the request.

HTTP_416 - Enum constant in enum class com.soklet.core.StatusCode

The ranges specified by the Range header field in the request cannot be fulfilled.

HTTP_417 - Enum constant in enum class com.soklet.core.StatusCode

This response code means the expectation indicated by the Expect request header field cannot be met by the server.

HTTP_418 - Enum constant in enum class com.soklet.core.StatusCode

The server refuses the attempt to brew coffee with a teapot.

HTTP_421 - Enum constant in enum class com.soklet.core.StatusCode

The request was directed at a server that is not able to produce a response.

HTTP_422 - Enum constant in enum class com.soklet.core.StatusCode

(WebDAV) The request was well-formed but was unable to be followed due to semantic errors.

HTTP_423 - Enum constant in enum class com.soklet.core.StatusCode

(WebDAV) The resource that is being accessed is locked.

HTTP_424 - Enum constant in enum class com.soklet.core.StatusCode

(WebDAV) The request failed due to failure of a previous request.

HTTP_425 - Enum constant in enum class com.soklet.core.StatusCode

Indicates that the server is unwilling to risk processing a request that might be replayed.

HTTP_426 - Enum constant in enum class com.soklet.core.StatusCode

The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.

HTTP_428 - Enum constant in enum class com.soklet.core.StatusCode

The origin server requires the request to be conditional.

HTTP_429 - Enum constant in enum class com.soklet.core.StatusCode

The user has sent too many requests in a given amount of time (rate limiting).

HTTP_431 - Enum constant in enum class com.soklet.core.StatusCode

The server is unwilling to process the request because its header fields are too large.

HTTP_451 - Enum constant in enum class com.soklet.core.StatusCode

The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.

HTTP_500 - Enum constant in enum class com.soklet.core.StatusCode

The server has encountered a situation it does not know how to handle.

HTTP_501 - Enum constant in enum class com.soklet.core.StatusCode

The request method is not supported by the server and cannot be handled.

HTTP_502 - Enum constant in enum class com.soklet.core.StatusCode

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.

HTTP_503 - Enum constant in enum class com.soklet.core.StatusCode

The server is not ready to handle the request.

HTTP_504 - Enum constant in enum class com.soklet.core.StatusCode

This error response is given when the server is acting as a gateway and cannot get a response in time.

HTTP_505 - Enum constant in enum class com.soklet.core.StatusCode

The HTTP version used in the request is not supported by the server.

HTTP_506 - Enum constant in enum class com.soklet.core.StatusCode

The server has an internal configuration error: during content negotiation, the chosen variant is configured to engage in content negotiation itself, which results in circular references when creating responses.

HTTP_507 - Enum constant in enum class com.soklet.core.StatusCode

(WebDAV) The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.

HTTP_508 - Enum constant in enum class com.soklet.core.StatusCode

(WebDAV) The server detected an infinite loop while processing the request.

HTTP_510 - Enum constant in enum class com.soklet.core.StatusCode

The client request declares an HTTP Extension (RFC 2774) that should be used to process the request, but the extension is not supported.

HTTP_511 - Enum constant in enum class com.soklet.core.StatusCode

Indicates that the client needs to authenticate to gain network access.

httpMethod(HttpMethod) - Method in class com.soklet.core.Request.Builder

httpMethod(HttpMethod) - Method in class com.soklet.core.Request.Copier

HttpMethod - Enum Class in com.soklet.core

Typesafe representation of HTTP request methods.

httpOnly(Boolean) - Method in class com.soklet.core.ResponseCookie.Builder

httpOnly(Boolean) - Method in class com.soklet.core.ResponseCookie.Copier

I

id(Object) - Method in class com.soklet.core.Request.Builder

id(Object) - Method in class com.soklet.core.Request.Copier

id(String) - Method in class com.soklet.core.ServerSentEvent.Builder

idGenerator(IdGenerator) - Method in class com.soklet.core.Request.Builder

IdGenerator - Interface in com.soklet.core

Contract for types that generate identifiers: sequential integers, UUIDs, etc.

IllegalFormParameterException - Exception Class in com.soklet.exception

IllegalFormParameterException(String, String, String) - Constructor for exception class com.soklet.exception.IllegalFormParameterException

IllegalFormParameterException(String, Throwable, String, String) - Constructor for exception class com.soklet.exception.IllegalFormParameterException

IllegalMultipartFieldException - Exception Class in com.soklet.exception

IllegalMultipartFieldException(String, MultipartField) - Constructor for exception class com.soklet.exception.IllegalMultipartFieldException

IllegalMultipartFieldException(String, Throwable, MultipartField) - Constructor for exception class com.soklet.exception.IllegalMultipartFieldException

IllegalPathParameterException - Exception Class in com.soklet.exception

IllegalPathParameterException(String, String, String) - Constructor for exception class com.soklet.exception.IllegalPathParameterException

IllegalPathParameterException(String, Throwable, String, String) - Constructor for exception class com.soklet.exception.IllegalPathParameterException

IllegalQueryParameterException - Exception Class in com.soklet.exception

IllegalQueryParameterException(String, String, String) - Constructor for exception class com.soklet.exception.IllegalQueryParameterException

IllegalQueryParameterException(String, Throwable, String, String) - Constructor for exception class com.soklet.exception.IllegalQueryParameterException

IllegalRequestBodyException - Exception Class in com.soklet.exception

IllegalRequestBodyException(String) - Constructor for exception class com.soklet.exception.IllegalRequestBodyException

IllegalRequestBodyException(String, Throwable) - Constructor for exception class com.soklet.exception.IllegalRequestBodyException

IllegalRequestCookieException - Exception Class in com.soklet.exception

IllegalRequestCookieException(String, String, String) - Constructor for exception class com.soklet.exception.IllegalRequestCookieException

IllegalRequestCookieException(String, Throwable, String, String) - Constructor for exception class com.soklet.exception.IllegalRequestCookieException

IllegalRequestHeaderException - Exception Class in com.soklet.exception

IllegalRequestHeaderException(String, String, String) - Constructor for exception class com.soklet.exception.IllegalRequestHeaderException

IllegalRequestHeaderException(String, Throwable, String, String) - Constructor for exception class com.soklet.exception.IllegalRequestHeaderException

initialize(SokletConfiguration, Server.RequestHandler) - Method in class com.soklet.core.impl.DefaultServer

initialize(SokletConfiguration, Server.RequestHandler) - Method in interface com.soklet.core.Server

The Soklet instance which manages this Server will invoke this method exactly once at initialization time - this allows Soklet to "talk" to your Server.

initialize(SokletConfiguration, ServerSentEventServer.RequestHandler) - Method in class com.soklet.core.impl.DefaultServerSentEventServer

initialize(SokletConfiguration, ServerSentEventServer.RequestHandler) - Method in interface com.soklet.core.ServerSentEventServer

The Soklet instance which manages this ServerSentEventServer will invoke this method exactly once at initialization time - this allows Soklet to "talk" to your ServerSentEventServer.

instanceProvider(InstanceProvider) - Method in class com.soklet.SokletConfiguration.Builder

instanceProvider(InstanceProvider) - Method in class com.soklet.SokletConfiguration.Copier

InstanceProvider - Interface in com.soklet.core

Contract for concrete instance generation given type information.

interceptRequest(Request, ResourceMethod, Function<Request, MarshaledResponse>, Consumer<MarshaledResponse>) - Method in interface com.soklet.core.LifecycleInterceptor

Supports alteration of the request processing flow by enabling programmatic control over its two key phases: acquiring a response and writing the response to the client.

isContentTooLarge() - Method in class com.soklet.core.Request

Was this request too large for the server to handle?

isHeartbeat() - Method in class com.soklet.core.ServerSentEvent

Is this instance the shared "heartbeat" event (as provided via ServerSentEvent.forHeartbeat())?

isLiteral() - Method in class com.soklet.core.ResourcePathDeclaration

Is this resource path declaration comprised of all "literal" components (that is, no placeholders)?

isMultipart() - Method in class com.soklet.core.Request

Is this a request with Content-Type of multipart/form-data?

isServerSentEventSource() - Method in class com.soklet.core.ResourceMethod

Returns whether or not this Resource Method functions as a Server-Sent Event Source.

isStarted() - Method in class com.soklet.core.impl.DefaultServer

isStarted() - Method in class com.soklet.core.impl.DefaultServerSentEventServer

isStarted() - Method in interface com.soklet.core.Server

Is this server started (that is, able to handle requests from clients)?

isStarted() - Method in interface com.soklet.core.ServerSentEventServer

Is this SSE server started (that is, able to handle requests from clients)?

isStarted() - Method in class com.soklet.Soklet

Is either the managed Server or ServerSentEventServer started?

L

LAX - Enum constant in enum class com.soklet.core.ResponseCookie.SameSite

Means that the cookie is not sent on cross-site requests, such as on requests to load images or frames, but is sent when a user is navigating to the origin site from an external site (for example, when following a link).

LIFECYCLE_INTERCEPTOR_DID_ESTABLISH_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.didEstablishServerSentEventConnection(Request, ResourceMethod) threw an exception.

LIFECYCLE_INTERCEPTOR_DID_FINISH_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.didFinishRequestHandling(Request, ResourceMethod, MarshaledResponse, Duration, List) threw an exception.

LIFECYCLE_INTERCEPTOR_DID_FINISH_RESPONSE_WRITING_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.didFinishResponseWriting(Request, ResourceMethod, MarshaledResponse, Duration, Throwable) threw an exception.

LIFECYCLE_INTERCEPTOR_DID_FINISH_SERVER_SENT_EVENT_WRITING_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.didFinishServerSentEventWriting(Request, ResourceMethod, ServerSentEvent, Duration, Throwable) threw an exception.

LIFECYCLE_INTERCEPTOR_DID_START_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.didStartRequestHandling(Request, ResourceMethod) threw an exception.

LIFECYCLE_INTERCEPTOR_DID_TERMINATE_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.didTerminateServerSentEventConnection(Request, ResourceMethod, Duration, Throwable) threw an exception.

LIFECYCLE_INTERCEPTOR_INTERCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.interceptRequest(Request, ResourceMethod, Function, Consumer) threw an exception.

LIFECYCLE_INTERCEPTOR_WILL_ESTABLISH_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.willEstablishServerSentEventConnection(Request, ResourceMethod) threw an exception.

LIFECYCLE_INTERCEPTOR_WILL_START_RESPONSE_WRITING_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.willStartResponseWriting(Request, ResourceMethod, MarshaledResponse) threw an exception.

LIFECYCLE_INTERCEPTOR_WILL_START_SERVER_SENT_EVENT_WRITING_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.willStartServerSentEventWriting(Request, ResourceMethod, ServerSentEvent) threw an exception.

LIFECYCLE_INTERCEPTOR_WILL_TERMINATE_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.willTerminateServerSentEventConnection(Request, ResourceMethod, Throwable) threw an exception.

LIFECYCLE_INTERCEPTOR_WRAP_REQUEST_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates LifecycleInterceptor.wrapRequest(Request, ResourceMethod, Consumer) threw an exception.

lifecycleInterceptor(LifecycleInterceptor) - Method in class com.soklet.SokletConfiguration.Builder

lifecycleInterceptor(LifecycleInterceptor) - Method in class com.soklet.SokletConfiguration.Copier

LifecycleInterceptor - Interface in com.soklet.core

"Hook" methods for customizing behavior in response to system lifecycle events - server started, request received, response written, and so on.

LITERAL - Enum constant in enum class com.soklet.core.ResourcePathDeclaration.ComponentType

A literal component of a resource path declaration.

localesFromAcceptLanguageHeaderValue(String) - Static method in class com.soklet.core.Utilities

LogEvent - Class in com.soklet.core

An informational "loggable" event that occurs during Soklet's internal processing - for example, if an error occurs while handling a request.

LogEvent.Builder - Class in com.soklet.core

Builder used to construct instances of LogEvent via LogEvent.with(LogEventType, String).

LogEvent.Copier - Class in com.soklet.core

Builder used to copy instances of LogEvent via LogEvent.copy().

logEventType(LogEventType) - Method in class com.soklet.core.LogEvent.Builder

logEventType(LogEventType) - Method in class com.soklet.core.LogEvent.Copier

LogEventType - Enum Class in com.soklet.core

Kinds of LogEvent instances that Soklet can produce.

M

marshaledResponse(MarshaledResponse) - Method in class com.soklet.core.LogEvent.Builder

marshaledResponse(MarshaledResponse) - Method in class com.soklet.core.LogEvent.Copier

marshaledResponse(MarshaledResponse) - Method in class com.soklet.core.RequestResult.Builder

marshaledResponse(MarshaledResponse) - Method in class com.soklet.core.RequestResult.Copier

MarshaledResponse - Class in com.soklet.core

A finalized representation of a Response, suitable for sending to clients over the wire.

MarshaledResponse.Builder - Class in com.soklet.core

Builder used to construct instances of MarshaledResponse via MarshaledResponse.withStatusCode(Integer).

MarshaledResponse.Copier - Class in com.soklet.core

Builder used to copy instances of MarshaledResponse via MarshaledResponse.copy().

marshalRequestBody(Request, ResourceMethod, Parameter, Type) - Method in class com.soklet.core.impl.DefaultRequestBodyMarshaler

marshalRequestBody(Request, ResourceMethod, Parameter, Type) - Method in interface com.soklet.core.RequestBodyMarshaler

Given a request, the Resource Method that will handle it, and a RequestBody-annotated parameter + its type, convert the request body bytes into an instance of type requestBodyType.

matches(ResourcePath) - Method in class com.soklet.core.ResourcePathDeclaration

Does this resource path declaration match the given resource path (taking placeholders into account, if present)?

matches(ResourcePathDeclaration) - Method in class com.soklet.core.ResourcePath

Does this resource path match the given resource path (taking placeholders into account, if present)?

maxAge(Duration) - Method in class com.soklet.core.ResponseCookie.Builder

maxAge(Duration) - Method in class com.soklet.core.ResponseCookie.Copier

maximumRequestSizeInBytes(Integer) - Method in class com.soklet.core.impl.DefaultServer.Builder

maximumRequestSizeInBytes(Integer) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

message(String) - Method in class com.soklet.core.LogEvent.Builder

message(String) - Method in class com.soklet.core.LogEvent.Copier

MissingFormParameterException - Exception Class in com.soklet.exception

MissingFormParameterException(String, String) - Constructor for exception class com.soklet.exception.MissingFormParameterException

MissingMultipartFieldException - Exception Class in com.soklet.exception

MissingMultipartFieldException(String, String) - Constructor for exception class com.soklet.exception.MissingMultipartFieldException

MissingQueryParameterException - Exception Class in com.soklet.exception

MissingQueryParameterException(String, String) - Constructor for exception class com.soklet.exception.MissingQueryParameterException

MissingRequestBodyException - Exception Class in com.soklet.exception

MissingRequestBodyException(String) - Constructor for exception class com.soklet.exception.MissingRequestBodyException

MissingRequestCookieException - Exception Class in com.soklet.exception

MissingRequestCookieException(String, String) - Constructor for exception class com.soklet.exception.MissingRequestCookieException

MissingRequestHeaderException - Exception Class in com.soklet.exception

MissingRequestHeaderException(String, String) - Constructor for exception class com.soklet.exception.MissingRequestHeaderException

Multipart - Annotation Interface in com.soklet.annotation

Apply to Resource Method parameters to enable HTML multipart form parameter injection.

MultipartField - Class in com.soklet.core

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 - Class in com.soklet.core

Builder used to construct instances of MultipartField via MultipartField.withName(String) or MultipartField.with(String, byte[]).

MultipartField.Copier - Class in com.soklet.core

Builder used to copy instances of MultipartField via MultipartField.copy().

multipartParser(MultipartParser) - Method in class com.soklet.core.impl.DefaultServer.Builder

multipartParser(MultipartParser) - Method in class com.soklet.core.Request.Builder

MultipartParser - Interface in com.soklet.core

Contract for parsing HTML form fields encoded according to the multipart/form-data specification.

N

name() - Element in annotation interface com.soklet.annotation.FormParameter

The name of the HTML form parameter.

name() - Element in annotation interface com.soklet.annotation.Multipart

The name of the HTML multipart form parameter.

name() - Element in annotation interface com.soklet.annotation.PathParameter

The name of the URL path parameter.

name() - Element in annotation interface com.soklet.annotation.QueryParameter

The name of the HTTP query parameter.

name() - Element in annotation interface com.soklet.annotation.RequestCookie

The name of the HTTP request cookie.

name() - Element in annotation interface com.soklet.annotation.RequestHeader

The name of the HTTP request header.

name(String) - Method in class com.soklet.core.MultipartField.Builder

name(String) - Method in class com.soklet.core.MultipartField.Copier

name(String) - Method in class com.soklet.core.ResponseCookie.Builder

name(String) - Method in class com.soklet.core.ResponseCookie.Copier

NONE - Enum constant in enum class com.soklet.core.ResponseCookie.SameSite

Means that the browser sends the cookie with both cross-site and same-site requests.

NoOriginsCorsAuthorizer - Class in com.soklet.core.impl

NoOriginsCorsAuthorizer() - Constructor for class com.soklet.core.impl.NoOriginsCorsAuthorizer

normalizedPathForUrl(String) - Static method in class com.soklet.core.Utilities

O

of(String) - Static method in class com.soklet.core.ResourcePath

Vends an instance that represents a runtime representation of a resource path, for example /users/123.

of(String) - Static method in class com.soklet.core.ResourcePathDeclaration

Vends an instance that represents a compile-time path declaration, for example /users/{userId}.

optional() - Element in annotation interface com.soklet.annotation.FormParameter

Is this HTML form parameter optional or required?

optional() - Element in annotation interface com.soklet.annotation.Multipart

Is this HTML multipart form parameter optional or required?

optional() - Element in annotation interface com.soklet.annotation.QueryParameter

Is this HTTP query parameter optional or required?

optional() - Element in annotation interface com.soklet.annotation.RequestBody

Is this HTTP request body optional or required?

optional() - Element in annotation interface com.soklet.annotation.RequestCookie

Is this HTTP request cookie optional or required?

optional() - Element in annotation interface com.soklet.annotation.RequestHeader

Is this HTTP request header optional or required?

OPTIONS - Enum constant in enum class com.soklet.core.HttpMethod

The HTTP OPTIONS request method.

OPTIONS - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to support the HTTP OPTIONS method.

OPTIONSes - Annotation Interface in com.soklet.annotation

Allows multiple OPTIONS annotations to be applied to the same Resource Method.

P

parameterValuesForResourceMethod(Request, ResourceMethod) - Method in class com.soklet.core.impl.DefaultResourceMethodParameterProvider

parameterValuesForResourceMethod(Request, ResourceMethod) - Method in interface com.soklet.core.ResourceMethodParameterProvider

For the given request and resourceMethod, vends the list of parameters to use when invoking the underlying Java method located at ResourceMethod.getMethod().

PATCH - Enum constant in enum class com.soklet.core.HttpMethod

The HTTP PATCH request method.

PATCH - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to support the HTTP PATCH method.

PATCHes - Annotation Interface in com.soklet.annotation

Allows multiple PATCH annotations to be applied to the same Resource Method.

path(String) - Method in class com.soklet.core.ResponseCookie.Builder

path(String) - Method in class com.soklet.core.ResponseCookie.Copier

PathParameter - Annotation Interface in com.soklet.annotation

Apply to Resource Method parameters to enable URL path parameter (for example, /widgets/{widgetId}) injection.

performConversion(F) - Method in class com.soklet.converter.AbstractValueConverter

Subclasses must implement this method to convert a 'from' instance to a 'to' instance.

performRequest(Request) - Method in interface com.soklet.core.Simulator

Given a request, process it and return response data (both logical Response, if present, and the MarshaledResponse bytes to be sent over the wire) as well as the matching Resource Method, if available.

PLACEHOLDER - Enum constant in enum class com.soklet.core.ResourcePathDeclaration.ComponentType

A placeholder component (that is, one whose value is provided at runtime) of a resource path declaration.

port(Integer) - Method in class com.soklet.core.impl.DefaultServer.Builder

port(Integer) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

POST - Enum constant in enum class com.soklet.core.HttpMethod

The HTTP POST request method.

POST - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to support the HTTP POST method.

POSTs - Annotation Interface in com.soklet.annotation

Allows multiple POST annotations to be applied to the same Resource Method.

provide(Class<T>) - Method in class com.soklet.core.impl.DefaultInstanceProvider

provide(Class<T>) - Method in interface com.soklet.core.InstanceProvider

Vends an instance of the given class.

PUT - Enum constant in enum class com.soklet.core.HttpMethod

The HTTP PUT request method.

PUT - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to support the HTTP PUT method.

PUTs - Annotation Interface in com.soklet.annotation

Allows multiple PUT annotations to be applied to the same Resource Method.

Q

QueryParameter - Annotation Interface in com.soklet.annotation

Apply to Resource Method parameters to enable HTTP query parameter injection.

queryParameters(Consumer<Map<String, Set<String>>>) - Method in class com.soklet.core.Request.Copier

queryParameters(Map<String, Set<String>>) - Method in class com.soklet.core.Request.Builder

queryParameters(Map<String, Set<String>>) - Method in class com.soklet.core.Request.Copier

R

redirect(RedirectType, String) - Method in class com.soklet.core.Response.Builder

RedirectType - Enum Class in com.soklet.core

Typesafe representation of HTTP Redirect types (301, 302, 303, 307, 308).

registerServerSentEventConsumer(ResourcePath, Consumer<ServerSentEvent>) - Method in interface com.soklet.core.Simulator

Registers a ServerSentEvent "consumer" for the given ResourcePath - similar to how a real client would listen for Server-Sent Events.

request(Request) - Method in class com.soklet.core.LogEvent.Builder

request(Request) - Method in class com.soklet.core.LogEvent.Copier

Request - Class in com.soklet.core

Encapsulates information specified in an HTTP request.

REQUEST_PROCESSING_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates that an exception was thrown during core request processing operations.

Request.Builder - Class in com.soklet.core

Builder used to construct instances of Request via Request.with(HttpMethod, String).

Request.Copier - Class in com.soklet.core

Builder used to copy instances of Request via Request.copy().

RequestBody - Annotation Interface in com.soklet.annotation

Apply to Resource Method parameters to enable HTTP request body injection.

requestBodyMarshaler(RequestBodyMarshaler) - Method in class com.soklet.SokletConfiguration.Builder

requestBodyMarshaler(RequestBodyMarshaler) - Method in class com.soklet.SokletConfiguration.Copier

RequestBodyMarshaler - Interface in com.soklet.core

Contract for converting request body bytes into a corresponding Java type.

RequestCookie - Annotation Interface in com.soklet.annotation

Apply to Resource Method parameters to enable HTTP request cookie injection.

requestHandlerExecutorServiceSupplier(Supplier<ExecutorService>) - Method in class com.soklet.core.impl.DefaultServer.Builder

requestHandlerExecutorServiceSupplier(Supplier<ExecutorService>) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

RequestHeader - Annotation Interface in com.soklet.annotation

Apply to Resource Method parameters to enable HTTP request header injection.

requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.core.impl.DefaultServer.Builder

requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

RequestResult - Class in com.soklet.core

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 - Class in com.soklet.core

Builder used to construct instances of RequestResult via RequestResult.withMarshaledResponse(MarshaledResponse).

RequestResult.Copier - Class in com.soklet.core

Builder used to copy instances of RequestResult via RequestResult.copy().

requestTimeout(Duration) - Method in class com.soklet.core.impl.DefaultServer.Builder

requestTimeout(Duration) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

Resource - Annotation Interface in com.soklet.annotation

This annotation must be present on a class for Resource Methods to be detected.

RESOURCE_METHOD_RESOLUTION_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates Resource Method resolution via (ResourceMethodResolver.resourceMethodForRequest(Request) threw an exception.

resourceMethod(ResourceMethod) - Method in class com.soklet.core.LogEvent.Builder

resourceMethod(ResourceMethod) - Method in class com.soklet.core.LogEvent.Copier

resourceMethod(ResourceMethod) - Method in class com.soklet.core.RequestResult.Builder

resourceMethod(ResourceMethod) - Method in class com.soklet.core.RequestResult.Copier

ResourceMethod - Class in com.soklet.core

Represents a Resource Method, which is a Java Method invoked by Soklet to handle an HTTP request.

resourceMethodForRequest(Request) - Method in class com.soklet.core.impl.DefaultResourceMethodResolver

resourceMethodForRequest(Request) - Method in interface com.soklet.core.ResourceMethodResolver

Given an HTTP request, provide a matching Resource Method to invoke.

resourceMethodParameterProvider(ResourceMethodParameterProvider) - Method in class com.soklet.SokletConfiguration.Builder

resourceMethodParameterProvider(ResourceMethodParameterProvider) - Method in class com.soklet.SokletConfiguration.Copier

ResourceMethodParameterProvider - Interface in com.soklet.core

Contract for determining parameter values to inject when invoking Resource Methods.

resourceMethodResolver(ResourceMethodResolver) - Method in class com.soklet.SokletConfiguration.Builder

resourceMethodResolver(ResourceMethodResolver) - Method in class com.soklet.SokletConfiguration.Copier

ResourceMethodResolver - Interface in com.soklet.core

Contract for matching incoming HTTP requests with appropriate Resource Methods (Java methods to invoke to handle requests).

ResourcePath - Class in com.soklet.core

An HTTP URL path used to resolve a Resource Method at runtime, such as /users/123.

ResourcePathDeclaration - Class in com.soklet.core

A compile-time HTTP URL path declaration associated with an annotated Resource Method, such as /users/{userId}.

ResourcePathDeclaration.Component - Class in com.soklet.core

Represents a /-delimited part of a ResourcePathDeclaration.

ResourcePathDeclaration.ComponentType - Enum Class in com.soklet.core

How to interpret a ResourcePathDeclaration.Component of a ResourcePathDeclaration - is it literal text or a placeholder?

response(Response) - Method in class com.soklet.core.RequestResult.Builder

response(Response) - Method in class com.soklet.core.RequestResult.Copier

Response - Class in com.soklet.core

Represents a logical HTTP response returned by a Resource Method.

RESPONSE_MARSHALER_FOR_THROWABLE_FAILED - Enum constant in enum class com.soklet.core.LogEventType

Indicates ResponseMarshaler.forThrowable(Request, Throwable, ResourceMethod) threw an exception.

Response.Builder - Class in com.soklet.core

Builder used to construct instances of Response via Response.withStatusCode(Integer) or Response.withRedirect(RedirectType, String).

Response.Copier - Class in com.soklet.core

Builder used to copy instances of Response via Response.copy().

ResponseCookie - Class in com.soklet.core

HTTP "response" Cookie representation which supports Set-Cookie header encoding.

ResponseCookie.Builder - Class in com.soklet.core

Builder used to construct instances of ResponseCookie via ResponseCookie.withName(String) or ResponseCookie.with(String, String).

ResponseCookie.Copier - Class in com.soklet.core

Builder used to copy instances of ResponseCookie via ResponseCookie.copy().

ResponseCookie.SameSite - Enum Class in com.soklet.core

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(ResponseMarshaler) - Method in class com.soklet.SokletConfiguration.Builder

responseMarshaler(ResponseMarshaler) - Method in class com.soklet.SokletConfiguration.Copier

ResponseMarshaler - Interface in com.soklet.core

Prepares responses for each request scenario Soklet supports (happy path, exception, CORS preflight, etc.)

retry(Duration) - Method in class com.soklet.core.ServerSentEvent.Builder

runSimulator(SokletConfiguration, Consumer<Simulator>) - Static method in class com.soklet.Soklet

Runs Soklet with a special "simulator" server that is useful for integration testing.

S

sameSite(ResponseCookie.SameSite) - Method in class com.soklet.core.ResponseCookie.Builder

sameSite(ResponseCookie.SameSite) - Method in class com.soklet.core.ResponseCookie.Copier

secure(Boolean) - Method in class com.soklet.core.ResponseCookie.Builder

secure(Boolean) - Method in class com.soklet.core.ResponseCookie.Copier

server(Server) - Method in class com.soklet.SokletConfiguration.Builder

server(Server) - Method in class com.soklet.SokletConfiguration.Copier

Server - Interface in com.soklet.core

Contract for HTTP server implementations that are designed to be managed by a Soklet instance.

SERVER_INTERNAL_ERROR - Enum constant in enum class com.soklet.core.LogEventType

Indicates an internal Server error occurred.

SERVER_SENT_EVENT_SERVER_INTERNAL_ERROR - Enum constant in enum class com.soklet.core.LogEventType

Indicates an internal ServerSentEventServer error occurred.

Server.RequestHandler - Interface in com.soklet.core

Request/response processing contract for Server implementations.

ServerSentEvent - Class in com.soklet.core

Encapsulates a Server-Sent Event payload that can be sent across the wire to a client.

ServerSentEvent.Builder - Class in com.soklet.core

Builder used to construct instances of ServerSentEvent via ServerSentEvent.withEvent(String) or ServerSentEvent.withData(String).

ServerSentEventBroadcaster - Interface in com.soklet.core

Broadcasts a Server-Sent Event payload to all clients listening on a ResourcePath.

serverSentEventServer(ServerSentEventServer) - Method in class com.soklet.SokletConfiguration.Builder

serverSentEventServer(ServerSentEventServer) - Method in class com.soklet.SokletConfiguration.Copier

ServerSentEventServer - Interface in com.soklet.core

A special HTTP server whose only purpose is to provide Server-Sent Event functionality.

ServerSentEventServer.RequestHandler - Interface in com.soklet.core

Request/response processing contract for ServerSentEventServer implementations.

ServerSentEventSource - Annotation Interface in com.soklet.annotation

Apply to Resource Methods to make them function as Server-Sent Event Sources.

ServerSentEventSources - Annotation Interface in com.soklet.annotation

Allows multiple ServerSentEventSource annotations to be applied to the same Resource Method.

sharedInstance() - Static method in class com.soklet.converter.ValueConverterRegistry

The system's default shared registry instance.

sharedInstance() - Static method in class com.soklet.core.impl.DefaultInstanceProvider

sharedInstance() - Static method in class com.soklet.core.impl.DefaultLifecycleInterceptor

sharedInstance() - Static method in class com.soklet.core.impl.DefaultMultipartParser

sharedInstance() - Static method in class com.soklet.core.impl.DefaultRequestBodyMarshaler

sharedInstance() - Static method in class com.soklet.core.impl.DefaultResourceMethodResolver

sharedInstance() - Static method in class com.soklet.core.impl.DefaultResponseMarshaler

sharedInstance() - Static method in class com.soklet.core.impl.NoOriginsCorsAuthorizer

shutdownTimeout(Duration) - Method in class com.soklet.core.impl.DefaultServer.Builder

shutdownTimeout(Duration) - Method in class com.soklet.core.impl.DefaultServerSentEventServer.Builder

Simulator - Interface in com.soklet.core

Simulates server behavior of accepting a request and returning a response, useful for writing integration tests.

socketPendingConnectionLimit(Integer) - Method in class com.soklet.core.impl.DefaultServer.Builder

socketSelectTimeout(Duration) - Method in class com.soklet.core.impl.DefaultServer.Builder

Soklet - Class in com.soklet

Soklet's main class - manages a Server (and optionally a ServerSentEventServer) using the provided system configuration.

Soklet(SokletConfiguration) - Constructor for class com.soklet.Soklet

Creates a Soklet instance with the given configuration.

SokletConfiguration - Class in com.soklet

Defines how a Soklet system is configured.

SokletConfiguration.Builder - Class in com.soklet

Builder used to construct instances of SokletConfiguration.

SokletConfiguration.Copier - Class in com.soklet

Builder used to copy instances of SokletConfiguration.

SokletProcessor - Class in com.soklet.annotation

Soklet's standard Annotation Processor which is used to generate lookup tables of Resource Method definitions at compile time.

SokletProcessor() - Constructor for class com.soklet.annotation.SokletProcessor

start() - Method in class com.soklet.core.impl.DefaultServer

start() - Method in class com.soklet.core.impl.DefaultServerSentEventServer

start() - Method in interface com.soklet.core.Server

Starts the server, which makes it able to accept requests from clients.

start() - Method in interface com.soklet.core.ServerSentEventServer

Starts the SSE server, which makes it able to accept requests from clients.

start() - Method in class com.soklet.Soklet

Starts the managed server instance[s].

statusCode(Integer) - Method in class com.soklet.core.MarshaledResponse.Builder

statusCode(Integer) - Method in class com.soklet.core.MarshaledResponse.Copier

statusCode(Integer) - Method in class com.soklet.core.Response.Builder

statusCode(Integer) - Method in class com.soklet.core.Response.Copier

StatusCode - Enum Class in com.soklet.core

Formal enumeration of valid HTTP status codes.

stop() - Method in class com.soklet.core.impl.DefaultServer

stop() - Method in class com.soklet.core.impl.DefaultServerSentEventServer

stop() - Method in interface com.soklet.core.Server

Stops the server, which makes it unable to accept requests from clients.

stop() - Method in interface com.soklet.core.ServerSentEventServer

Stops the SSE server, which makes it unable to accept requests from clients.

stop() - Method in class com.soklet.Soklet

Stops the managed server instance[s].

STRICT - Enum constant in enum class com.soklet.core.ResponseCookie.SameSite

Means that the browser sends the cookie only for same-site requests, that is, requests originating from the same site that set the cookie.

T

throwable(Throwable) - Method in class com.soklet.core.LogEvent.Builder

throwable(Throwable) - Method in class com.soklet.core.LogEvent.Copier

toSetCookieHeaderRepresentation() - Method in class com.soklet.core.ResponseCookie

Generates a Set-Cookie header representation of this response cookie, for example Set-Cookie: <cookie-name>=<cookie-value>; Domain=<domain-value>; Secure; HttpOnly

toString() - Method in class com.soklet.converter.AbstractValueConverter

toString() - Method in class com.soklet.converter.TypeReference

toString() - Method in class com.soklet.core.Cors

toString() - Method in class com.soklet.core.CorsPreflight

toString() - Method in class com.soklet.core.CorsPreflightResponse

toString() - Method in class com.soklet.core.CorsResponse

toString() - Method in class com.soklet.core.LogEvent

toString() - Method in class com.soklet.core.MarshaledResponse

toString() - Method in class com.soklet.core.MultipartField

toString() - Method in class com.soklet.core.Request

toString() - Method in class com.soklet.core.RequestResult

toString() - Method in class com.soklet.core.ResourceMethod

toString() - Method in class com.soklet.core.ResourcePath

toString() - Method in class com.soklet.core.ResourcePathDeclaration.Component

toString() - Method in class com.soklet.core.ResourcePathDeclaration

toString() - Method in class com.soklet.core.Response

toString() - Method in class com.soklet.core.ResponseCookie

toString() - Method in class com.soklet.core.ServerSentEvent

toString() - Method in enum class com.soklet.core.StatusCode

trimAggressively(String) - Static method in class com.soklet.core.Utilities

A "stronger" version of String.trim() which discards any kind of whitespace or invisible separator.

trimAggressivelyToEmpty(String) - Static method in class com.soklet.core.Utilities

trimAggressivelyToNull(String) - Static method in class com.soklet.core.Utilities

TypeReference<T> - Class in com.soklet.converter

Construct for creating type tokens that represent generic types.

U

uri(String) - Method in class com.soklet.core.Request.Builder

uri(String) - Method in class com.soklet.core.Request.Copier

Utilities - Class in com.soklet.core

A non-instantiable collection of utility methods.

V

value() - Element in annotation interface com.soklet.annotation.DELETE

The DELETE URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.DELETEs

value() - Element in annotation interface com.soklet.annotation.GET

The GET URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.GETs

value() - Element in annotation interface com.soklet.annotation.HEAD

The HEAD URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.HEADs

value() - Element in annotation interface com.soklet.annotation.OPTIONS

The OPTIONS URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.OPTIONSes

value() - Element in annotation interface com.soklet.annotation.PATCH

The PATCH URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.PATCHes

value() - Element in annotation interface com.soklet.annotation.POST

The POST URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.POSTs

value() - Element in annotation interface com.soklet.annotation.PUT

The PUT URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.PUTs

value() - Element in annotation interface com.soklet.annotation.ServerSentEventSource

The Server-Sent Event Source GET URL that should be handled by this Resource Method.

value() - Element in annotation interface com.soklet.annotation.ServerSentEventSources

value(String) - Method in class com.soklet.core.ResponseCookie.Builder

value(String) - Method in class com.soklet.core.ResponseCookie.Copier

ValueConversionException - Exception Class in com.soklet.converter

Thrown if an error occurs during value conversion.

ValueConversionException(String, Type, Object, Type) - Constructor for exception class com.soklet.converter.ValueConversionException

Creates an exception that describes the value conversion error.

ValueConversionException(String, Throwable, Type, Object, Type) - Constructor for exception class com.soklet.converter.ValueConversionException

Creates an exception that describes the value conversion error.

ValueConversionException(Throwable, Type, Object, Type) - Constructor for exception class com.soklet.converter.ValueConversionException

Creates an exception that describes the value conversion error.

ValueConverter<F,T> - Interface in com.soklet.converter

Contract for converting objects from one type to another.

valueConverterRegistry(ValueConverterRegistry) - Method in class com.soklet.SokletConfiguration.Builder

valueConverterRegistry(ValueConverterRegistry) - Method in class com.soklet.SokletConfiguration.Copier

ValueConverterRegistry - Class in com.soklet.converter

A collection of ValueConverter instances, supplemented with quality-of-life features that most applications need.

ValueConverterRegistry() - Constructor for class com.soklet.converter.ValueConverterRegistry

Creates a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters().

ValueConverterRegistry(Set<ValueConverter<?, ?>>) - Constructor for class com.soklet.converter.ValueConverterRegistry

Creates a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters(), optionally supplemented with custom converters.

ValueConverters - Class in com.soklet.converter

Non-instantiable utility class that exists to vend a set of default ValueConverter instances via ValueConverters.defaultValueConverters().

valueOf(String) - Static method in enum class com.soklet.core.HttpMethod

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.soklet.core.LogEventType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.soklet.core.RedirectType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.soklet.core.ResourcePathDeclaration.ComponentType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.soklet.core.ResponseCookie.SameSite

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.soklet.core.StatusCode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.soklet.core.HttpMethod

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.soklet.core.LogEventType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.soklet.core.RedirectType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.soklet.core.ResourcePathDeclaration.ComponentType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.soklet.core.ResponseCookie.SameSite

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.soklet.core.StatusCode

Returns an array containing the constants of this enum class, in the order they are declared.

valuesAsSet() - Static method in enum class com.soklet.core.HttpMethod

Exposes HttpMethod.values() as a Set for convenience.

virtualThreadsAvailable() - Static method in class com.soklet.core.Utilities

Does the platform runtime support virtual threads (either Java 19 and 20 w/preview enabled or Java 21+)?

W

WhitelistedOriginsCorsAuthorizer - Class in com.soklet.core.impl

WhitelistedOriginsCorsAuthorizer(Function<String, Boolean>) - Constructor for class com.soklet.core.impl.WhitelistedOriginsCorsAuthorizer

WhitelistedOriginsCorsAuthorizer(Set<String>) - Constructor for class com.soklet.core.impl.WhitelistedOriginsCorsAuthorizer

willEstablishServerSentEventConnection(Request, ResourceMethod) - Method in interface com.soklet.core.LifecycleInterceptor

Called immediately before a Server-Sent Event connection of indefinite duration to the client is opened.

willStartResponseWriting(Request, ResourceMethod, MarshaledResponse) - Method in interface com.soklet.core.LifecycleInterceptor

Called before the response is sent to the client.

willStartServer(Server) - Method in interface com.soklet.core.LifecycleInterceptor

Called before the server starts.

willStartServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.core.LifecycleInterceptor

Called before the Server-Sent Event server starts.

willStartServerSentEventWriting(Request, ResourceMethod, ServerSentEvent) - Method in interface com.soklet.core.LifecycleInterceptor

Called before a Server-Sent Event is sent to the client.

willStopServer(Server) - Method in interface com.soklet.core.LifecycleInterceptor

Called before the server stops.

willStopServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.core.LifecycleInterceptor

Called before the Server-Sent Event server stops.

willTerminateServerSentEventConnection(Request, ResourceMethod, Throwable) - Method in interface com.soklet.core.LifecycleInterceptor

Called immediately before a Server-Sent Event connection to the client is terminated.

with(HttpMethod, String) - Static method in class com.soklet.core.Request

Acquires a builder for Request instances.

with(LogEventType, String) - Static method in class com.soklet.core.LogEvent

Acquires a builder for LogEvent instances.

with(String, byte[]) - Static method in class com.soklet.core.MultipartField

Acquires a builder for MultipartField instances.

with(String, String) - Static method in class com.soklet.core.ResponseCookie

Acquires a builder for ResponseCookie instances.

withAccessControlAllowOrigin(String) - Static method in class com.soklet.core.CorsPreflightResponse

Acquires a builder for CorsPreflightResponse instances.

withAccessControlAllowOrigin(String) - Static method in class com.soklet.core.CorsResponse

Acquires a builder for CorsResponse instances.

withComponents(HttpMethod, ResourcePathDeclaration, Method, Boolean) - Static method in class com.soklet.core.ResourceMethod

Vends a Resource Method given its unique components.

withData(String) - Static method in class com.soklet.core.ServerSentEvent

Acquires a builder for ServerSentEvent instances, seeded with a data value.

withEvent(String) - Static method in class com.soklet.core.ServerSentEvent

Acquires a builder for ServerSentEvent instances, seeded with an event value.

withMarshaledResponse(MarshaledResponse) - Static method in class com.soklet.core.RequestResult

Acquires a builder for RequestResult instances.

withName(String) - Static method in class com.soklet.core.MultipartField

Acquires a builder for MultipartField instances.

withName(String) - Static method in class com.soklet.core.ResponseCookie

Acquires a builder for ResponseCookie instances without specifying the cookie's value.

withPort(Integer) - Static method in class com.soklet.core.impl.DefaultServer

withPort(Integer) - Static method in class com.soklet.core.impl.DefaultServerSentEventServer

withRedirect(RedirectType, String) - Static method in class com.soklet.core.Response

Acquires a builder for Response instances that are intended to redirect the client.

withServer(Server) - Static method in class com.soklet.SokletConfiguration

Vends a configuration builder for the given server.

withStatusCode(Integer) - Static method in class com.soklet.core.MarshaledResponse

Acquires a builder for MarshaledResponse instances.

withStatusCode(Integer) - Static method in class com.soklet.core.Response

Acquires a builder for Response instances.

wrapRequest(Request, ResourceMethod, Consumer<Request>) - Method in interface com.soklet.core.LifecycleInterceptor

Wraps around the whole "outside" of the entire request-handling flow.

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form