Index

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.
acceptAllInstance() - Static method in interface com.soklet.CorsAuthorizer
Acquires a threadsafe CorsAuthorizer configured to permit all cross-domain requests regardless of Origin.
acceptWithClientContext(Object) - Static method in interface com.soklet.HandshakeResult
Vends an instance that indicates a successful handshake with a custom client context.
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(Set) - Method in class com.soklet.CorsPreflightResponse.Builder
 
accessControlAllowHeaders(Set) - Method in class com.soklet.CorsPreflightResponse.Copier
 
accessControlAllowHeaders(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
 
accessControlAllowMethods(Consumer) - 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(Set) - Method in class com.soklet.CorsResponse.Builder
 
accessControlExposeHeaders(Set) - Method in class com.soklet.CorsResponse.Copier
 
accessControlExposeHeaders(Consumer) - 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.
activeRequests(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets the active HTTP request count.
activeSseConnections(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets the active server-sent event connection count.
allowOriginFallback(Boolean) - Method in class com.soklet.Utilities.EffectiveOriginResolver
Controls whether Origin is used as a fallback signal when determining the client URL prefix.
ATTEMPTED - Enum constant in enum class com.soklet.MetricsCollector.ServerSentEventEnqueueOutcome
An enqueue attempt to a connection was made.
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

BACKPRESSURE - Enum constant in enum class com.soklet.ServerSentEventConnection.TerminationReason
Connection was closed due to backpressure (write queue at capacity).
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(ServerSentEventComment) - Method in interface com.soklet.ServerSentEventBroadcaster
Broadcasts a single Server-Sent Event comment to all clients listening to this broadcaster's ResourcePath.
broadcastComment(Function, Function) - Method in interface com.soklet.ServerSentEventBroadcaster
Broadcasts a Server-Sent Event comment where the payload is dynamically generated and memoized based on a specific trait of the client (e.g.
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.
broadcastEvent(Function, Function) - Method in interface com.soklet.ServerSentEventBroadcaster
Broadcasts a Server-Sent Event where the payload is dynamically generated and memoized based on a specific trait of the client (e.g.
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.MetricsCollector.Snapshot.Builder
Builds a MetricsCollector.Snapshot instance.
build() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions.Builder
build() - Method in class com.soklet.MultipartField.Builder
 
build() - Method in class com.soklet.ParameterizedHeaderValue.Builder
Builds an immutable ParameterizedHeaderValue.
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
 
builder() - Static method in class com.soklet.HandshakeResult.Accepted
Vends a builder for an instance that indicates a successful handshake.
builder() - Static method in class com.soklet.MetricsCollector.Snapshot
Acquires an "empty" builder for MetricsCollector.Snapshot instances.
builder() - Static method in interface com.soklet.ResponseMarshaler
Acquires a builder for a default ResponseMarshaler implementation that uses StandardCharsets.UTF_8 encoding.
builder() - 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.

C

charset(Charset) - Method in class com.soklet.ResponseMarshaler.Builder
 
charset(Charset) - Method in class com.soklet.MultipartField.Builder
 
clientContext(Object) - Method in class com.soklet.HandshakeResult.Accepted.Builder
Specifies an application-specific custom context to be preserved over the lifetime of the SSE connection.
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
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.
COMMENT - Enum constant in enum class com.soklet.ServerSentEventComment.CommentType
Application-provided comment.
commentType() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Returns the value of the commentType record component.
commentType() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Returns the value of the commentType record component.
commentType() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteKey
Returns the value of the commentType record component.
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
 
ConnectionRejectionReason - Enum Class in com.soklet
Reasons a connection attempt was rejected before a request or SSE connection could be established.
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(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
 
cookies(Consumer) - Method in class com.soklet.MarshaledResponse.Copier
 
cookies(Consumer) - 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
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().
COUNT_SUM_ONLY - Enum constant in enum class com.soklet.MetricsCollector.SnapshotTextOptions.HistogramFormat
Emit only _count and _sum samples (omit buckets).

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.IdGenerator
Acquires a threadsafe IdGenerator with a best-effort local IP prefix.
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.LifecycleObserver
Acquires a threadsafe LifecycleObserver instance with sensible defaults.
defaultInstance() - Static method in interface com.soklet.MetricsCollector
Acquires a threadsafe MetricsCollector instance with sensible defaults.
defaultInstance() - Static method in interface com.soklet.MultipartParser
Acquires a threadsafe MultipartParser.
defaultInstance() - Static method in interface com.soklet.RequestInterceptor
Acquires a threadsafe RequestInterceptor instance with sensible defaults.
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.
didAcceptConnection(ServerType, InetSocketAddress) - Method in interface com.soklet.LifecycleObserver
Called after a server accepts a new TCP connection.
didAcceptConnection(ServerType, InetSocketAddress) - Method in interface com.soklet.MetricsCollector
Called after a server accepts a new TCP connection.
didAcceptRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.LifecycleObserver
Called after a request is accepted for application-level handling.
didAcceptRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.MetricsCollector
Called after a request is accepted for application-level handling.
didBroadcastServerSentEvent(ResourcePathDeclaration, int, int, int) - Method in interface com.soklet.MetricsCollector
Called after a broadcast attempt for a Server-Sent Event payload.
didBroadcastServerSentEventComment(ResourcePathDeclaration, ServerSentEventComment.CommentType, int, int, int) - Method in interface com.soklet.MetricsCollector
Called after a broadcast attempt for a Server-Sent Event comment payload.
didDropServerSentEvent(ServerSentEventConnection, ServerSentEvent, MetricsCollector.ServerSentEventDropReason, Integer, Integer) - Method in interface com.soklet.MetricsCollector
Called after an SSE event is dropped before it can be enqueued for delivery.
didDropServerSentEventComment(ServerSentEventConnection, ServerSentEventComment, MetricsCollector.ServerSentEventDropReason, Integer, Integer) - Method in interface com.soklet.MetricsCollector
Called after an SSE comment is dropped before it can be enqueued for delivery.
didEstablishServerSentEventConnection(ServerSentEventConnection) - Method in interface com.soklet.LifecycleObserver
Called after an SSE connection is established.
didEstablishServerSentEventConnection(ServerSentEventConnection) - Method in interface com.soklet.MetricsCollector
Called after an SSE connection is established.
didFailToAcceptConnection(ServerType, InetSocketAddress, ConnectionRejectionReason, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after a server fails to accept a new TCP connection.
didFailToAcceptConnection(ServerType, InetSocketAddress, ConnectionRejectionReason, Throwable) - Method in interface com.soklet.MetricsCollector
Called after a server fails to accept a new TCP connection.
didFailToAcceptRequest(ServerType, InetSocketAddress, String, RequestRejectionReason, Throwable) - Method in interface com.soklet.LifecycleObserver
Called when a request fails to be accepted before application-level handling begins.
didFailToAcceptRequest(ServerType, InetSocketAddress, String, RequestRejectionReason, Throwable) - Method in interface com.soklet.MetricsCollector
Called when a request fails to be accepted before application-level handling begins.
didFailToEstablishServerSentEventConnection(Request, ResourceMethod, ServerSentEventConnection.HandshakeFailureReason, Throwable) - Method in interface com.soklet.LifecycleObserver
Called if an SSE connection fails to establish.
didFailToEstablishServerSentEventConnection(Request, ResourceMethod, ServerSentEventConnection.HandshakeFailureReason, Throwable) - Method in interface com.soklet.MetricsCollector
Called if an SSE connection fails to establish.
didFailToReadRequest(ServerType, InetSocketAddress, String, RequestReadFailureReason, Throwable) - Method in interface com.soklet.LifecycleObserver
Called when a request could not be read or parsed into a valid Request.
didFailToReadRequest(ServerType, InetSocketAddress, String, RequestReadFailureReason, Throwable) - Method in interface com.soklet.MetricsCollector
Called when a request could not be read or parsed into a valid Request.
didFailToStartServer(Server, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after a Server instance was asked to start, but failed due to an exception.
didFailToStartServerSentEventServer(ServerSentEventServer, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after a ServerSentEventServer instance was asked to start, but failed due to an exception.
didFailToStartSoklet(Soklet, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after a Soklet instance was asked to start, but failed due to an exception.
didFailToStopServer(Server, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after a Server instance was asked to stop, but failed due to an exception.
didFailToStopServerSentEventServer(ServerSentEventServer, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after a ServerSentEventServer instance was asked to stop, but failed due to an exception.
didFailToStopSoklet(Soklet, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after a Soklet instance was asked to stop, but failed due to an exception.
didFailToWriteResponse(ServerType, Request, ResourceMethod, MarshaledResponse, Duration, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after response data fails to write.
didFailToWriteResponse(ServerType, Request, ResourceMethod, MarshaledResponse, Duration, Throwable) - Method in interface com.soklet.MetricsCollector
Called after response data fails to write.
didFailToWriteServerSentEvent(ServerSentEventConnection, ServerSentEvent, Duration, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after an SSE event fails to write.
didFailToWriteServerSentEvent(ServerSentEventConnection, ServerSentEvent, Duration, Throwable, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
Called after an SSE event fails to write.
didFailToWriteServerSentEventComment(ServerSentEventConnection, ServerSentEventComment, Duration, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after an SSE comment fails to write.
didFailToWriteServerSentEventComment(ServerSentEventConnection, ServerSentEventComment, Duration, Throwable, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
Called after an SSE comment fails to write.
didFinishRequestHandling(ServerType, Request, ResourceMethod, MarshaledResponse, Duration, List) - Method in interface com.soklet.LifecycleObserver
Called after a request finishes processing.
didFinishRequestHandling(ServerType, Request, ResourceMethod, MarshaledResponse, Duration, List) - Method in interface com.soklet.MetricsCollector
Called after a request finishes processing.
didReadRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.LifecycleObserver
Called when a request was successfully read or parsed into a valid Request.
didReadRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.MetricsCollector
Called when a request was successfully read or parsed into a valid Request.
didReceiveLogEvent(LogEvent) - Method in interface com.soklet.LifecycleObserver
Called when Soklet emits a log event.
didStartRequestHandling(ServerType, Request, ResourceMethod) - Method in interface com.soklet.LifecycleObserver
Called as soon as a request is received and a Resource Method has been resolved to handle it.
didStartRequestHandling(ServerType, Request, ResourceMethod) - Method in interface com.soklet.MetricsCollector
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.LifecycleObserver
Called after the server starts.
didStartServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleObserver
Called after the SSE server starts.
didStartSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
Called after a Soklet instance starts.
didStopServer(Server) - Method in interface com.soklet.LifecycleObserver
Called after the server stops.
didStopServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleObserver
Called after the SSE server stops.
didStopSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
Called after a Soklet instance stops.
didTerminateServerSentEventConnection(ServerSentEventConnection, Duration, ServerSentEventConnection.TerminationReason, Throwable) - Method in interface com.soklet.LifecycleObserver
Called after an SSE connection is terminated.
didTerminateServerSentEventConnection(ServerSentEventConnection, Duration, ServerSentEventConnection.TerminationReason, Throwable) - Method in interface com.soklet.MetricsCollector
Called after an SSE connection is terminated.
didWriteResponse(ServerType, Request, ResourceMethod, MarshaledResponse, Duration) - Method in interface com.soklet.LifecycleObserver
Called after response data is written.
didWriteResponse(ServerType, Request, ResourceMethod, MarshaledResponse, Duration) - Method in interface com.soklet.MetricsCollector
Called after response data is written.
didWriteServerSentEvent(ServerSentEventConnection, ServerSentEvent, Duration) - Method in interface com.soklet.LifecycleObserver
Called after an SSE event is written.
didWriteServerSentEvent(ServerSentEventConnection, ServerSentEvent, Duration, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
Called after an SSE event is written.
didWriteServerSentEventComment(ServerSentEventConnection, ServerSentEventComment, Duration) - Method in interface com.soklet.LifecycleObserver
Called after an SSE comment is written.
didWriteServerSentEventComment(ServerSentEventConnection, ServerSentEventComment, Duration, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
Called after an SSE comment is written.
disabledInstance() - Static method in interface com.soklet.MetricsCollector
Acquires a threadsafe MetricsCollector instance that performs no work.
domain(String) - Method in class com.soklet.ResponseCookie.Builder
 
domain(String) - Method in class com.soklet.ResponseCookie.Copier
 
DROPPED - Enum constant in enum class com.soklet.MetricsCollector.ServerSentEventEnqueueOutcome
An enqueue attempt failed because the payload was dropped.
dropReason() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Returns the value of the dropReason record component.
dropReason() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteDropKey
Returns the value of the dropReason record component.

E

encodeQueryParameters(Map, QueryFormat) - Static method in class com.soklet.Utilities
Encodes decoded query parameters into a raw query string.
ENQUEUED - Enum constant in enum class com.soklet.MetricsCollector.ServerSentEventEnqueueOutcome
An enqueue attempt succeeded.
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
 
equals(Object) - Method in record class com.soklet.MetricsCollector.RequestReadFailureKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.RequestRejectionKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerRouteKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerRouteStatusKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteDropKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteHandshakeFailureKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteTerminationKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.soklet.ParameterizedHeaderValue
 
equals(Object) - Method in class com.soklet.ParameterizedHeaderValue.Parameter
 
ERROR - Enum constant in enum class com.soklet.ServerSentEventConnection.TerminationReason
Connection ended due to an error while processing or writing.
event(String) - Method in class com.soklet.ServerSentEvent.Builder
 
expires(Instant) - Method in class com.soklet.ResponseCookie.Builder
 
expires(Instant) - Method in class com.soklet.ResponseCookie.Copier
 
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.
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.
extractEffectiveOrigin(Utilities.EffectiveOriginResolver) - Static method in class com.soklet.Utilities
Best-effort attempt to determine a client's effective origin by examining request headers.
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).
forServiceUnavailable(Request, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler
Prepares a response for a request that is rejected because the server is overloaded (e.g. connection limit reached), triggering an HTTP 503 Service Unavailable.
forThrowable(Request, Throwable, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler
Prepares a response for scenarios in which an uncaught exception is encountered.
fromBlankSlate() - Static method in class com.soklet.converter.ValueConverterRegistry
Acquires a registry without any default converters or automatic enum/reflexive conversions.
fromBlankSlateSupplementedBy(Set) - Static method in class com.soklet.converter.ValueConverterRegistry
Acquires a registry without any default converters or automatic enum/reflexive conversions, supplemented with custom converters.
fromClasses(Set) - Static method in interface com.soklet.ResourceMethodResolver
Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided classes.
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.
fromComment(String) - Static method in class com.soklet.ServerSentEventComment
Acquires a ServerSentEventComment instance with a comment payload.
fromComponents(HttpMethod, ResourcePathDeclaration, Method, Boolean) - Static method in class com.soklet.ResourceMethod
Vends a Resource Method given its unique components.
fromConfig(SokletConfig) - Static method in class com.soklet.Soklet
Acquires a Soklet instance with the given configuration.
fromDefaults() - Static method in class com.soklet.converter.ValueConverterRegistry
Acquires a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters().
fromDefaultsSupplementedBy(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.
fromHeaderRepresentation(String) - Static method in enum class com.soklet.ResponseCookie.Priority
 
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.
fromMarshaledResponse(MarshaledResponse) - Static method in class com.soklet.RequestResult
Creates a RequestResult from a marshaled response without additional customization.
fromMethods(Set) - Static method in interface com.soklet.ResourceMethodResolver
Acquires a threadsafe ResourceMethodResolver implementation which locates Resource Methods by examining the provided methods.
fromMetricsFormat(MetricsCollector.MetricsFormat) - Static method in class com.soklet.MetricsCollector.SnapshotTextOptions
Creates options with the specified format and defaults for all other fields.
fromOrigin(HttpMethod, String) - Static method in class com.soklet.Cors
Acquires a CORS non-preflight request representation for the given HTTP request data.
fromPath(HttpMethod, String) - Static method in class com.soklet.Request
Creates a Request from a path without additional customization.
fromPath(String) - Static method in class com.soklet.ResourcePath
Vends an instance that represents a runtime representation of a resource path, for example /users/123.
fromPath(String) - Static method in class com.soklet.ResourcePathDeclaration
Vends an instance that represents a compile-time path declaration, for example /users/{userId}.
fromPort(Integer) - Static method in interface com.soklet.Server
Creates a Server configured with the given port and default settings.
fromPort(Integer) - Static method in interface com.soklet.ServerSentEventServer
Creates a ServerSentEventServer configured with the given port and default settings.
fromPrefix(String) - Static method in interface com.soklet.IdGenerator
Acquires a threadsafe IdGenerator with the given prefix.
fromRawUrl(HttpMethod, String) - Static method in class com.soklet.Request
Creates a Request from a raw request target without additional customization.
fromRedirect(RedirectType, String) - Static method in class com.soklet.Response
Creates a redirect Response with no additional customization.
fromResponse(Response) - Static method in class com.soklet.MarshaledResponse
Creates a MarshaledResponse from a logical Response without additional customization.
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 class com.soklet.MarshaledResponse
Creates a MarshaledResponse with the given status code and no additional customization.
fromStatusCode(Integer) - Static method in class com.soklet.Response
Creates a Response with the given status code and no additional customization.
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.
fromValueConverterRegistry(ValueConverterRegistry) - Static method in interface com.soklet.RequestBodyMarshaler
Acquires a threadsafe RequestBodyMarshaler implementation which converts request body data using the provided ValueConverterRegistry.
fromWhitelistAuthorizer(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.
fromWhitelistAuthorizer(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.
fromWhitelistedOrigins(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.
fromWhitelistedOrigins(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.
FULL_BUCKETS - Enum constant in enum class com.soklet.MetricsCollector.SnapshotTextOptions.HistogramFormat
Emit full histogram series (buckets, count, and sum).

G

generateId(Request) - Method in interface com.soklet.IdGenerator
Generates an identifier for the given Request.
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.
getActiveRequests() - Method in class com.soklet.MetricsCollector.Snapshot
Returns the number of active HTTP requests.
getActiveSseConnections() - Method in class com.soklet.MetricsCollector.Snapshot
Returns the number of active server-sent event connections.
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().
getBucketBoundary(int) - Method in class com.soklet.MetricsCollector.HistogramSnapshot
The inclusive upper bound for the bucket at the given index.
getBucketCount() - Method in class com.soklet.MetricsCollector.HistogramSnapshot
Number of histogram buckets, including the overflow bucket.
getBucketCumulativeCount(int) - Method in class com.soklet.MetricsCollector.HistogramSnapshot
The cumulative count for the bucket at the given index.
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.
getClientContext() - Method in class com.soklet.HandshakeResult.Accepted
Returns the client context, if specified, for this accepted Server-Sent Event handshake.
getClientContext() - Method in interface com.soklet.ServerSentEventConnection
Returns the connection-specific context as provided by an accepted handshake.
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
Returns the client initialization function, if specified, for this accepted Server-Sent Event handshake.
getComment() - Method in class com.soklet.ServerSentEventComment
The comment payload.
getCommentType() - Method in class com.soklet.ServerSentEventComment
The comment type.
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
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.
getCount() - Method in class com.soklet.MetricsCollector.HistogramSnapshot
Total number of recorded values.
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.
getEstablishedAt() - Method in interface com.soklet.ServerSentEventConnection
Returns the moment at which this connection was established.
getEvent() - Method in class com.soklet.ServerSentEvent
The event value for this Server-Sent Event.
getExpires() - Method in class com.soklet.ResponseCookie
Gets the cookie's Expires value, if present.
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.Priority
 
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.
getHistogramFormat() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions
The histogram rendering strategy.
getHttpConnectionsAccepted() - Method in class com.soklet.MetricsCollector.Snapshot
Returns the total number of accepted HTTP connections.
getHttpConnectionsRejected() - Method in class com.soklet.MetricsCollector.Snapshot
Returns the total number of rejected HTTP connections.
getHttpHandlerDurations() - Method in class com.soklet.MetricsCollector.Snapshot
Returns HTTP handler duration histograms keyed by server route and status class.
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.
getHttpRequestBodyBytes() - Method in class com.soklet.MetricsCollector.Snapshot
Returns HTTP request body size histograms keyed by server route.
getHttpRequestDurations() - Method in class com.soklet.MetricsCollector.Snapshot
Returns HTTP request duration histograms keyed by server route and status class.
getHttpRequestReadFailures() - Method in class com.soklet.MetricsCollector.Snapshot
Returns HTTP request read failure counters keyed by failure reason.
getHttpRequestRejections() - Method in class com.soklet.MetricsCollector.Snapshot
Returns HTTP request rejection counters keyed by rejection reason.
getHttpResponseBodyBytes() - Method in class com.soklet.MetricsCollector.Snapshot
Returns HTTP response body size histograms keyed by server route and status class.
getHttpTimeToFirstByte() - Method in class com.soklet.MetricsCollector.Snapshot
Returns HTTP time-to-first-byte histograms keyed by server route and status class.
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.
getIncludeZeroBuckets() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions
Whether zero-count buckets should be emitted.
getInstanceProvider() - Method in class com.soklet.SokletConfig
How Soklet will perform instance creation.
getLabels() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions.MetricSample
The label set for this sample.
getLanguageRanges() - Method in class com.soklet.Request
Locale.LanguageRange information for this request as specified by Accept-Language header value[s].
getLifecycleObserver() - Method in class com.soklet.SokletConfig
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.
getMax() - Method in class com.soklet.MetricsCollector.HistogramSnapshot
Largest recorded value, or 0 if no values were recorded.
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.
getMetricFilter() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions
Optional filter for rendered samples.
getMetricsCollector() - Method in class com.soklet.SokletConfig
How Soklet will collect operational metrics.
getMetricsFormat() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions
The text exposition format to emit.
getMin() - Method in class com.soklet.MetricsCollector.HistogramSnapshot
Smallest recorded value, or 0 if no values were recorded.
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.MetricsCollector.SnapshotTextOptions.MetricSample
The name for this sample.
getName() - Method in class com.soklet.MultipartField
The name of this field.
getName() - Method in class com.soklet.ParameterizedHeaderValue
Returns the name (non-parameter) portion of this header value.
getName() - Method in class com.soklet.ParameterizedHeaderValue.Parameter
Gets the parameter name.
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.
getParameters() - Method in class com.soklet.ParameterizedHeaderValue
Returns the parameters (including their types and unencoded values) that make up this header value.
getParameterType() - Method in class com.soklet.ParameterizedHeaderValue.Parameter
Gets the type of this parameter.
getPartitioned() - Method in class com.soklet.ResponseCookie
Gets the cookie's Partitioned flag.
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
 
getPercentile(double) - Method in class com.soklet.MetricsCollector.HistogramSnapshot
Returns an approximate percentile based on bucket boundaries.
getPriority() - Method in class com.soklet.ResponseCookie
Gets the cookie's Priority value, if present.
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.
getRemoteAddress() - Method in class com.soklet.Request
The remote network address for the client connection, if available.
getRequest() - Method in class com.soklet.LogEvent
The request associated with this log event, if available.
getRequest() - Method in interface com.soklet.ServerSentEventConnection
The request made by the client to the Event Source Method which accepted the SSE handshake and established the connection.
getRequestBodyMarshaler() - Method in class com.soklet.SokletConfig
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
 
getRequestInterceptor() - Method in class com.soklet.SokletConfig
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.
getResourceMethod() - Method in interface com.soklet.ServerSentEventConnection
Returns the Event Source Method that provided the accepted handshake for this connection.
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
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.
getSseCommentDeliveryLag() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE comment delivery lag histograms keyed by route and comment type.
getSseCommentDrops() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE comment drop counters keyed by route, comment type, and drop reason.
getSseCommentEnqueueOutcomes() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE comment enqueue outcome counters keyed by route, comment type, and outcome.
getSseCommentQueueDepth() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE comment queue depth histograms keyed by route and comment type.
getSseCommentSizes() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE comment size histograms keyed by route and comment type.
getSseConnectionDurations() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE connection duration histograms keyed by route and termination reason.
getSseConnectionsAccepted() - Method in class com.soklet.MetricsCollector.Snapshot
Returns the total number of accepted SSE connections.
getSseConnectionsRejected() - Method in class com.soklet.MetricsCollector.Snapshot
Returns the total number of rejected SSE connections.
getSseEventDeliveryLag() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE event delivery lag histograms keyed by route.
getSseEventDrops() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE event drop counters keyed by route and drop reason.
getSseEventEnqueueOutcomes() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE event enqueue outcome counters keyed by route and outcome.
getSseEventSizes() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE event size histograms keyed by route.
getSseEventWriteDurations() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE event write duration histograms keyed by route.
getSseHandshakesAccepted() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE handshake acceptance counters keyed by route.
getSseHandshakesRejected() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE handshake rejection counters keyed by route and failure reason.
getSseQueueDepth() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE queue depth histograms keyed by route.
getSseRequestReadFailures() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE request read failure counters keyed by failure reason.
getSseRequestRejections() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE request rejection counters keyed by rejection reason.
getSseTimeToFirstEvent() - Method in class com.soklet.MetricsCollector.Snapshot
Returns SSE time-to-first-event histograms keyed by route.
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.
getStringValue() - Method in class com.soklet.ParameterizedHeaderValue
Returns the HTTP wire format string for this header field value: the name followed by any semicolon-delimited parameters.
getSum() - Method in class com.soklet.MetricsCollector.HistogramSnapshot
Sum of all recorded values.
getSupportedAnnotationTypes() - Method in class com.soklet.SokletProcessor
 
getSupportedOptions() - 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.ParameterizedHeaderValue.Parameter
Gets the unencoded/original parameter value.
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, 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, 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, ResourceMethod) - Method in interface com.soklet.ResponseMarshaler.Builder.ServiceUnavailableHandler
Prepares a response for a request that triggers an HTTP 503 Service Unavailable.
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.
HANDSHAKE_REJECTED - Enum constant in enum class com.soklet.ServerSentEventConnection.HandshakeFailureReason
The SSE handshake completed with a non-accepted result.
HANDSHAKE_TIMEOUT - Enum constant in enum class com.soklet.ServerSentEventConnection.HandshakeFailureReason
The SSE handshake did not complete in time.
handshakeFailureReason() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteHandshakeFailureKey
Returns the value of the handshakeFailureReason record component.
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 record class com.soklet.MetricsCollector.RequestReadFailureKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.RequestRejectionKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerRouteKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerRouteStatusKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteDropKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteHandshakeFailureKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteKey
Returns a hash code value for this object.
hashCode() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteTerminationKey
Returns a hash code value for this object.
hashCode() - Method in class com.soklet.MultipartField
 
hashCode() - Method in class com.soklet.ParameterizedHeaderValue
 
hashCode() - Method in class com.soklet.ParameterizedHeaderValue.Parameter
 
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(Map) - Method in class com.soklet.MarshaledResponse.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.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
 
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
 
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.
HEARTBEAT - Enum constant in enum class com.soklet.ServerSentEventComment.CommentType
Keep-alive/heartbeat comment.
heartbeatInstance() - Static method in class com.soklet.ServerSentEventComment
Acquires a shared heartbeat comment instance.
heartbeatInterval(Duration) - Method in class com.soklet.ServerSentEventServer.Builder
 
HIGH - Enum constant in enum class com.soklet.ResponseCookie.Priority
 
Histogram(long[]) - Constructor for class com.soklet.MetricsCollector.Histogram
Creates a histogram with the provided bucket boundaries.
histogramFormat(MetricsCollector.SnapshotTextOptions.HistogramFormat) - Method in class com.soklet.MetricsCollector.SnapshotTextOptions.Builder
Sets how histograms are rendered in the text snapshot.
HistogramSnapshot(long[], long[], long, long, long, long) - Constructor for class com.soklet.MetricsCollector.HistogramSnapshot
Creates an immutable histogram snapshot.
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
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
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
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.
httpConnectionsAccepted(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets the total number of accepted HTTP connections.
httpConnectionsRejected(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets the total number of rejected HTTP connections.
httpHandlerDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets HTTP handler duration histograms keyed by server route and status class.
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
 
httpRequestBodyBytes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets HTTP request body size histograms keyed by server route.
httpRequestDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets HTTP request duration histograms keyed by server route and status class.
httpRequestReadFailures(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets HTTP request read failure counters keyed by failure reason.
httpRequestRejections(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets HTTP request rejection counters keyed by rejection reason.
httpResponseBodyBytes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets HTTP response body size histograms keyed by server route and status class.
httpTimeToFirstByte(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets HTTP time-to-first-byte histograms keyed by server route and status class.

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 Request 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
 
includeZeroBuckets(Boolean) - Method in class com.soklet.MetricsCollector.SnapshotTextOptions.Builder
Controls whether zero-count buckets are emitted.
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(ServerType, Request, ResourceMethod, Function, Consumer) - Method in interface com.soklet.RequestInterceptor
Intercepts request processing, allowing the request to be replaced and/or the response to be transformed.
INTERNAL_ERROR - Enum constant in enum class com.soklet.ConnectionRejectionReason
An unexpected internal error occurred while handling the connection.
INTERNAL_ERROR - Enum constant in enum class com.soklet.RequestReadFailureReason
An unexpected internal error occurred while reading or parsing the request.
INTERNAL_ERROR - Enum constant in enum class com.soklet.RequestRejectionReason
An unexpected internal error occurred while attempting to enqueue the request.
INTERNAL_ERROR - Enum constant in enum class com.soklet.ServerSentEventConnection.HandshakeFailureReason
An unexpected internal error occurred while establishing the SSE connection.
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_OBSERVER_DID_ACCEPT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_ACCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_ESTABLISH_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_FAIL_TO_ACCEPT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_FAIL_TO_ACCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_FAIL_TO_READ_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_FINISH_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_READ_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_START_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_TERMINATE_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_WRITE_RESPONSE_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_WRITE_SERVER_SENT_EVENT_COMMENT_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_DID_WRITE_SERVER_SENT_EVENT_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_ACCEPT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_ACCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_ESTABLISH_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_READ_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_TERMINATE_SERVER_SENT_EVENT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_WRITE_RESPONSE_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_WRITE_SERVER_SENT_EVENT_COMMENT_FAILED - Enum constant in enum class com.soklet.LogEventType
LIFECYCLE_OBSERVER_WILL_WRITE_SERVER_SENT_EVENT_FAILED - Enum constant in enum class com.soklet.LogEventType
lifecycleObserver(LifecycleObserver) - Method in class com.soklet.SokletConfig.Builder
 
lifecycleObserver(LifecycleObserver) - Method in class com.soklet.SokletConfig.Copier
 
LifecycleObserver - Interface in com.soklet
Read-only hook methods for observing system and request lifecycle events.
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.
LOW - Enum constant in enum class com.soklet.ResponseCookie.Priority
 

M

marshaledResponse(MarshaledResponse) - Method in class com.soklet.RequestResult.Builder
 
marshaledResponse(MarshaledResponse) - Method in class com.soklet.RequestResult.Copier
 
marshaledResponse(MarshaledResponse) - Method in class com.soklet.LogEvent.Builder
 
marshaledResponse(MarshaledResponse) - Method in class com.soklet.LogEvent.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
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.
MATCHED - Enum constant in enum class com.soklet.MetricsCollector.RouteType
The request matched a ResourcePathDeclaration.
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)?
MAX_CONNECTIONS - Enum constant in enum class com.soklet.ConnectionRejectionReason
The server rejected the connection because a connection limit was reached.
maxAge(Duration) - Method in class com.soklet.ResponseCookie.Builder
 
maxAge(Duration) - Method in class com.soklet.ResponseCookie.Copier
 
maximumConnections(Integer) - Method in class com.soklet.Server.Builder
 
maximumRequestSizeInBytes(Integer) - Method in class com.soklet.Server.Builder
 
maximumRequestSizeInBytes(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
 
MEDIUM - Enum constant in enum class com.soklet.ResponseCookie.Priority
 
message(String) - Method in class com.soklet.LogEvent.Builder
 
message(String) - Method in class com.soklet.LogEvent.Copier
 
method() - Method in record class com.soklet.MetricsCollector.ServerRouteKey
Returns the value of the method record component.
method() - Method in record class com.soklet.MetricsCollector.ServerRouteStatusKey
Returns the value of the method record component.
methodNotAllowedHandler(ResponseMarshaler.Builder.MethodNotAllowedHandler) - Method in class com.soklet.ResponseMarshaler.Builder
 
metricFilter(Predicate) - Method in class com.soklet.MetricsCollector.SnapshotTextOptions.Builder
Sets an optional per-sample filter.
METRICS_COLLECTOR_FAILED - Enum constant in enum class com.soklet.LogEventType
Indicates a MetricsCollector invocation threw an exception.
MetricSample(String, Map) - Constructor for class com.soklet.MetricsCollector.SnapshotTextOptions.MetricSample
Creates a metrics sample definition.
metricsCollector(MetricsCollector) - Method in class com.soklet.SokletConfig.Builder
 
metricsCollector(MetricsCollector) - Method in class com.soklet.SokletConfig.Copier
 
MetricsCollector - Interface in com.soklet
Contract for collecting operational metrics from Soklet.
MetricsCollector.Histogram - Class in com.soklet
A thread-safe histogram with fixed bucket boundaries.
MetricsCollector.HistogramSnapshot - Class in com.soklet
Immutable snapshot of a MetricsCollector.Histogram.
MetricsCollector.MetricsFormat - Enum Class in com.soklet
MetricsCollector.RequestReadFailureKey - Record Class in com.soklet
Key for request read failures grouped by reason.
MetricsCollector.RequestRejectionKey - Record Class in com.soklet
Key for request rejections grouped by reason.
MetricsCollector.RouteType - Enum Class in com.soklet
Indicates whether a request was matched to a ResourcePathDeclaration.
MetricsCollector.ServerRouteKey - Record Class in com.soklet
Key for metrics grouped by HTTP method and route match information.
MetricsCollector.ServerRouteStatusKey - Record Class in com.soklet
Key for metrics grouped by HTTP method, route match information, and status class (e.g. 2xx).
MetricsCollector.ServerSentEventCommentRouteDropKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event comment type, route match information, and drop reason.
MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event comment type, route match information, and enqueue outcome.
MetricsCollector.ServerSentEventCommentRouteKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event comment type and route match information.
MetricsCollector.ServerSentEventDropReason - Enum Class in com.soklet
Reasons a Server-Sent Event payload or comment was dropped before it could be written.
MetricsCollector.ServerSentEventEnqueueOutcome - Enum Class in com.soklet
Outcomes for a Server-Sent Event enqueue attempt.
MetricsCollector.ServerSentEventRouteDropKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event route match information and drop reason.
MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event route match information and enqueue outcome.
MetricsCollector.ServerSentEventRouteHandshakeFailureKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event route match information and handshake failure reason.
MetricsCollector.ServerSentEventRouteKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event route match information.
MetricsCollector.ServerSentEventRouteTerminationKey - Record Class in com.soklet
Key for metrics grouped by Server-Sent Event route match information and termination reason.
MetricsCollector.Snapshot - Class in com.soklet
Immutable snapshot of collected metrics.
MetricsCollector.Snapshot.Builder - Class in com.soklet
Builder used to construct instances of MetricsCollector.Snapshot.
MetricsCollector.SnapshotTextOptions - Class in com.soklet
Options for rendering a textual metrics snapshot.
MetricsCollector.SnapshotTextOptions.Builder - Class in com.soklet
MetricsCollector.SnapshotTextOptions.HistogramFormat - Enum Class in com.soklet
Supported histogram rendering strategies.
MetricsCollector.SnapshotTextOptions.MetricSample - Class in com.soklet
A single text-format sample with its label set.
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
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.MetricsCollector.SnapshotTextOptions.HistogramFormat
Suppress histogram output entirely.
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

onBroadcastError(Consumer) - Method in interface com.soklet.Simulator
Registers a handler for exceptions thrown by simulated Server-Sent Event consumers.
onUnicastError(Consumer) - Method in interface com.soklet.Simulator
Registers a handler for exceptions thrown by simulated Server-Sent Event unicast consumers.
OPEN_METRICS_1_0 - Enum constant in enum class com.soklet.MetricsCollector.MetricsFormat
OpenMetrics text exposition format (1.0), including the # EOF trailer.
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
 
outcome() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Returns the value of the outcome record component.
outcome() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey
Returns the value of the outcome record component.

P

ParameterizedHeaderValue - Class in com.soklet
Represents a single HTTP header field value that includes a name and may include semicolon-delimited parameters - encoding rules per RFC specifications are strictly enforced.
ParameterizedHeaderValue.Builder - Class in com.soklet
Builder used to construct instances of ParameterizedHeaderValue via ParameterizedHeaderValue.withName(String).
ParameterizedHeaderValue.Parameter - Class in com.soklet
A single header-value parameter: given a header value like attachment; filename="resume.pdf"; filename*=UTF-8''r%C3%A9sum%C3%A9.pdf, there are two filename parameter name-value pairs.
ParameterizedHeaderValue.ParameterType - Enum Class in com.soklet
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().
partitioned(Boolean) - Method in class com.soklet.ResponseCookie.Builder
 
partitioned(Boolean) - Method in class com.soklet.ResponseCookie.Copier
 
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.
priority(ResponseCookie.Priority) - Method in class com.soklet.ResponseCookie.Builder
 
priority(ResponseCookie.Priority) - Method in class com.soklet.ResponseCookie.Copier
 
process(Set, RoundEnvironment) - Method in class com.soklet.SokletProcessor
 
PROMETHEUS - Enum constant in enum class com.soklet.MetricsCollector.MetricsFormat
Prometheus text exposition format (v0.0.4).
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(Map) - Method in class com.soklet.Request.Copier
 
queryParameters(Map) - Method in class com.soklet.Request.PathBuilder
 
queryParameters(Consumer) - Method in class com.soklet.Request.Copier
 
QUEUE_FULL - Enum constant in enum class com.soklet.MetricsCollector.ServerSentEventDropReason
The per-connection write queue was full.
QUOTED - Enum constant in enum class com.soklet.ParameterizedHeaderValue.ParameterType
name="value" where value is an HTTP quoted-string (RFC 9110).
quotedParameter(String, String) - Method in class com.soklet.ParameterizedHeaderValue.Builder
Adds a parameter whose value is encoded as an HTTP quoted-string (RFC 9110).

R

rawUrl(String) - Method in class com.soklet.Request.RawBuilder
 
reason() - Method in record class com.soklet.MetricsCollector.RequestReadFailureKey
Returns the value of the reason record component.
reason() - Method in record class com.soklet.MetricsCollector.RequestRejectionKey
Returns the value of the reason record component.
record(long) - Method in class com.soklet.MetricsCollector.Histogram
Records a value into the histogram.
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.
rejectAllInstance() - Static method in interface com.soklet.CorsAuthorizer
Acquires a threadsafe CorsAuthorizer configured to reject all cross-domain requests regardless of Origin.
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.
REMOTE_CLOSE - Enum constant in enum class com.soklet.ServerSentEventConnection.TerminationReason
Connection ended because the remote peer closed the socket.
remoteAddress(InetSocketAddress) - Method in class com.soklet.Request.Copier
 
remoteAddress(InetSocketAddress) - Method in class com.soklet.Request.PathBuilder
 
remoteAddress(InetSocketAddress) - Method in class com.soklet.Request.RawBuilder
 
remoteAddress(InetSocketAddress) - Method in class com.soklet.Utilities.EffectiveOriginResolver
The remote address of the client connection.
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_HANDLER_EXECUTOR_SHUTDOWN - Enum constant in enum class com.soklet.RequestRejectionReason
The request handler executor was shut down.
REQUEST_HANDLER_QUEUE_FULL - Enum constant in enum class com.soklet.RequestRejectionReason
The request handler queue was full.
REQUEST_INTERCEPTOR_INTERCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
REQUEST_INTERCEPTOR_WRAP_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
REQUEST_PROCESSING_FAILED - Enum constant in enum class com.soklet.LogEventType
Indicates that an exception was thrown during core request processing operations.
REQUEST_READ_REJECTED - Enum constant in enum class com.soklet.RequestReadFailureReason
The request reader rejected the task (for example, due to queue saturation).
REQUEST_READ_TIMEOUT - Enum constant in enum class com.soklet.ConnectionRejectionReason
The initial request read timed out before a full request could be parsed.
REQUEST_READ_TIMEOUT - Enum constant in enum class com.soklet.RequestReadFailureReason
The initial request read timed out before a full request could be parsed.
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.
requestHandlerConcurrency(Integer) - Method in class com.soklet.Server.Builder
 
requestHandlerConcurrency(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
 
requestHandlerExecutorServiceSupplier(Supplier) - Method in class com.soklet.Server.Builder
 
requestHandlerExecutorServiceSupplier(Supplier) - Method in class com.soklet.ServerSentEventServer.Builder
 
requestHandlerQueueCapacity(Integer) - Method in class com.soklet.Server.Builder
 
requestHandlerQueueCapacity(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
 
requestHandlerTimeout(Duration) - Method in class com.soklet.Server.Builder
 
requestHandlerTimeout(Duration) - 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.
requestInterceptor(RequestInterceptor) - Method in class com.soklet.SokletConfig.Builder
 
requestInterceptor(RequestInterceptor) - Method in class com.soklet.SokletConfig.Copier
 
RequestInterceptor - Interface in com.soklet
Hook methods that can adjust Soklet's request processing flow.
requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.Server.Builder
 
requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.ServerSentEventServer.Builder
 
RequestReadFailureKey(RequestReadFailureReason) - Constructor for record class com.soklet.MetricsCollector.RequestReadFailureKey
Creates an instance of a RequestReadFailureKey record class.
RequestReadFailureReason - Enum Class in com.soklet
Reasons a request could not be read or parsed into a valid Request.
RequestRejectionKey(RequestRejectionReason) - Constructor for record class com.soklet.MetricsCollector.RequestRejectionKey
Creates an instance of a RequestRejectionKey record class.
RequestRejectionReason - Enum Class in com.soklet
Reasons an HTTP or SSE request was rejected before application-level handling began.
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
 
reset() - Method in class com.soklet.MetricsCollector.Histogram
Resets all counts and min/max values.
reset() - Method in interface com.soklet.MetricsCollector
Resets any in-memory metrics state, if supported.
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
Response.Builder - Class in com.soklet
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
ResponseCookie.Copier - Class in com.soklet
Builder used to copy instances of ResponseCookie via ResponseCookie.copy().
ResponseCookie.Priority - Enum Class in com.soklet
Represents the Priority response cookie attribute.
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
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.ServiceUnavailableHandler - Interface in com.soklet
Function used to support pluggable implementations of ResponseMarshaler.forServiceUnavailable(Request, 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.
RFC_8187 - Enum constant in enum class com.soklet.ParameterizedHeaderValue.ParameterType
name*=UTF-8''... where value is an RFC 8187 ext-value.
rfc8187Parameter(String, String) - Method in class com.soklet.ParameterizedHeaderValue.Builder
Adds an extended parameter (denoted by the * suffix on the parameter name) whose value is encoded as an RFC 8187 ext-value (UTF-8, percent-encoded).
route() - Method in record class com.soklet.MetricsCollector.ServerRouteKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerRouteStatusKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteDropKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteHandshakeFailureKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteKey
Returns the value of the route record component.
route() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteTerminationKey
Returns the value of the route record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerRouteKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerRouteStatusKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteDropKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteHandshakeFailureKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteKey
Returns the value of the routeType record component.
routeType() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteTerminationKey
Returns the value of the routeType record component.
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_BROADCAST_GENERATION_FAILED - Enum constant in enum class com.soklet.LogEventType
Indicates that the ServerSentEventServer encountered an error when executing application-provided code while performing a memoized broadcast via ServerSentEventBroadcaster.broadcastEvent(Function, Function) or ServerSentEventBroadcaster.broadcastComment(Function, Function).
SERVER_SENT_EVENT_SERVER_CONNECTION_REJECTED - Enum constant in enum class com.soklet.LogEventType
Indicates that the ServerSentEventServer rejected a connection, e.g. due to capacity limits.
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_REQUEST - Enum constant in enum class com.soklet.LogEventType
Indicates that the ServerSentEventServer received a request with an illegal structure, such as a missing or invalid HTTP verb or an unsupported HTTP/2.0 request.
SERVER_SENT_EVENT_SERVER_WRITING_HANDSHAKE_RESPONSE_FAILED - Enum constant in enum class com.soklet.LogEventType
Indicates that the ServerSentEventServer was unable to successfully write a handshake response.
SERVER_STOP - Enum constant in enum class com.soklet.ServerSentEventConnection.TerminationReason
Connection was closed during server shutdown.
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.
ServerRouteKey(HttpMethod, MetricsCollector.RouteType, ResourcePathDeclaration) - Constructor for record class com.soklet.MetricsCollector.ServerRouteKey
Creates an instance of a ServerRouteKey record class.
ServerRouteStatusKey(HttpMethod, MetricsCollector.RouteType, ResourcePathDeclaration, String) - Constructor for record class com.soklet.MetricsCollector.ServerRouteStatusKey
Creates an instance of a ServerRouteStatusKey record class.
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
ServerSentEventBroadcaster - Interface in com.soklet
Broadcasts a Server-Sent Event payload to all clients listening on a ResourcePath.
ServerSentEventComment - Class in com.soklet
Encapsulates a Server-Sent Event comment payload and its comment type.
ServerSentEventComment.CommentType - Enum Class in com.soklet
Types of Server-Sent Event comments.
ServerSentEventCommentRouteDropKey(MetricsCollector.RouteType, ResourcePathDeclaration, ServerSentEventComment.CommentType, MetricsCollector.ServerSentEventDropReason) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Creates an instance of a ServerSentEventCommentRouteDropKey record class.
ServerSentEventCommentRouteEnqueueOutcomeKey(MetricsCollector.RouteType, ResourcePathDeclaration, ServerSentEventComment.CommentType, MetricsCollector.ServerSentEventEnqueueOutcome) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Creates an instance of a ServerSentEventCommentRouteEnqueueOutcomeKey record class.
ServerSentEventCommentRouteKey(MetricsCollector.RouteType, ResourcePathDeclaration, ServerSentEventComment.CommentType) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventCommentRouteKey
Creates an instance of a ServerSentEventCommentRouteKey record class.
ServerSentEventConnection - Interface in com.soklet
Represents characteristics of a long-running connection that has been established with a ServerSentEventServer.
ServerSentEventConnection.HandshakeFailureReason - Enum Class in com.soklet
Categorizes why a Server-Sent Event handshake failed.
ServerSentEventConnection.TerminationReason - Enum Class in com.soklet
Categorizes why a Server-Sent Event connection terminated.
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).
ServerSentEventRouteDropKey(MetricsCollector.RouteType, ResourcePathDeclaration, MetricsCollector.ServerSentEventDropReason) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventRouteDropKey
Creates an instance of a ServerSentEventRouteDropKey record class.
ServerSentEventRouteEnqueueOutcomeKey(MetricsCollector.RouteType, ResourcePathDeclaration, MetricsCollector.ServerSentEventEnqueueOutcome) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey
Creates an instance of a ServerSentEventRouteEnqueueOutcomeKey record class.
ServerSentEventRouteHandshakeFailureKey(MetricsCollector.RouteType, ResourcePathDeclaration, ServerSentEventConnection.HandshakeFailureReason) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventRouteHandshakeFailureKey
Creates an instance of a ServerSentEventRouteHandshakeFailureKey record class.
ServerSentEventRouteKey(MetricsCollector.RouteType, ResourcePathDeclaration) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventRouteKey
Creates an instance of a ServerSentEventRouteKey record class.
ServerSentEventRouteTerminationKey(MetricsCollector.RouteType, ResourcePathDeclaration, ServerSentEventConnection.TerminationReason) - Constructor for record class com.soklet.MetricsCollector.ServerSentEventRouteTerminationKey
Creates an instance of a ServerSentEventRouteTerminationKey record class.
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.
serviceUnavailableHandler(ResponseMarshaler.Builder.ServiceUnavailableHandler) - Method in class com.soklet.ResponseMarshaler.Builder
 
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.
snapshot() - Method in class com.soklet.MetricsCollector.Histogram
Captures an immutable snapshot of the histogram.
snapshot() - Method in interface com.soklet.MetricsCollector
Returns a snapshot of metrics collected so far, if supported.
snapshotText(MetricsCollector.SnapshotTextOptions) - Method in interface com.soklet.MetricsCollector
Returns a text snapshot of metrics collected so far, if supported.
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
 
sseCommentDeliveryLag(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE comment delivery lag histograms keyed by route and comment type.
sseCommentDrops(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE comment drop counters keyed by route, comment type, and drop reason.
sseCommentEnqueueOutcomes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE comment enqueue outcome counters keyed by route, comment type, and outcome.
sseCommentQueueDepth(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE comment queue depth histograms keyed by route and comment type.
sseCommentSizes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE comment size histograms keyed by route and comment type.
sseConnectionDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE connection duration histograms keyed by route and termination reason.
sseConnectionsAccepted(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets the total number of accepted SSE connections.
sseConnectionsRejected(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets the total number of rejected SSE connections.
sseEventDeliveryLag(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE event delivery lag histograms keyed by route.
sseEventDrops(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE event drop counters keyed by route and drop reason.
sseEventEnqueueOutcomes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE event enqueue outcome counters keyed by route and outcome.
sseEventSizes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE event size histograms keyed by route.
sseEventWriteDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE event write duration histograms keyed by route.
sseHandshakesAccepted(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE handshake acceptance counters keyed by route.
sseHandshakesRejected(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE handshake rejection counters keyed by route and failure reason.
sseQueueDepth(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE queue depth histograms keyed by route.
sseRequestReadFailures(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE request read failure counters keyed by failure reason.
sseRequestRejections(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE request rejection counters keyed by rejection reason.
sseTimeToFirstEvent(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
Sets SSE time-to-first-event histograms keyed by route.
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].
statusClass() - Method in record class com.soklet.MetricsCollector.ServerRouteStatusKey
Returns the value of the statusClass record component.
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.
stringValue() - Method in class com.soklet.ParameterizedHeaderValue.Builder
Returns the HTTP wire-format string for this header field value.

T

terminationReason() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteTerminationKey
Returns the value of the terminationReason record component.
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
 
TOKEN - Enum constant in enum class com.soklet.ParameterizedHeaderValue.ParameterType
name=value where value is an HTTP token (RFC 9110).
tokenParameter(String, String) - Method in class com.soklet.ParameterizedHeaderValue.Builder
Adds a parameter whose value is encoded as an HTTP token (RFC 9110).
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.MetricsCollector.HistogramSnapshot
 
toString() - Method in record class com.soklet.MetricsCollector.RequestReadFailureKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.RequestRejectionKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerRouteKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerRouteStatusKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteDropKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventCommentRouteKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteDropKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteHandshakeFailureKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteKey
Returns a string representation of this record class.
toString() - Method in record class com.soklet.MetricsCollector.ServerSentEventRouteTerminationKey
Returns a string representation of this record class.
toString() - Method in class com.soklet.MultipartField
 
toString() - Method in class com.soklet.ParameterizedHeaderValue.Parameter
 
toString() - Method in class com.soklet.ParameterizedHeaderValue
Returns a debug representation of this instance and its internal state.
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.ServerSentEventComment
 
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.
TRUST_ALL - Enum constant in enum class com.soklet.Utilities.EffectiveOriginResolver.TrustPolicy
Trust forwarded headers from any source.
TRUST_NONE - Enum constant in enum class com.soklet.Utilities.EffectiveOriginResolver.TrustPolicy
Ignore forwarded headers entirely.
TRUST_PROXY_ALLOWLIST - Enum constant in enum class com.soklet.Utilities.EffectiveOriginResolver.TrustPolicy
Trust forwarded headers only from proxies in a configured allowlist.
trustedProxyAddresses(Set) - Method in class com.soklet.Utilities.EffectiveOriginResolver
Allows specifying an IP allowlist for trusted proxies.
trustedProxyPredicate(Predicate) - Method in class com.soklet.Utilities.EffectiveOriginResolver
TypeReference<T> - Class in com.soklet.converter
Construct for creating type tokens that represent generic types.

U

unicastComment(ServerSentEventComment) - 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.
UNKNOWN - Enum constant in enum class com.soklet.ServerSentEventConnection.TerminationReason
Connection ended for an unspecified reason.
UNMATCHED - Enum constant in enum class com.soklet.MetricsCollector.RouteType
The request did not match any ResourcePathDeclaration.
UNPARSEABLE_REQUEST - Enum constant in enum class com.soklet.ConnectionRejectionReason
The incoming request could not be parsed into a valid HTTP request.
UNPARSEABLE_REQUEST - Enum constant in enum class com.soklet.RequestReadFailureReason
The incoming request could not be parsed into a valid HTTP request.
Utilities - Class in com.soklet
A non-instantiable collection of utility methods.
Utilities.EffectiveOriginResolver - Class in com.soklet
Utilities.EffectiveOriginResolver.TrustPolicy - Enum Class in com.soklet
Forwarded header trust policy.

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, Throwable, Type, Object, Type) - Constructor for exception class com.soklet.converter.ValueConversionException
Creates an exception that describes the value conversion error.
ValueConversionException(String, 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.ConnectionRejectionReason
Returns the enum constant of this class with the specified name.
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.MetricsCollector.MetricsFormat
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.MetricsCollector.RouteType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.MetricsCollector.ServerSentEventDropReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.MetricsCollector.ServerSentEventEnqueueOutcome
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.MetricsCollector.SnapshotTextOptions.HistogramFormat
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.ParameterizedHeaderValue.ParameterType
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.RequestReadFailureReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.RequestRejectionReason
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.Priority
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.ServerSentEventComment.CommentType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.ServerSentEventConnection.HandshakeFailureReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.soklet.ServerSentEventConnection.TerminationReason
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.
valueOf(String) - Static method in enum class com.soklet.Utilities.EffectiveOriginResolver.TrustPolicy
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.soklet.ConnectionRejectionReason
Returns an array containing the constants of this enum class, in the order they are declared.
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.MetricsCollector.MetricsFormat
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.MetricsCollector.RouteType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.MetricsCollector.ServerSentEventDropReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.MetricsCollector.ServerSentEventEnqueueOutcome
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.MetricsCollector.SnapshotTextOptions.HistogramFormat
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.ParameterizedHeaderValue.ParameterType
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.RequestReadFailureReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.RequestRejectionReason
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.Priority
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.ServerSentEventComment.CommentType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.ServerSentEventConnection.HandshakeFailureReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.soklet.ServerSentEventConnection.TerminationReason
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.
values() - Static method in enum class com.soklet.Utilities.EffectiveOriginResolver.TrustPolicy
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

willAcceptConnection(ServerType, InetSocketAddress) - Method in interface com.soklet.LifecycleObserver
Called when a server is about to accept a new TCP connection.
willAcceptConnection(ServerType, InetSocketAddress) - Method in interface com.soklet.MetricsCollector
Called when a server is about to accept a new TCP connection.
willAcceptRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.LifecycleObserver
Called when a request is about to be accepted for application-level handling.
willAcceptRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.MetricsCollector
Called when a request is about to be accepted for application-level handling.
willEstablishServerSentEventConnection(Request, ResourceMethod) - Method in interface com.soklet.LifecycleObserver
Called before an SSE connection is established.
willEstablishServerSentEventConnection(Request, ResourceMethod) - Method in interface com.soklet.MetricsCollector
Called before an SSE connection is established.
willReadRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.LifecycleObserver
Called when Soklet is about to read or parse a request into a valid Request.
willReadRequest(ServerType, InetSocketAddress, String) - Method in interface com.soklet.MetricsCollector
Called when Soklet is about to read or parse a request into a valid Request.
willStartServer(Server) - Method in interface com.soklet.LifecycleObserver
Called before the server starts.
willStartServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleObserver
Called before the SSE server starts.
willStartSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
Called before a Soklet instance starts.
willStopServer(Server) - Method in interface com.soklet.LifecycleObserver
Called before the server stops.
willStopServerSentEventServer(ServerSentEventServer) - Method in interface com.soklet.LifecycleObserver
Called before the SSE server stops.
willStopSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
Called before a Soklet instance stops.
willTerminateServerSentEventConnection(ServerSentEventConnection, ServerSentEventConnection.TerminationReason, Throwable) - Method in interface com.soklet.LifecycleObserver
Called before an SSE connection is terminated.
willTerminateServerSentEventConnection(ServerSentEventConnection, ServerSentEventConnection.TerminationReason, Throwable) - Method in interface com.soklet.MetricsCollector
Called before an SSE connection is terminated.
willWriteResponse(ServerType, Request, ResourceMethod, MarshaledResponse) - Method in interface com.soklet.LifecycleObserver
Called before response data is written.
willWriteResponse(ServerType, Request, ResourceMethod, MarshaledResponse) - Method in interface com.soklet.MetricsCollector
Called before response data is written.
willWriteServerSentEvent(ServerSentEventConnection, ServerSentEvent) - Method in interface com.soklet.LifecycleObserver
Called before an SSE event is written.
willWriteServerSentEvent(ServerSentEventConnection, ServerSentEvent) - Method in interface com.soklet.MetricsCollector
Called before an SSE event is written.
willWriteServerSentEventComment(ServerSentEventConnection, ServerSentEventComment) - Method in interface com.soklet.LifecycleObserver
Called before an SSE comment is written.
willWriteServerSentEventComment(ServerSentEventConnection, ServerSentEventComment) - Method in interface com.soklet.MetricsCollector
Called before an SSE comment is written.
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.
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.
withData(String) - Static method in class com.soklet.ServerSentEvent
Acquires a builder for ServerSentEvent instances, seeded with a data value.
withEvent(String) - Static method in class com.soklet.ServerSentEvent
Acquires a builder for ServerSentEvent instances, seeded with an event value.
withHeaders(Map, Utilities.EffectiveOriginResolver.TrustPolicy) - Static method in class com.soklet.Utilities.EffectiveOriginResolver
Acquires a builder seeded with raw request headers and a trust policy.
withMarshaledResponse(MarshaledResponse) - Static method in class com.soklet.RequestResult
Acquires a builder for RequestResult instances.
withMetricsFormat(MetricsCollector.MetricsFormat) - Static method in class com.soklet.MetricsCollector.SnapshotTextOptions
Begins building options with the specified format.
withName(String) - Static method in class com.soklet.MultipartField
Acquires a builder for MultipartField instances.
withName(String) - Static method in class com.soklet.ParameterizedHeaderValue
 
withName(String) - Static method in class com.soklet.ResponseCookie
Acquires a builder for ResponseCookie instances without specifying the cookie's value.
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.
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.
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.
withRequest(Request, Utilities.EffectiveOriginResolver.TrustPolicy) - Static method in class com.soklet.Utilities.EffectiveOriginResolver
Acquires a builder seeded with a Request and a trust policy.
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.
wrapRequest(ServerType, Request, Consumer) - Method in interface com.soklet.RequestInterceptor
Called before Soklet begins request processing, allowing the request to be wrapped or replaced.
writeTimeout(Duration) - Method in class com.soklet.ServerSentEventServer.Builder
 

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