Index (Soklet 2.0.0-SNAPSHOT API)

A B C D E F G H I L M N O P Q R S T U V W X
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.
accept() - Static method in interface com.soklet.HandshakeResult: Vends an instance that indicates a successful handshake, with no additional information provided.
acceptWithDefaults() - Static method in interface com.soklet.HandshakeResult: Vends a builder for an instance that indicates a successful handshake.
accessControlAllowCredentials(Boolean) - Method in class com.soklet.CorsPreflightResponse.Builder
accessControlAllowCredentials(Boolean) - Method in class com.soklet.CorsPreflightResponse.Copier
accessControlAllowCredentials(Boolean) - Method in class com.soklet.CorsResponse.Builder
accessControlAllowCredentials(Boolean) - Method in class com.soklet.CorsResponse.Copier
accessControlAllowHeaders(Consumer) - Method in class com.soklet.CorsPreflightResponse.Copier
accessControlAllowHeaders(Set) - Method in class com.soklet.CorsPreflightResponse.Builder
accessControlAllowHeaders(Set) - Method in class com.soklet.CorsPreflightResponse.Copier
accessControlAllowMethods(Consumer) - Method in class com.soklet.CorsPreflightResponse.Copier
accessControlAllowMethods(Set) - Method in class com.soklet.CorsPreflightResponse.Builder
accessControlAllowMethods(Set) - Method in class com.soklet.CorsPreflightResponse.Copier
accessControlAllowOrigin(String) - Method in class com.soklet.CorsPreflightResponse.Builder
accessControlAllowOrigin(String) - Method in class com.soklet.CorsPreflightResponse.Copier
accessControlAllowOrigin(String) - Method in class com.soklet.CorsResponse.Builder
accessControlAllowOrigin(String) - Method in class com.soklet.CorsResponse.Copier
accessControlExposeHeaders(Consumer) - Method in class com.soklet.CorsResponse.Copier
accessControlExposeHeaders(Set) - Method in class com.soklet.CorsResponse.Builder
accessControlExposeHeaders(Set) - Method in class com.soklet.CorsResponse.Copier
accessControlMaxAge(Duration) - Method in class com.soklet.CorsPreflightResponse.Builder
accessControlMaxAge(Duration) - Method in class com.soklet.CorsPreflightResponse.Copier
acquireBroadcaster(ResourcePath) - Method in interface com.soklet.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.
authorize(Request, Cors) - Method in interface com.soklet.CorsAuthorizer: Authorizes a non-preflight CORS request.
authorizePreflight(Request, CorsPreflight, Map) - Method in interface com.soklet.CorsAuthorizer: Authorizes a CORS preflight request.
awaitShutdown(ShutdownTrigger...) - Method in class com.soklet.Soklet: Blocks the current thread until JVM shutdown (SIGTERM/SIGINT/System.exit(...) and so forth), or if one of the provided shutdownTriggers occurs.

B

