Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractValueConverter<F,
T> - Class in com.soklet.converter -
Convenience superclass which provides default implementations of
ValueConvertermethods. - 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.SseHandshakeResult
-
Vends an instance that indicates a successful handshake, with no additional information provided.
- acceptAllInstance() - Static method in interface com.soklet.CorsAuthorizer
-
Acquires a threadsafe
CorsAuthorizerconfigured to permit all cross-domain requests regardless ofOrigin. - acceptAllInstance() - Static method in interface com.soklet.McpCorsAuthorizer
-
Acquires an authorizer that allows all browser origins and always enables credentials.
- acceptWithClientContext(Object) - Static method in interface com.soklet.SseHandshakeResult
-
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.SseServer
-
Given a
ResourcePaththat corresponds to a Resource Method annotated withSseEventSource, acquire aSseBroadcasterwhich is capable of "pushing" messages to all connected Server-Sent Event clients. - activeMcpSessions(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets the active MCP session count.
- activeMcpStreams(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets the active MCP stream count.
- 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
Originis used as a fallback signal when determining the client URL prefix. - asMap() - Method in interface com.soklet.McpSessionContext
-
Provides an immutable snapshot of all stored session values.
- asNumber() - Method in record class com.soklet.McpJsonRpcRequestId
-
Reads the request ID as a number when it is number-backed.
- asNumber() - Method in record class com.soklet.McpProgressToken
-
Reads the progress token as a number when it is number-backed.
- ASSISTANT - Enum constant in enum class com.soklet.McpPromptMessageRole
- asString() - Method in record class com.soklet.McpJsonRpcRequestId
-
Reads the request ID as a string when it is string-backed.
- asString() - Method in record class com.soklet.McpProgressToken
-
Reads the progress token as a string when it is string-backed.
- ATTEMPTED - Enum constant in enum class com.soklet.MetricsCollector.SseEventEnqueueOutcome
-
An enqueue attempt to a connection was made.
- authorize(McpCorsContext, Cors) - Method in interface com.soklet.McpCorsAuthorizer
-
Authorizes a non-preflight browser-originated MCP request and, when allowed, supplies the CORS response metadata to apply.
- authorize(Request, Cors) - Method in interface com.soklet.CorsAuthorizer
-
Authorizes a non-preflight CORS request.
- authorizePreflight(McpCorsContext, CorsPreflight, Set) - Method in interface com.soklet.McpCorsAuthorizer
-
Authorizes a browser preflight request for the MCP transport.
- 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 providedshutdownTriggersoccurs.
B
- BACKPRESSURE - Enum constant in enum class com.soklet.SseConnection.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
- blobBase64() - Method in record class com.soklet.McpResourceContents
-
Returns the value of the
blobBase64record component. - body(byte[]) - Method in class com.soklet.MarshaledResponse.Builder
-
Sets a byte-array-backed response body, or removes any current body if
bytesisnull. - 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(MarshaledResponseBody) - Method in class com.soklet.MarshaledResponse.Builder
-
Sets a response body descriptor, or removes any current body if
bodyisnull. - body(MarshaledResponseBody) - Method in class com.soklet.MarshaledResponse.Copier
- body(Object) - Method in class com.soklet.Response.Builder
- body(Object) - Method in class com.soklet.Response.Copier
- body(ByteBuffer) - Method in class com.soklet.MarshaledResponse.Builder
-
Sets a byte-buffer-backed response body, or removes any current body if
byteBufferisnull. - body(ByteBuffer) - Method in class com.soklet.MarshaledResponse.Copier
- body(FileChannel, Long, Long, Boolean) - Method in class com.soklet.MarshaledResponse.Builder
-
Sets a file-channel-backed response body.
- body(FileChannel, Long, Long, Boolean) - Method in class com.soklet.MarshaledResponse.Copier
- body(Path, Long, Long) - Method in class com.soklet.MarshaledResponse.Builder
-
Sets a ranged path-backed response body.
- body(Path, Long, Long) - Method in class com.soklet.MarshaledResponse.Copier
- body(Path) - Method in class com.soklet.MarshaledResponse.Builder
-
Sets a path-backed response body, or removes any current body if
pathisnull. - body(Path) - Method in class com.soklet.MarshaledResponse.Copier
- BOOLEAN - Enum constant in enum class com.soklet.McpType
- broadcastComment(SseComment) - Method in interface com.soklet.SseBroadcaster
-
Broadcasts a single Server-Sent Event comment to all clients listening to this broadcaster's
ResourcePath. - broadcastComment(Function, Function) - Method in interface com.soklet.SseBroadcaster
-
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.SseServer.Builder
- broadcastEvent(SseEvent) - Method in interface com.soklet.SseBroadcaster
-
Broadcasts a Server-Sent Event payload to all clients listening to this broadcaster's
ResourcePath. - broadcastEvent(Function, Function) - Method in interface com.soklet.SseBroadcaster
-
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.HttpRequestResult.Builder
- build() - Method in class com.soklet.HttpServer.Builder
- build() - Method in class com.soklet.LogEvent.Builder
- build() - Method in class com.soklet.MarshaledResponse.Builder
- build() - Method in class com.soklet.McpSchema.ObjectBuilder
-
Builds the immutable schema value.
- build() - Method in class com.soklet.McpServer.Builder
-
Builds the MCP server.
- build() - Method in class com.soklet.McpToolResult.Builder
-
Builds the immutable tool result.
- build() - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Builds a
MetricsCollector.Snapshotinstance. - build() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions.Builder
-
Builds a
MetricsCollector.SnapshotTextOptionsinstance. - 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.Response.Builder
- build() - Method in class com.soklet.ResponseCookie.Builder
- build() - Method in class com.soklet.ResponseMarshaler.Builder
- build() - Method in class com.soklet.SokletConfig.Builder
- build() - Method in class com.soklet.SseEvent.Builder
- build() - Method in class com.soklet.SseHandshakeResult.Accepted.Builder
- build() - Method in class com.soklet.SseServer.Builder
- builder() - Static method in class com.soklet.McpToolResult
-
Creates a builder for
McpToolResult. - builder() - Static method in class com.soklet.MetricsCollector.Snapshot
-
Acquires an "empty" builder for
MetricsCollector.Snapshotinstances. - builder() - Static method in interface com.soklet.ResponseMarshaler
-
Acquires a builder for a default
ResponseMarshalerimplementation that usesStandardCharsets.UTF_8encoding. - builder() - Static method in class com.soklet.SseEvent
-
Acquires an "empty" builder for
SseEventinstances, useful for creating special cases likeretry-only orid-only events. - builder() - Static method in class com.soklet.SseHandshakeResult.Accepted
-
Vends a builder for an instance that indicates a successful handshake.
- ByteBuffer(ByteBuffer) - Constructor for class com.soklet.MarshaledResponseBody.ByteBuffer
- Bytes(byte[]) - Constructor for class com.soklet.MarshaledResponseBody.Bytes
C
- charset(Charset) - Method in class com.soklet.ResponseMarshaler.Builder
- charset(Charset) - Method in class com.soklet.MultipartField.Builder
- checkRequest(McpAdmissionContext) - Method in interface com.soklet.McpRequestAdmissionPolicy
-
Decides whether an MCP transport request should proceed.
- CLIENT_DISCONNECTED - Enum constant in enum class com.soklet.McpStreamTerminationReason
- CLIENT_REQUESTED - Enum constant in enum class com.soklet.McpSessionTerminationReason
- clientCapabilities() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
clientCapabilitiesrecord component. - clientContext(Object) - Method in class com.soklet.SseHandshakeResult.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.SseHandshakeResult.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-IDrequest header. - close() - Method in interface com.soklet.HttpServer
-
AutoCloseable-enabled synonym forHttpServer.stop(). - close() - Method in class com.soklet.McpRequestResult.StreamOpened
-
Simulates client-side closure of the open MCP stream.
- close() - Method in interface com.soklet.McpServer
- close() - Method in class com.soklet.Soklet
-
Synonym for
Soklet.stop(). - close() - Method in interface com.soklet.SseServer
-
AutoCloseable-enabled synonym forSseServer.stop(). - code() - Method in record class com.soklet.McpJsonRpcError
-
Returns the value of the
coderecord component. - 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.SseComment.CommentType
-
Application-provided comment.
- commentType() - Method in record class com.soklet.MetricsCollector.SseCommentRouteDropKey
-
Returns the value of the
commentTyperecord component. - commentType() - Method in record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Returns the value of the
commentTyperecord component. - commentType() - Method in record class com.soklet.MetricsCollector.SseCommentRouteKey
-
Returns the value of the
commentTyperecord component. - concurrency(Integer) - Method in class com.soklet.HttpServer.Builder
- concurrentConnectionLimit(Integer) - Method in class com.soklet.McpServer.Builder
-
Sets the concurrent connection limit for the MCP server.
- concurrentConnectionLimit(Integer) - Method in class com.soklet.SseServer.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.McpServer.Builder
-
Sets the outbound queue capacity for live MCP streams.
- connectionQueueCapacity(Integer) - Method in class com.soklet.SseServer.Builder
- ConnectionRejectionReason - Enum Class in com.soklet
-
Reasons a connection attempt was rejected by a transport server before request handling could begin.
- contains(String) - Method in interface com.soklet.McpSessionContext
-
Checks whether a session value is present for the given key.
- content() - Method in record class com.soklet.McpPromptMessage
-
Returns the value of the
contentrecord component. - content(McpTextContent) - Method in class com.soklet.McpToolResult.Builder
-
Appends a content block to the result.
- content(List) - Method in class com.soklet.McpToolResult.Builder
-
Appends multiple content blocks to the result in order.
- 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
fromto an instance ofT. - 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(Set) - Method in class com.soklet.SseHandshakeResult.Accepted.Builder
-
Specifies custom response cookies to be sent with the handshake.
- 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.HttpRequestResult
-
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.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(McpCorsAuthorizer) - Method in class com.soklet.McpServer.Builder
-
Sets the MCP CORS authorizer.
- 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.HttpRequestResult.Builder
- corsPreflightResponse(CorsPreflightResponse) - Method in class com.soklet.HttpRequestResult.Copier
- CorsPreflightResponse - Class in com.soklet
-
Response headers to send over the wire for CORS preflight requests.
- CorsPreflightResponse.Builder - Class in com.soklet
-
Builder used to construct instances of
CorsPreflightResponseviaCorsPreflightResponse.withAccessControlAllowOrigin(String). - CorsPreflightResponse.Copier - Class in com.soklet
-
Builder used to copy instances of
CorsPreflightResponseviaCorsPreflightResponse.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
CorsResponseviaCorsResponse.withAccessControlAllowOrigin(String). - CorsResponse.Copier - Class in com.soklet
-
Builder used to copy instances of
CorsResponseviaCorsResponse.copy(). - COUNT_SUM_ONLY - Enum constant in enum class com.soklet.MetricsCollector.SnapshotTextOptions.HistogramFormat
-
Emit only
_countand_sumsamples (omit buckets). - create(McpStoredSession) - Method in interface com.soklet.McpSessionStore
-
Persists a newly-created session.
- createdAt() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
createdAtrecord component.
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.SseEvent.Builder
- defaultInstance() - Static method in interface com.soklet.IdGenerator
-
Acquires a threadsafe
IdGeneratorwith a best-effort local IP prefix. - defaultInstance() - Static method in interface com.soklet.InstanceProvider
-
Acquires a threadsafe
InstanceProviderwith a reflection-basedinstanceClass.getDeclaredConstructor().newInstance()instantiation strategy. - defaultInstance() - Static method in interface com.soklet.LifecycleObserver
-
Acquires a threadsafe
LifecycleObserverinstance with sensible defaults. - defaultInstance() - Static method in interface com.soklet.McpRequestAdmissionPolicy
-
Acquires the default no-op admission policy.
- defaultInstance() - Static method in interface com.soklet.McpResponseMarshaler
-
Acquires Soklet's default structured-content marshaler.
- defaultInstance() - Static method in interface com.soklet.MetricsCollector
-
Acquires a threadsafe
MetricsCollectorinstance 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
RequestInterceptorinstance with sensible defaults. - defaultInstance() - Static method in interface com.soklet.ResponseMarshaler
-
Acquires a threadsafe
ResponseMarshalerwith 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
ValueConverterinstances. - DELETE - Enum constant in enum class com.soklet.HttpMethod
-
The HTTP
DELETErequest method. - DELETE - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to support the HTTP
DELETEmethod. - deleteBySessionId(String) - Method in interface com.soklet.McpSessionStore
-
Deletes a session by ID.
- DELETEs - Annotation Interface in com.soklet.annotation
-
Allows multiple
DELETEannotations to be applied to the same Resource Method. - description() - Element in annotation interface com.soklet.annotation.McpPrompt
-
Declares the human-readable prompt description.
- description() - Element in annotation interface com.soklet.annotation.McpResource
-
Declares optional resource description metadata.
- description() - Element in annotation interface com.soklet.annotation.McpServerEndpoint
-
Declares optional server description metadata.
- description() - Element in annotation interface com.soklet.annotation.McpTool
-
Declares the human-readable tool description.
- description() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.soklet.McpListedResource
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.soklet.McpPromptResult
-
Returns the value of the
descriptionrecord component. - 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.
- didBroadcastSseComment(ResourcePathDeclaration, SseComment.CommentType, int, int, int) - Method in interface com.soklet.MetricsCollector
-
Called after a broadcast attempt for a Server-Sent Event comment payload.
- didBroadcastSseEvent(ResourcePathDeclaration, int, int, int) - Method in interface com.soklet.MetricsCollector
-
Called after a broadcast attempt for a Server-Sent Event payload.
- didCreateMcpSession(Request, Class, String) - Method in interface com.soklet.LifecycleObserver
-
Called after an MCP session is durably created.
- didCreateMcpSession(Request, Class, String) - Method in interface com.soklet.MetricsCollector
-
Called after an MCP session is durably created.
- didDropSseComment(SseConnection, SseComment, MetricsCollector.SseEventDropReason, Integer, Integer) - Method in interface com.soklet.MetricsCollector
-
Called after an SSE comment is dropped before it can be enqueued for delivery.
- didDropSseEvent(SseConnection, SseEvent, MetricsCollector.SseEventDropReason, Integer, Integer) - Method in interface com.soklet.MetricsCollector
-
Called after an SSE event is dropped before it can be enqueued for delivery.
- didEstablishMcpSseStream(Request, Class, String) - Method in interface com.soklet.LifecycleObserver
-
Called after an MCP GET stream is established.
- didEstablishMcpSseStream(Request, Class, String) - Method in interface com.soklet.MetricsCollector
-
Called after an MCP GET stream is established.
- didEstablishSseConnection(SseConnection) - Method in interface com.soklet.LifecycleObserver
-
Called after an SSE connection is established.
- didEstablishSseConnection(SseConnection) - 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.
- didFailToEstablishSseConnection(Request, ResourceMethod, SseConnection.HandshakeFailureReason, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called if an SSE connection fails to establish.
- didFailToEstablishSseConnection(Request, ResourceMethod, SseConnection.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. - didFailToStartHttpServer(HttpServer, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after a
HttpServerinstance was asked to start, but failed due to an exception. - didFailToStartMcpServer(McpServer, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after an
McpServerinstance was asked to start, but failed due to an exception. - didFailToStartSoklet(Soklet, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after a
Sokletinstance was asked to start, but failed due to an exception. - didFailToStartSseServer(SseServer, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after a
SseServerinstance was asked to start, but failed due to an exception. - didFailToStopHttpServer(HttpServer, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after a
HttpServerinstance was asked to stop, but failed due to an exception. - didFailToStopMcpServer(McpServer, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after an
McpServerinstance was asked to stop, but failed due to an exception. - didFailToStopSoklet(Soklet, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after a
Sokletinstance was asked to stop, but failed due to an exception. - didFailToStopSseServer(SseServer, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after a
SseServerinstance 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.
- didFailToWriteSseComment(SseConnection, SseComment, Duration, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after an SSE comment fails to write.
- didFailToWriteSseComment(SseConnection, SseComment, Duration, Throwable, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
-
Called after an SSE comment fails to write.
- didFailToWriteSseEvent(SseConnection, SseEvent, Duration, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after an SSE event fails to write.
- didFailToWriteSseEvent(SseConnection, SseEvent, Duration, Throwable, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
-
Called after an SSE event fails to write.
- didFinishMcpRequestHandling(Request, Class, String, String, McpJsonRpcRequestId, McpRequestOutcome, McpJsonRpcError, Duration, List) - Method in interface com.soklet.LifecycleObserver
-
Called after MCP JSON-RPC request handling finishes.
- didFinishMcpRequestHandling(Request, Class, String, String, McpJsonRpcRequestId, McpRequestOutcome, McpJsonRpcError, Duration, List) - Method in interface com.soklet.MetricsCollector
-
Called after MCP JSON-RPC request handling finishes.
- 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.
- didStartHttpServer(HttpServer) - Method in interface com.soklet.LifecycleObserver
-
Called after the server starts.
- didStartMcpRequestHandling(Request, Class, String, String, McpJsonRpcRequestId) - Method in interface com.soklet.LifecycleObserver
-
Called after a valid MCP JSON-RPC request begins handling.
- didStartMcpRequestHandling(Request, Class, String, String, McpJsonRpcRequestId) - Method in interface com.soklet.MetricsCollector
-
Called after a valid MCP JSON-RPC request begins handling.
- didStartMcpServer(McpServer) - Method in interface com.soklet.LifecycleObserver
-
Called after the MCP server starts.
- 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.
- didStartSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
-
Called after a
Sokletinstance starts. - didStartSseServer(SseServer) - Method in interface com.soklet.LifecycleObserver
-
Called after the SSE server starts.
- didStopHttpServer(HttpServer) - Method in interface com.soklet.LifecycleObserver
-
Called after the server stops.
- didStopMcpServer(McpServer) - Method in interface com.soklet.LifecycleObserver
-
Called after the MCP server stops.
- didStopSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
-
Called after a
Sokletinstance stops. - didStopSseServer(SseServer) - Method in interface com.soklet.LifecycleObserver
-
Called after the SSE server stops.
- didTerminateMcpSession(Class, String, Duration, McpSessionTerminationReason, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after an MCP session is terminated.
- didTerminateMcpSession(Class, String, Duration, McpSessionTerminationReason, Throwable) - Method in interface com.soklet.MetricsCollector
-
Called after an MCP session is terminated.
- didTerminateMcpSseStream(Request, Class, String, Duration, McpStreamTerminationReason, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after an MCP GET stream is terminated.
- didTerminateMcpSseStream(Request, Class, String, Duration, McpStreamTerminationReason, Throwable) - Method in interface com.soklet.MetricsCollector
-
Called after an MCP GET stream is terminated.
- didTerminateSseConnection(SseConnection, Duration, SseConnection.TerminationReason, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called after an SSE connection is terminated.
- didTerminateSseConnection(SseConnection, Duration, SseConnection.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.
- didWriteSseComment(SseConnection, SseComment, Duration) - Method in interface com.soklet.LifecycleObserver
-
Called after an SSE comment is written.
- didWriteSseComment(SseConnection, SseComment, Duration, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
-
Called after an SSE comment is written.
- didWriteSseEvent(SseConnection, SseEvent, Duration) - Method in interface com.soklet.LifecycleObserver
-
Called after an SSE event is written.
- didWriteSseEvent(SseConnection, SseEvent, Duration, Duration, Integer, Integer) - Method in interface com.soklet.MetricsCollector
-
Called after an SSE event is written.
- disabledInstance() - Static method in interface com.soklet.MetricsCollector
-
Acquires a threadsafe
MetricsCollectorinstance 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.SseEventEnqueueOutcome
-
An enqueue attempt failed because the payload was dropped.
- dropReason() - Method in record class com.soklet.MetricsCollector.SseCommentRouteDropKey
-
Returns the value of the
dropReasonrecord component. - dropReason() - Method in record class com.soklet.MetricsCollector.SseEventRouteDropKey
-
Returns the value of the
dropReasonrecord component.
E
- encodeQueryParameters(Map, QueryFormat) - Static method in class com.soklet.Utilities
-
Encodes decoded query parameters into a raw query string.
- endpointClass() - Method in record class com.soklet.McpCorsContext
-
Returns the value of the
endpointClassrecord component. - endpointClass() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
endpointClassrecord component. - endpointClass() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
endpointClassrecord component. - endpointClass() - Method in record class com.soklet.MetricsCollector.McpEndpointRequestOutcomeKey
-
Returns the value of the
endpointClassrecord component. - endpointClass() - Method in record class com.soklet.MetricsCollector.McpEndpointSessionTerminationKey
-
Returns the value of the
endpointClassrecord component. - endpointClass() - Method in record class com.soklet.MetricsCollector.McpEndpointStreamTerminationKey
-
Returns the value of the
endpointClassrecord component. - endpointPathDeclaration() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
endpointPathDeclarationrecord component. - endpointRegistrationForClass(Class) - Method in interface com.soklet.McpHandlerResolver
-
Resolves MCP endpoint metadata for the given endpoint class.
- ENQUEUED - Enum constant in enum class com.soklet.MetricsCollector.SseEventEnqueueOutcome
-
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.HttpRequestResult
- equals(Object) - Method in class com.soklet.LogEvent
- equals(Object) - Method in class com.soklet.McpRequestResult.StreamOpened
- equals(Object) - Method in class com.soklet.McpToolResult
- equals(Object) - Method in class com.soklet.MultipartField
- equals(Object) - Method in class com.soklet.Request
- 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.SseHandshakeResult.Accepted
- equals(Object) - Method in class com.soklet.SseHandshakeResult.Rejected
- equals(Object) - Method in class com.soklet.SseRequestResult.HandshakeRejected
- equals(Object) - Method in class com.soklet.SseRequestResult.RequestFailed
- equals(Object) - Method in record class com.soklet.McpArray
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpBoolean
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpClientCapabilities
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpClientInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpCorsContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpEndpointRegistration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpJsonRpcError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpJsonRpcRequestId
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpListedResource
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpListResourcesResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpNegotiatedCapabilities
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpNumber
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpObject
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpProgressToken
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpPromptMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpPromptResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpResourceContents
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.soklet.McpSchema
- equals(Object) - Method in record class com.soklet.McpStoredSession
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpString
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.McpTextContent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.HttpServerRouteKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.McpEndpointRequestOutcomeKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.McpEndpointSessionTerminationKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.McpEndpointStreamTerminationKey
-
Indicates whether some other object is "equal to" this one.
- 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.SseCommentRouteDropKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.SseCommentRouteKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.SseEventRouteDropKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.SseEventRouteEnqueueOutcomeKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.SseEventRouteHandshakeFailureKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.SseEventRouteKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.soklet.MetricsCollector.SseEventRouteTerminationKey
-
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.SseConnection.TerminationReason
-
Connection ended due to an error while processing or writing.
- event(String) - Method in class com.soklet.SseEvent.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
Charsetfrom the firstContent-Typeheader, if present and valid. - extractCharsetFromHeaderValue(String) - Static method in class com.soklet.Utilities
-
Extracts the
charset=...parameter from aContent-Typeheader value. - extractContentTypeFromHeaders(Map) - Static method in class com.soklet.Utilities
-
Extracts the media type (without parameters) from the first
Content-Typeheader. - extractContentTypeFromHeaderValue(String) - Static method in class com.soklet.Utilities
-
Extracts the media type (without parameters) from a
Content-Typeheader value. - extractCookiesFromHeaders(Map) - Static method in class com.soklet.Utilities
-
Parses
Cookierequest 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-Languageheader value into a best-effort ordered list ofLocales. - extractMultipartFields(Request) - Method in interface com.soklet.MultipartParser
-
Given a request, detect all HTML form fields with
multipart/form-dataencoding 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
- File(Path, Long, Long) - Constructor for class com.soklet.MarshaledResponseBody.File
- FileChannel(FileChannel, Long, Long, Boolean) - Constructor for class com.soklet.MarshaledResponseBody.FileChannel
- filename(String) - Method in class com.soklet.MultipartField.Builder
- filename(String) - Method in class com.soklet.MultipartField.Copier
- findBySessionId(String) - Method in interface com.soklet.McpSessionStore
-
Loads a session by ID.
- finish() - Method in class com.soklet.CorsPreflightResponse.Copier
- finish() - Method in class com.soklet.CorsResponse.Copier
- finish() - Method in class com.soklet.HttpRequestResult.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.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
CorsAuthorizerapproves a preflight request. - forCorsPreflightRejected(Request, CorsPreflight) - Method in interface com.soklet.ResponseMarshaler
-
Prepares a response for "CORS preflight rejected" scenario when your
CorsAuthorizerdenies a preflight request. - forHead(Request, MarshaledResponse) - Method in interface com.soklet.ResponseMarshaler
-
Prepares a response for an HTTP
HEADrequest. - 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
OPTIONSrequest. - forOptionsSplat(Request) - Method in interface com.soklet.ResponseMarshaler
-
Prepares a response for an HTTP
OPTIONS *(colloquially, "OPTIONSSplat") 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.
- fromAssistantText(String) - Static method in record class com.soklet.McpPromptMessage
-
Creates an assistant-role prompt message from plain text.
- fromBlankSlate() - Static method in class com.soklet.converter.ValueConverterRegistry
-
Acquires a registry without any default converters or automatic enum/reflexive conversions.
- fromBlankSlate() - Static method in interface com.soklet.McpSessionContext
-
Creates an empty session context.
- 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.
- fromBlob(String, String, String) - Static method in record class com.soklet.McpResourceContents
-
Creates a blob-backed resource-contents payload.
- fromClasses(Set) - Static method in interface com.soklet.McpHandlerResolver
-
Acquires a threadsafe
McpHandlerResolverimplementation which discovers MCP endpoints by reflecting over the given endpoint classes. - fromClasses(Set) - Static method in interface com.soklet.ResourceMethodResolver
-
Acquires a threadsafe
ResourceMethodResolverimplementation which locates Resource Methods by examining the providedclasses. - fromClasspathIntrospection() - Static method in interface com.soklet.McpHandlerResolver
-
Acquires a threadsafe
McpHandlerResolverimplementation which discovers MCP endpoints by examining a processor-generated lookup table. - fromClasspathIntrospection() - Static method in interface com.soklet.ResourceMethodResolver
-
Acquires a threadsafe
ResourceMethodResolverimplementation which locates Resource Methods by examining a lookup table of JavaMethoddeclarations that are annotated withGET,POST,SseEventSource, etc. - fromCodeAndMessage(Integer, String) - Static method in record class com.soklet.McpJsonRpcError
-
Creates a JSON-RPC error descriptor from a code and message.
- fromComment(String) - Static method in class com.soklet.SseComment
-
Acquires a
SseCommentinstance with acommentpayload. - fromComponents(HttpMethod, ResourcePathDeclaration, Method, Boolean) - Static method in class com.soklet.ResourceMethod
-
Vends a Resource Method given its unique components.
- fromComponents(String, String, String) - Static method in record class com.soklet.McpListedResource
-
Creates a minimal resource-list entry without optional metadata.
- 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. - fromDescriptionAndMessages(String, McpPromptMessage...) - Static method in record class com.soklet.McpPromptResult
-
Creates a prompt result containing a description and messages.
- fromErrorMessage(String) - Static method in class com.soklet.McpToolResult
-
Creates an error result containing a single text message.
- 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.SameSiteenum value that matches the correspondingSameSiteresponse header value representation (one ofStrict,Lax, orNone- 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.
- fromInMemory() - Static method in interface com.soklet.McpSessionStore
-
Acquires the default in-memory session store using Soklet's default idle timeout.
- fromInMemory(Duration) - Static method in interface com.soklet.McpSessionStore
-
Acquires the default in-memory session store using a caller-supplied idle timeout.
- fromMarshaledResponse(MarshaledResponse) - Static method in class com.soklet.HttpRequestResult
-
Creates a
HttpRequestResultfrom a marshaled response without additional customization. - fromMessages(McpPromptMessage...) - Static method in record class com.soklet.McpPromptResult
-
Creates a prompt result containing only messages.
- fromMethods(Set) - Static method in interface com.soklet.ResourceMethodResolver
-
Acquires a threadsafe
ResourceMethodResolverimplementation which locates Resource Methods by examining the providedmethods. - fromMetricsFormat(MetricsCollector.MetricsFormat) - Static method in class com.soklet.MetricsCollector.SnapshotTextOptions
-
Creates options with the specified format and defaults for all other fields.
- fromNumber(BigDecimal) - Static method in record class com.soklet.McpJsonRpcRequestId
-
Creates a number-backed JSON-RPC request ID.
- fromNumber(BigDecimal) - Static method in record class com.soklet.McpProgressToken
-
Creates a number-backed progress token.
- fromOrigin(HttpMethod, String) - Static method in class com.soklet.Cors
-
Acquires a CORS non-preflight request representation for the given HTTP request data.
- fromOriginAuthorizer(Predicate) - Static method in interface com.soklet.McpCorsAuthorizer
-
Acquires an authorizer backed by an origin-authorization predicate and with credentials disabled by default.
- fromOriginAuthorizer(Predicate, Function) - Static method in interface com.soklet.McpCorsAuthorizer
-
Acquires an authorizer backed by an origin-authorization predicate plus a credentials resolver.
- fromPath(HttpMethod, String) - Static method in class com.soklet.Request
-
Creates a
Requestfrom 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.HttpServer
-
Creates a
HttpServerconfigured with the given port and default settings. - fromPort(Integer) - Static method in interface com.soklet.McpServer
-
Creates a default MCP server bound to the given port.
- fromPort(Integer) - Static method in interface com.soklet.SseServer
-
Creates a
SseServerconfigured with the given port and default settings. - fromPrefix(String) - Static method in interface com.soklet.IdGenerator
-
Acquires a threadsafe
IdGeneratorwith the given prefix. - fromRawUrl(HttpMethod, String) - Static method in class com.soklet.Request
-
Creates a
Requestfrom a raw request target without additional customization. - fromRedirect(RedirectType, String) - Static method in class com.soklet.Response
-
Creates a redirect
Responsewith no additional customization. - fromResources(List) - Static method in record class com.soklet.McpListResourcesResult
-
Creates a non-paginated
resources/listresult. - fromResourcesAndNextCursor(List, String) - Static method in record class com.soklet.McpListResourcesResult
-
Creates a paginated
resources/listresult. - fromResponse(Response) - Static method in class com.soklet.MarshaledResponse
-
Creates a
MarshaledResponsefrom a logicalResponsewithout additional customization. - fromSetCookieHeaderRepresentation(String) - Static method in class com.soklet.ResponseCookie
-
Given a
Set-Cookieheader representation, provide aResponseCookiethat matches it. - fromStatusCode(Integer) - Static method in class com.soklet.MarshaledResponse
-
Creates a
MarshaledResponsewith the given status code and no additional customization. - fromStatusCode(Integer) - Static method in class com.soklet.Response
-
Creates a
Responsewith 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.
- fromString(String) - Static method in record class com.soklet.McpJsonRpcRequestId
-
Creates a string-backed JSON-RPC request ID.
- fromString(String) - Static method in record class com.soklet.McpProgressToken
-
Creates a string-backed progress token.
- FromStringValueConverter<T> - Class in com.soklet.converter
-
Convenience superclass which provides default implementations of
ValueConvertermethods that convert fromStringto other types. - FromStringValueConverter() - Constructor for class com.soklet.converter.FromStringValueConverter
-
Ensures that the 'from' type of this converter is
String. - fromText(String) - Static method in record class com.soklet.McpTextContent
-
Creates a text content block.
- fromText(String, String, String) - Static method in record class com.soklet.McpResourceContents
-
Creates a text-backed resource-contents payload.
- fromUserText(String) - Static method in record class com.soklet.McpPromptMessage
-
Creates a user-role prompt message from plain text.
- fromValueConverterRegistry(ValueConverterRegistry) - Static method in interface com.soklet.RequestBodyMarshaler
-
Acquires a threadsafe
RequestBodyMarshalerimplementation which converts request body data using the providedValueConverterRegistry. - fromValues(Map) - Static method in interface com.soklet.McpSessionContext
-
Creates a session context from the provided values.
- fromWhitelistAuthorizer(Function) - Static method in interface com.soklet.CorsAuthorizer
-
Acquires a threadsafe
CorsAuthorizerconfigured to accept only those cross-domain requests whoseOriginis allowed by the providedwhitelistAuthorizerfunction. - fromWhitelistAuthorizer(Function, Function) - Static method in interface com.soklet.CorsAuthorizer
-
Acquires a threadsafe
CorsAuthorizerconfigured to accept only those cross-domain requests whoseOriginis allowed by the providedwhitelistAuthorizerfunction. - fromWhitelistedOrigins(Set) - Static method in interface com.soklet.CorsAuthorizer
-
Acquires a threadsafe
CorsAuthorizerconfigured to accept only those cross-domain requests whoseOriginmatches a value in the provided set ofwhitelistedOrigins. - fromWhitelistedOrigins(Set) - Static method in interface com.soklet.McpCorsAuthorizer
-
Acquires an authorizer that allows only the provided normalized origins and disables credentials by default.
- fromWhitelistedOrigins(Set, Function) - Static method in interface com.soklet.CorsAuthorizer
-
Acquires a threadsafe
CorsAuthorizerconfigured to accept only those cross-domain requests whoseOriginmatches a value in the provided set ofwhitelistedOrigins. - fromWhitelistedOrigins(Set, Function) - Static method in interface com.soklet.McpCorsAuthorizer
-
Acquires an authorizer that allows only the provided normalized origins and delegates credential behavior per origin.
- 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
ValueConverterthat matches the 'from' and 'to' type references specified. - get(String) - Method in record class com.soklet.McpObject
-
Retrieves a named member from the object.
- get(String) - Method in interface com.soklet.McpSessionContext
-
Retrieves a stored session value without type conversion.
- get(String, Class) - Method in interface com.soklet.McpSessionContext
-
Retrieves a stored session value with an assignability check.
- get(Type, Type) - Method in class com.soklet.converter.ValueConverterRegistry
-
Obtain a
ValueConverterthat matches the 'from' and 'to' types specified. - GET - Enum constant in enum class com.soklet.HttpMethod
-
The HTTP
GETrequest method. - GET - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to support the HTTP
GETmethod. - getAccessControlAllowCredentials() - Method in class com.soklet.CorsPreflightResponse
-
Value for the
Access-Control-Allow-Credentialsresponse header. - getAccessControlAllowCredentials() - Method in class com.soklet.CorsResponse
-
Value for the
Access-Control-Allow-Credentialsresponse header. - getAccessControlAllowHeaders() - Method in class com.soklet.CorsPreflightResponse
-
Set of values for the
Access-Control-Allow-Headersresponse header. - getAccessControlAllowMethods() - Method in class com.soklet.CorsPreflightResponse
-
Set of values for the
Access-Control-Allow-Methodsresponse header. - getAccessControlAllowOrigin() - Method in class com.soklet.CorsPreflightResponse
-
Value for the
Access-Control-Allow-Originresponse header. - getAccessControlAllowOrigin() - Method in class com.soklet.CorsResponse
-
Value for the
Access-Control-Allow-Originresponse header. - getAccessControlExposeHeaders() - Method in class com.soklet.CorsResponse
-
Value for the
Access-Control-Expose-Headersresponse header. - getAccessControlMaxAge() - Method in class com.soklet.CorsPreflightResponse
-
Value for the
Access-Control-Max-Ageresponse header. - getAccessControlRequestHeaders() - Method in class com.soklet.CorsPreflight
-
Returns the set of values for the HTTP
Access-Control-Request-Headersrequest header. - getAccessControlRequestMethod() - Method in class com.soklet.CorsPreflight
-
The HTTP
Access-Control-Request-Methodrequest header value. - getActiveMcpSessions() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns the number of active MCP sessions.
- getActiveMcpStreams() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns the number of active MCP streams.
- 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.
- getArguments() - Method in interface com.soklet.McpPromptHandlerContext
-
Provides the prompt arguments object for the current request.
- getArguments() - Method in interface com.soklet.McpToolHandlerContext
-
Provides the tool arguments object for the current request.
- getArgumentsSchema() - Method in interface com.soklet.McpPromptHandler
-
Provides the argument schema used for validation and prompt argument advertisement.
- getBody() - Method in class com.soklet.MarshaledResponse
-
The finalized 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 aStringencoded using the client-specified character set perRequest.getCharset(). - getBodyLength() - Method in class com.soklet.MarshaledResponse
-
The number of bytes this response body will write.
- 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.
- getBuffer() - Method in class com.soklet.MarshaledResponseBody.ByteBuffer
-
The read-only buffer slice backing this body.
- getBytes() - Method in class com.soklet.MarshaledResponseBody.Bytes
-
The byte array backing this body.
- getChannel() - Method in class com.soklet.MarshaledResponseBody.FileChannel
-
The file channel backing this body.
- 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-Typeheader value. - getClientCapabilities() - Method in interface com.soklet.McpInitializationContext
-
Provides the client capabilities sent during initialization.
- getClientCapabilities() - Method in interface com.soklet.McpPromptHandlerContext
-
Provides the negotiated client capabilities for the session.
- getClientCapabilities() - Method in interface com.soklet.McpToolHandlerContext
-
Provides the negotiated client capabilities for the session.
- getClientContext() - Method in interface com.soklet.SseConnection
-
Returns the connection-specific context as provided by an accepted handshake.
- getClientContext() - Method in class com.soklet.SseHandshakeResult.Accepted
-
Returns the client context, if specified, for this accepted Server-Sent Event handshake.
- getClientCount() - Method in interface com.soklet.SseBroadcaster
-
Approximately how many clients are listening to this broadcaster's
ResourcePath? - getClientInfo() - Method in interface com.soklet.McpInitializationContext
-
Provides optional client metadata sent during initialization.
- getClientInitializer() - Method in class com.soklet.SseHandshakeResult.Accepted
-
Returns the client initialization function, if specified, for this accepted Server-Sent Event handshake.
- getCloseOnComplete() - Method in class com.soklet.MarshaledResponseBody.FileChannel
-
Whether Soklet should close this caller-supplied channel after the response completes or fails.
- getComment() - Method in class com.soklet.SseComment
-
The comment payload.
- getCommentType() - Method in class com.soklet.SseComment
-
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? - getContent() - Method in class com.soklet.McpToolResult
-
Provides the text content blocks returned by the tool.
- getContentType() - Method in class com.soklet.MultipartField
-
The content type for this field, if available (for example,
image/pngfor an image file). - getContentType() - Method in class com.soklet.Request
-
The
Content-Typeheader 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.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.
- getCookies() - Method in class com.soklet.SseHandshakeResult.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).
- getCors() - Method in class com.soklet.Request
-
Non-preflight CORS request data.
- getCorsAuthorizer() - Method in interface com.soklet.McpServer
-
Provides the MCP CORS authorizer.
- getCorsAuthorizer() - Method in class com.soklet.SokletConfig
-
How Soklet handles Cross-Origin Resource Sharing (CORS).
- getCorsPreflight() - Method in class com.soklet.Request
-
CORS preflight-related request data.
- getCorsPreflightResponse() - Method in class com.soklet.HttpRequestResult
-
The CORS preflight logical response, if applicable for the request.
- getCount() - Method in class com.soklet.MarshaledResponseBody.File
-
The number of file bytes to write.
- getCount() - Method in class com.soklet.MarshaledResponseBody.FileChannel
-
The number of channel bytes to write.
- getCount() - Method in class com.soklet.MetricsCollector.HistogramSnapshot
-
Total number of recorded values.
- getCursor() - Method in interface com.soklet.McpListResourcesContext
-
Provides the pagination cursor supplied by the client.
- getData() - Method in class com.soklet.MultipartField
-
The binary value of this field, if available.
- getData() - Method in class com.soklet.SseEvent
-
The
datapayload for this Server-Sent Event. - getDataAsString() - Method in class com.soklet.MultipartField
-
The value of this field represented as a string, if available.
- getDescription() - Method in interface com.soklet.McpPromptHandler
-
Provides the MCP prompt description.
- getDescription() - Method in interface com.soklet.McpResourceHandler
-
Provides optional description metadata for the resource.
- getDescription() - Method in interface com.soklet.McpToolHandler
-
Provides the MCP tool description.
- getDomain() - Method in class com.soklet.ResponseCookie
-
Gets the cookie's
Domainvalue, if present. - getEndpointClass() - Method in interface com.soklet.McpAdmissionContext
-
Provides the resolved MCP endpoint class.
- getEndpointClass() - Method in interface com.soklet.McpRequestContext
-
Provides the resolved endpoint class for the current request.
- getEndpointClass() - Method in interface com.soklet.McpStructuredContentContext
-
Provides the endpoint class that produced the structured content.
- getEndpointPathParameter(String) - Method in interface com.soklet.McpInitializationContext
-
Retrieves an endpoint path parameter as a string.
- getEndpointPathParameter(String) - Method in interface com.soklet.McpPromptHandlerContext
-
Retrieves an endpoint path parameter as a string.
- getEndpointPathParameter(String) - Method in interface com.soklet.McpResourceHandlerContext
-
Retrieves an endpoint path parameter as a string.
- getEndpointPathParameter(String) - Method in interface com.soklet.McpResourceListHandlerContext
-
Retrieves an endpoint path parameter as a string.
- getEndpointPathParameter(String) - Method in interface com.soklet.McpToolHandlerContext
-
Retrieves an endpoint path parameter as a string.
- getEndpointPathParameter(String, Class) - Method in interface com.soklet.McpInitializationContext
-
Retrieves an endpoint path parameter using a Soklet value conversion.
- getEndpointPathParameter(String, Class) - Method in interface com.soklet.McpPromptHandlerContext
-
Retrieves an endpoint path parameter using a Soklet value conversion.
- getEndpointPathParameter(String, Class) - Method in interface com.soklet.McpResourceHandlerContext
-
Retrieves an endpoint path parameter using a Soklet value conversion.
- getEndpointPathParameter(String, Class) - Method in interface com.soklet.McpResourceListHandlerContext
-
Retrieves an endpoint path parameter using a Soklet value conversion.
- getEndpointPathParameter(String, Class) - Method in interface com.soklet.McpToolHandlerContext
-
Retrieves an endpoint path parameter using a Soklet value conversion.
- getEndpointRegistrations() - Method in interface com.soklet.McpHandlerResolver
-
Vends the set of all registered MCP endpoint metadata in the system.
- getEstablishedAt() - Method in interface com.soklet.SseConnection
-
Returns the moment at which this connection was established.
- getEvent() - Method in class com.soklet.SseEvent
-
The
eventvalue for this Server-Sent Event. - getExpires() - Method in class com.soklet.ResponseCookie
-
Gets the cookie's
Expiresvalue, 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-urlencodedform 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. - getHandlerResolver() - Method in interface com.soklet.McpServer
-
Provides the MCP handler resolver.
- 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, orNone. - 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.
- getHeaders() - Method in class com.soklet.SseHandshakeResult.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).
- 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 interface com.soklet.McpAdmissionContext
-
Provides the HTTP method for the MCP transport 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
HttpOnlyflag, 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.
- getHttpRequestResult() - Method in interface com.soklet.McpRequestResult
-
Provides the low-level Soklet request result associated with the simulated MCP request.
- getHttpRequestResult() - Method in class com.soklet.McpRequestResult.ResponseCompleted
- getHttpRequestResult() - Method in class com.soklet.McpRequestResult.StreamOpened
- getHttpRequestResult() - Method in class com.soklet.SseRequestResult.HandshakeAccepted
-
The initial result of the handshake, as written back to the client (note that the connection remains open).
- getHttpRequestResult() - Method in class com.soklet.SseRequestResult.HandshakeRejected
-
The result of the handshake, as written back to the client (the connection is then closed).
- getHttpRequestResult() - Method in class com.soklet.SseRequestResult.RequestFailed
-
The result of the handshake, as written back to the client (the connection is then closed).
- getHttpResponseBodyBytes() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns HTTP response body size histograms keyed by server route and status class.
- getHttpServer() - Method in class com.soklet.SokletConfig
-
The HTTP server managed by Soklet, if configured.
- 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.SseEvent
-
The
idfor this Server-Sent Event, used by clients to populate theLast-Event-IDrequest header should a reconnect occur. - getIdGenerator() - Method in interface com.soklet.McpServer
-
Provides the generator used for MCP session IDs.
- getIncludeZeroBuckets() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions
-
Whether zero-count buckets should be emitted.
- getInputSchema() - Method in interface com.soklet.McpToolHandler
-
Provides the input schema used for framework validation and client advertisement.
- getInstanceProvider() - Method in class com.soklet.SokletConfig
-
How Soklet will perform instance creation.
- getJsonRpcMethod() - Method in interface com.soklet.McpAdmissionContext
-
Provides the JSON-RPC method name when the request is a parsed MCP
POST. - getJsonRpcMethod() - Method in interface com.soklet.McpRequestContext
-
Provides the JSON-RPC method name.
- getJsonRpcRequestId() - Method in interface com.soklet.McpAdmissionContext
-
Provides the parsed JSON-RPC request ID for request-style MCP operations.
- getJsonRpcRequestId() - Method in interface com.soklet.McpRequestContext
-
Provides the JSON-RPC request ID for request-style operations.
- getLabels() - Method in class com.soklet.MetricsCollector.SnapshotTextOptions.MetricSample
-
The label set for this sample.
- getLanguageRanges() - Method in class com.soklet.Request
-
Locale.LanguageRangeinformation for this request as specified byAccept-Languageheader value[s]. - getLength() - Method in class com.soklet.MarshaledResponseBody.ByteBuffer
- getLength() - Method in class com.soklet.MarshaledResponseBody.Bytes
- getLength() - Method in class com.soklet.MarshaledResponseBody.File
- getLength() - Method in class com.soklet.MarshaledResponseBody.FileChannel
- getLength() - Method in interface com.soklet.MarshaledResponseBody
-
The number of bytes this body will write.
- getLifecycleObserver() - Method in class com.soklet.SokletConfig
-
How Soklet will observe server and request lifecycle events.
- getListResourcesContext() - Method in interface com.soklet.McpResourceListHandlerContext
-
Provides the list-specific request context.
- getLocales() - Method in class com.soklet.Request
-
Locale information for this request as specified by
Accept-Languageheader 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.HttpRequestResult
-
The final representation of the response to be written over the wire.
- getMarshaledResponse() - Method in class com.soklet.LogEvent
-
The response associated with this log event, if available.
- 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-Agevalue expressed as aDuration, if present. - getMcpConnectionsAccepted() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns the total number of accepted MCP connections.
- getMcpConnectionsRejected() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns the total number of rejected MCP connections.
- getMcpRequestDurations() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns MCP request duration histograms keyed by endpoint, JSON-RPC method, and outcome.
- getMcpRequestReadFailures() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns MCP request read failure counters keyed by failure reason.
- getMcpRequestRejections() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns MCP request rejection counters keyed by rejection reason.
- getMcpRequests() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns MCP request outcome counters keyed by endpoint, JSON-RPC method, and outcome.
- getMcpServer() - Method in class com.soklet.SokletConfig
-
The MCP server managed by Soklet, if configured.
- getMcpSessionDurations() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns MCP session duration histograms keyed by endpoint and termination reason.
- getMcpStreamDurations() - Method in class com.soklet.MetricsCollector.Snapshot
-
Returns MCP stream duration histograms keyed by endpoint and termination reason.
- 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.
- getMimeType() - Method in interface com.soklet.McpResourceHandler
-
Provides the MIME type returned by this resource handler.
- 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-datafields provided by the client for this request. - getName() - Method in exception class com.soklet.exception.IllegalRequestCookieException
- getName() - Method in interface com.soklet.McpPromptHandler
-
Provides the MCP prompt name.
- getName() - Method in interface com.soklet.McpResourceHandler
-
Provides the MCP resource name.
- getName() - Method in interface com.soklet.McpToolHandler
-
Provides the MCP tool name.
- 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.
- getNegotiatedCapabilities() - Method in interface com.soklet.McpRequestContext
-
Provides the negotiated server capabilities for the request's session.
- getOffset() - Method in class com.soklet.MarshaledResponseBody.File
-
The zero-based file offset from which response bytes should be written.
- getOffset() - Method in class com.soklet.MarshaledResponseBody.FileChannel
-
The zero-based channel offset from which response bytes should be written.
- getOperationType() - Method in interface com.soklet.McpAdmissionContext
-
Provides the high-level operation type when the request maps to a known MCP operation.
- getOperationType() - Method in interface com.soklet.McpRequestContext
-
Provides the high-level MCP operation type.
- getOrigin() - Method in class com.soklet.Cors
-
The HTTP
Originheader value for this request. - getOrigin() - Method in class com.soklet.CorsPreflight
-
Returns the HTTP
Originrequest 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
Partitionedflag. - getPath() - Method in class com.soklet.MarshaledResponseBody.File
-
The file path backing this body.
- 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
Pathvalue, 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
Priorityvalue, if present. - getProgressReporter() - Method in interface com.soklet.McpToolCallContext
-
Provides the request-scoped progress reporter when the call negotiated progress support.
- getProgressToken() - Method in interface com.soklet.McpProgressReporter
-
Provides the progress token associated with the current request.
- getProtocolVersion() - Method in interface com.soklet.McpInitializationContext
-
Provides the negotiated MCP protocol version for this initialization flow.
- getProtocolVersion() - Method in interface com.soklet.McpRequestContext
-
Provides the negotiated protocol version for the request's session.
- 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.McpAdmissionContext
-
Provides the transport request being evaluated for admission.
- getRequest() - Method in interface com.soklet.McpInitializationContext
-
Provides the transport request that carried the
initializecall. - getRequest() - Method in interface com.soklet.McpRequestContext
-
Provides the transport request being handled.
- getRequest() - Method in interface com.soklet.SseConnection
-
The request made by the client to the Event Source Method which accepted the SSE handshake and established the connection.
- getRequestAdmissionPolicy() - Method in interface com.soklet.McpServer
-
Provides the request admission policy.
- getRequestBodyMarshaler() - Method in class com.soklet.SokletConfig
-
How Soklet will marshal request bodies to Java types.
- getRequestContext() - Method in interface com.soklet.McpListResourcesContext
-
Provides the underlying request context for the current
resources/listcall. - getRequestContext() - Method in interface com.soklet.McpPromptHandlerContext
-
Provides the underlying request context.
- getRequestContext() - Method in interface com.soklet.McpResourceHandlerContext
-
Provides the underlying request context.
- getRequestContext() - Method in interface com.soklet.McpToolCallContext
-
Provides the underlying request context.
- getRequestCookieName() - Method in exception class com.soklet.exception.MissingRequestCookieException
- getRequestedUri() - Method in interface com.soklet.McpResourceHandlerContext
-
Provides the concrete resource URI requested by the client.
- 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 interface com.soklet.McpServer
-
Provides the request interceptor.
- getRequestInterceptor() - Method in class com.soklet.SokletConfig
-
How Soklet will perform custom behavior during request handling.
- getResourceMethod() - Method in class com.soklet.HttpRequestResult
-
The Resource Method that handled the request, if available.
- getResourceMethod() - Method in class com.soklet.LogEvent
-
The Resource Method associated with this log event, if available.
- getResourceMethod() - Method in interface com.soklet.SseConnection
-
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
ResourcePathrepresentation ofRequest.getPath(). - getResourcePath() - Method in interface com.soklet.SseBroadcaster
-
The runtime Resource Path with which this broadcaster is associated.
- getResourcePath() - Method in interface com.soklet.SseUnicaster
-
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.HttpRequestResult
-
The logical response, determined by the return value of the Resource Method (if available).
- getResponse() - Method in class com.soklet.SseHandshakeResult.Rejected
-
The logical response to send to the client for this handshake rejection.
- getResponseMarshaler() - Method in interface com.soklet.McpServer
-
Provides the response marshaler used for tool structured content.
- getResponseMarshaler() - Method in class com.soklet.SokletConfig
- getRetry() - Method in class com.soklet.SseEvent
-
The
retryduration for this Server-Sent Event. - GETs - Annotation Interface in com.soklet.annotation
-
Allows multiple
GETannotations to be applied to the same Resource Method. - getSameSite() - Method in class com.soklet.ResponseCookie
-
Gets the cookie's
SameSitevalue, if present. - getSecure() - Method in class com.soklet.ResponseCookie
-
Gets the cookie's
Secureflag, if present. - getSessionContext() - Method in interface com.soklet.McpPromptHandlerContext
-
Provides the current session context.
- getSessionContext() - Method in interface com.soklet.McpRequestContext
-
Provides the current session context for the request's session.
- getSessionContext() - Method in interface com.soklet.McpResourceHandlerContext
-
Provides the current session context.
- getSessionContext() - Method in interface com.soklet.McpResourceListHandlerContext
-
Provides the current session context.
- getSessionContext() - Method in interface com.soklet.McpStructuredContentContext
-
Provides the session context active for the tool call.
- getSessionContext() - Method in interface com.soklet.McpToolHandlerContext
-
Provides the current session context.
- getSessionId() - Method in interface com.soklet.McpAdmissionContext
-
Provides the requested MCP session ID when one is present on the transport request.
- getSessionId() - Method in interface com.soklet.McpRequestContext
-
Provides the MCP session ID associated with the request.
- getSessionStore() - Method in interface com.soklet.McpServer
-
Provides the session store.
- 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.
- getSseHandshakeResult() - Method in class com.soklet.SseRequestResult.HandshakeAccepted
-
Gets the data provided when the handshake was accepted by the
SseEventSource-annotated Resource Method. - getSseHandshakeResult() - Method in class com.soklet.SseRequestResult.HandshakeRejected
-
Gets the data provided when the handshake was explicitly rejected by the
SseEventSource-annotated Resource Method. - 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.
- getSseServer() - Method in class com.soklet.SokletConfig
-
The SSE server managed by Soklet, if configured.
- 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.
- getStructuredContent() - Method in class com.soklet.McpToolResult
-
Provides optional app-owned structured content to be marshaled into the MCP response.
- 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.
- getTitle() - Method in interface com.soklet.McpPromptHandler
-
Provides optional prompt title metadata.
- getToolCallContext() - Method in interface com.soklet.McpStructuredContentContext
-
Provides the tool-call context for the current structured content marshaling operation.
- getToolCallContext() - Method in interface com.soklet.McpToolHandlerContext
-
Provides the tool-call-specific request context.
- getToolName() - Method in interface com.soklet.McpStructuredContentContext
-
Provides the tool name whose structured content is being marshaled.
- 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?
- getUri() - Method in interface com.soklet.McpResourceHandler
-
Provides the resource URI or URI template handled by this resource.
- getUriParameter(String) - Method in interface com.soklet.McpResourceHandlerContext
-
Retrieves a URI-template parameter as a string.
- getUriParameter(String, Class) - Method in interface com.soklet.McpResourceHandlerContext
-
Retrieves a URI-template parameter using a Soklet value conversion.
- 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
- getVarargsComponent() - Method in class com.soklet.ResourcePathDeclaration
-
Gets the
ResourcePathDeclaration.ComponentType.VARARGScomponent in this declaration, if any.
H
- handle(McpPromptHandlerContext) - Method in interface com.soklet.McpPromptHandler
-
Handles an MCP
prompts/getrequest. - handle(McpResourceHandlerContext) - Method in interface com.soklet.McpResourceHandler
-
Handles an MCP
resources/readrequest. - handle(McpResourceListHandlerContext) - Method in interface com.soklet.McpResourceListHandler
- handle(McpToolHandlerContext) - Method in interface com.soklet.McpToolHandler
-
Handles an MCP
tools/callrequest. - 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, "OPTIONSSplat") request. - handle(Request, CorsPreflight) - Method in interface com.soklet.ResponseMarshaler.Builder.CorsPreflightRejectedHandler
-
Prepares a response for "CORS preflight rejected" scenario when your
CorsAuthorizerdenies 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
CorsAuthorizerapproves 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
HEADrequest. - 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
OPTIONSrequest. - handleError(Throwable, McpRequestContext) - Method in interface com.soklet.McpEndpoint
-
Maps a non-tool MCP exception to a JSON-RPC error.
- handleRequest(Request, Consumer) - Method in interface com.soklet.HttpServer.RequestHandler
-
Callback to be invoked by a
HttpServerimplementation after it has received an HTTP request but prior to writing an HTTP response. - handleRequest(Request, Consumer) - Method in interface com.soklet.McpServer.RequestHandler
-
Handles an MCP transport request.
- handleRequest(Request, Consumer) - Method in interface com.soklet.SseServer.RequestHandler
-
Callback to be invoked by a
SseServerimplementation after it has received a Server-Sent Event Source HTTP request but prior to writing initial data to the HTTP response. - handlerResolver(McpHandlerResolver) - Method in class com.soklet.McpServer.Builder
-
Sets the handler resolver.
- handleToolError(Throwable, McpToolCallContext) - Method in interface com.soklet.McpEndpoint
-
Maps a thrown tool exception to an MCP tool result.
- HANDSHAKE_REJECTED - Enum constant in enum class com.soklet.SseConnection.HandshakeFailureReason
-
The SSE handshake completed with a non-accepted result.
- HANDSHAKE_TIMEOUT - Enum constant in enum class com.soklet.SseConnection.HandshakeFailureReason
-
The SSE handshake did not complete in time.
- handshakeFailureReason() - Method in record class com.soklet.MetricsCollector.SseEventRouteHandshakeFailureKey
-
Returns the value of the
handshakeFailureReasonrecord component. - 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.HttpRequestResult
- hashCode() - Method in class com.soklet.LogEvent
- hashCode() - Method in record class com.soklet.McpArray
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpBoolean
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpClientCapabilities
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpClientInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpCorsContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpEndpointRegistration
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpJsonRpcError
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpJsonRpcRequestId
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpListedResource
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpListResourcesResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpNegotiatedCapabilities
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpNumber
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpObject
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpProgressToken
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpPromptMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpPromptResult
-
Returns a hash code value for this object.
- hashCode() - Method in class com.soklet.McpRequestResult.StreamOpened
- hashCode() - Method in record class com.soklet.McpResourceContents
-
Returns a hash code value for this object.
- hashCode() - Method in class com.soklet.McpSchema
- hashCode() - Method in record class com.soklet.McpStoredSession
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpString
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.McpTextContent
-
Returns a hash code value for this object.
- hashCode() - Method in class com.soklet.McpToolResult
- hashCode() - Method in record class com.soklet.MetricsCollector.HttpServerRouteKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.McpEndpointRequestOutcomeKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.McpEndpointSessionTerminationKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.McpEndpointStreamTerminationKey
-
Returns a hash code value for this object.
- 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.SseCommentRouteDropKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.SseCommentRouteKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.SseEventRouteDropKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.SseEventRouteEnqueueOutcomeKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.SseEventRouteHandshakeFailureKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.SseEventRouteKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.soklet.MetricsCollector.SseEventRouteTerminationKey
-
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.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.SseHandshakeResult.Accepted
- hashCode() - Method in class com.soklet.SseHandshakeResult.Rejected
- hashCode() - Method in class com.soklet.SseRequestResult.HandshakeRejected
- hashCode() - Method in class com.soklet.SseRequestResult.RequestFailed
- hasResourceListHandler() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
hasResourceListHandlerrecord component. - HEAD - Enum constant in enum class com.soklet.HttpMethod
-
The HTTP
HEADrequest method. - HEAD - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to support the HTTP
HEADmethod. - headers(Map) - Method in class com.soklet.MarshaledResponse.Copier
- 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(Map) - Method in class com.soklet.SseHandshakeResult.Accepted.Builder
-
Specifies custom response headers to be sent with the handshake.
- 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
HEADannotations to be applied to the same Resource Method. - HEARTBEAT - Enum constant in enum class com.soklet.SseComment.CommentType
-
Keep-alive/heartbeat comment.
- heartbeatInstance() - Static method in class com.soklet.SseComment
-
Acquires a shared heartbeat comment instance.
- heartbeatInterval(Duration) - Method in class com.soklet.McpServer.Builder
-
Sets the heartbeat interval for long-lived MCP event streams.
- heartbeatInterval(Duration) - Method in class com.soklet.SseServer.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.HttpServer.Builder
- host(String) - Method in class com.soklet.McpServer.Builder
-
Sets the host to bind, or
nullto use the server default. - host(String) - Method in class com.soklet.SseServer.Builder
- HTTP_100 - Enum constant in enum class com.soklet.StatusCode
-
This interim response indicates that the client should continue the request or ignore the response if the request is already finished.
- HTTP_101 - Enum constant in enum class com.soklet.StatusCode
-
This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to.
- HTTP_102 - Enum constant in enum class com.soklet.StatusCode
-
This code was used in WebDAV contexts to indicate that a request has been received by the server, but no status was available at the time of the response.
- HTTP_103 - Enum constant in enum class com.soklet.StatusCode
-
This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources.
- HTTP_200 - Enum constant in enum class com.soklet.StatusCode
-
The request succeeded.
- HTTP_201 - Enum constant in enum class com.soklet.StatusCode
-
The request succeeded, and a new resource was created as a result.
- HTTP_202 - Enum constant in enum class com.soklet.StatusCode
-
The request has been received but not yet acted upon.
- HTTP_203 - Enum constant in enum class com.soklet.StatusCode
-
This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy.
- HTTP_204 - Enum constant in enum class com.soklet.StatusCode
-
There is no content to send for this request, but the headers are useful.
- HTTP_205 - Enum constant in enum class com.soklet.StatusCode
-
Tells the user agent to reset the document which sent this request.
- HTTP_206 - Enum constant in enum class com.soklet.StatusCode
-
This response code is used in response to a range request when the client has requested a part or parts of a resource.
- HTTP_207 - Enum constant in enum class com.soklet.StatusCode
-
(WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate.
- HTTP_208 - Enum constant in enum class com.soklet.StatusCode
-
(WebDAV) Used inside a
<dav:propstat>response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection. - HTTP_226 - Enum constant in enum class com.soklet.StatusCode
-
(HTTP Delta encoding) The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
- HTTP_300 - Enum constant in enum class com.soklet.StatusCode
-
In agent-driven content negotiation, the request has more than one possible response and the user agent or user should choose one of them.
- HTTP_301 - Enum constant in enum class com.soklet.StatusCode
-
The URL of the requested resource has been changed permanently.
- HTTP_301_MOVED_PERMANENTLY - Enum constant in enum class com.soklet.RedirectType
-
Represents
301 Moved Permanently. - HTTP_302 - Enum constant in enum class com.soklet.StatusCode
-
This response code means that the URI of requested resource has been changed temporarily.
- HTTP_302_FOUND - Enum constant in enum class com.soklet.RedirectType
-
Represents
302 Found. - HTTP_303 - Enum constant in enum class com.soklet.StatusCode
-
The server sent this response to direct the client to get the requested resource at another URI with a GET request.
- HTTP_303_SEE_OTHER - Enum constant in enum class com.soklet.RedirectType
-
Represents
303 See Other. - HTTP_304 - Enum constant in enum class com.soklet.StatusCode
-
This is used for caching purposes.
- HTTP_305 - Enum constant in enum class com.soklet.StatusCode
-
Deprecated.
- HTTP_306 - Enum constant in enum class com.soklet.StatusCode
-
Deprecated.
- HTTP_307 - Enum constant in enum class com.soklet.StatusCode
-
The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request.
- HTTP_307_TEMPORARY_REDIRECT - Enum constant in enum class com.soklet.RedirectType
-
Represents
307 Temporary Redirect. - HTTP_308 - Enum constant in enum class com.soklet.StatusCode
-
This means that the resource is now permanently located at another URI, specified by the Location response header.
- HTTP_308_PERMANENT_REDIRECT - Enum constant in enum class com.soklet.RedirectType
-
Represents
308 Permanent Redirect. - HTTP_400 - Enum constant in enum class com.soklet.StatusCode
-
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
- HTTP_401 - Enum constant in enum class com.soklet.StatusCode
-
Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
- HTTP_402 - Enum constant in enum class com.soklet.StatusCode
-
The initial purpose of this code was for digital payment systems, however this status code is rarely used and no standard convention exists.
- HTTP_403 - Enum constant in enum class com.soklet.StatusCode
-
The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.
- HTTP_404 - Enum constant in enum class com.soklet.StatusCode
-
The server cannot find the requested resource.
- HTTP_405 - Enum constant in enum class com.soklet.StatusCode
-
The request method is known by the server but is not supported by the target resource.
- HTTP_406 - Enum constant in enum class com.soklet.StatusCode
-
This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent.
- HTTP_407 - Enum constant in enum class com.soklet.StatusCode
-
This is similar to
401 Unauthorizedbut 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
-
HttpServer 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
Rangeheader 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() - Method in record class com.soklet.McpCorsContext
-
Returns the value of the
httpMethodrecord component. - 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.
- HttpRequestResult - Class in com.soklet
-
Encapsulates the results of a request that would normally be handled by your
HttpServer(both logical response and bytes to be sent over the wire), used for integration testing viaSimulator.performHttpRequest(Request). - HttpRequestResult.Builder - Class in com.soklet
-
Builder used to construct instances of
HttpRequestResultviaHttpRequestResult.withMarshaledResponse(MarshaledResponse). - HttpRequestResult.Copier - Class in com.soklet
-
Builder used to copy instances of
HttpRequestResultviaHttpRequestResult.copy(). - httpResponseBodyBytes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets HTTP response body size histograms keyed by server route and status class.
- httpServer(HttpServer) - Method in class com.soklet.SokletConfig.Builder
- httpServer(HttpServer) - Method in class com.soklet.SokletConfig.Copier
- HttpServer - Interface in com.soklet
-
Contract for HTTP server implementations that are designed to be managed by a
Sokletinstance. - HttpServer.Builder - Class in com.soklet
-
Builder used to construct a standard implementation of
HttpServer. - HttpServer.RequestHandler - Interface in com.soklet
-
Request/response processing contract for
HttpServerimplementations. - HttpServerRouteKey(HttpMethod, MetricsCollector.RouteType, ResourcePathDeclaration) - Constructor for record class com.soklet.MetricsCollector.HttpServerRouteKey
-
Creates an instance of a
HttpServerRouteKeyrecord class. - HttpServerRouteStatusKey(HttpMethod, MetricsCollector.RouteType, ResourcePathDeclaration, String) - Constructor for record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Creates an instance of a
HttpServerRouteStatusKeyrecord 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.SseEvent.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.HttpServer.Builder
- idGenerator(IdGenerator) - Method in class com.soklet.SseServer.Builder
- idGenerator(IdGenerator) - Method in class com.soklet.McpServer.Builder
-
Sets the generator used for MCP session IDs.
- IdGenerator<T> - Interface in com.soklet
- IDLE_TIMEOUT - Enum constant in enum class com.soklet.McpSessionTerminationReason
- 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
- INITIALIZATION_FAILED - Enum constant in enum class com.soklet.McpSessionTerminationReason
- initialize(McpInitializationContext, McpSessionContext) - Method in interface com.soklet.McpEndpoint
-
Initializes a newly-created MCP session.
- initialize(SokletConfig, HttpServer.RequestHandler) - Method in interface com.soklet.HttpServer
-
The
Sokletinstance which manages thisHttpServerwill invoke this method exactly once at initialization time - this allowsSokletto "talk" to yourHttpServer. - initialize(SokletConfig, McpServer.RequestHandler) - Method in interface com.soklet.McpServer
-
Initializes the server with Soklet-owned infrastructure.
- initialize(SokletConfig, SseServer.RequestHandler) - Method in interface com.soklet.SseServer
- INITIALIZE - Enum constant in enum class com.soklet.McpOperationType
- initialized() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
initializedrecord component. - initializedNotificationReceived() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
initializedNotificationReceivedrecord component. - INSTANCE - Enum constant in enum class com.soklet.McpNull
- 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.
- instructions() - Element in annotation interface com.soklet.annotation.McpServerEndpoint
-
Declares optional server instructions metadata.
- instructions() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
instructionsrecord component. - INTEGER - Enum constant in enum class com.soklet.McpType
- interceptRequest(McpRequestContext, McpHandlerInvocation) - Method in interface com.soklet.McpRequestInterceptor
-
Intercepts an MCP JSON-RPC request before Soklet dispatches it to framework or application logic.
- 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.McpSessionTerminationReason
- INTERNAL_ERROR - Enum constant in enum class com.soklet.McpStreamTerminationReason
- 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.SseConnection.HandshakeFailureReason
-
An unexpected internal error occurred while establishing the SSE connection.
- invoke() - Method in interface com.soklet.McpHandlerInvocation
-
Invokes the downstream MCP handling logic.
- isClosed() - Method in class com.soklet.McpRequestResult.StreamOpened
-
Indicates whether the simulated stream has been closed.
- isContentTooLarge() - Method in class com.soklet.Request
-
Was this request too large for the server to handle?
- isError() - Method in class com.soklet.McpToolResult
-
Indicates whether the tool result represents an error result.
- isError(Boolean) - Method in class com.soklet.McpToolResult.Builder
-
Sets whether the result should be flagged as an error result.
- 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-Typeofmultipart/form-data? - isSseEventSource() - Method in class com.soklet.ResourceMethod
-
Returns whether this Resource Method functions as a Server-Sent Event Source.
- isStarted() - Method in interface com.soklet.HttpServer
-
Is this server started (that is, able to handle requests from clients)?
- isStarted() - Method in interface com.soklet.McpServer
-
Indicates whether the server has been started.
- isStarted() - Method in class com.soklet.Soklet
-
Is any managed transport server started?
- isStarted() - Method in interface com.soklet.SseServer
-
Is this SSE server started (that is, able to handle requests from clients)?
J
- JSON_RPC_ERROR - Enum constant in enum class com.soklet.McpRequestOutcome
- jsonRpcMethod() - Method in record class com.soklet.MetricsCollector.McpEndpointRequestOutcomeKey
-
Returns the value of the
jsonRpcMethodrecord component.
L
- lastActivityAt() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
lastActivityAtrecord component. - 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
-
Indicates
LifecycleObserver.didAcceptConnection(ServerType, java.net.InetSocketAddress)threw an exception. - LIFECYCLE_OBSERVER_DID_ACCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didAcceptRequest(ServerType, java.net.InetSocketAddress, String)threw an exception. - LIFECYCLE_OBSERVER_DID_CREATE_MCP_SESSION_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didCreateMcpSession(Request, Class, String)threw an exception. - LIFECYCLE_OBSERVER_DID_ESTABLISH_MCP_SSE_STREAM_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didEstablishMcpSseStream(Request, Class, String)threw an exception. - LIFECYCLE_OBSERVER_DID_ESTABLISH_SSE_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_MCP_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.LogEventType
- LIFECYCLE_OBSERVER_DID_FINISH_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didFinishRequestHandling(ServerType, Request, ResourceMethod, MarshaledResponse, Duration, List)threw an exception. - LIFECYCLE_OBSERVER_DID_READ_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didReadRequest(ServerType, java.net.InetSocketAddress, String)threw an exception. - LIFECYCLE_OBSERVER_DID_START_MCP_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didStartMcpRequestHandling(Request, Class, String, String, McpJsonRpcRequestId)threw an exception. - LIFECYCLE_OBSERVER_DID_START_REQUEST_HANDLING_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didStartRequestHandling(ServerType, Request, ResourceMethod)threw an exception. - LIFECYCLE_OBSERVER_DID_TERMINATE_MCP_SESSION_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didTerminateMcpSession(Class, String, Duration, McpSessionTerminationReason, Throwable)threw an exception. - LIFECYCLE_OBSERVER_DID_TERMINATE_MCP_SSE_STREAM_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didTerminateMcpSseStream(Request, Class, String, Duration, McpStreamTerminationReason, Throwable)threw an exception. - LIFECYCLE_OBSERVER_DID_TERMINATE_SSE_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.didTerminateSseConnection(SseConnection, Duration, SseConnection.TerminationReason, Throwable)threw an exception. - LIFECYCLE_OBSERVER_DID_WRITE_RESPONSE_FAILED - Enum constant in enum class com.soklet.LogEventType
- LIFECYCLE_OBSERVER_DID_WRITE_SSE_COMMENT_FAILED - Enum constant in enum class com.soklet.LogEventType
- LIFECYCLE_OBSERVER_DID_WRITE_SSE_FAILED - Enum constant in enum class com.soklet.LogEventType
- LIFECYCLE_OBSERVER_WILL_ACCEPT_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willAcceptConnection(ServerType, java.net.InetSocketAddress)threw an exception. - LIFECYCLE_OBSERVER_WILL_ACCEPT_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willAcceptRequest(ServerType, java.net.InetSocketAddress, String)threw an exception. - LIFECYCLE_OBSERVER_WILL_ESTABLISH_SSE_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willEstablishSseConnection(Request, ResourceMethod)threw an exception. - LIFECYCLE_OBSERVER_WILL_READ_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willReadRequest(ServerType, java.net.InetSocketAddress, String)threw an exception. - LIFECYCLE_OBSERVER_WILL_TERMINATE_MCP_SSE_STREAM_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willTerminateMcpSseStream(Request, Class, String, McpStreamTerminationReason, Throwable)threw an exception. - LIFECYCLE_OBSERVER_WILL_TERMINATE_SSE_CONNECTION_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willTerminateSseConnection(SseConnection, SseConnection.TerminationReason, Throwable)threw an exception. - LIFECYCLE_OBSERVER_WILL_WRITE_RESPONSE_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willWriteResponse(ServerType, Request, ResourceMethod, MarshaledResponse)threw an exception. - LIFECYCLE_OBSERVER_WILL_WRITE_SSE_COMMENT_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willWriteSseComment(SseConnection, SseComment)threw an exception. - LIFECYCLE_OBSERVER_WILL_WRITE_SSE_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
LifecycleObserver.willWriteSseEvent(SseConnection, SseEvent)threw an exception. - 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
LogEventviaLogEvent.with(LogEventType, String). - LogEvent.Copier - Class in com.soklet
-
Builder used to copy instances of
LogEventviaLogEvent.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
LogEventinstances that Soklet can produce. - LOW - Enum constant in enum class com.soklet.ResponseCookie.Priority
M
- marshaledResponse(MarshaledResponse) - Method in class com.soklet.HttpRequestResult.Builder
- marshaledResponse(MarshaledResponse) - Method in class com.soklet.HttpRequestResult.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
-
Builder used to construct instances of
MarshaledResponseviaMarshaledResponse.withResponse(Response)orMarshaledResponse.withStatusCode(Integer). - MarshaledResponse.Copier - Class in com.soklet
-
Builder used to copy instances of
MarshaledResponseviaMarshaledResponse.copy(). - MarshaledResponseBody - Interface in com.soklet
-
A known-length, finalized HTTP response body.
- MarshaledResponseBody.ByteBuffer - Class in com.soklet
-
A finalized response body backed by a
ByteBuffer. - MarshaledResponseBody.Bytes - Class in com.soklet
-
A finalized response body backed by a byte array.
- MarshaledResponseBody.File - Class in com.soklet
-
A finalized response body backed by a file path.
- MarshaledResponseBody.FileChannel - Class in com.soklet
-
A finalized response body backed by a
FileChannel. - 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 typerequestBodyType. - marshalStructuredContent(Object, McpStructuredContentContext) - Method in interface com.soklet.McpResponseMarshaler
-
Converts app-owned structured content into an
McpValuetree that Soklet can embed into the MCP response. - 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.HttpServer.Builder
- maximumRequestSizeInBytes(Integer) - Method in class com.soklet.HttpServer.Builder
-
Sets the maximum accepted HTTP request size in bytes.
- maximumRequestSizeInBytes(Integer) - Method in class com.soklet.McpServer.Builder
-
Sets the maximum accepted MCP request size in bytes.
- maximumRequestSizeInBytes(Integer) - Method in class com.soklet.SseServer.Builder
-
Sets the maximum accepted SSE handshake request size in bytes.
- MCP - Enum constant in enum class com.soklet.ServerType
-
An MCP server which handles MCP transport traffic over HTTP.
- McpAdmissionContext - Interface in com.soklet
-
Transport/admission context for MCP request rejection or acceptance.
- McpArgument - Annotation Interface in com.soklet.annotation
-
Applies to MCP handler method parameters that should be bound from the incoming MCP
argumentsobject. - McpArray - Record Class in com.soklet
-
Immutable MCP array value.
- McpArray(List) - Constructor for record class com.soklet.McpArray
-
Creates an instance of a
McpArrayrecord class. - McpBoolean - Record Class in com.soklet
-
Immutable MCP boolean value.
- McpBoolean(Boolean) - Constructor for record class com.soklet.McpBoolean
-
Creates an instance of a
McpBooleanrecord class. - McpClientCapabilities - Record Class in com.soklet
-
Immutable wrapper for MCP client capabilities.
- McpClientCapabilities(McpObject) - Constructor for record class com.soklet.McpClientCapabilities
-
Creates an instance of a
McpClientCapabilitiesrecord class. - McpClientInfo - Record Class in com.soklet
-
Immutable client information provided during MCP initialization.
- McpClientInfo(String, String) - Constructor for record class com.soklet.McpClientInfo
-
Creates an instance of a
McpClientInforecord class. - mcpConnectionsAccepted(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets the total number of accepted MCP connections.
- mcpConnectionsRejected(Long) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets the total number of rejected MCP connections.
- McpCorsAuthorizer - Interface in com.soklet
-
CORS authorization contract for MCP transport requests.
- McpCorsContext - Record Class in com.soklet
-
Request metadata used by
McpCorsAuthorizer. - McpCorsContext(Request, Class, HttpMethod, String, String) - Constructor for record class com.soklet.McpCorsContext
-
Creates an instance of a
McpCorsContextrecord class. - McpEndpoint - Interface in com.soklet
-
Common contract implemented by MCP endpoint classes.
- McpEndpointPathParameter - Annotation Interface in com.soklet.annotation
-
Applies to MCP handler method parameters that should be bound from the resolved endpoint path.
- McpEndpointRegistration - Record Class in com.soklet
-
Immutable metadata describing a resolved MCP endpoint registration.
- McpEndpointRegistration(Class, ResourcePathDeclaration, String, String, String, String, String, String, Set, Set, Set, Boolean) - Constructor for record class com.soklet.McpEndpointRegistration
-
Creates an instance of a
McpEndpointRegistrationrecord class. - McpEndpointRequestOutcomeKey(Class, String, McpRequestOutcome) - Constructor for record class com.soklet.MetricsCollector.McpEndpointRequestOutcomeKey
-
Creates an instance of a
McpEndpointRequestOutcomeKeyrecord class. - McpEndpointSessionTerminationKey(Class, McpSessionTerminationReason) - Constructor for record class com.soklet.MetricsCollector.McpEndpointSessionTerminationKey
-
Creates an instance of a
McpEndpointSessionTerminationKeyrecord class. - McpEndpointStreamTerminationKey(Class, McpStreamTerminationReason) - Constructor for record class com.soklet.MetricsCollector.McpEndpointStreamTerminationKey
-
Creates an instance of a
McpEndpointStreamTerminationKeyrecord class. - McpHandlerInvocation<T> - Interface in com.soklet
-
Generic invocation callback used by
McpRequestInterceptor. - McpHandlerResolver - Interface in com.soklet
-
Contract for discovering MCP endpoints and composing programmatic handlers onto them.
- McpInitializationContext - Interface in com.soklet
-
Initialization-time MCP request metadata.
- McpJsonRpcError - Record Class in com.soklet
-
Immutable JSON-RPC error descriptor used by MCP request handling.
- McpJsonRpcError(Integer, String) - Constructor for record class com.soklet.McpJsonRpcError
-
Creates an instance of a
McpJsonRpcErrorrecord class. - McpJsonRpcRequestId - Record Class in com.soklet
-
Immutable wrapper for JSON-RPC request identifiers.
- McpJsonRpcRequestId(McpValue) - Constructor for record class com.soklet.McpJsonRpcRequestId
-
Creates an instance of a
McpJsonRpcRequestIdrecord class. - McpListedResource - Record Class in com.soklet
-
Resource-list entry exposed by v1 MCP endpoints.
- McpListedResource(String, String, String, String, String, Long) - Constructor for record class com.soklet.McpListedResource
-
Creates an instance of a
McpListedResourcerecord class. - McpListResources - Annotation Interface in com.soklet.annotation
-
Applies to a method that provides
resources/listresults for an MCP endpoint. - McpListResourcesContext - Interface in com.soklet
-
Context for
resources/list. - McpListResourcesResult - Record Class in com.soklet
-
Immutable result for
resources/list. - McpListResourcesResult(List, String) - Constructor for record class com.soklet.McpListResourcesResult
-
Creates an instance of a
McpListResourcesResultrecord class. - McpNegotiatedCapabilities - Record Class in com.soklet
-
Immutable wrapper for negotiated MCP server capabilities.
- McpNegotiatedCapabilities(McpObject) - Constructor for record class com.soklet.McpNegotiatedCapabilities
-
Creates an instance of a
McpNegotiatedCapabilitiesrecord class. - McpNull - Enum Class in com.soklet
-
Singleton MCP null value.
- McpNumber - Record Class in com.soklet
-
Immutable MCP number value.
- McpNumber(BigDecimal) - Constructor for record class com.soklet.McpNumber
-
Creates an instance of a
McpNumberrecord class. - McpObject - Record Class in com.soklet
-
Immutable MCP object value.
- McpObject(Map) - Constructor for record class com.soklet.McpObject
-
Creates an instance of a
McpObjectrecord class. - McpOperationType - Enum Class in com.soklet
-
High-level MCP operation types.
- McpProgressReporter - Interface in com.soklet
-
Request-scoped progress reporting seam for MCP tool calls.
- McpProgressToken - Record Class in com.soklet
-
Immutable wrapper for MCP progress tokens.
- McpProgressToken(McpValue) - Constructor for record class com.soklet.McpProgressToken
-
Creates an instance of a
McpProgressTokenrecord class. - McpPrompt - Annotation Interface in com.soklet.annotation
-
Applies to methods that expose an MCP prompt.
- McpPromptHandler - Interface in com.soklet
-
Programmatic MCP prompt handler contract.
- McpPromptHandlerContext - Interface in com.soklet
-
Context supplied to programmatic MCP prompt handlers.
- McpPromptMessage - Record Class in com.soklet
-
Immutable MCP prompt message.
- McpPromptMessage(McpPromptMessageRole, McpTextContent) - Constructor for record class com.soklet.McpPromptMessage
-
Creates an instance of a
McpPromptMessagerecord class. - McpPromptMessageRole - Enum Class in com.soklet
-
Public prompt message roles supported in v1.
- McpPromptResult - Record Class in com.soklet
-
Immutable MCP prompt result.
- McpPromptResult(String, List) - Constructor for record class com.soklet.McpPromptResult
-
Creates an instance of a
McpPromptResultrecord class. - McpRequestAdmissionPolicy - Interface in com.soklet
-
Admission seam for MCP transport requests.
- McpRequestContext - Interface in com.soklet
-
Request-scoped MCP metadata.
- mcpRequestDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets MCP request duration histograms keyed by endpoint, JSON-RPC method, and outcome.
- McpRequestInterceptor - Interface in com.soklet
-
MCP-side analogue of HTTP
RequestInterceptor. - McpRequestOutcome - Enum Class in com.soklet
-
High-level outcomes for MCP JSON-RPC request handling.
- mcpRequestReadFailures(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets MCP request read failure counters keyed by failure reason.
- mcpRequestRejections(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets MCP request rejection counters keyed by rejection reason.
- McpRequestResult - Interface in com.soklet
-
Result of simulator-mode MCP request handling.
- McpRequestResult.ResponseCompleted - Class in com.soklet
-
MCP request completed without leaving an open stream.
- McpRequestResult.StreamOpened - Class in com.soklet
-
MCP request left an open simulated stream.
- mcpRequests(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets MCP request outcome counters keyed by endpoint, JSON-RPC method, and outcome.
- McpResource - Annotation Interface in com.soklet.annotation
-
Applies to methods that expose an MCP resource.
- McpResourceContents - Record Class in com.soklet
-
Immutable resource-read result payload.
- McpResourceContents(String, String, String, String) - Constructor for record class com.soklet.McpResourceContents
-
Creates an instance of a
McpResourceContentsrecord class. - McpResourceHandler - Interface in com.soklet
-
Programmatic MCP resource-read handler contract.
- McpResourceHandlerContext - Interface in com.soklet
-
Context supplied to programmatic MCP resource handlers.
- McpResourceListHandler - Interface in com.soklet
-
Programmatic MCP
resources/listhandler contract. - McpResourceListHandlerContext - Interface in com.soklet
-
Context supplied to programmatic MCP
resources/listhandlers. - McpResponseMarshaler - Interface in com.soklet
-
Converts app-owned structured content objects into
McpValue. - McpSchema - Class in com.soklet
-
Public programmatic MCP schema DSL.
- McpSchema.ObjectBuilder - Class in com.soklet
-
Builder for root-level object schemas.
- mcpServer(McpServer) - Method in class com.soklet.SokletConfig.Builder
- mcpServer(McpServer) - Method in class com.soklet.SokletConfig.Copier
- McpServer - Interface in com.soklet
-
Contract for MCP server implementations that are designed to be managed by a
Sokletinstance. - McpServer.Builder - Class in com.soklet
-
Builder for
McpServerinstances. - McpServer.RequestHandler - Interface in com.soklet
-
Request callback used by
Sokletto hand transport requests to an initialized MCP server. - McpServerEndpoint - Annotation Interface in com.soklet.annotation
-
Applies to classes that expose an MCP endpoint.
- McpSessionContext - Interface in com.soklet
-
Immutable key/value bag associated with an MCP session.
- mcpSessionDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets MCP session duration histograms keyed by endpoint and termination reason.
- McpSessionStore - Interface in com.soklet
-
Compare-and-set persistence contract for MCP sessions.
- McpSessionTerminationReason - Enum Class in com.soklet
-
Reasons why an MCP session may terminate.
- McpStoredSession - Record Class in com.soklet
-
Immutable stored representation of an MCP session.
- McpStoredSession(String, Class, Instant, Instant, Boolean, Boolean, String, McpClientCapabilities, McpNegotiatedCapabilities, McpSessionContext, Instant, Long) - Constructor for record class com.soklet.McpStoredSession
-
Creates an instance of a
McpStoredSessionrecord class. - mcpStreamDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets MCP stream duration histograms keyed by endpoint and termination reason.
- McpStreamTerminationReason - Enum Class in com.soklet
-
Reasons why a simulated or real MCP stream may terminate.
- McpString - Record Class in com.soklet
-
Immutable MCP string value.
- McpString(String) - Constructor for record class com.soklet.McpString
-
Creates an instance of a
McpStringrecord class. - McpStructuredContentContext - Interface in com.soklet
-
Context supplied to
McpResponseMarshalerduring structured-content conversion. - McpTextContent - Record Class in com.soklet
-
Text content block used by v1 MCP tool and prompt results.
- McpTextContent(String) - Constructor for record class com.soklet.McpTextContent
-
Creates an instance of a
McpTextContentrecord class. - McpTool - Annotation Interface in com.soklet.annotation
-
Applies to methods that expose an MCP tool.
- McpToolCallContext - Interface in com.soklet
-
Tool-call-specific MCP request metadata.
- McpToolHandler - Interface in com.soklet
-
Programmatic MCP tool handler contract.
- McpToolHandlerContext - Interface in com.soklet
-
Context supplied to programmatic MCP tool handlers.
- McpToolResult - Class in com.soklet
-
Immutable tool result used by v1 MCP tool handlers.
- McpToolResult.Builder - Class in com.soklet
-
Builder used to construct
McpToolResultinstances. - McpType - Enum Class in com.soklet
-
Supported scalar schema types for the programmatic MCP schema DSL.
- McpUriParameter - Annotation Interface in com.soklet.annotation
-
Applies to MCP resource handler method parameters that should be bound from a resource URI template.
- McpValue - Interface in com.soklet
-
Small immutable public value model for MCP JSON-like values.
- MEDIUM - Enum constant in enum class com.soklet.ResponseCookie.Priority
- message() - Method in record class com.soklet.McpJsonRpcError
-
Returns the value of the
messagerecord component. - message(String) - Method in class com.soklet.LogEvent.Builder
- message(String) - Method in class com.soklet.LogEvent.Copier
- messages() - Method in record class com.soklet.McpPromptResult
-
Returns the value of the
messagesrecord component. - method() - Method in record class com.soklet.MetricsCollector.HttpServerRouteKey
-
Returns the value of the
methodrecord component. - method() - Method in record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Returns the value of the
methodrecord 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
MetricsCollectorinvocation 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.HttpServerRouteKey - Record Class in com.soklet
-
Key for metrics grouped by HTTP method and route match information.
- MetricsCollector.HttpServerRouteStatusKey - Record Class in com.soklet
-
Key for metrics grouped by HTTP method, route match information, and status class (e.g. 2xx).
- MetricsCollector.McpEndpointRequestOutcomeKey - Record Class in com.soklet
-
Key for metrics grouped by MCP endpoint class, JSON-RPC method, and request outcome.
- MetricsCollector.McpEndpointSessionTerminationKey - Record Class in com.soklet
-
Key for metrics grouped by MCP endpoint class and session termination reason.
- MetricsCollector.McpEndpointStreamTerminationKey - Record Class in com.soklet
-
Key for metrics grouped by MCP endpoint class and stream termination reason.
- MetricsCollector.MetricsFormat - Enum Class in com.soklet
-
Text format to use for
MetricsCollector.snapshotText(SnapshotTextOptions). - 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.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
-
Builder for
MetricsCollector.SnapshotTextOptions. - 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.
- MetricsCollector.SseCommentRouteDropKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event comment type, route match information, and drop reason.
- MetricsCollector.SseCommentRouteEnqueueOutcomeKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event comment type, route match information, and enqueue outcome.
- MetricsCollector.SseCommentRouteKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event comment type and route match information.
- MetricsCollector.SseEventDropReason - Enum Class in com.soklet
-
Reasons a Server-Sent Event payload or comment was dropped before it could be written.
- MetricsCollector.SseEventEnqueueOutcome - Enum Class in com.soklet
-
Outcomes for a Server-Sent Event enqueue attempt.
- MetricsCollector.SseEventRouteDropKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event route match information and drop reason.
- MetricsCollector.SseEventRouteEnqueueOutcomeKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event route match information and enqueue outcome.
- MetricsCollector.SseEventRouteHandshakeFailureKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event route match information and handshake failure reason.
- MetricsCollector.SseEventRouteKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event route match information.
- MetricsCollector.SseEventRouteTerminationKey - Record Class in com.soklet
-
Key for metrics grouped by Server-Sent Event route match information and termination reason.
- mimeType() - Element in annotation interface com.soklet.annotation.McpResource
-
Declares the MIME type returned by the resource-read handler.
- mimeType() - Method in record class com.soklet.McpListedResource
-
Returns the value of the
mimeTyperecord component. - mimeType() - Method in record class com.soklet.McpResourceContents
-
Returns the value of the
mimeTyperecord component. - 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
Stringrepresentations of its value, and other attributes as encoded according to themultipart/form-dataspecification. - MultipartField.Builder - Class in com.soklet
-
Builder used to construct instances of
MultipartFieldviaMultipartField.withName(String)orMultipartField.with(String, byte[]). - MultipartField.Copier - Class in com.soklet
-
Builder used to copy instances of
MultipartFieldviaMultipartField.copy(). - multipartParser(MultipartParser) - Method in class com.soklet.HttpServer.Builder
- multipartParser(MultipartParser) - Method in class com.soklet.Request.PathBuilder
- multipartParser(MultipartParser) - Method in class com.soklet.Request.RawBuilder
- MultipartParser - Interface in com.soklet
-
Contract for parsing HTML form fields encoded according to the
multipart/form-dataspecification.
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.McpPrompt
-
Declares the MCP prompt name.
- name() - Element in annotation interface com.soklet.annotation.McpResource
-
Declares the MCP resource name.
- name() - Element in annotation interface com.soklet.annotation.McpServerEndpoint
-
Declares the MCP server name.
- name() - Element in annotation interface com.soklet.annotation.McpTool
-
Declares the MCP tool name.
- 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() - Method in record class com.soklet.McpClientInfo
-
Returns the value of the
namerecord component. - name() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
namerecord component. - name() - Method in record class com.soklet.McpListedResource
-
Returns the value of the
namerecord component. - 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
- negotiatedCapabilities() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
negotiatedCapabilitiesrecord component. - nextCursor() - Method in record class com.soklet.McpListResourcesResult
-
Returns the value of the
nextCursorrecord component. - nonBrowserClientsOnlyInstance() - Static method in interface com.soklet.McpCorsAuthorizer
-
Acquires the conservative default authorizer that leaves non-browser MCP requests alone while rejecting browser CORS authorization.
- 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
- NOTIFICATIONS_INITIALIZED - Enum constant in enum class com.soklet.McpOperationType
- NUMBER - Enum constant in enum class com.soklet.McpType
O
- object() - Static method in class com.soklet.McpSchema
-
Creates a builder for a root-level object schema.
- onBroadcastError(Consumer) - Method in interface com.soklet.Simulator
-
Registers a handler for exceptions thrown by simulated Server-Sent Event consumers.
- onMcpStreamError(Consumer) - Method in interface com.soklet.Simulator
-
Registers a handler for exceptions thrown by simulated MCP stream 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
# EOFtrailer. - 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.McpArgument
-
Indicates whether the argument is optional for annotated binding.
- 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?
- optional(String, McpType) - Method in class com.soklet.McpSchema.ObjectBuilder
-
Adds an optional scalar property.
- optionalEnum(String, String...) - Method in class com.soklet.McpSchema.ObjectBuilder
-
Adds an optional enum-backed string property.
- OPTIONS - Enum constant in enum class com.soklet.HttpMethod
-
The HTTP
OPTIONSrequest method. - OPTIONS - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to support the HTTP
OPTIONSmethod. - OPTIONSes - Annotation Interface in com.soklet.annotation
-
Allows multiple
OPTIONSannotations 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
- origin() - Method in record class com.soklet.McpCorsContext
-
Returns the value of the
originrecord component. - outcome() - Method in record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Returns the value of the
outcomerecord component. - outcome() - Method in record class com.soklet.MetricsCollector.SseEventRouteEnqueueOutcomeKey
-
Returns the value of the
outcomerecord 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
ParameterizedHeaderValueviaParameterizedHeaderValue.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 twofilenameparameter name-value pairs. - ParameterizedHeaderValue.ParameterType - Enum Class in com.soklet
-
What type of header-value parameter this is:
ParameterizedHeaderValue.ParameterType.TOKEN,ParameterizedHeaderValue.ParameterType.QUOTED, orParameterizedHeaderValue.ParameterType.RFC_8187. - parameterValuesForResourceMethod(Request, ResourceMethod) - Method in interface com.soklet.ResourceMethodParameterProvider
-
For the given
requestandresourceMethod, vends the list of parameters to use when invoking the underlying Java method located atResourceMethod.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
PATCHrequest method. - PATCH - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to support the HTTP
PATCHmethod. - PATCHes - Annotation Interface in com.soklet.annotation
-
Allows multiple
PATCHannotations to be applied to the same Resource Method. - path() - Element in annotation interface com.soklet.annotation.McpServerEndpoint
-
Declares the HTTP path for the MCP transport endpoint.
- 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.
- performHttpRequest(Request) - Method in interface com.soklet.Simulator
-
Given a request that would normally be handled by your standard
HttpServer, process it and return response data (both logicalResponse, if present, and theMarshaledResponsebytes to be sent over the wire) as well as the matching Resource Method, if available. - performMcpRequest(Request) - Method in interface com.soklet.Simulator
-
Given a request that would normally be handled by your MCP server, process it and return the corresponding MCP-oriented simulator result.
- performSseRequest(Request) - Method in interface com.soklet.Simulator
-
Given a request that would normally be handled by your
SseServer(that is, for a Resource Method decorated with theSseEventSourceannotation), process it and return response data (SseRequestResult.HandshakeAccepted,SseRequestResult.HandshakeRejected, orSseRequestResult.RequestFailed); - PING - Enum constant in enum class com.soklet.McpOperationType
- 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.HttpServer.Builder
- port(Integer) - Method in class com.soklet.McpServer.Builder
-
Sets the port to bind.
- port(Integer) - Method in class com.soklet.SseServer.Builder
- POST - Enum constant in enum class com.soklet.HttpMethod
-
The HTTP
POSTrequest method. - POST - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to support the HTTP
POSTmethod. - 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
POSTannotations 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).
- promptNames() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
promptNamesrecord component. - PROMPTS_GET - Enum constant in enum class com.soklet.McpOperationType
- PROMPTS_LIST - Enum constant in enum class com.soklet.McpOperationType
- protocolVersion() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
protocolVersionrecord component. - 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
PUTrequest method. - PUT - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to support the HTTP
PUTmethod. - PUTs - Annotation Interface in com.soklet.annotation
-
Allows multiple
PUTannotations 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.SseEventDropReason
-
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
reasonrecord component. - reason() - Method in record class com.soklet.MetricsCollector.RequestRejectionKey
-
Returns the value of the
reasonrecord 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.SseRequestResult.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.SseRequestResult.HandshakeAccepted
-
Registers a
SseEvent"consumer" for this connection - similar to how a real client would listen for Server-Sent Events. - registerMessageConsumer(Consumer) - Method in class com.soklet.McpRequestResult.StreamOpened
-
Registers the consumer that should receive MCP messages from the open simulated stream.
- rejectAllInstance() - Static method in interface com.soklet.CorsAuthorizer
-
Acquires a threadsafe
CorsAuthorizerconfigured to reject all cross-domain requests regardless ofOrigin. - rejectAllInstance() - Static method in interface com.soklet.McpCorsAuthorizer
-
Acquires an authorizer that rejects all browser-originated MCP CORS requests.
- rejectWithResponse(Response) - Static method in interface com.soklet.SseHandshakeResult
-
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.SseConnection.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.
- replace(McpStoredSession, McpStoredSession) - Method in interface com.soklet.McpSessionStore
-
Replaces a session using compare-and-set semantics.
- reportProgress(BigDecimal, BigDecimal, String) - Method in interface com.soklet.McpProgressReporter
-
Emits an MCP
notifications/progressupdate for the current request. - request() - Method in record class com.soklet.McpCorsContext
-
Returns the value of the
requestrecord component. - 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
-
Indicates
RequestInterceptor.interceptRequest(ServerType, Request, ResourceMethod, Function, Consumer)threw an exception. - REQUEST_INTERCEPTOR_WRAP_REQUEST_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
RequestInterceptor.wrapRequest(ServerType, Request, Consumer)threw an exception. - 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
RequestviaRequest.copy(). - Request.PathBuilder - Class in com.soklet
-
Builder used to construct instances of
RequestviaRequest.withPath(HttpMethod, String). - Request.RawBuilder - Class in com.soklet
-
Builder used to construct instances of
RequestviaRequest.withRawUrl(HttpMethod, String). - requestAdmissionPolicy(McpRequestAdmissionPolicy) - Method in class com.soklet.McpServer.Builder
-
Sets the request admission policy.
- 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.HttpServer.Builder
- requestHandlerConcurrency(Integer) - Method in class com.soklet.McpServer.Builder
-
Sets the handler concurrency level.
- requestHandlerConcurrency(Integer) - Method in class com.soklet.SseServer.Builder
- requestHandlerExecutorServiceSupplier(Supplier) - Method in class com.soklet.HttpServer.Builder
- requestHandlerExecutorServiceSupplier(Supplier) - Method in class com.soklet.McpServer.Builder
-
Sets the supplier used to create the handler executor service.
- requestHandlerExecutorServiceSupplier(Supplier) - Method in class com.soklet.SseServer.Builder
- requestHandlerQueueCapacity(Integer) - Method in class com.soklet.HttpServer.Builder
- requestHandlerQueueCapacity(Integer) - Method in class com.soklet.McpServer.Builder
-
Sets the handler queue capacity.
- requestHandlerQueueCapacity(Integer) - Method in class com.soklet.SseServer.Builder
- requestHandlerTimeout(Duration) - Method in class com.soklet.HttpServer.Builder
- requestHandlerTimeout(Duration) - Method in class com.soklet.McpServer.Builder
-
Sets the timeout for MCP handler execution.
- requestHandlerTimeout(Duration) - Method in class com.soklet.SseServer.Builder
- RequestHeader - Annotation Interface in com.soklet.annotation
-
Apply to Resource Method parameters to enable HTTP request header injection.
- requestInterceptor(McpRequestInterceptor) - Method in class com.soklet.McpServer.Builder
-
Sets the request interceptor.
- 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.
- requestOutcome() - Method in record class com.soklet.MetricsCollector.McpEndpointRequestOutcomeKey
-
Returns the value of the
requestOutcomerecord component. - requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.HttpServer.Builder
- requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.McpServer.Builder
-
Sets the read buffer size used while reading MCP requests.
- requestReadBufferSizeInBytes(Integer) - Method in class com.soklet.SseServer.Builder
- RequestReadFailureKey(RequestReadFailureReason) - Constructor for record class com.soklet.MetricsCollector.RequestReadFailureKey
-
Creates an instance of a
RequestReadFailureKeyrecord 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
RequestRejectionKeyrecord class. - RequestRejectionReason - Enum Class in com.soklet
-
Reasons an HTTP or SSE request was rejected before application-level handling began.
- requestTimeout(Duration) - Method in class com.soklet.HttpServer.Builder
- requestTimeout(Duration) - Method in class com.soklet.McpServer.Builder
-
Sets the end-to-end request timeout.
- requestTimeout(Duration) - Method in class com.soklet.SseServer.Builder
- required(String, McpType) - Method in class com.soklet.McpSchema.ObjectBuilder
-
Adds a required scalar property.
- requiredEnum(String, String...) - Method in class com.soklet.McpSchema.ObjectBuilder
-
Adds a required enum-backed string property.
- 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.HttpRequestResult.Builder
- resourceMethod(ResourceMethod) - Method in class com.soklet.HttpRequestResult.Copier
- resourceMethod(ResourceMethod) - Method in class com.soklet.LogEvent.Builder
- resourceMethod(ResourceMethod) - Method in class com.soklet.LogEvent.Copier
- ResourceMethod - Class in com.soklet
-
Represents a Resource Method, which is a Java
Methodinvoked 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.SseServer.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 aResourcePathDeclaration. - ResourcePathDeclaration.ComponentType - Enum Class in com.soklet
-
How to interpret a
ResourcePathDeclaration.Componentof aResourcePathDeclaration- is it literal text or a placeholder? - resources() - Method in record class com.soklet.McpListResourcesResult
-
Returns the value of the
resourcesrecord component. - RESOURCES_LIST - Enum constant in enum class com.soklet.McpOperationType
- RESOURCES_READ - Enum constant in enum class com.soklet.McpOperationType
- RESOURCES_TEMPLATES_LIST - Enum constant in enum class com.soklet.McpOperationType
- resourceUris() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
resourceUrisrecord component. - response(Response) - Method in class com.soklet.HttpRequestResult.Builder
- response(Response) - Method in class com.soklet.HttpRequestResult.Copier
- Response - Class in com.soklet
-
Represents a logical HTTP response returned by a Resource Method.
- RESPONSE_MARSHALER_FOR_THROWABLE_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates
ResponseMarshaler.forThrowable(Request, Throwable, ResourceMethod)threw an exception. - Response.Builder - Class in com.soklet
-
Builder used to construct instances of
ResponseviaResponse.withStatusCode(Integer)orResponse.withRedirect(RedirectType, String). - Response.Copier - Class in com.soklet
-
Builder used to copy instances of
ResponseviaResponse.copy(). - ResponseCookie - Class in com.soklet
-
HTTP "response" Cookie representation which supports
Set-Cookieheader encoding. - ResponseCookie.Builder - Class in com.soklet
-
Builder used to construct instances of
ResponseCookieviaResponseCookie.withName(String)orResponseCookie.with(String, String). - ResponseCookie.Copier - Class in com.soklet
-
Builder used to copy instances of
ResponseCookieviaResponseCookie.copy(). - ResponseCookie.Priority - Enum Class in com.soklet
-
Represents the
Priorityresponse 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(McpResponseMarshaler) - Method in class com.soklet.McpServer.Builder
-
Sets the response marshaler used for tool structured content.
- responseMarshaler(ResponseMarshaler) - Method in class com.soklet.SokletConfig.Builder
- responseMarshaler(ResponseMarshaler) - Method in class com.soklet.SokletConfig.Copier
- ResponseMarshaler - Interface in com.soklet
-
Prepares responses for each request scenario Soklet supports (Resource Method, exception, CORS preflight, etc.)
- ResponseMarshaler.Builder - Class in com.soklet
-
Builder used to construct a standard implementation of
ResponseMarshaler. - ResponseMarshaler.Builder.ContentTooLargeHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forContentTooLarge(Request, ResourceMethod). - ResponseMarshaler.Builder.CorsAllowedHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forCorsAllowed(Request, Cors, CorsResponse, MarshaledResponse). - ResponseMarshaler.Builder.CorsPreflightAllowedHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forCorsPreflightAllowed(Request, CorsPreflight, CorsPreflightResponse). - ResponseMarshaler.Builder.CorsPreflightRejectedHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forCorsPreflightRejected(Request, CorsPreflight). - ResponseMarshaler.Builder.HeadHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forHead(Request, MarshaledResponse). - ResponseMarshaler.Builder.MethodNotAllowedHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forMethodNotAllowed(Request, Set). - ResponseMarshaler.Builder.NotFoundHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forNotFound(Request). - ResponseMarshaler.Builder.OptionsHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forOptions(Request, Set). - ResponseMarshaler.Builder.OptionsSplatHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forOptionsSplat(Request). - ResponseMarshaler.Builder.PostProcessor - Interface in com.soklet
-
Function used to support a pluggable "post-process" hook for any final customization or processing before data goes over the wire.
- ResponseMarshaler.Builder.ResourceMethodHandler - Interface in com.soklet
-
Function used to support pluggable implementations of
ResponseMarshaler.forResourceMethod(Request, Response, ResourceMethod). - ResponseMarshaler.Builder.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.SseEvent.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 8187ext-value(UTF-8, percent-encoded). - role() - Method in record class com.soklet.McpPromptMessage
-
Returns the value of the
rolerecord component. - route() - Method in record class com.soklet.MetricsCollector.HttpServerRouteKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseCommentRouteDropKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseCommentRouteKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseEventRouteDropKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseEventRouteEnqueueOutcomeKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseEventRouteHandshakeFailureKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseEventRouteKey
-
Returns the value of the
routerecord component. - route() - Method in record class com.soklet.MetricsCollector.SseEventRouteTerminationKey
-
Returns the value of the
routerecord component. - routeType() - Method in record class com.soklet.MetricsCollector.HttpServerRouteKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseCommentRouteDropKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseCommentRouteKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseEventRouteDropKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseEventRouteEnqueueOutcomeKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseEventRouteHandshakeFailureKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseEventRouteKey
-
Returns the value of the
routeTyperecord component. - routeType() - Method in record class com.soklet.MetricsCollector.SseEventRouteTerminationKey
-
Returns the value of the
routeTyperecord component. - runSimulator(SokletConfig, Consumer) - Static method in class com.soklet.Soklet
-
Runs Soklet with special non-network "simulator" implementations of the configured transport servers - 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_INTERNAL_ERROR - Enum constant in enum class com.soklet.LogEventType
-
Indicates an internal
HttpServererror occurred. - SERVER_STOP - Enum constant in enum class com.soklet.SseConnection.TerminationReason
-
Connection was closed during server shutdown.
- SERVER_STOPPING - Enum constant in enum class com.soklet.McpSessionTerminationReason
- SERVER_STOPPING - Enum constant in enum class com.soklet.McpStreamTerminationReason
- SERVER_UNPARSEABLE_REQUEST - Enum constant in enum class com.soklet.LogEventType
-
Indicates that the
HttpServerreceived a request with an illegal structure, such as a missing or invalid HTTP verb or an unsupported HTTP/2.0 request. - ServerType - Enum Class in com.soklet
-
Types of servers supported by Soklet - currently
ServerType.STANDARD_HTTP,ServerType.SSE, andServerType.MCP. - serviceUnavailableHandler(ResponseMarshaler.Builder.ServiceUnavailableHandler) - Method in class com.soklet.ResponseMarshaler.Builder
- SESSION_TERMINATED - Enum constant in enum class com.soklet.McpStreamTerminationReason
- sessionContext() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
sessionContextrecord component. - sessionId() - Method in record class com.soklet.McpCorsContext
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
sessionIdrecord component. - sessionStore(McpSessionStore) - Method in class com.soklet.McpServer.Builder
-
Sets the session store.
- shutdownTimeout(Duration) - Method in class com.soklet.HttpServer.Builder
- shutdownTimeout(Duration) - Method in class com.soklet.McpServer.Builder
-
Sets the shutdown timeout.
- shutdownTimeout(Duration) - Method in class com.soklet.SseServer.Builder
- ShutdownTrigger - Enum Class in com.soklet
-
Events that might trigger a
Sokletinstance 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.
- sizeBytes() - Method in record class com.soklet.McpListedResource
-
Returns the value of the
sizeBytesrecord component. - 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.HttpServer.Builder
- socketSelectTimeout(Duration) - Method in class com.soklet.HttpServer.Builder
- Soklet - Class in com.soklet
-
Soklet's main class - manages one or more configured transport servers (
HttpServer,SseServer, and/orMcpServer) 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, broadcasting Server-Sent Events, and serving Model Context Protocol (MCP) endpoints. - 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
- SSE - Enum constant in enum class com.soklet.ServerType
-
A Server-Sent Event server which handles SSE connections (that is, services Resource Methods annotated with
SseEventSource). - SSE_SERVER_BROADCAST_GENERATION_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates that the
SseServerencountered an error when executing application-provided code while performing a memoized broadcast viaSseBroadcaster.broadcastEvent(Function, Function)orSseBroadcaster.broadcastComment(Function, Function). - SSE_SERVER_CONNECTION_REJECTED - Enum constant in enum class com.soklet.LogEventType
-
Indicates that the
SseServerrejected a connection, e.g. due to capacity limits. - SSE_SERVER_INTERNAL_ERROR - Enum constant in enum class com.soklet.LogEventType
-
Indicates an internal
SseServererror occurred. - SSE_SERVER_UNPARSEABLE_REQUEST - Enum constant in enum class com.soklet.LogEventType
-
Indicates that the
SseServerreceived a request with an illegal structure, such as a missing or invalid HTTP verb or an unsupported HTTP/2.0 request. - SSE_SERVER_WRITING_HANDSHAKE_RESPONSE_FAILED - Enum constant in enum class com.soklet.LogEventType
-
Indicates that the
SseServerwas unable to successfully write a handshake response. - SseBroadcaster - Interface in com.soklet
-
Broadcasts a Server-Sent Event payload to all clients listening on a
ResourcePath. - SseComment - Class in com.soklet
-
Encapsulates a Server-Sent Event comment payload and its comment type.
- SseComment.CommentType - Enum Class in com.soklet
-
Types of Server-Sent Event comments.
- 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.
- SseCommentRouteDropKey(MetricsCollector.RouteType, ResourcePathDeclaration, SseComment.CommentType, MetricsCollector.SseEventDropReason) - Constructor for record class com.soklet.MetricsCollector.SseCommentRouteDropKey
-
Creates an instance of a
SseCommentRouteDropKeyrecord class. - SseCommentRouteEnqueueOutcomeKey(MetricsCollector.RouteType, ResourcePathDeclaration, SseComment.CommentType, MetricsCollector.SseEventEnqueueOutcome) - Constructor for record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Creates an instance of a
SseCommentRouteEnqueueOutcomeKeyrecord class. - SseCommentRouteKey(MetricsCollector.RouteType, ResourcePathDeclaration, SseComment.CommentType) - Constructor for record class com.soklet.MetricsCollector.SseCommentRouteKey
-
Creates an instance of a
SseCommentRouteKeyrecord class. - sseCommentSizes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets SSE comment size histograms keyed by route and comment type.
- SseConnection - Interface in com.soklet
-
Represents characteristics of a long-running connection that has been established with a
SseServer. - SseConnection.HandshakeFailureReason - Enum Class in com.soklet
-
Categorizes why a Server-Sent Event handshake failed.
- SseConnection.TerminationReason - Enum Class in com.soklet
-
Categorizes why a Server-Sent Event connection terminated.
- 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.
- SseEvent - Class in com.soklet
-
Encapsulates a Server-Sent Event payload that can be sent across the wire to a client.
- SseEvent.Builder - Class in com.soklet
-
Builder used to construct instances of
SseEventviaSseEvent.withEvent(String),SseEvent.withData(String), orSseEvent.builder(). - 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.
- SseEventRouteDropKey(MetricsCollector.RouteType, ResourcePathDeclaration, MetricsCollector.SseEventDropReason) - Constructor for record class com.soklet.MetricsCollector.SseEventRouteDropKey
-
Creates an instance of a
SseEventRouteDropKeyrecord class. - SseEventRouteEnqueueOutcomeKey(MetricsCollector.RouteType, ResourcePathDeclaration, MetricsCollector.SseEventEnqueueOutcome) - Constructor for record class com.soklet.MetricsCollector.SseEventRouteEnqueueOutcomeKey
-
Creates an instance of a
SseEventRouteEnqueueOutcomeKeyrecord class. - SseEventRouteHandshakeFailureKey(MetricsCollector.RouteType, ResourcePathDeclaration, SseConnection.HandshakeFailureReason) - Constructor for record class com.soklet.MetricsCollector.SseEventRouteHandshakeFailureKey
-
Creates an instance of a
SseEventRouteHandshakeFailureKeyrecord class. - SseEventRouteKey(MetricsCollector.RouteType, ResourcePathDeclaration) - Constructor for record class com.soklet.MetricsCollector.SseEventRouteKey
-
Creates an instance of a
SseEventRouteKeyrecord class. - SseEventRouteTerminationKey(MetricsCollector.RouteType, ResourcePathDeclaration, SseConnection.TerminationReason) - Constructor for record class com.soklet.MetricsCollector.SseEventRouteTerminationKey
-
Creates an instance of a
SseEventRouteTerminationKeyrecord class. - sseEventSizes(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets SSE event size histograms keyed by route.
- SseEventSource - Annotation Interface in com.soklet.annotation
-
Apply to Resource Methods to make them function as Server-Sent Event Sources.
- SseEventSources - Annotation Interface in com.soklet.annotation
-
Allows multiple
SseEventSourceannotations to be applied to the same Resource Method. - sseEventWriteDurations(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets SSE event write duration histograms keyed by route.
- SseHandshakeResult - Interface in com.soklet
-
Represents the result of a
SseEventSource"handshake". - SseHandshakeResult.Accepted - Class in com.soklet
-
Type which indicates a successful Server-Sent Event handshake.
- SseHandshakeResult.Accepted.Builder - Class in com.soklet
-
Builder used to construct instances of
SseHandshakeResult.Accepted. - SseHandshakeResult.Rejected - Class in com.soklet
-
Type which indicates a rejected Server-Sent Event handshake.
- 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.
- SseRequestResult - Interface in com.soklet
-
Sealed interface used by
Simulator.performSseRequest(Request)during integration tests, which encapsulates the 3 logical outcomes for SSE connections: accepted handshake, rejected handshake, and general request failure. - SseRequestResult.HandshakeAccepted - Class in com.soklet
-
Represents the result of an SSE accepted handshake (connection stays open) when simulated by
Simulator.performSseRequest(Request). - SseRequestResult.HandshakeRejected - Class in com.soklet
-
Represents the result of an SSE rejected handshake (explicit rejection; connection closed) when simulated by
Simulator.performSseRequest(Request). - SseRequestResult.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.performSseRequest(Request). - sseServer(SseServer) - Method in class com.soklet.SokletConfig.Builder
- sseServer(SseServer) - Method in class com.soklet.SokletConfig.Copier
- SseServer - Interface in com.soklet
-
A special HTTP server whose only purpose is to provide Server-Sent Event functionality.
- SseServer.Builder - Class in com.soklet
-
Builder used to construct a standard implementation of
SseServer. - SseServer.RequestHandler - Interface in com.soklet
-
Request/response processing contract for
SseServerimplementations. - sseTimeToFirstEvent(Map) - Method in class com.soklet.MetricsCollector.Snapshot.Builder
-
Sets SSE time-to-first-event histograms keyed by route.
- SseUnicaster - Interface in com.soklet
-
Unicasts a Server-Sent Event or comment payload to a specific client listening on a
ResourcePath. - STANDARD_HTTP - Enum constant in enum class com.soklet.ServerType
- start() - Method in interface com.soklet.HttpServer
-
Starts the server, which makes it able to accept requests from clients.
- start() - Method in interface com.soklet.McpServer
-
Starts the MCP server.
- start() - Method in class com.soklet.Soklet
-
Starts the managed server instance[s].
- start() - Method in interface com.soklet.SseServer
-
Starts the SSE server, which makes it able to accept requests from clients.
- statusClass() - Method in record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Returns the value of the
statusClassrecord 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.HttpServer
-
Stops the server, which makes it unable to accept requests from clients.
- stop() - Method in interface com.soklet.McpServer
-
Stops the MCP server.
- stop() - Method in class com.soklet.Soklet
-
Stops the managed server instance[s].
- stop() - Method in interface com.soklet.SseServer
-
Stops the SSE server, which makes it unable to accept requests from clients.
- 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.
- STRING - Enum constant in enum class com.soklet.McpType
- stringValue() - Method in class com.soklet.ParameterizedHeaderValue.Builder
-
Returns the HTTP wire-format string for this header field value.
- structuredContent(Object) - Method in class com.soklet.McpToolResult.Builder
-
Sets the structured content value to be marshaled into the tool result.
- SUCCESS_NOTIFICATION - Enum constant in enum class com.soklet.McpRequestOutcome
- SUCCESS_RESPONSE - Enum constant in enum class com.soklet.McpRequestOutcome
T
- terminatedAt() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
terminatedAtrecord component. - terminationReason() - Method in record class com.soklet.MetricsCollector.McpEndpointSessionTerminationKey
-
Returns the value of the
terminationReasonrecord component. - terminationReason() - Method in record class com.soklet.MetricsCollector.McpEndpointStreamTerminationKey
-
Returns the value of the
terminationReasonrecord component. - terminationReason() - Method in record class com.soklet.MetricsCollector.SseEventRouteTerminationKey
-
Returns the value of the
terminationReasonrecord component. - text() - Method in record class com.soklet.McpResourceContents
-
Returns the value of the
textrecord component. - text() - Method in record class com.soklet.McpTextContent
-
Returns the value of the
textrecord 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
- title() - Element in annotation interface com.soklet.annotation.McpPrompt
-
Declares optional prompt title metadata for clients that display a separate title.
- title() - Element in annotation interface com.soklet.annotation.McpServerEndpoint
-
Declares optional server title metadata.
- title() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
titlerecord component. - title() - Method in record class com.soklet.McpListedResource
-
Returns the value of the
titlerecord component. - TOKEN - Enum constant in enum class com.soklet.ParameterizedHeaderValue.ParameterType
-
name=valuewhere 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). - TOOL_ERROR_RESULT - Enum constant in enum class com.soklet.McpRequestOutcome
- toolNames() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
toolNamesrecord component. - TOOLS_CALL - Enum constant in enum class com.soklet.McpOperationType
- TOOLS_LIST - Enum constant in enum class com.soklet.McpOperationType
- toSetCookieHeaderRepresentation() - Method in class com.soklet.ResponseCookie
-
Generates a
Set-Cookieheader representation of this response cookie, for exampleSet-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.HttpRequestResult
- toString() - Method in class com.soklet.LogEvent
- toString() - Method in class com.soklet.MarshaledResponse
- toString() - Method in record class com.soklet.McpArray
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpBoolean
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpClientCapabilities
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpClientInfo
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpCorsContext
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpEndpointRegistration
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpJsonRpcError
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpJsonRpcRequestId
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpListedResource
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpListResourcesResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpNegotiatedCapabilities
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpNumber
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpObject
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpProgressToken
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpPromptMessage
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpPromptResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpResourceContents
-
Returns a string representation of this record class.
- toString() - Method in class com.soklet.McpSchema
- toString() - Method in record class com.soklet.McpStoredSession
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpString
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.McpTextContent
-
Returns a string representation of this record class.
- toString() - Method in class com.soklet.McpToolResult
- toString() - Method in class com.soklet.MetricsCollector.HistogramSnapshot
- toString() - Method in record class com.soklet.MetricsCollector.HttpServerRouteKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.HttpServerRouteStatusKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.McpEndpointRequestOutcomeKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.McpEndpointSessionTerminationKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.McpEndpointStreamTerminationKey
-
Returns a string representation of this record class.
- 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.SseCommentRouteDropKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.SseCommentRouteEnqueueOutcomeKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.SseCommentRouteKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.SseEventRouteDropKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.SseEventRouteEnqueueOutcomeKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.SseEventRouteHandshakeFailureKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.SseEventRouteKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.soklet.MetricsCollector.SseEventRouteTerminationKey
-
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.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.SseComment
- toString() - Method in class com.soklet.SseEvent
- toString() - Method in class com.soklet.SseHandshakeResult.Accepted
- toString() - Method in class com.soklet.SseHandshakeResult.Rejected
- toString() - Method in class com.soklet.SseRequestResult.HandshakeAccepted
- toString() - Method in class com.soklet.SseRequestResult.HandshakeRejected
- toString() - Method in class com.soklet.SseRequestResult.RequestFailed
- toString() - Method in enum class com.soklet.StatusCode
- toValue() - Method in class com.soklet.McpSchema
-
Converts this schema into its MCP JSON-schema object representation.
- trimAggressively(String) - Static method in class com.soklet.Utilities
-
A "stronger" version of
String.trim()which discards leading and trailing Unicode space-separator characters (\p{Z}). - trimAggressivelyToEmpty(String) - Static method in class com.soklet.Utilities
-
Aggressively trims leading and trailing Unicode space-separator characters from the given string and returns
""if the input isnull. - trimAggressivelyToNull(String) - Static method in class com.soklet.Utilities
-
Aggressively trims leading and trailing Unicode space-separator characters from the given string and returns
nullif 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
-
Predicate used when
Utilities.EffectiveOriginResolver.TrustPolicy.TRUST_PROXY_ALLOWLISTis in effect. - TypeReference<T> - Class in com.soklet.converter
-
Construct for creating type tokens that represent generic types.
U
- unicastComment(SseComment) - Method in interface com.soklet.SseUnicaster
-
Unicasts a single Server-Sent Event comment to a specific client listening to this unicaster's
ResourcePath. - unicastEvent(SseEvent) - Method in interface com.soklet.SseUnicaster
-
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.SseConnection.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.
- uri() - Element in annotation interface com.soklet.annotation.McpResource
-
Declares the resource URI or URI template.
- uri() - Method in record class com.soklet.McpListedResource
-
Returns the value of the
urirecord component. - uri() - Method in record class com.soklet.McpResourceContents
-
Returns the value of the
urirecord component. - USER - Enum constant in enum class com.soklet.McpPromptMessageRole
- 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.
- UUID - Enum constant in enum class com.soklet.McpType
V
- value() - Element in annotation interface com.soklet.annotation.DELETE
-
The
DELETEURL 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
GETURL 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
HEADURL 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.McpArgument
-
Specifies the argument name in the incoming MCP
argumentsobject. - value() - Element in annotation interface com.soklet.annotation.McpEndpointPathParameter
-
Specifies the endpoint path parameter name to bind.
- value() - Element in annotation interface com.soklet.annotation.McpUriParameter
-
Specifies the resource URI-template parameter name to bind.
- value() - Element in annotation interface com.soklet.annotation.OPTIONS
-
The
OPTIONSURL 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
PATCHURL 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
POSTURL 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
PUTURL 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.SseEventSource
-
The Server-Sent Event Source
GETURL that should be handled by this Resource Method. - value() - Element in annotation interface com.soklet.annotation.SseEventSources
- value() - Method in record class com.soklet.McpBoolean
-
Returns the value of the
valuerecord component. - value() - Method in record class com.soklet.McpClientCapabilities
-
Returns the value of the
valuerecord component. - value() - Method in record class com.soklet.McpJsonRpcRequestId
-
Returns the value of the
valuerecord component. - value() - Method in record class com.soklet.McpNegotiatedCapabilities
-
Returns the value of the
valuerecord component. - value() - Method in record class com.soklet.McpNumber
-
Returns the value of the
valuerecord component. - value() - Method in record class com.soklet.McpProgressToken
-
Returns the value of the
valuerecord component. - value() - Method in record class com.soklet.McpString
-
Returns the value of the
valuerecord component. - 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
ValueConverterinstances, 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
ValueConverterinstances viaValueConverters.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.McpNull
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.McpOperationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.McpPromptMessageRole
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.McpRequestOutcome
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.McpSessionTerminationReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.McpStreamTerminationReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.McpType
-
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.SnapshotTextOptions.HistogramFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.MetricsCollector.SseEventDropReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.MetricsCollector.SseEventEnqueueOutcome
-
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.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.SseComment.CommentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.SseConnection.HandshakeFailureReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.soklet.SseConnection.TerminationReason
-
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() - Method in record class com.soklet.McpArray
-
Returns the value of the
valuesrecord component. - values() - Static method in enum class com.soklet.McpNull
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in record class com.soklet.McpObject
-
Returns the value of the
valuesrecord component. - values() - Static method in enum class com.soklet.McpOperationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.soklet.McpPromptMessageRole
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.soklet.McpRequestOutcome
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.soklet.McpSessionTerminationReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.soklet.McpStreamTerminationReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.soklet.McpType
-
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.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.MetricsCollector.SseEventDropReason
-
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.SseEventEnqueueOutcome
-
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.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.SseComment.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.SseConnection.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.SseConnection.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.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 aSetfor 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.SseServer.Builder
- version() - Element in annotation interface com.soklet.annotation.McpServerEndpoint
-
Declares the MCP server version.
- version() - Method in record class com.soklet.McpClientInfo
-
Returns the value of the
versionrecord component. - version() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
versionrecord component. - version() - Method in record class com.soklet.McpStoredSession
-
Returns the value of the
versionrecord component.
W
- websiteUrl() - Element in annotation interface com.soklet.annotation.McpServerEndpoint
-
Declares optional server website URL metadata.
- websiteUrl() - Method in record class com.soklet.McpEndpointRegistration
-
Returns the value of the
websiteUrlrecord component. - 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.
- willEstablishSseConnection(Request, ResourceMethod) - Method in interface com.soklet.LifecycleObserver
-
Called before an SSE connection is established.
- willEstablishSseConnection(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. - willStartHttpServer(HttpServer) - Method in interface com.soklet.LifecycleObserver
-
Called before the server starts.
- willStartMcpServer(McpServer) - Method in interface com.soklet.LifecycleObserver
-
Called before the MCP server starts.
- willStartSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
-
Called before a
Sokletinstance starts. - willStartSseServer(SseServer) - Method in interface com.soklet.LifecycleObserver
-
Called before the SSE server starts.
- willStopHttpServer(HttpServer) - Method in interface com.soklet.LifecycleObserver
-
Called before the server stops.
- willStopMcpServer(McpServer) - Method in interface com.soklet.LifecycleObserver
-
Called before the MCP server stops.
- willStopSoklet(Soklet) - Method in interface com.soklet.LifecycleObserver
-
Called before a
Sokletinstance stops. - willStopSseServer(SseServer) - Method in interface com.soklet.LifecycleObserver
-
Called before the SSE server stops.
- willTerminateMcpSseStream(Request, Class, String, McpStreamTerminationReason, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called before an MCP GET stream is terminated.
- willTerminateSseConnection(SseConnection, SseConnection.TerminationReason, Throwable) - Method in interface com.soklet.LifecycleObserver
-
Called before an SSE connection is terminated.
- willTerminateSseConnection(SseConnection, SseConnection.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.
- willWriteSseComment(SseConnection, SseComment) - Method in interface com.soklet.LifecycleObserver
-
Called before an SSE comment is written.
- willWriteSseComment(SseConnection, SseComment) - Method in interface com.soklet.MetricsCollector
-
Called before an SSE comment is written.
- willWriteSseEvent(SseConnection, SseEvent) - Method in interface com.soklet.LifecycleObserver
-
Called before an SSE event is written.
- willWriteSseEvent(SseConnection, SseEvent) - Method in interface com.soklet.MetricsCollector
-
Called before an SSE event is written.
- with(LogEventType, String) - Static method in class com.soklet.LogEvent
-
Acquires a builder for
LogEventinstances. - with(String, byte[]) - Static method in class com.soklet.MultipartField
-
Acquires a builder for
MultipartFieldinstances. - 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
- with(String, Object) - Method in interface com.soklet.McpSessionContext
-
Returns a new session context containing the given key/value pair.
- with(String, String) - Static method in class com.soklet.ResponseCookie
-
Acquires a builder for
ResponseCookieinstances. - withAccessControlAllowOrigin(String) - Static method in class com.soklet.CorsPreflightResponse
-
Acquires a builder for
CorsPreflightResponseinstances. - withAccessControlAllowOrigin(String) - Static method in class com.soklet.CorsResponse
-
Acquires a builder for
CorsResponseinstances. - withCharset(Charset) - Static method in interface com.soklet.ResponseMarshaler
-
Acquires a builder for a default
ResponseMarshalerimplementation. - withData(String) - Static method in class com.soklet.SseEvent
-
Acquires a builder for
SseEventinstances, seeded with adatavalue. - withDescription(String) - Method in record class com.soklet.McpListedResource
-
Returns a copy of this resource entry with a description.
- withEvent(String) - Static method in class com.soklet.SseEvent
-
Acquires a builder for
SseEventinstances, seeded with aneventvalue. - 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.
- withHttpServer(HttpServer) - Static method in class com.soklet.SokletConfig
-
Vends a configuration builder, primed with the given HTTP
HttpServer. - withMarshaledResponse(MarshaledResponse) - Static method in class com.soklet.HttpRequestResult
-
Acquires a builder for
HttpRequestResultinstances. - withMcpServer(McpServer) - Static method in class com.soklet.SokletConfig
-
Vends a configuration builder, primed with the given
McpServer. - 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
MultipartFieldinstances. - withName(String) - Static method in class com.soklet.ParameterizedHeaderValue
- withName(String) - Static method in class com.soklet.ResponseCookie
-
Acquires a builder for
ResponseCookieinstances without specifying the cookie's value. - without(String) - Method in interface com.soklet.McpSessionContext
-
Returns a new session context without the given key.
- withoutBody() - Method in class com.soklet.MarshaledResponse.Builder
-
Removes the response body from this builder.
- withoutBody() - Method in class com.soklet.MarshaledResponse.Copier
-
Removes the response body from this copier.
- withPath(HttpMethod, String) - Static method in class com.soklet.Request
-
Acquires a builder for
Requestinstances from already-decoded path and query components - useful for manual construction, e.g. integration tests. - withPort(Integer) - Static method in interface com.soklet.HttpServer
-
Acquires a builder for
HttpServerinstances. - withPort(Integer) - Static method in interface com.soklet.McpServer
-
Acquires a builder configured with the given port.
- withPort(Integer) - Static method in interface com.soklet.SseServer
-
Acquires a builder for
SseServerinstances. - withPrompt(McpPromptHandler, Class) - Method in interface com.soklet.McpHandlerResolver
-
Returns a new resolver with the given prompt handler layered onto the specified endpoint class.
- withRawUrl(HttpMethod, String) - Static method in class com.soklet.Request
-
Acquires a builder for
Requestinstances 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
Responseinstances 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
Requestand a trust policy. - withResource(McpResourceHandler, Class) - Method in interface com.soklet.McpHandlerResolver
-
Returns a new resolver with the given resource handler layered onto the specified endpoint class.
- withResourceList(McpResourceListHandler, Class) - Method in interface com.soklet.McpHandlerResolver
-
Returns a new resolver with the given resource-list handler layered onto the specified endpoint class.
- withResponse(Response) - Static method in class com.soklet.MarshaledResponse
-
Acquires a builder for
MarshaledResponseinstances. - withSizeBytes(Long) - Method in record class com.soklet.McpListedResource
-
Returns a copy of this resource entry with a size metadata value.
- withSseServer(SseServer) - Static method in class com.soklet.SokletConfig
-
Vends a configuration builder, primed with the given
SseServer. - withStatusCode(Integer) - Static method in class com.soklet.MarshaledResponse
-
Acquires a builder for
MarshaledResponseinstances. - withStatusCode(Integer) - Static method in class com.soklet.Response
-
Acquires a builder for
Responseinstances. - withTitle(String) - Method in record class com.soklet.McpListedResource
-
Returns a copy of this resource entry with a title.
- withTool(McpToolHandler, Class) - Method in interface com.soklet.McpHandlerResolver
-
Returns a new resolver with the given tool handler layered onto the specified endpoint class.
- wrapRequest(ServerType, Request, Consumer) - Method in interface com.soklet.RequestInterceptor
-
Called before Soklet begins request processing, allowing the request to be wrapped or replaced.
- WRITE_FAILED - Enum constant in enum class com.soklet.McpStreamTerminationReason
- writeTimeout(Duration) - Method in class com.soklet.McpServer.Builder
-
Sets the transport write timeout.
- writeTimeout(Duration) - Method in class com.soklet.SseServer.Builder
X
- X_WWW_FORM_URLENCODED - Enum constant in enum class com.soklet.QueryFormat
-
Follow RFC 1866 (the
application/x-www-form-urlencodedcontent type), where keys and values are percent-encoded but prefer"+"for spaces.
All Classes and Interfaces|All Packages|Serialized Form