Class SokletConfig

java.lang.Object

com.soklet.SokletConfig

@ThreadSafe
public final class SokletConfig
extends Object

Defines how a Soklet system is configured.

Threadsafe instances can be acquired via one of the builder factory methods such as withHttpServer(HttpServer), withSseServer(SseServer), or withMcpServer(McpServer).

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SokletConfig.Builder	Builder used to construct instances of SokletConfig.
static final class	SokletConfig.Copier	Builder used to copy instances of SokletConfig.

Method Summary

Modifier and Type	Method	Description
@NonNull SokletConfig.Copier	copy()	Vends a mutable copy of this instance's configuration, suitable for building new instances.
@NonNull CorsAuthorizer	getCorsAuthorizer()	How Soklet handles Cross-Origin Resource Sharing (CORS).
@NonNull Optional<HttpServer>	getHttpServer()	The HTTP server managed by Soklet, if configured.
@NonNull InstanceProvider	getInstanceProvider()	How Soklet will perform instance creation.
@NonNull LifecycleObserver	getLifecycleObserver()	How Soklet will observe server and request lifecycle events.
@NonNull Optional<McpServer>	getMcpServer()	The MCP server managed by Soklet, if configured.
@NonNull MetricsCollector	getMetricsCollector()	How Soklet will collect operational metrics.
@NonNull RequestBodyMarshaler	getRequestBodyMarshaler()	How Soklet will marshal request bodies to Java types.
@NonNull RequestInterceptor	getRequestInterceptor()	How Soklet will perform custom behavior during request handling.
@NonNull ResourceMethodParameterProvider	getResourceMethodParameterProvider()	How Soklet performs Resource Method parameter injection (experts only!)
@NonNull ResourceMethodResolver	getResourceMethodResolver()	How Soklet performs Resource Method resolution (experts only!)
@NonNull ResponseMarshaler	getResponseMarshaler()	How Soklet will marshal response bodies to bytes suitable for transmission over the wire.
@NonNull Optional<SseServer>	getSseServer()	The SSE server managed by Soklet, if configured.
@NonNull ValueConverterRegistry	getValueConverterRegistry()	How Soklet will perform conversions from one Java type to another, like a String to a LocalDate.
static @NonNull SokletConfig.Builder	withHttpServer(@NonNull HttpServer httpServer)	Vends a configuration builder, primed with the given HTTP HttpServer.
static @NonNull SokletConfig.Builder	withMcpServer(@NonNull McpServer mcpServer)	Vends a configuration builder, primed with the given McpServer.
static @NonNull SokletConfig.Builder	withSseServer(@NonNull SseServer sseServer)	Vends a configuration builder, primed with the given SseServer.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withHttpServer

public static @NonNull SokletConfig.Builder withHttpServer(@NonNull HttpServer httpServer)

Vends a configuration builder, primed with the given HTTP HttpServer.

Parameters:

httpServer - the HTTP server necessary for construction

Returns:

a builder for SokletConfig instances

withSseServer

public static @NonNull SokletConfig.Builder withSseServer(@NonNull SseServer sseServer)

Vends a configuration builder, primed with the given SseServer.

Parameters:

sseServer - the SSE server necessary for construction

Returns:

a builder for SokletConfig instances

withMcpServer

public static @NonNull SokletConfig.Builder withMcpServer(@NonNull McpServer mcpServer)

Vends a configuration builder, primed with the given McpServer.

Parameters:

mcpServer - the MCP server necessary for construction

Returns:

a builder for SokletConfig instances

copy

public @NonNull SokletConfig.Copier copy()

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

Returns:

a mutable copy of this instance's configuration

getInstanceProvider

public @NonNull InstanceProvider getInstanceProvider()

How Soklet will perform instance creation.

Returns:

the instance responsible for instance creation

getValueConverterRegistry

public @NonNull ValueConverterRegistry getValueConverterRegistry()

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

Returns:

the instance responsible for value conversions

getRequestBodyMarshaler

public @NonNull RequestBodyMarshaler getRequestBodyMarshaler()

How Soklet will marshal request bodies to Java types.

Returns:

the instance responsible for request body marshaling

getResourceMethodResolver

public @NonNull ResourceMethodResolver getResourceMethodResolver()

How Soklet performs Resource Method resolution (experts only!)

Returns:

the instance responsible for Resource Method resolution

getResourceMethodParameterProvider

public @NonNull ResourceMethodParameterProvider getResourceMethodParameterProvider()

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

Returns:

the instance responsible for Resource Method parameter injection

getResponseMarshaler

public @NonNull ResponseMarshaler getResponseMarshaler()

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

Returns:

the instance responsible for response body marshaling

getRequestInterceptor

public @NonNull RequestInterceptor getRequestInterceptor()

How Soklet will perform custom behavior during request handling.

Returns:

the instance responsible for request interceptor behavior

getLifecycleObserver

public @NonNull LifecycleObserver getLifecycleObserver()

How Soklet will observe server and request lifecycle events.

Returns:

the instance responsible for lifecycle observation

getMetricsCollector

public @NonNull MetricsCollector getMetricsCollector()

How Soklet will collect operational metrics.

Returns:

the instance responsible for metrics collection

getCorsAuthorizer

public @NonNull CorsAuthorizer getCorsAuthorizer()

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

Returns:

the instance responsible for CORS-related processing

getHttpServer

public @NonNull Optional<HttpServer> getHttpServer()

The HTTP server managed by Soklet, if configured.

Returns:

the HTTP server, if configured

getSseServer

public @NonNull Optional<SseServer> getSseServer()

The SSE server managed by Soklet, if configured.

Returns:

the SSE server instance, or Optional.empty() if none was configured

getMcpServer

public @NonNull Optional<McpServer> getMcpServer()

The MCP server managed by Soklet, if configured.

Returns:

the MCP server, if configured