Class HttpServer.Builder

java.lang.Object

com.soklet.HttpServer.Builder

Enclosing interface:

HttpServer

@NotThreadSafe
public static final class HttpServer.Builder
extends Object

Builder used to construct a standard implementation of HttpServer.

This class is intended for use by a single thread.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull HttpServer	build()
@NonNull HttpServer.Builder	concurrency(@Nullable Integer concurrency)
@NonNull HttpServer.Builder	host(@Nullable String host)
@NonNull HttpServer.Builder	idGenerator(@Nullable IdGenerator<?> idGenerator)
@NonNull HttpServer.Builder	maximumConnections(@Nullable Integer maximumConnections)
@NonNull HttpServer.Builder	maximumHeaderCount(@Nullable Integer maximumHeaderCount)	Sets the maximum number of HTTP header fields accepted in one request.
@NonNull HttpServer.Builder	maximumRequestSizeInBytes(@Nullable Integer maximumRequestSizeInBytes)	Sets the maximum accepted HTTP request size in bytes.
@NonNull HttpServer.Builder	maximumRequestTargetLengthInBytes(@Nullable Integer maximumRequestTargetLengthInBytes)	Sets the maximum request-target length accepted in bytes.
@NonNull HttpServer.Builder	multipartParser(@Nullable MultipartParser multipartParser)
@NonNull HttpServer.Builder	port(@NonNull Integer port)
@NonNull HttpServer.Builder	requestBodyTimeout(@Nullable Duration requestBodyTimeout)	Sets the maximum duration for reading the HTTP request body after the request line and headers have been received.
@NonNull HttpServer.Builder	requestHandlerConcurrency(@Nullable Integer requestHandlerConcurrency)
@NonNull HttpServer.Builder	requestHandlerExecutorServiceSupplier(@Nullable Supplier<ExecutorService> requestHandlerExecutorServiceSupplier)
@NonNull HttpServer.Builder	requestHandlerQueueCapacity(@Nullable Integer requestHandlerQueueCapacity)
@NonNull HttpServer.Builder	requestHandlerTimeout(@Nullable Duration requestHandlerTimeout)
@NonNull HttpServer.Builder	requestHeaderTimeout(@Nullable Duration requestHeaderTimeout)	Sets the maximum duration for reading the HTTP request line and headers.
@NonNull HttpServer.Builder	requestReadBufferSizeInBytes(@Nullable Integer requestReadBufferSizeInBytes)
@NonNull HttpServer.Builder	shutdownTimeout(@Nullable Duration shutdownTimeout)
@NonNull HttpServer.Builder	socketPendingConnectionLimit(@Nullable Integer socketPendingConnectionLimit)
@NonNull HttpServer.Builder	socketSelectTimeout(@Nullable Duration socketSelectTimeout)
@NonNull HttpServer.Builder	streamingChunkSizeInBytes(@Nullable Integer streamingChunkSizeInBytes)	Sets the maximum payload chunk size used for HTTP/1.1 chunked streaming.
@NonNull HttpServer.Builder	streamingExecutorServiceSupplier(@Nullable Supplier<ExecutorService> streamingExecutorServiceSupplier)	Sets the executor service supplier used to run streaming response producers.
@NonNull HttpServer.Builder	streamingQueueCapacityInBytes(@Nullable Integer streamingQueueCapacityInBytes)	Sets the per-stream producer queue capacity in bytes.
@NonNull HttpServer.Builder	streamingResponseIdleTimeout(@Nullable Duration streamingResponseIdleTimeout)	Sets the maximum idle duration between bytes produced for a streaming response.
@NonNull HttpServer.Builder	streamingResponseTimeout(@Nullable Duration streamingResponseTimeout)	Sets the maximum total duration for a streaming response.

Methods inherited from class Object

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

Method Details

port

public @NonNull HttpServer.Builder port(@NonNull Integer port)

host

public @NonNull HttpServer.Builder host(@Nullable String host)

concurrency

public @NonNull HttpServer.Builder concurrency(@Nullable Integer concurrency)

requestHeaderTimeout

public @NonNull HttpServer.Builder requestHeaderTimeout(@Nullable Duration requestHeaderTimeout)

Sets the maximum duration for reading the HTTP request line and headers.

If this value is not specified, Soklet uses the server default.

Parameters:

requestHeaderTimeout - the request header timeout, or null for the default

Returns:

this builder

requestBodyTimeout

public @NonNull HttpServer.Builder requestBodyTimeout(@Nullable Duration requestBodyTimeout)

Sets the maximum duration for reading the HTTP request body after the request line and headers have been received.

If this value is not specified, Soklet uses the server default.

Parameters:

