Class SokletConfiguration

java.lang.Object

com.soklet.SokletConfiguration

@ThreadSafe
public class SokletConfiguration
extends Object

Defines how a Soklet system is configured.

Author:

Mark Allen

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
SokletConfiguration.Copier	copy()	Vends a mutable copy of this instance's configuration, suitable for building new instances.
static SokletConfiguration.Builder	forTesting()	Vends a configuration builder with mock servers, suitable for unit and integration testing.
CorsAuthorizer	getCorsAuthorizer()	How Soklet handles Cross-Origin Resource Sharing (CORS).
InstanceProvider	getInstanceProvider()	How Soklet will perform instance creation.
LifecycleInterceptor	getLifecycleInterceptor()	How Soklet will perform custom behavior during server and request lifecycle events.
RequestBodyMarshaler	getRequestBodyMarshaler()	How Soklet will marshal request bodies to Java types.
ResourceMethodParameterProvider	getResourceMethodParameterProvider()	How Soklet performs Resource Method parameter injection (experts only!)
ResourceMethodResolver	getResourceMethodResolver()	How Soklet performs Resource Method resolution (experts only!)
ResponseMarshaler	getResponseMarshaler()	How Soklet will marshal response bodies to bytes suitable for transmission over the wire.
Server	getServer()	The server managed by Soklet.
Optional<ServerSentEventServer>	getServerSentEventServer()	The SSE server managed by Soklet, if configured.
ValueConverterRegistry	getValueConverterRegistry()	How Soklet will perform conversions from one Java type to another, like a String to a LocalDate.
static SokletConfiguration.Builder	withServer(Server server)	Vends a configuration builder for the given server.

Methods inherited from class java.lang.Object

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

Method Details

withServer

@Nonnull
public static SokletConfiguration.Builder withServer(@Nonnull
 Server server)

Vends a configuration builder for the given server.

Parameters:

server - the server necessary for construction

Returns:

a builder for SokletConfiguration instances

forTesting

@Nonnull
public static SokletConfiguration.Builder forTesting()

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

Returns:

a builder for SokletConfiguration instances

copy

@Nonnull
public SokletConfiguration.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

@Nonnull
public InstanceProvider getInstanceProvider()

How Soklet will perform instance creation.

Returns:

the instance responsible for instance creation

getValueConverterRegistry

@Nonnull
public 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

@Nonnull
public RequestBodyMarshaler getRequestBodyMarshaler()

How Soklet will marshal request bodies to Java types.

Returns:

the instance responsible for request body marshaling

getResourceMethodResolver

@Nonnull
public ResourceMethodResolver getResourceMethodResolver()

How Soklet performs Resource Method resolution (experts only!)

Returns:

the instance responsible for Resource Method resolution

getResourceMethodParameterProvider

@Nonnull
public ResourceMethodParameterProvider getResourceMethodParameterProvider()

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

Returns:

the instance responsible for Resource Method parameter injection

getResponseMarshaler

@Nonnull
public ResponseMarshaler getResponseMarshaler()

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

Returns:

the instance responsible for response body marshaling

getLifecycleInterceptor

@Nonnull
public LifecycleInterceptor getLifecycleInterceptor()

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

Returns:

the instance responsible for performing lifecycle event customization

getCorsAuthorizer

@Nonnull
public CorsAuthorizer getCorsAuthorizer()

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

Returns:

the instance responsible for CORS-related processing

getServer

@Nonnull
public Server getServer()

The server managed by Soklet.

Returns:

the server instance

getServerSentEventServer

@Nonnull
public Optional<ServerSentEventServer> getServerSentEventServer()

The SSE server managed by Soklet, if configured.

Returns:

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