BadRequestException - Exception Class in com.soklet.exception: Abstract superclass for exceptions that would normally result in an HTTP 400 (Bad Request) status code.
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.MarshaledResponse.Builder
body(byte[]) - Method in class com.soklet.MarshaledResponse.Copier
body(byte[]) - Method in class com.soklet.Request.Copier
body(byte[]) - Method in class com.soklet.Request.PathBuilder
body(byte[]) - Method in class com.soklet.Request.RawBuilder
body(Object) - Method in class com.soklet.Response.Builder
body(Object) - Method in class com.soklet.Response.Copier
broadcastComment(String) - Method in interface com.soklet.ServerSentEventBroadcaster: Broadcasts a single Server-Sent Event comment to all clients listening to this broadcaster's ResourcePath.
broadcasterCacheCapacity(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
broadcastEvent(ServerSentEvent) - Method in interface com.soklet.ServerSentEventBroadcaster: Broadcasts a Server-Sent Event payload to all clients listening to this broadcaster's ResourcePath.
build() - Method in class com.soklet.CorsPreflightResponse.Builder
build() - Method in class com.soklet.CorsResponse.Builder
build() - Method in class com.soklet.HandshakeResult.Accepted.Builder
build() - Method in class com.soklet.LogEvent.Builder
build() - Method in class com.soklet.MarshaledResponse.Builder
build() - Method in class com.soklet.MultipartField.Builder
build() - Method in class com.soklet.Request.PathBuilder
build() - Method in class com.soklet.Request.RawBuilder
build() - Method in class com.soklet.RequestResult.Builder
build() - Method in class com.soklet.Response.Builder
build() - Method in class com.soklet.ResponseCookie.Builder
build() - Method in class com.soklet.ResponseMarshaler.Builder
build() - Method in class com.soklet.Server.Builder
build() - Method in class com.soklet.ServerSentEvent.Builder
build() - Method in class com.soklet.ServerSentEventServer.Builder
build() - Method in class com.soklet.SokletConfig.Builder

C

charset(Charset) - Method in class com.soklet.MultipartField.Builder
charset(Charset) - Method in class com.soklet.ResponseMarshaler.Builder
clientInitializer(Consumer) - Method in class com.soklet.HandshakeResult.Accepted.Builder: Specifies custom "client initializer" function to run immediately after the handshake succeeds - useful for performing "catch-up" logic if the client had provided a Last-Event-ID request header.
close() - Method in interface com.soklet.Server: AutoCloseable-enabled synonym for Server.stop().
close() - Method in interface com.soklet.ServerSentEventServer: AutoCloseable-enabled synonym for ServerSentEventServer.stop().
close() - Method in class com.soklet.Soklet: Synonym for Soklet.stop().
com.soklet - package com.soklet: Core Soklet contracts and functionality.
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.exception - package com.soklet.exception: Exceptions thrown during HTTP request processing.
concurrency(Integer) - Method in class com.soklet.Server.Builder
concurrentConnectionLimit(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
CONFIGURATION_UNSUPPORTED - Enum constant in enum class com.soklet.LogEventType: Indicates that a Soklet configuration option was requested but isn't supported in the current runtime/environment; behavior may differ (perhaps ignored or degraded).
connectionQueueCapacity(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
contentTooLarge(Boolean) - Method in class com.soklet.Request.Copier
contentTooLarge(Boolean) - Method in class com.soklet.Request.PathBuilder
contentTooLarge(Boolean) - Method in class com.soklet.Request.RawBuilder
contentTooLargeHandler(ResponseMarshaler.Builder.ContentTooLargeHandler) - Method in class com.soklet.ResponseMarshaler.Builder
contentType(String) - Method in class com.soklet.MultipartField.Builder
contentType(String) - Method in class com.soklet.MultipartField.Copier
contentType(Charset) - Method in class com.soklet.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) - Method in class com.soklet.MarshaledResponse.Copier
cookies(Consumer) - Method in class com.soklet.Response.Copier
cookies(Set) - Method in class com.soklet.HandshakeResult.Accepted.Builder: Specifies custom response cookies to be sent with the handshake.
cookies(Set) - Method in class com.soklet.MarshaledResponse.Builder
cookies(Set) - Method in class com.soklet.MarshaledResponse.Copier
cookies(Set) - Method in class com.soklet.Response.Builder
cookies(Set) - Method in class com.soklet.Response.Copier
copy() - Method in class com.soklet.CorsPreflightResponse: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.CorsResponse: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.LogEvent: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.MarshaledResponse: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.MultipartField: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.Request: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.RequestResult: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.Response: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.ResponseCookie: Vends a mutable copier seeded with this instance's data, suitable for building new instances.
copy() - Method in class com.soklet.SokletConfig: Vends a mutable copy of this instance's configuration, suitable for building new instances.
Cors - Class in com.soklet: Encapsulates non-preflight CORS HTTP request data.
corsAllowedHandler(ResponseMarshaler.Builder.CorsAllowedHandler) - Method in class com.soklet.ResponseMarshaler.Builder
corsAuthorizer(CorsAuthorizer) - Method in class com.soklet.SokletConfig.Builder
corsAuthorizer(CorsAuthorizer) - Method in class com.soklet.SokletConfig.Copier
CorsAuthorizer - Interface in com.soklet: Contract for types that authorize CORS requests.
CorsPreflight - Class in com.soklet: Encapsulates CORS preflight-related HTTP request data.
corsPreflightAllowedHandler(ResponseMarshaler.Builder.CorsPreflightAllowedHandler) - Method in class com.soklet.ResponseMarshaler.Builder
corsPreflightRejectedHandler(ResponseMarshaler.Builder.CorsPreflightRejectedHandler) - Method in class com.soklet.ResponseMarshaler.Builder
corsPreflightResponse(CorsPreflightResponse) - Method in class com.soklet.RequestResult.Builder
corsPreflightResponse(CorsPreflightResponse) - Method in class com.soklet.RequestResult.Copier
CorsPreflightResponse - Class in com.soklet: Response headers to send over the wire for CORS preflight requests.
CorsPreflightResponse.Builder - Class in com.soklet: Builder used to construct instances of CorsPreflightResponse via CorsPreflightResponse.withAccessControlAllowOrigin(String).
CorsPreflightResponse.Copier - Class in com.soklet: Builder used to copy instances of CorsPreflightResponse via CorsPreflightResponse.copy().
CorsResponse - Class in com.soklet: Response headers to send over the wire for non-preflight CORS requests.
CorsResponse.Builder - Class in com.soklet: Builder used to construct instances of CorsResponse via CorsResponse.withAccessControlAllowOrigin(String).
CorsResponse.Copier - Class in com.soklet: Builder used to copy instances of CorsResponse via CorsResponse.copy().

D

data(byte[]) - Method in class com.soklet.MultipartField.Builder
data(byte[]) - Method in class com.soklet.MultipartField.Copier
data(String) - Method in class com.soklet.ServerSentEvent.Builder
defaultInstance() - Static method in interface com.soklet.InstanceProvider: Acquires a threadsafe InstanceProvider with a reflection-based instanceClass.getDeclaredConstructor().newInstance() instantiation strategy.
defaultInstance() - Static method in interface com.soklet.LifecycleInterceptor: Acquires a threadsafe LifecycleInterceptor instance with sensible defaults.
defaultInstance() - Static method in interface com.soklet.MultipartParser: Acquires a threadsafe MultipartParser.
defaultInstance() - Static method in interface com.soklet.ResponseMarshaler: Acquires a threadsafe ResponseMarshaler with a reasonable "out of the box" configuration that uses UTF-8 to write character data.
defaultValueConverters() - Static method in class com.soklet.converter.ValueConverters: Vends the immutable system-default set of ValueConverter instances.
DELETE - Enum constant in enum class com.soklet.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.LifecycleInterceptor: Called immediately after a Server-Sent Event connection of indefinite duration to the client is opened.
didFinishRequestHandling(Request, ResourceMethod, MarshaledResponse, Duration, List) - Method in interface com.soklet.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.LifecycleInterceptor: Called after the response is sent to the client.
didFinishServerSentEventWriting(Request, ResourceMethod, ServerSentEvent, Duration, Throwable) - Method in interface com.soklet.LifecycleInterceptor: Called after a Server-Sent Event is sent to the client.
didReceiveLogEvent(LogEvent) - Method in interface com.soklet.LifecycleInterceptor: Called when an event suitable for logging occurs during processing (generally, an exception).
didStartRequestHandling(Request, ResourceMethod) - Method in interface com.soklet.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.LifecycleInterceptor: Called after the server starts.
didStartServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleInterceptor: Called after the Server-Sent Event server starts.
didStopServer(Server) - Method in interface com.soklet.LifecycleInterceptor: Called after the server stops.
didStopServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleInterceptor: Called after the Server-Sent Event server stops.
didTerminateServerSentEventConnection(Request, ResourceMethod, Duration, Throwable) - Method in interface com.soklet.LifecycleInterceptor: Called immediately after a Server-Sent Event connection to the client is terminated.
domain(String) - Method in class com.soklet.ResponseCookie.Builder
domain(String) - Method in class com.soklet.ResponseCookie.Copier

E

encodeQueryParameters(Map, QueryFormat) - Static method in class com.soklet.Utilities: Encodes decoded query parameters into a raw query string.
ENTER_KEY - Enum constant in enum class com.soklet.ShutdownTrigger: When the user presses 'Enter' in the console.
equals(Object) - Method in class com.soklet.converter.TypeReference
equals(Object) - Method in class com.soklet.Cors
equals(Object) - Method in class com.soklet.CorsPreflight
equals(Object) - Method in class com.soklet.CorsPreflightResponse
equals(Object) - Method in class com.soklet.CorsResponse
equals(Object) - Method in class com.soklet.HandshakeResult.Accepted
equals(Object) - Method in class com.soklet.HandshakeResult.Rejected
equals(Object) - Method in class com.soklet.LogEvent
equals(Object) - Method in class com.soklet.MultipartField
equals(Object) - Method in class com.soklet.Request
equals(Object) - Method in class com.soklet.RequestResult
equals(Object) - Method in class com.soklet.ResourceMethod
equals(Object) - Method in class com.soklet.ResourcePath
equals(Object) - Method in class com.soklet.ResourcePathDeclaration.Component
equals(Object) - Method in class com.soklet.ResourcePathDeclaration
equals(Object) - Method in class com.soklet.Response
equals(Object) - Method in class com.soklet.ResponseCookie
equals(Object) - Method in class com.soklet.ServerSentEventRequestResult.HandshakeRejected
equals(Object) - Method in class com.soklet.ServerSentEventRequestResult.RequestFailed
event(String) - Method in class com.soklet.ServerSentEvent.Builder
extractCharsetFromHeaders(Map) - Static method in class com.soklet.Utilities: Extracts the Charset from the first Content-Type header, if present and valid.
extractCharsetFromHeaderValue(String) - Static method in class com.soklet.Utilities: Extracts the charset=... parameter from a Content-Type header value.
extractClientUrlPrefixFromHeaders(Map) - Static method in class com.soklet.Utilities: Best-effort attempt to determine a client's URL prefix by examining request headers.
extractContentTypeFromHeaders(Map) - Static method in class com.soklet.Utilities: Extracts the media type (without parameters) from the first Content-Type header.
extractContentTypeFromHeaderValue(String) - Static method in class com.soklet.Utilities: Extracts the media type (without parameters) from a Content-Type header value.
extractCookiesFromHeaders(Map) - Static method in class com.soklet.Utilities: Parses Cookie request headers into a map of cookie names to values.
extractHeadersFromRawHeaderLines(List) - Static method in class com.soklet.Utilities: Given a list of raw HTTP header lines, convert them into a normalized case-insensitive, order-preserving map which "inflates" comma-separated headers into distinct values where permitted according to RFC 7230/9110.
extractLocalesFromAcceptLanguageHeaderValue(String) - Static method in class com.soklet.Utilities: Parses an Accept-Language header value into a best-effort ordered list of Locales.
extractMultipartFields(Request) - Method in interface com.soklet.MultipartParser: Given a request, detect all HTML form fields with multipart/form-data encoding and parse their values.
extractPathFromUrl(String, Boolean) - Static method in class com.soklet.Utilities: Normalizes a URL or path into a canonical request path and optionally performs percent-decoding on the path.
extractPlaceholders(ResourcePath) - Method in class com.soklet.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.ResourcePath: What is the mapping between this resource path's placeholder values to the given resource path declaration's placeholder names?
extractQueryParametersFromQuery(String, QueryFormat) - Static method in class com.soklet.Utilities: Parses a query string such as "a=1&b=2&c=%20" into a multimap of names to values.
extractQueryParametersFromQuery(String, QueryFormat, Charset) - Static method in class com.soklet.Utilities: Parses a query string such as "a=1&b=2&c=%20" into a multimap of names to values.
extractQueryParametersFromUrl(String, QueryFormat) - Static method in class com.soklet.Utilities: Parses query strings from relative or absolute URLs such as "/example?a=a=1&b=2&c=%20" or "https://www.soklet.com/example?a=1&b=2&c=%20" into a multimap of names to values.
extractQueryParametersFromUrl(String, QueryFormat, Charset) - Static method in class com.soklet.Utilities: Parses query strings from relative or absolute URLs such as "/example?a=a=1&b=2&c=%20" or "https://www.soklet.com/example?a=1&b=2&c=%20" into a multimap of names to values.
extractRawQueryFromUrl(String) - Static method in class com.soklet.Utilities: Extracts the raw (un-decoded) query component from a URL.

F

filename(String) - Method in class com.soklet.MultipartField.Builder
filename(String) - Method in class com.soklet.MultipartField.Copier
finish() - Method in class com.soklet.CorsPreflightResponse.Copier
finish() - Method in class com.soklet.CorsResponse.Copier
finish() - Method in class com.soklet.LogEvent.Copier
finish() - Method in class com.soklet.MarshaledResponse.Copier
finish() - Method in class com.soklet.MultipartField.Copier
finish() - Method in class com.soklet.Request.Copier
finish() - Method in class com.soklet.RequestResult.Copier
finish() - Method in class com.soklet.Response.Copier
finish() - Method in class com.soklet.ResponseCookie.Copier
finish() - Method in class com.soklet.SokletConfig.Copier
forContentTooLarge(Request, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for a request that triggers an HTTP 413 Content Too Large.
forCorsAllowed(Request, Cors, CorsResponse, MarshaledResponse) - Method in interface com.soklet.ResponseMarshaler: Applies "CORS is permitted for this request" data to a response.
forCorsPreflightAllowed(Request, CorsPreflight, CorsPreflightResponse) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for "CORS preflight allowed" scenario when your CorsAuthorizer approves a preflight request.
forCorsPreflightRejected(Request, CorsPreflight) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for "CORS preflight rejected" scenario when your CorsAuthorizer denies a preflight request.
forHead(Request, MarshaledResponse) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for an HTTP HEAD request.
forMethodNotAllowed(Request, Set) - Method in interface com.soklet.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 interface com.soklet.ResponseMarshaler: Prepares a response for a request that does not have a matching Resource Method, which triggers an HTTP 404 Not Found.
forOptions(Request, Set) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for an HTTP OPTIONS request.
forOptionsSplat(Request) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.
forResourceMethod(Request, Response, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for a request that was matched to a Resource Method and returned normally (i.e., without throwing an exception).
forThrowable(Request, Throwable, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler: Prepares a response for scenarios in which an uncaught exception is encountered.
fromClasspathIntrospection() - Static method in interface com.soklet.ResourceMethodResolver: Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining a lookup table of Java Method declarations that are annotated with GET, POST, ServerSentEventSource, etc.
fromHeaderRepresentation(String) - Static method in enum class com.soklet.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) - Static method in class com.soklet.Cors: Extracts a CORS non-preflight request representation from the given HTTP request data.
fromHeaders(Map) - Static method in class com.soklet.CorsPreflight: Extracts a CORS preflight request representation from the given HTTP request data.
fromSetCookieHeaderRepresentation(String) - Static method in class com.soklet.ResponseCookie: Given a Set-Cookie header representation, provide a ResponseCookie that matches it.
fromStatusCode(Integer) - Static method in enum class com.soklet.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.IdGenerator: Generates an identifier.
get(TypeReference, TypeReference) - 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.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.CorsPreflightResponse: Value for the Access-Control-Allow-Credentials response header.
getAccessControlAllowCredentials() - Method in class com.soklet.CorsResponse: Value for the Access-Control-Allow-Credentials response header.
getAccessControlAllowHeaders() - Method in class com.soklet.CorsPreflightResponse: Set of values for the Access-Control-Allow-Headers response header.
getAccessControlAllowMethods() - Method in class com.soklet.CorsPreflightResponse: Set of values for the Access-Control-Allow-Methods response header.
getAccessControlAllowOrigin() - Method in class com.soklet.CorsPreflightResponse: Value for the Access-Control-Allow-Origin response header.
getAccessControlAllowOrigin() - Method in class com.soklet.CorsResponse: Value for the Access-Control-Allow-Origin response header.
getAccessControlExposeHeaders() - Method in class com.soklet.CorsResponse: Value for the Access-Control-Expose-Headers response header.
getAccessControlMaxAge() - Method in class com.soklet.CorsPreflightResponse: Value for the Access-Control-Max-Age response header.
getAccessControlRequestHeaders() - Method in class com.soklet.CorsPreflight: Returns the set of values for the HTTP Access-Control-Request-Headers request header.
getAccessControlRequestMethod() - Method in class com.soklet.CorsPreflight: The HTTP Access-Control-Request-Method request header value.
getBody() - Method in class com.soklet.MarshaledResponse: The HTTP response body to write, if available.
getBody() - Method in class com.soklet.Request: The raw bytes of the request body - callers should not modify this array; it is not defensively copied for performance reasons.
getBody() - Method in class com.soklet.Response: The "logical" body content to be written to the response, if present.
getBodyAsString() - Method in class com.soklet.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.MultipartField: The charset used to encode this field, if applicable.
getCharset() - Method in class com.soklet.Request: The request's character encoding, as specified by the client in the Content-Type header value.
getClientCount() - Method in interface com.soklet.ServerSentEventBroadcaster: Approximately how many clients are listening to this broadcaster's ResourcePath?
getClientInitializer() - Method in class com.soklet.HandshakeResult.Accepted: The client initialization function, if specified, for this accepted Server-Sent Event handshake.
getComponents() - Method in class com.soklet.ResourcePath: What are the /-delimited components of this resource path?
getComponents() - Method in class com.soklet.ResourcePathDeclaration: What are the /-delimited components of this resource path declaration?
getContentType() - Method in class com.soklet.MultipartField: The content type for this field, if available (for example, image/png for an image file).
getContentType() - Method in class com.soklet.Request: The Content-Type header value, as specified by the client.
getCookie(String) - Method in class com.soklet.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.HandshakeResult.Accepted: Returns the cookies explicitly specified when this handshake was accepted (which may be different from the finalized map of headers sent to the client).
getCookies() - Method in class com.soklet.MarshaledResponse: The HTTP cookies to write for this response.
getCookies() - Method in class com.soklet.Request: The cookies provided by the client for this request.
getCookies() - Method in class com.soklet.Response: The cookies to be written to the client for this response.
getCors() - Method in class com.soklet.Request: Non-preflight CORS request data.
getCorsAuthorizer() - Method in class com.soklet.SokletConfig: How Soklet handles Cross-Origin Resource Sharing (CORS).
getCorsPreflight() - Method in class com.soklet.Request: CORS preflight-related request data.
getCorsPreflightResponse() - Method in class com.soklet.RequestResult: The CORS preflight logical response, if applicable for the request.
getData() - Method in class com.soklet.MultipartField: The binary value of this field, if available.
getData() - Method in class com.soklet.ServerSentEvent: The data payload for this Server-Sent Event.
getDataAsString() - Method in class com.soklet.MultipartField: The value of this field represented as a string, if available.
getDomain() - Method in class com.soklet.ResponseCookie: Gets the cookie's Domain value, if present.
getEvent() - Method in class com.soklet.ServerSentEvent: The event value for this Server-Sent Event.
getFilename() - Method in class com.soklet.MultipartField: The filename associated with this field, if available.
getFormParameter(String) - Method in class com.soklet.Request: Convenience method to access a decoded 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.Request: The decoded HTML application/x-www-form-urlencoded 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.
getHandshakeResult() - Method in class com.soklet.ServerSentEventRequestResult.HandshakeAccepted: Gets the data provided when the handshake was accepted by the ServerSentEventSource-annotated Resource Method.
getHandshakeResult() - Method in class com.soklet.ServerSentEventRequestResult.HandshakeRejected: Gets the data provided when the handshake was explicitly rejected by the ServerSentEventSource-annotated Resource Method.
getHeader(String) - Method in class com.soklet.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.ResponseCookie.SameSite: The HTTP header value that corresponds to this enum value - one of Strict, Lax, or None.
getHeaders() - Method in class com.soklet.HandshakeResult.Accepted: Returns the headers explicitly specified when this handshake was accepted (which may be different from the finalized map of headers sent to the client).
getHeaders() - Method in class com.soklet.MarshaledResponse: The HTTP headers to write for this response.
getHeaders() - Method in class com.soklet.Request: The headers provided by the client for this request.
getHeaders() - Method in class com.soklet.Response: The headers to be written to the client for this response.
getHttpMethod() - Method in class com.soklet.Cors: The HTTP method for this request.
getHttpMethod() - Method in class com.soklet.Request: The HTTP method for this request.
getHttpMethod() - Method in class com.soklet.ResourceMethod: Returns the HTTP method for this Resource Method.
getHttpOnly() - Method in class com.soklet.ResponseCookie: Gets the cookie's HttpOnly flag, if present.
getId() - Method in class com.soklet.Request: An application-specific identifier for this request.
getId() - Method in class com.soklet.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.SokletConfig: How Soklet will perform instance creation.
getLanguageRanges() - Method in class com.soklet.Request: Locale.LanguageRange information for this request as specified by Accept-Language header value[s].
getLifecycleInterceptor() - Method in class com.soklet.SokletConfig: How Soklet will perform custom behavior during server and request lifecycle events.
getLocales() - Method in class com.soklet.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.LogEvent: The type of log event this is.
getMarshaledResponse() - Method in class com.soklet.LogEvent: The response associated with this log event, if available.
getMarshaledResponse() - Method in class com.soklet.RequestResult: The final representation of the response to be written over the wire.
getMaxAge() - Method in class com.soklet.ResponseCookie: Gets the cookie's Max-Age value expressed as a Duration, if present.
getMessage() - Method in class com.soklet.LogEvent: The message for this log event.
getMethod() - Method in class com.soklet.ResourceMethod: Returns the Java method to invoke for the combination of HTTP method and resource path.
getMultipartField() - Method in exception class com.soklet.exception.IllegalMultipartFieldException
getMultipartField(String) - Method in class com.soklet.Request: Convenience method to access a decoded 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.Request: The decoded HTML multipart/form-data fields provided by the client for this request.
getName() - Method in exception class com.soklet.exception.IllegalRequestCookieException
getName() - Method in class com.soklet.MultipartField: The name of this field.
getName() - Method in class com.soklet.ResponseCookie: Gets the cookie's name.
getOrigin() - Method in class com.soklet.Cors: The HTTP Origin header value for this request.
getOrigin() - Method in class com.soklet.CorsPreflight: Returns the HTTP Origin request header value.
getPath() - Method in class com.soklet.Request: The percent-decoded path component of this request (no query string).
getPath() - Method in class com.soklet.ResourcePath: What is the string representation of this resource path?
getPath() - Method in class com.soklet.ResourcePathDeclaration: What is the string representation of this resource path declaration?
getPath() - Method in class com.soklet.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.Request: Convenience method to access a decoded 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.Request: The decoded query parameters provided by the client for this request.
getQueryParameterValue() - Method in exception class com.soklet.exception.IllegalQueryParameterException
getRawPath() - Method in class com.soklet.Request: The raw (un-decoded) path component of this request exactly as the client specified.
getRawPathAndQuery() - Method in class com.soklet.Request: The raw (un-decoded) path and query components of this request exactly as the client specified.
getRawQuery() - Method in class com.soklet.Request: The raw (un-decoded) query component of this request exactly as the client specified.
getReasonPhrase() - Method in enum class com.soklet.StatusCode: An English-language description for this HTTP status code.
getRequest() - Method in class com.soklet.LogEvent: The request associated with this log event, if available.
getRequestBodyMarshaler() - Method in class com.soklet.SokletConfig: 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
getRequestResult() - Method in class com.soklet.ServerSentEventRequestResult.HandshakeAccepted: The initial result of the handshake, as written back to the client (note that the connection remains open).
getRequestResult() - Method in class com.soklet.ServerSentEventRequestResult.HandshakeRejected: The result of the handshake, as written back to the client (the connection is then closed).
getRequestResult() - Method in class com.soklet.ServerSentEventRequestResult.RequestFailed: The result of the handshake, as written back to the client (the connection is then closed).
getResourceMethod() - Method in class com.soklet.LogEvent: The Resource Method associated with this log event, if available.
getResourceMethod() - Method in class com.soklet.RequestResult: The Resource Method that handled the request, if available.
getResourceMethodParameterProvider() - Method in class com.soklet.SokletConfig: How Soklet performs Resource Method parameter injection (experts only!)
getResourceMethodResolver() - Method in class com.soklet.SokletConfig: How Soklet performs Resource Method resolution (experts only!)
getResourceMethods() - Method in interface com.soklet.ResourceMethodResolver: Vends the set of all Resource Methods registered in the system.
getResourcePath() - Method in class com.soklet.Request: Convenience method to acquire a ResourcePath representation of Request.getPath().
getResourcePath() - Method in interface com.soklet.ServerSentEventBroadcaster: The runtime Resource Path with which this broadcaster is associated.
getResourcePath() - Method in interface com.soklet.ServerSentEventUnicaster: The runtime Resource Path with which this unicaster is associated.
getResourcePathDeclaration() - Method in class com.soklet.ResourceMethod: Returns the HTTP path for this Resource Method, which might contain placeholders - for example, /example/{exampleId}.
getResponse() - Method in class com.soklet.HandshakeResult.Rejected: The logical response to send to the client for this handshake rejection.
getResponse() - Method in class com.soklet.RequestResult: The logical response, determined by the return value of the Resource Method (if available).
getResponseMarshaler() - Method in class com.soklet.SokletConfig: How Soklet will marshal response bodies to bytes suitable for transmission over the wire.
getRetry() - Method in class com.soklet.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.ResponseCookie: Gets the cookie's SameSite value, if present.
getSecure() - Method in class com.soklet.ResponseCookie: Gets the cookie's Secure flag, if present.
getServer() - Method in class com.soklet.SokletConfig: The server managed by Soklet.
getServerSentEventServer() - Method in class com.soklet.SokletConfig: The SSE server managed by Soklet, if configured.
getStatusCode() - Method in class com.soklet.MarshaledResponse: The HTTP status code for this response.
getStatusCode() - Method in enum class com.soklet.RedirectType: The HTTP status code for this redirect type.
getStatusCode() - Method in class com.soklet.Response: The HTTP status code to be written to the client for this response.
getStatusCode() - Method in enum class com.soklet.StatusCode: The HTTP status code that corresponds to this enum value.
getSupportedAnnotationTypes() - Method in class com.soklet.SokletProcessor
getSupportedSourceVersion() - Method in class com.soklet.SokletProcessor
getThrowable() - Method in class com.soklet.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.ResourcePathDeclaration.Component: What type of resource path declaration component is this?
getValue() - Method in exception class com.soklet.exception.IllegalRequestCookieException
getValue() - Method in class com.soklet.ResourcePathDeclaration.Component: What is the value of this resource path declaration component?
getValue() - Method in class com.soklet.ResponseCookie: Gets the cookie's value, if present.
getValueConverterRegistry() - Method in class com.soklet.SokletConfig: How Soklet will perform conversions from one Java type to another, like a String to a LocalDate.
getVarargsComponent() - Method in class com.soklet.ResourcePathDeclaration: Gets the ResourcePathDeclaration.ComponentType.VARARGS component in this declaration, if any.

H

handle(Request) - Method in interface com.soklet.ResponseMarshaler.Builder.NotFoundHandler: Prepares a response for a request that triggers an HTTP 404 Not Found.
handle(Request) - Method in interface com.soklet.ResponseMarshaler.Builder.OptionsSplatHandler: Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.
handle(Request, CorsPreflight) - Method in interface com.soklet.ResponseMarshaler.Builder.CorsPreflightRejectedHandler: Prepares a response for "CORS preflight rejected" scenario when your CorsAuthorizer denies a preflight request.
handle(Request, CorsPreflight, CorsPreflightResponse) - Method in interface com.soklet.ResponseMarshaler.Builder.CorsPreflightAllowedHandler: Prepares a response for "CORS preflight allowed" scenario when your CorsAuthorizer approves a preflight request.
handle(Request, Cors, CorsResponse, MarshaledResponse) - Method in interface com.soklet.ResponseMarshaler.Builder.CorsAllowedHandler: Applies "CORS is permitted for this request" data to a response.
handle(Request, MarshaledResponse) - Method in interface com.soklet.ResponseMarshaler.Builder.HeadHandler: Prepares a response for an HTTP HEAD request.
handle(Request, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler.Builder.ContentTooLargeHandler: Prepares a response for a request that triggers an HTTP 413 Content Too Large.
handle(Request, Response, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler.Builder.ResourceMethodHandler: Prepares a response for the scenario in which the request was matched to a Resource Method and executed non-exceptionally.
handle(Request, Throwable, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler.Builder.ThrowableHandler: Prepares a response for scenarios in which an uncaught exception is encountered.
handle(Request, Set) - Method in interface com.soklet.ResponseMarshaler.Builder.MethodNotAllowedHandler: Prepares a response for a request that triggers an HTTP 405 Method Not Allowed.
handle(Request, Set) - Method in interface com.soklet.ResponseMarshaler.Builder.OptionsHandler: Prepares a response for an HTTP OPTIONS request.
handleRequest(Request, Consumer) - Method in interface com.soklet.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) - Method in interface com.soklet.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.
HandshakeResult - Interface in com.soklet: Represents the result of a ServerSentEventSource "handshake".
HandshakeResult.Accepted - Class in com.soklet: Type which indicates a successful Server-Sent Event handshake.
HandshakeResult.Accepted.Builder - Class in com.soklet: Builder used to construct instances of HandshakeResult.Accepted.
HandshakeResult.Rejected - Class in com.soklet: Type which indicates a rejected Server-Sent Event handshake.
hashCode() - Method in class com.soklet.converter.TypeReference
hashCode() - Method in class com.soklet.Cors
hashCode() - Method in class com.soklet.CorsPreflight
hashCode() - Method in class com.soklet.CorsPreflightResponse
hashCode() - Method in class com.soklet.CorsResponse
hashCode() - Method in class com.soklet.HandshakeResult.Accepted
hashCode() - Method in class com.soklet.HandshakeResult.Rejected
hashCode() - Method in class com.soklet.LogEvent
hashCode() - Method in class com.soklet.MultipartField
hashCode() - Method in class com.soklet.Request
hashCode() - Method in class com.soklet.RequestResult
hashCode() - Method in class com.soklet.ResourceMethod
hashCode() - Method in class com.soklet.ResourcePath
hashCode() - Method in class com.soklet.ResourcePathDeclaration.Component
hashCode() - Method in class com.soklet.ResourcePathDeclaration
hashCode() - Method in class com.soklet.Response
hashCode() - Method in class com.soklet.ResponseCookie
hashCode() - Method in class com.soklet.ServerSentEventRequestResult.HandshakeRejected
hashCode() - Method in class com.soklet.ServerSentEventRequestResult.RequestFailed
HEAD - Enum constant in enum class com.soklet.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) - Method in class com.soklet.MarshaledResponse.Copier
headers(Consumer) - Method in class com.soklet.Request.Copier
headers(Consumer) - Method in class com.soklet.Response.Copier
headers(Map) - Method in class com.soklet.HandshakeResult.Accepted.Builder: Specifies custom response headers to be sent with the handshake.
headers(Map) - Method in class com.soklet.MarshaledResponse.Builder
headers(Map) - Method in class com.soklet.MarshaledResponse.Copier
headers(Map) - Method in class com.soklet.Request.Copier
headers(Map) - Method in class com.soklet.Request.PathBuilder
headers(Map) - Method in class com.soklet.Request.RawBuilder
headers(Map) - Method in class com.soklet.Response.Builder
headers(Map) - Method in class com.soklet.Response.Copier
headHandler(ResponseMarshaler.Builder.HeadHandler) - Method in class com.soklet.ResponseMarshaler.Builder
HEADs - Annotation Interface in com.soklet.annotation: Allows multiple HEAD annotations to be applied to the same Resource Method.
heartbeatInterval(Duration) - Method in class com.soklet.ServerSentEventServer.Builder
host(String) - Method in class com.soklet.Server.Builder
host(String) - Method in class com.soklet.ServerSentEventServer.Builder
HTTP_100 - Enum constant in enum class com.soklet.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.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.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.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.StatusCode: The request succeeded.
HTTP_201 - Enum constant in enum class com.soklet.StatusCode: The request succeeded, and a new resource was created as a result.
HTTP_202 - Enum constant in enum class com.soklet.StatusCode: The request has been received but not yet acted upon.
HTTP_203 - Enum constant in enum class com.soklet.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.StatusCode: There is no content to send for this request, but the headers are useful.
HTTP_205 - Enum constant in enum class com.soklet.StatusCode: Tells the user agent to reset the document which sent this request.
HTTP_206 - Enum constant in enum class com.soklet.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.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.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.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.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.StatusCode: The URL of the requested resource has been changed permanently.
HTTP_301_MOVED_PERMANENTLY - Enum constant in enum class com.soklet.RedirectType: Represents 301 Moved Permanently.
HTTP_302 - Enum constant in enum class com.soklet.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.RedirectType: Represents 302 Found.
HTTP_303 - Enum constant in enum class com.soklet.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.RedirectType: Represents 303 See Other.
HTTP_304 - Enum constant in enum class com.soklet.StatusCode: This is used for caching purposes.
HTTP_305 - Enum constant in enum class com.soklet.StatusCode: Deprecated.
HTTP_306 - Enum constant in enum class com.soklet.StatusCode: Deprecated.
HTTP_307 - Enum constant in enum class com.soklet.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.RedirectType: Represents 307 Temporary Redirect.
HTTP_308 - Enum constant in enum class com.soklet.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.RedirectType: Represents 308 Permanent Redirect.
HTTP_400 - Enum constant in enum class com.soklet.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.StatusCode: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
HTTP_402 - Enum constant in enum class com.soklet.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.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.StatusCode: The server cannot find the requested resource.
HTTP_405 - Enum constant in enum class com.soklet.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.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.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.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.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.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.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.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.StatusCode: The request body is larger than limits defined by server.
HTTP_414 - Enum constant in enum class com.soklet.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.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.StatusCode: The ranges specified by the Range header field in the request cannot be fulfilled.
HTTP_417 - Enum constant in enum class com.soklet.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.StatusCode: The server refuses the attempt to brew coffee with a teapot.
HTTP_421 - Enum constant in enum class com.soklet.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.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.StatusCode: (WebDAV) The resource that is being accessed is locked.
HTTP_424 - Enum constant in enum class com.soklet.StatusCode: (WebDAV) The request failed due to failure of a previous request.
HTTP_425 - Enum constant in enum class com.soklet.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.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.StatusCode: The origin server requires the request to be conditional.
HTTP_429 - Enum constant in enum class com.soklet.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.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.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.StatusCode: The server has encountered a situation it does not know how to handle.
HTTP_501 - Enum constant in enum class com.soklet.StatusCode: The request method is not supported by the server and cannot be handled.
HTTP_502 - Enum constant in enum class com.soklet.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.StatusCode: The server is not ready to handle the request.
HTTP_504 - Enum constant in enum class com.soklet.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.StatusCode: The HTTP version used in the request is not supported by the server.
HTTP_506 - Enum constant in enum class com.soklet.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.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.StatusCode: (WebDAV) The server detected an infinite loop while processing the request.
HTTP_510 - Enum constant in enum class com.soklet.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.StatusCode: Indicates that the client needs to authenticate to gain network access.
httpMethod(HttpMethod) - Method in class com.soklet.Request.Copier
httpMethod(HttpMethod) - Method in class com.soklet.Request.PathBuilder
httpMethod(HttpMethod) - Method in class com.soklet.Request.RawBuilder
HttpMethod - Enum Class in com.soklet: Typesafe representation of HTTP request methods.
httpOnly(Boolean) - Method in class com.soklet.ResponseCookie.Builder
httpOnly(Boolean) - Method in class com.soklet.ResponseCookie.Copier

I

id(Object) - Method in class com.soklet.Request.Copier
id(Object) - Method in class com.soklet.Request.PathBuilder
id(Object) - Method in class com.soklet.Request.RawBuilder
id(String) - Method in class com.soklet.ServerSentEvent.Builder
idGenerator(IdGenerator) - Method in class com.soklet.Request.PathBuilder
idGenerator(IdGenerator) - Method in class com.soklet.Request.RawBuilder
idGenerator(IdGenerator) - Method in class com.soklet.Server.Builder
idGenerator(IdGenerator) - Method in class com.soklet.ServerSentEventServer.Builder
IdGenerator<T> - Interface in com.soklet: Contract for generating identifiers of a particular type (for example, sequential Long values, random UUIDs, etc.)
IllegalFormParameterException - Exception Class in com.soklet.exception: Exception thrown when an HTTP form parameter value does not match the expected Java type.
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: Exception thrown when an HTTP multipart field value does not match the expected Java type.
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: Exception thrown when a URL path parameter value does not match the expected Java type.
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: Exception thrown when an HTTP query parameter value does not match the expected Java type.
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: Exception thrown when an HTTP request body does not match the expected Java type.
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: Exception thrown when an HTTP request cookie value does not match the expected Java type.
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
IllegalRequestException - Exception Class in com.soklet.exception: Exception thrown when the HTTP request line itself is malformed, such as a client specifying a nonexistent HTTP method.
IllegalRequestException(String) - Constructor for exception class com.soklet.exception.IllegalRequestException
IllegalRequestException(String, Throwable) - Constructor for exception class com.soklet.exception.IllegalRequestException
IllegalRequestHeaderException - Exception Class in com.soklet.exception: Exception thrown when an HTTP request header value does not match the expected Java type.
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
init(ProcessingEnvironment) - Method in class com.soklet.SokletProcessor
initialize(SokletConfig, Server.RequestHandler) - Method in interface com.soklet.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(SokletConfig, ServerSentEventServer.RequestHandler) - Method in interface com.soklet.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.SokletConfig.Builder
instanceProvider(InstanceProvider) - Method in class com.soklet.SokletConfig.Copier
InstanceProvider - Interface in com.soklet: Contract for concrete instance generation given type information.
interceptRequest(Request, ResourceMethod, Function, Consumer) - Method in interface com.soklet.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.Request: Was this request too large for the server to handle?
isLiteral() - Method in class com.soklet.ResourcePathDeclaration: Is this resource path declaration comprised of all "literal" components (that is, no placeholders)?
isMultipart() - Method in class com.soklet.Request: Is this a request with Content-Type of multipart/form-data?
isServerSentEventSource() - Method in class com.soklet.ResourceMethod: Returns whether this Resource Method functions as a Server-Sent Event Source.
isStarted() - Method in interface com.soklet.Server: Is this server started (that is, able to handle requests from clients)?
isStarted() - Method in interface com.soklet.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.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.LogEventType: Indicates LifecycleInterceptor.didEstablishServerSentEventConnection(Request, ResourceMethod) threw an exception.
LIFECYCLE_INTERCEPTOR_DID_FINISH_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.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.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.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.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.LogEventType: Indicates LifecycleInterceptor.didTerminateServerSentEventConnection(Request, ResourceMethod, Duration, Throwable) threw an exception.
LIFECYCLE_INTERCEPTOR_INTERCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.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.LogEventType: Indicates LifecycleInterceptor.willEstablishServerSentEventConnection(Request, ResourceMethod) threw an exception.
LIFECYCLE_INTERCEPTOR_WILL_START_RESPONSE_WRITING_FAILED - Enum constant in enum class com.soklet.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.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.LogEventType: Indicates LifecycleInterceptor.willTerminateServerSentEventConnection(Request, ResourceMethod, Throwable) threw an exception.
LIFECYCLE_INTERCEPTOR_WRAP_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType: Indicates LifecycleInterceptor.wrapRequest(Request, ResourceMethod, Consumer) threw an exception.
lifecycleInterceptor(LifecycleInterceptor) - Method in class com.soklet.SokletConfig.Builder
lifecycleInterceptor(LifecycleInterceptor) - Method in class com.soklet.SokletConfig.Copier
LifecycleInterceptor - Interface in com.soklet: "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.ResourcePathDeclaration.ComponentType: A literal component of a resource path declaration.
LogEvent - Class in com.soklet: 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: Builder used to construct instances of LogEvent via LogEvent.with(LogEventType, String).
LogEvent.Copier - Class in com.soklet: Builder used to copy instances of LogEvent via LogEvent.copy().
logEventType(LogEventType) - Method in class com.soklet.LogEvent.Builder
logEventType(LogEventType) - Method in class com.soklet.LogEvent.Copier
LogEventType - Enum Class in com.soklet: Kinds of LogEvent instances that Soklet can produce.

M

marshaledResponse(MarshaledResponse) - Method in class com.soklet.LogEvent.Builder
marshaledResponse(MarshaledResponse) - Method in class com.soklet.LogEvent.Copier
marshaledResponse(MarshaledResponse) - Method in class com.soklet.RequestResult.Builder
marshaledResponse(MarshaledResponse) - Method in class com.soklet.RequestResult.Copier
MarshaledResponse - Class in com.soklet: A finalized representation of a Response, suitable for sending to clients over the wire.
MarshaledResponse.Builder - Class in com.soklet: Builder used to construct instances of MarshaledResponse via MarshaledResponse.withResponse(Response) or MarshaledResponse.withStatusCode(Integer).
MarshaledResponse.Copier - Class in com.soklet: Builder used to copy instances of MarshaledResponse via MarshaledResponse.copy().
marshalRequestBody(Request, ResourceMethod, Parameter, Type) - Method in interface com.soklet.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.ResourcePathDeclaration: Does this resource path declaration match the given resource path (taking placeholders/varargs into account, if present)?
matches(ResourcePathDeclaration) - Method in class com.soklet.ResourcePath: Does this resource path match the given resource path (taking placeholders/varargs into account, if present)?
maxAge(Duration) - Method in class com.soklet.ResponseCookie.Builder
maxAge(Duration) - Method in class com.soklet.ResponseCookie.Copier
maximumRequestSizeInBytes(Integer) - Method in class com.soklet.Server.Builder
maximumRequestSizeInBytes(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
message(String) - Method in class com.soklet.LogEvent.Builder
message(String) - Method in class com.soklet.LogEvent.Copier
methodNotAllowedHandler(ResponseMarshaler.Builder.MethodNotAllowedHandler) - Method in class com.soklet.ResponseMarshaler.Builder
MissingFormParameterException - Exception Class in com.soklet.exception: Exception thrown when a required HTTP form parameter is missing from the request.
MissingFormParameterException(String, String) - Constructor for exception class com.soklet.exception.MissingFormParameterException
MissingMultipartFieldException - Exception Class in com.soklet.exception: Exception thrown when a required HTTP multipart field is missing from the request.
MissingMultipartFieldException(String, String) - Constructor for exception class com.soklet.exception.MissingMultipartFieldException
MissingQueryParameterException - Exception Class in com.soklet.exception: Exception thrown when a required HTTP query parameter is missing from the request.
MissingQueryParameterException(String, String) - Constructor for exception class com.soklet.exception.MissingQueryParameterException
MissingRequestBodyException - Exception Class in com.soklet.exception: Exception thrown when a required request body is missing from the HTTP request.
MissingRequestBodyException(String) - Constructor for exception class com.soklet.exception.MissingRequestBodyException
MissingRequestCookieException - Exception Class in com.soklet.exception: Exception thrown when a required request cookie is missing from the HTTP request.
MissingRequestCookieException(String, String) - Constructor for exception class com.soklet.exception.MissingRequestCookieException
MissingRequestHeaderException - Exception Class in com.soklet.exception: Exception thrown when a required request header is missing from the HTTP request.
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: 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: Builder used to construct instances of MultipartField via MultipartField.withName(String) or MultipartField.with(String, byte[]).
MultipartField.Copier - Class in com.soklet: Builder used to copy instances of MultipartField via MultipartField.copy().
multipartParser(MultipartParser) - Method in class com.soklet.Request.PathBuilder
multipartParser(MultipartParser) - Method in class com.soklet.Request.RawBuilder
multipartParser(MultipartParser) - Method in class com.soklet.Server.Builder
MultipartParser - Interface in com.soklet: 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.MultipartField.Builder
name(String) - Method in class com.soklet.MultipartField.Copier
name(String) - Method in class com.soklet.ResponseCookie.Builder
name(String) - Method in class com.soklet.ResponseCookie.Copier
NONE - Enum constant in enum class com.soklet.ResponseCookie.SameSite: Means that the browser sends the cookie with both cross-site and same-site requests.
notFoundHandler(ResponseMarshaler.Builder.NotFoundHandler) - Method in class com.soklet.ResponseMarshaler.Builder

O

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.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.
optionsHandler(ResponseMarshaler.Builder.OptionsHandler) - Method in class com.soklet.ResponseMarshaler.Builder
optionsSplatHandler(ResponseMarshaler.Builder.OptionsSplatHandler) - Method in class com.soklet.ResponseMarshaler.Builder

P

parameterValuesForResourceMethod(Request, ResourceMethod) - Method in interface com.soklet.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.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.Request.Copier
path(String) - Method in class com.soklet.Request.PathBuilder
path(String) - Method in class com.soklet.ResponseCookie.Builder
path(String) - Method in class com.soklet.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.Simulator: Given a request that would normally be handled by your standard Server, 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.
performServerSentEventRequest(Request) - Method in interface com.soklet.Simulator: Given a request that would normally be handled by your ServerSentEventServer (that is, for a Resource Method decorated with the ServerSentEventSource annotation), process it and return response data (ServerSentEventRequestResult.HandshakeAccepted, ServerSentEventRequestResult.HandshakeRejected, or ServerSentEventRequestResult.RequestFailed);
PLACEHOLDER - Enum constant in enum class com.soklet.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.Server.Builder
port(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
POST - Enum constant in enum class com.soklet.HttpMethod: The HTTP POST request method.
POST - Annotation Interface in com.soklet.annotation: Apply to Resource Methods to support the HTTP POST method.
postProcess(MarshaledResponse) - Method in interface com.soklet.ResponseMarshaler.Builder.PostProcessor: Applies an optional "post-process" hook for any final customization or processing before data goes over the wire.
postProcessor(ResponseMarshaler.Builder.PostProcessor) - Method in class com.soklet.ResponseMarshaler.Builder
POSTs - Annotation Interface in com.soklet.annotation: Allows multiple POST annotations to be applied to the same Resource Method.
process(Set, RoundEnvironment) - Method in class com.soklet.SokletProcessor
provide(Class) - Method in interface com.soklet.InstanceProvider: Vends an instance of the given class.
provide(Parameter) - Method in interface com.soklet.InstanceProvider: Vends an instance appropriate for the supplied Parameter.
PUT - Enum constant in enum class com.soklet.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

QueryFormat - Enum Class in com.soklet: Strategies for encoding/decoding query strings: Content-Type: application/x-www-form-urlencoded (supports "+" for spaces) or "strict" RFC 3986 (percent-decoding only).
QueryParameter - Annotation Interface in com.soklet.annotation: Apply to Resource Method parameters to enable HTTP query parameter injection.
queryParameters(Consumer) - Method in class com.soklet.Request.Copier
queryParameters(Map) - Method in class com.soklet.Request.Copier
queryParameters(Map) - Method in class com.soklet.Request.PathBuilder

R

rawUrl(String) - Method in class com.soklet.Request.RawBuilder
redirect(RedirectType, String) - Method in class com.soklet.Response.Builder
RedirectType - Enum Class in com.soklet: Typesafe representation of HTTP Redirect types (301, 302, 303, 307, 308).
registerCommentConsumer(Consumer) - Method in class com.soklet.ServerSentEventRequestResult.HandshakeAccepted: Registers a Server-Sent comment "consumer" for this connection - similar to how a real client would listen for Server-Sent comment payloads.
registerEventConsumer(Consumer) - Method in class com.soklet.ServerSentEventRequestResult.HandshakeAccepted: Registers a ServerSentEvent "consumer" for this connection - similar to how a real client would listen for Server-Sent Events.
rejectWithResponse(Response) - Static method in interface com.soklet.HandshakeResult: Vends an instance that indicates a rejected handshake along with a logical response to send to the client.
request(Request) - Method in class com.soklet.LogEvent.Builder
request(Request) - Method in class com.soklet.LogEvent.Copier
Request - Class in com.soklet: Encapsulates information specified in an HTTP request.
REQUEST_PROCESSING_FAILED - Enum constant in enum class com.soklet.LogEventType: Indicates that an exception was thrown during core request processing operations.
Request.Copier - Class in com.soklet: Builder used to copy instances of Request via Request.copy().
Request.PathBuilder - Class in com.soklet: Builder used to construct instances of Request via Request.withPath(HttpMethod, String).
Request.RawBuilder - Class in com.soklet: Builder used to construct instances of Request via Request.withRawUrl(HttpMethod, String).
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.SokletConfig.Builder
requestBodyMarshaler(RequestBodyMarshaler) - Method in class com.soklet.SokletConfig.Copier
RequestBodyMarshaler - Interface in com.soklet: 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) - Method in class com.soklet.Server.Builder
requestHandlerExecutorServiceSupplier(Supplier) - Method in class com.soklet.ServerSentEventServer.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.Server.Builder
requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
RequestResult - Class in com.soklet: Encapsulates the results of a request that would normally be handled by your Server (both logical response and bytes to be sent over the wire), used for integration testing via Simulator.performRequest(Request).
RequestResult.Builder - Class in com.soklet: Builder used to construct instances of RequestResult via RequestResult.withMarshaledResponse(MarshaledResponse).
RequestResult.Copier - Class in com.soklet: Builder used to copy instances of RequestResult via RequestResult.copy().
requestTimeout(Duration) - Method in class com.soklet.Server.Builder
requestTimeout(Duration) - Method in class com.soklet.ServerSentEventServer.Builder
RESOURCE_METHOD_RESOLUTION_FAILED - Enum constant in enum class com.soklet.LogEventType: Indicates Resource Method resolution via (ResourceMethodResolver.resourceMethodForRequest(Request, ServerType) threw an exception.
resourceMethod(ResourceMethod) - Method in class com.soklet.LogEvent.Builder
resourceMethod(ResourceMethod) - Method in class com.soklet.LogEvent.Copier
resourceMethod(ResourceMethod) - Method in class com.soklet.RequestResult.Builder
resourceMethod(ResourceMethod) - Method in class com.soklet.RequestResult.Copier
ResourceMethod - Class in com.soklet: Represents a Resource Method, which is a Java Method invoked by Soklet to handle an HTTP request.
resourceMethodForRequest(Request, ServerType) - Method in interface com.soklet.ResourceMethodResolver: Given an HTTP request, provide a matching Resource Method to invoke.
resourceMethodHandler(ResponseMarshaler.Builder.ResourceMethodHandler) - Method in class com.soklet.ResponseMarshaler.Builder
resourceMethodParameterProvider(ResourceMethodParameterProvider) - Method in class com.soklet.SokletConfig.Builder
resourceMethodParameterProvider(ResourceMethodParameterProvider) - Method in class com.soklet.SokletConfig.Copier
ResourceMethodParameterProvider - Interface in com.soklet: Contract for determining parameter values to inject when invoking Resource Methods.
resourceMethodResolver(ResourceMethodResolver) - Method in class com.soklet.SokletConfig.Builder
resourceMethodResolver(ResourceMethodResolver) - Method in class com.soklet.SokletConfig.Copier
ResourceMethodResolver - Interface in com.soklet: Contract for matching incoming HTTP requests with appropriate Resource Methods (Java methods to invoke to handle requests).
ResourcePath - Class in com.soklet: An HTTP URL path used to resolve a Resource Method at runtime, such as /users/123.
resourcePathCacheCapacity(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
ResourcePathDeclaration - Class in com.soklet: A compile-time HTTP URL path declaration associated with an annotated Resource Method, such as /users/{userId}.
ResourcePathDeclaration.Component - Class in com.soklet: Represents a /-delimited part of a ResourcePathDeclaration.
ResourcePathDeclaration.ComponentType - Enum Class in com.soklet: How to interpret a ResourcePathDeclaration.Component of a ResourcePathDeclaration - is it literal text or a placeholder?
response(Response) - Method in class com.soklet.RequestResult.Builder
response(Response) - Method in class com.soklet.RequestResult.Copier
Response - Class in com.soklet: Represents a logical HTTP response returned by a Resource Method.
RESPONSE_MARSHALER_FOR_THROWABLE_FAILED - Enum constant in enum class com.soklet.LogEventType: Indicates ResponseMarshaler.forThrowable(Request, Throwable, ResourceMethod) threw an exception.
Response.Builder - Class in com.soklet: Builder used to construct instances of Response via Response.withStatusCode(Integer) or Response.withRedirect(RedirectType, String).
Response.Copier - Class in com.soklet: Builder used to copy instances of Response via Response.copy().
ResponseCookie - Class in com.soklet: HTTP "response" Cookie representation which supports Set-Cookie header encoding.
ResponseCookie.Builder - Class in com.soklet: Builder used to construct instances of ResponseCookie via ResponseCookie.withName(String) or ResponseCookie.with(String, String).
ResponseCookie.Copier - Class in com.soklet: Builder used to copy instances of ResponseCookie via ResponseCookie.copy().
ResponseCookie.SameSite - Enum Class in com.soklet: Values which control whether 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.SokletConfig.Builder
responseMarshaler(ResponseMarshaler) - Method in class com.soklet.SokletConfig.Copier
ResponseMarshaler - Interface in com.soklet: Prepares responses for each request scenario Soklet supports (Resource Method, exception, CORS preflight, etc.)
ResponseMarshaler.Builder - Class in com.soklet: Builder used to construct a standard implementation of ResponseMarshaler.
ResponseMarshaler.Builder.ContentTooLargeHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forContentTooLarge(Request, ResourceMethod).
ResponseMarshaler.Builder.CorsAllowedHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forCorsAllowed(Request, Cors, CorsResponse, MarshaledResponse).
ResponseMarshaler.Builder.CorsPreflightAllowedHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forCorsPreflightAllowed(Request, CorsPreflight, CorsPreflightResponse).
ResponseMarshaler.Builder.CorsPreflightRejectedHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forCorsPreflightRejected(Request, CorsPreflight).
ResponseMarshaler.Builder.HeadHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forHead(Request, MarshaledResponse).
ResponseMarshaler.Builder.MethodNotAllowedHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forMethodNotAllowed(Request, Set).
ResponseMarshaler.Builder.NotFoundHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forNotFound(Request).
ResponseMarshaler.Builder.OptionsHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forOptions(Request, Set).
ResponseMarshaler.Builder.OptionsSplatHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forOptionsSplat(Request).
ResponseMarshaler.Builder.PostProcessor - Interface in com.soklet: Function used to support a pluggable "post-process" hook for any final customization or processing before data goes over the wire.
ResponseMarshaler.Builder.ResourceMethodHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forResourceMethod(Request, Response, ResourceMethod).
ResponseMarshaler.Builder.ThrowableHandler - Interface in com.soklet: Function used to support pluggable implementations of ResponseMarshaler.forThrowable(Request, Throwable, ResourceMethod).
retry(Duration) - Method in class com.soklet.ServerSentEvent.Builder
RFC_3986_STRICT - Enum constant in enum class com.soklet.QueryFormat: Follow RFC 3986, where keys and values are percent-encoded and "+" values are never decoded as spaces.
runSimulator(SokletConfig, Consumer) - Static method in class com.soklet.Soklet: Runs Soklet with special non-network "simulator" implementations of Server and ServerSentEventServer - useful for integration testing.

S

sameSite(ResponseCookie.SameSite) - Method in class com.soklet.ResponseCookie.Builder
sameSite(ResponseCookie.SameSite) - Method in class com.soklet.ResponseCookie.Copier
secure(Boolean) - Method in class com.soklet.ResponseCookie.Builder
secure(Boolean) - Method in class com.soklet.ResponseCookie.Copier
server(Server) - Method in class com.soklet.SokletConfig.Builder
server(Server) - Method in class com.soklet.SokletConfig.Copier
Server - Interface in com.soklet: 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.LogEventType: Indicates an internal Server error occurred.
SERVER_SENT_EVENT - Enum constant in enum class com.soklet.ServerType: A Server-Sent Event server which handles SSE connections (that is, services Resource Methods annotated with ServerSentEventSource).
SERVER_SENT_EVENT_SERVER_FAILED_WRITING_HANDSHAKE_RESPONSE - Enum constant in enum class com.soklet.LogEventType: Indicates that the ServerSentEventServer was unable to successfully write a handshake response.
SERVER_SENT_EVENT_SERVER_INTERNAL_ERROR - Enum constant in enum class com.soklet.LogEventType: Indicates an internal ServerSentEventServer error occurred.
SERVER_SENT_EVENT_SERVER_UNPARSEABLE_HANDSHAKE_REQUEST - Enum constant in enum class com.soklet.LogEventType: Indicates that the ServerSentEventServer received a handshake request with an illegal structure, such as a missing or invalid HTTP verb or an unsupported HTTP/2.0 request.
SERVER_UNPARSEABLE_REQUEST - Enum constant in enum class com.soklet.LogEventType: Indicates that the Server received a request with an illegal structure, such as a missing or invalid HTTP verb or an unsupported HTTP/2.0 request.
Server.Builder - Class in com.soklet: Builder used to construct a standard implementation of Server.
Server.RequestHandler - Interface in com.soklet: Request/response processing contract for Server implementations.
ServerSentEvent - Class in com.soklet: Encapsulates a Server-Sent Event payload that can be sent across the wire to a client.
ServerSentEvent.Builder - Class in com.soklet: Builder used to construct instances of ServerSentEvent via ServerSentEvent.withEvent(String), ServerSentEvent.withData(String), or ServerSentEvent.withDefaults().
ServerSentEventBroadcaster - Interface in com.soklet: Broadcasts a Server-Sent Event payload to all clients listening on a ResourcePath.
ServerSentEventRequestResult - Interface in com.soklet: Sealed interface used by Simulator.performServerSentEventRequest(Request) during integration tests, which encapsulates the 3 logical outcomes for SSE connections: accepted handshake, rejected handshake, and general request failure.
ServerSentEventRequestResult.HandshakeAccepted - Class in com.soklet: Represents the result of an SSE accepted handshake (connection stays open) when simulated by Simulator.performServerSentEventRequest(Request).
ServerSentEventRequestResult.HandshakeRejected - Class in com.soklet: Represents the result of an SSE rejected handshake (explicit rejection; connection closed) when simulated by Simulator.performServerSentEventRequest(Request).
ServerSentEventRequestResult.RequestFailed - Class in com.soklet: Represents the result of an SSE request failure (implicit rejection, e.g. an exception occurred; connection closed) when simulated by Simulator.performServerSentEventRequest(Request).
serverSentEventServer(ServerSentEventServer) - Method in class com.soklet.SokletConfig.Builder
serverSentEventServer(ServerSentEventServer) - Method in class com.soklet.SokletConfig.Copier
ServerSentEventServer - Interface in com.soklet: A special HTTP server whose only purpose is to provide Server-Sent Event functionality.
ServerSentEventServer.Builder - Class in com.soklet: Builder used to construct a standard implementation of ServerSentEventServer.
ServerSentEventServer.RequestHandler - Interface in com.soklet: 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.
ServerSentEventUnicaster - Interface in com.soklet: Unicasts a Server-Sent Event or comment payload to a specific client listening on a ResourcePath.
ServerType - Enum Class in com.soklet: Types of servers supported by Soklet - currently ServerType.STANDARD_HTTP and ServerType.SERVER_SENT_EVENT.
shutdownTimeout(Duration) - Method in class com.soklet.Server.Builder
shutdownTimeout(Duration) - Method in class com.soklet.ServerSentEventServer.Builder
ShutdownTrigger - Enum Class in com.soklet: Events that might trigger a Soklet instance to shut down.
Simulator - Interface in com.soklet: Simulates server behavior of accepting a request and returning a response without touching the network, useful for writing integration tests.
socketPendingConnectionLimit(Integer) - Method in class com.soklet.Server.Builder
socketSelectTimeout(Duration) - Method in class com.soklet.Server.Builder
Soklet - Class in com.soklet: Soklet's main class - manages a Server (and optionally a ServerSentEventServer) using the provided system configuration.
SokletConfig - Class in com.soklet: Defines how a Soklet system is configured.
SokletConfig.Builder - Class in com.soklet: Builder used to construct instances of SokletConfig.
SokletConfig.Copier - Class in com.soklet: Builder used to copy instances of SokletConfig.
Soklet is a small HTTP 1.1 server and route handler for Java, well-suited for building RESTful APIs and broadcasting Server-Sent Events. - Section in Overview
SokletProcessor - Class in com.soklet: Soklet's standard Annotation Processor which is used to generate lookup tables of Resource Method definitions at compile time as well as prevent usage errors that are detectable by static analysis.
SokletProcessor() - Constructor for class com.soklet.SokletProcessor
STANDARD_HTTP - Enum constant in enum class com.soklet.ServerType: A server which speaks HTTP over TCP (that is, services Resource Methods annotated with GET, POST, etc.)
start() - Method in interface com.soklet.Server: Starts the server, which makes it able to accept requests from clients.
start() - Method in interface com.soklet.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.MarshaledResponse.Builder
statusCode(Integer) - Method in class com.soklet.MarshaledResponse.Copier
statusCode(Integer) - Method in class com.soklet.Response.Builder
statusCode(Integer) - Method in class com.soklet.Response.Copier
StatusCode - Enum Class in com.soklet: Formal enumeration of valid HTTP status codes.
stop() - Method in interface com.soklet.Server: Stops the server, which makes it unable to accept requests from clients.
stop() - Method in interface com.soklet.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.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.LogEvent.Builder
throwable(Throwable) - Method in class com.soklet.LogEvent.Copier
throwableHandler(ResponseMarshaler.Builder.ThrowableHandler) - Method in class com.soklet.ResponseMarshaler.Builder
toSetCookieHeaderRepresentation() - Method in class com.soklet.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.Cors
toString() - Method in class com.soklet.CorsPreflight
toString() - Method in class com.soklet.CorsPreflightResponse
toString() - Method in class com.soklet.CorsResponse
toString() - Method in class com.soklet.HandshakeResult.Accepted
toString() - Method in class com.soklet.HandshakeResult.Rejected
toString() - Method in class com.soklet.LogEvent
toString() - Method in class com.soklet.MarshaledResponse
toString() - Method in class com.soklet.MultipartField
toString() - Method in class com.soklet.Request
toString() - Method in class com.soklet.RequestResult
toString() - Method in class com.soklet.ResourceMethod
toString() - Method in class com.soklet.ResourcePath
toString() - Method in class com.soklet.ResourcePathDeclaration.Component
toString() - Method in class com.soklet.ResourcePathDeclaration
toString() - Method in class com.soklet.Response
toString() - Method in class com.soklet.ResponseCookie
toString() - Method in class com.soklet.ServerSentEvent
toString() - Method in class com.soklet.ServerSentEventRequestResult.HandshakeAccepted
toString() - Method in class com.soklet.ServerSentEventRequestResult.HandshakeRejected
toString() - Method in class com.soklet.ServerSentEventRequestResult.RequestFailed
toString() - Method in enum class com.soklet.StatusCode
trimAggressively(String) - Static method in class com.soklet.Utilities: A "stronger" version of String.trim() which discards any kind of whitespace or invisible separator.
trimAggressivelyToEmpty(String) - Static method in class com.soklet.Utilities: Aggressively trims Unicode whitespace from the given string and returns "" if the input is null.
trimAggressivelyToNull(String) - Static method in class com.soklet.Utilities: Aggressively trims Unicode whitespace from the given string and returns null if the result is empty.
TypeReference<T> - Class in com.soklet.converter: Construct for creating type tokens that represent generic types.

U

unicastComment(String) - Method in interface com.soklet.ServerSentEventUnicaster: Unicasts a single Server-Sent Event comment to a specific client listening to this unicaster's ResourcePath.
unicastEvent(ServerSentEvent) - Method in interface com.soklet.ServerSentEventUnicaster: Unicasts a single Server-Sent Event payload to a specific client listening to this unicaster's ResourcePath.
Utilities - Class in com.soklet: 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.ResponseCookie.Builder
value(String) - Method in class com.soklet.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.SokletConfig.Builder
valueConverterRegistry(ValueConverterRegistry) - Method in class com.soklet.SokletConfig.Copier
ValueConverterRegistry - Class in com.soklet.converter: A collection of ValueConverter instances, supplemented with quality-of-life features that most applications need.
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.HttpMethod: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.LogEventType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.QueryFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.RedirectType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.ResourcePathDeclaration.ComponentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.ResponseCookie.SameSite: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.ServerType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.ShutdownTrigger: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.StatusCode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.soklet.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.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.QueryFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.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.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.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.ServerType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.ShutdownTrigger: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.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.HttpMethod: Exposes HttpMethod.values() as a Set for convenience.
VARARGS - Enum constant in enum class com.soklet.ResourcePathDeclaration.ComponentType: A "varargs" placeholder component that may match multiple path segments.
verifyConnectionOnceEstablished(Boolean) - Method in class com.soklet.ServerSentEventServer.Builder

W

willEstablishServerSentEventConnection(Request, ResourceMethod) - Method in interface com.soklet.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.LifecycleInterceptor: Called before the response is sent to the client.
willStartServer(Server) - Method in interface com.soklet.LifecycleInterceptor: Called before the server starts.
willStartServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleInterceptor: Called before the Server-Sent Event server starts.
willStartServerSentEventWriting(Request, ResourceMethod, ServerSentEvent) - Method in interface com.soklet.LifecycleInterceptor: Called before a Server-Sent Event is sent to the client.
willStopServer(Server) - Method in interface com.soklet.LifecycleInterceptor: Called before the server stops.
willStopServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleInterceptor: Called before the Server-Sent Event server stops.
willTerminateServerSentEventConnection(Request, ResourceMethod, Throwable) - Method in interface com.soklet.LifecycleInterceptor: Called immediately before a Server-Sent Event connection to the client is terminated.
with(LogEventType, String) - Static method in class com.soklet.LogEvent: Acquires a builder for LogEvent instances.
with(String, byte[]) - Static method in class com.soklet.MultipartField: Acquires a builder for MultipartField instances.
with(String, HttpMethod) - Static method in class com.soklet.CorsPreflight: Acquires a CORS preflight request representation for the given HTTP request data.
with(String, HttpMethod, Set) - Static method in class com.soklet.CorsPreflight: Acquires a CORS preflight request representation for the given HTTP request data.
with(String, ResourcePathDeclaration.ComponentType) - Static method in class com.soklet.ResourcePathDeclaration.Component: Acquires a ResourcePathDeclaration.Component instance given a value and type.
with(String, String) - Static method in class com.soklet.ResponseCookie: Acquires a builder for ResponseCookie instances.
withAcceptAllPolicy() - Static method in interface com.soklet.CorsAuthorizer: Acquires a threadsafe CorsAuthorizer configured to permit all cross-domain requests regardless of Origin.
withAccessControlAllowOrigin(String) - Static method in class com.soklet.CorsPreflightResponse: Acquires a builder for CorsPreflightResponse instances.
withAccessControlAllowOrigin(String) - Static method in class com.soklet.CorsResponse: Acquires a builder for CorsResponse instances.
withCharset(Charset) - Static method in interface com.soklet.ResponseMarshaler: Acquires a builder for a default ResponseMarshaler implementation.
withClasses(Set) - Static method in interface com.soklet.ResourceMethodResolver: Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided classes.
withComponents(HttpMethod, ResourcePathDeclaration, Method, Boolean) - Static method in class com.soklet.ResourceMethod: Vends a Resource Method given its unique components.
withConfig(SokletConfig) - Static method in class com.soklet.Soklet: Acquires a Soklet instance with the given configuration.
withData(String) - Static method in class com.soklet.ServerSentEvent: Acquires a builder for ServerSentEvent instances, seeded with a data value.
withDefaults() - Static method in class com.soklet.converter.ValueConverterRegistry: Acquires a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters().
withDefaults() - Static method in interface com.soklet.IdGenerator: Acquires a threadsafe IdGenerator with a default numeric ID range (values will wrap once maximum is reached) and a best-effort local IP prefix.
withDefaults() - Static method in interface com.soklet.ResponseMarshaler: Acquires a builder for a default ResponseMarshaler implementation that uses StandardCharsets.UTF_8 encoding.
withDefaults() - Static method in class com.soklet.ServerSentEvent: Acquires an "empty" builder for ServerSentEvent instances, useful for creating special cases like retry-only or id-only events.
withDefaultsSupplementedBy(Set) - Static method in class com.soklet.converter.ValueConverterRegistry: Acquires a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters(), supplemented with custom converters.
withEvent(String) - Static method in class com.soklet.ServerSentEvent: Acquires a builder for ServerSentEvent instances, seeded with an event value.
withMarshaledResponse(MarshaledResponse) - Static method in class com.soklet.RequestResult: Acquires a builder for RequestResult instances.
withMethods(Set) - Static method in interface com.soklet.ResourceMethodResolver: Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided methods.
withName(String) - Static method in class com.soklet.MultipartField: Acquires a builder for MultipartField instances.
withName(String) - Static method in class com.soklet.ResponseCookie: Acquires a builder for ResponseCookie instances without specifying the cookie's value.
withOrigin(HttpMethod, String) - Static method in class com.soklet.Cors: Acquires a CORS non-preflight request representation for the given HTTP request data.
withPath(HttpMethod, String) - Static method in class com.soklet.Request: Acquires a builder for Request instances from already-decoded path and query components - useful for manual construction, e.g. integration tests.
withPath(String) - Static method in class com.soklet.ResourcePath: Vends an instance that represents a runtime representation of a resource path, for example /users/123.
withPath(String) - Static method in class com.soklet.ResourcePathDeclaration: Vends an instance that represents a compile-time path declaration, for example /users/{userId}.
withPort(Integer) - Static method in interface com.soklet.Server: Acquires a builder for Server instances.
withPort(Integer) - Static method in interface com.soklet.ServerSentEventServer: Acquires a builder for ServerSentEventServer instances.
withPrefix(String) - Static method in interface com.soklet.IdGenerator: Acquires a threadsafe IdGenerator with a default numeric ID range (values will wrap once maximum is reached) and the given prefix.
withRange(Long, Long) - Static method in interface com.soklet.IdGenerator: Acquires a threadsafe IdGenerator with the given minimum and maximum ID values (values will wrap once maximum is reached), and a best-effort local IP prefix.
withRangeAndPrefix(Long, Long, String) - Static method in interface com.soklet.IdGenerator: Returns a threadsafe IdGenerator with the given minimum and maximum ID values (values will wrap once maximum is reached), and the specified prefix.
withRawUrl(HttpMethod, String) - Static method in class com.soklet.Request: Acquires a builder for Request instances from the URL provided by clients on a "raw" HTTP/1.1 request line.
withRedirect(RedirectType, String) - Static method in class com.soklet.Response: Acquires a builder for Response instances that are intended to redirect the client.
withRejectAllPolicy() - Static method in interface com.soklet.CorsAuthorizer: Acquires a threadsafe CorsAuthorizer configured to reject all cross-domain requests regardless of Origin.
withResponse(Response) - Static method in class com.soklet.MarshaledResponse: Acquires a builder for MarshaledResponse instances.
withServer(Server) - Static method in class com.soklet.SokletConfig: Vends a configuration builder, primed with the given Server.
withStatusCode(Integer) - Static method in class com.soklet.MarshaledResponse: Acquires a builder for MarshaledResponse instances.
withStatusCode(Integer) - Static method in class com.soklet.Response: Acquires a builder for Response instances.
withValueConverterRegistry(ValueConverterRegistry) - Static method in interface com.soklet.RequestBodyMarshaler: Acquires a threadsafe RequestBodyMarshaler implementation which converts request body data using the provided ValueConverterRegistry.
withWhitelistAuthorizer(Function) - Static method in interface com.soklet.CorsAuthorizer: Acquires a threadsafe CorsAuthorizer configured to accept only those cross-domain requests whose Origin is allowed by the provided whitelistAuthorizer function.
withWhitelistAuthorizer(Function, Function) - Static method in interface com.soklet.CorsAuthorizer: Acquires a threadsafe CorsAuthorizer configured to accept only those cross-domain requests whose Origin is allowed by the provided whitelistAuthorizer function.
withWhitelistedOrigins(Set) - Static method in interface com.soklet.CorsAuthorizer: Acquires a threadsafe CorsAuthorizer configured to accept only those cross-domain requests whose Origin matches a value in the provided set of whitelistedOrigins.
withWhitelistedOrigins(Set, Function) - Static method in interface com.soklet.CorsAuthorizer: Acquires a threadsafe CorsAuthorizer configured to accept only those cross-domain requests whose Origin matches a value in the provided set of whitelistedOrigins.
wrapRequest(Request, ResourceMethod, Consumer) - Method in interface com.soklet.LifecycleInterceptor: Wraps around the whole "outside" of the entire request-handling flow.

X

X_WWW_FORM_URLENCODED - Enum constant in enum class com.soklet.QueryFormat: Follow RFC 1866 (the application/x-www-form-urlencoded content type), where keys and values are percent-encoded but prefer "+" for spaces.

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