requestBodyTimeout - the request body timeout, or null for the default

Returns:

this builder

requestHandlerTimeout

public @NonNull HttpServer.Builder requestHandlerTimeout(@Nullable Duration requestHandlerTimeout)

requestHandlerConcurrency

public @NonNull HttpServer.Builder requestHandlerConcurrency(@Nullable Integer requestHandlerConcurrency)

requestHandlerQueueCapacity

public @NonNull HttpServer.Builder requestHandlerQueueCapacity(@Nullable Integer requestHandlerQueueCapacity)

socketSelectTimeout

public @NonNull HttpServer.Builder socketSelectTimeout(@Nullable Duration socketSelectTimeout)

socketPendingConnectionLimit

public @NonNull HttpServer.Builder socketPendingConnectionLimit(@Nullable Integer socketPendingConnectionLimit)

maximumConnections

public @NonNull HttpServer.Builder maximumConnections(@Nullable Integer maximumConnections)

shutdownTimeout

public @NonNull HttpServer.Builder shutdownTimeout(@Nullable Duration shutdownTimeout)

maximumRequestSizeInBytes

public @NonNull HttpServer.Builder maximumRequestSizeInBytes(@Nullable Integer maximumRequestSizeInBytes)

Sets the maximum accepted HTTP request size in bytes.

This limit applies to the whole received HTTP request, including request line, headers, transfer framing, and body bytes. Applications that think in terms of payload size should leave room for request metadata and protocol framing.

Parameters:

maximumRequestSizeInBytes - the maximum request size, or null for the default

Returns:

this builder

maximumHeaderCount

public @NonNull HttpServer.Builder maximumHeaderCount(@Nullable Integer maximumHeaderCount)

Sets the maximum number of HTTP header fields accepted in one request.

Parameters:

maximumHeaderCount - the maximum header count, or null for the default

Returns:

this builder

maximumRequestTargetLengthInBytes

public @NonNull HttpServer.Builder maximumRequestTargetLengthInBytes(@Nullable Integer maximumRequestTargetLengthInBytes)

Sets the maximum request-target length accepted in bytes.

Parameters:

maximumRequestTargetLengthInBytes - the maximum request-target length, or null for the default

Returns:

this builder

requestReadBufferSizeInBytes

public @NonNull HttpServer.Builder requestReadBufferSizeInBytes(@Nullable Integer requestReadBufferSizeInBytes)

multipartParser

public @NonNull HttpServer.Builder multipartParser(@Nullable MultipartParser multipartParser)

requestHandlerExecutorServiceSupplier

public @NonNull HttpServer.Builder requestHandlerExecutorServiceSupplier(@Nullable Supplier<ExecutorService> requestHandlerExecutorServiceSupplier)

streamingExecutorServiceSupplier

public @NonNull HttpServer.Builder streamingExecutorServiceSupplier(@Nullable Supplier<ExecutorService> streamingExecutorServiceSupplier)

Sets the executor service supplier used to run streaming response producers.

Parameters:

streamingExecutorServiceSupplier - the executor service supplier, or null for the default

Returns:

this builder

streamingQueueCapacityInBytes

public @NonNull HttpServer.Builder streamingQueueCapacityInBytes(@Nullable Integer streamingQueueCapacityInBytes)

Sets the per-stream producer queue capacity in bytes.

Parameters:

streamingQueueCapacityInBytes - the queue capacity, or null for the default

Returns:

this builder

streamingChunkSizeInBytes

public @NonNull HttpServer.Builder streamingChunkSizeInBytes(@Nullable Integer streamingChunkSizeInBytes)

Sets the maximum payload chunk size used for HTTP/1.1 chunked streaming.

Parameters:

streamingChunkSizeInBytes - the payload chunk size, or null for the default

Returns:

this builder

streamingResponseTimeout

public @NonNull HttpServer.Builder streamingResponseTimeout(@Nullable Duration streamingResponseTimeout)

Sets the maximum total duration for a streaming response.

Use Duration.ZERO to disable the timeout.

Parameters:

streamingResponseTimeout - the streaming response timeout, or null for the default

Returns:

this builder

streamingResponseIdleTimeout

public @NonNull HttpServer.Builder streamingResponseIdleTimeout(@Nullable Duration streamingResponseIdleTimeout)

Sets the maximum idle duration between bytes produced for a streaming response.

Use Duration.ZERO to disable the timeout.

Parameters:

streamingResponseIdleTimeout - the streaming response idle timeout, or null for the default

Returns:

this builder

idGenerator

public @NonNull HttpServer.Builder idGenerator(@Nullable IdGenerator<?> idGenerator)

build

public @NonNull HttpServer build()