Class HttpServerOptions.Builder

java.lang.Object

org.refcodes.ontology.Taxonomy.Builder

org.refcodes.runtime.Settings.Builder

org.refcodes.runtime.Options.Builder

org.refcodes.rest.HttpServerOptions.Builder

All Implemented Interfaces:

ExecutorServiceAccessor.ExecutorServiceBuilder<HttpServerOptions.Builder>, MaxConnectionsAccessor.MaxConnectionsBuilder<HttpServerOptions.Builder>, PortAccessor.PortBuilder<HttpServerOptions.Builder>, KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpServerOptions.Builder>, BaseLocatorAccessor.BaseLocatorBuilder<HttpServerOptions.Builder>, HttpServerContext.Builder<HttpServerOptions.Builder>, RealmAccessor.RealmBuilder<HttpServerOptions.Builder>, SchemeAccessor.SchemeBuilder<HttpServerOptions.Builder>

Enclosing class:

HttpServerOptions

public static class HttpServerOptions.Builder
extends Options.Builder
implements HttpServerContext.Builder<HttpServerOptions.Builder>, ExecutorServiceAccessor.ExecutorServiceBuilder<HttpServerOptions.Builder>

Builder for creating HttpServerOptions instances.

Field Summary

Fields inherited from class Taxonomy.Builder

properties

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpServerOptions	build()	Creates the configured HttpServerOptions.
HttpServerOptions.Builder	withBaseLocator(String aBaseLocator)
HttpServerOptions.Builder	withExecutorService(ExecutorService aExecutorService)
HttpServerOptions.Builder	withKeyStoreDescriptor(KeyStoreDescriptor aKeyStoreDescriptor)	Configures the TLS/SSL keystore descriptor.
HttpServerOptions.Builder	withMaxConnections(int aMaxConnections)	Configures the maximum number of concurrent open connections.
HttpServerOptions.Builder	withPort(int aPort)	Configures the TCP port.
HttpServerOptions.Builder	withProtocol(String aProtocol)	Configures the transport protocol.
HttpServerOptions.Builder	withRealm(String aRealm)
HttpServerOptions.Builder	withScheme(Scheme aScheme)	Configures the Scheme.

Methods inherited from class Options.Builder

withProperties, withProperty, withProperty, withProperty

Methods inherited from class Taxonomy.Builder

withProperty

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

withScheme

public HttpServerOptions.Builder withScheme(Scheme aScheme)

Configures the Scheme.

Specified by:

withScheme in interface SchemeAccessor.SchemeBuilder<HttpServerOptions.Builder>

Parameters:

aScheme - The scheme to configure.

Returns:

This builder.

withProtocol

public HttpServerOptions.Builder withProtocol(String aProtocol)

Configures the transport protocol.

Specified by:

withProtocol in interface SchemeAccessor.SchemeBuilder<HttpServerOptions.Builder>

Parameters:

aProtocol - The protocol to configure.

Returns:

This builder.

withPort

public HttpServerOptions.Builder withPort(int aPort)

Configures the TCP port.

Specified by:

withPort in interface PortAccessor.PortBuilder<HttpServerOptions.Builder>

Parameters:

aPort - The TCP port.

Returns:

This builder.

withMaxConnections

public HttpServerOptions.Builder withMaxConnections(int aMaxConnections)

Configures the maximum number of concurrent open connections.

Specified by:

withMaxConnections in interface MaxConnectionsAccessor.MaxConnectionsBuilder<HttpServerOptions.Builder>

Parameters:

aMaxConnections - The maximum number of concurrent open connections.

Returns:

This builder.

withKeyStoreDescriptor

public HttpServerOptions.Builder withKeyStoreDescriptor(KeyStoreDescriptor aKeyStoreDescriptor)

Configures the TLS/SSL keystore descriptor.

Specified by:

withKeyStoreDescriptor in interface KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpServerOptions.Builder>

Parameters:

aKeyStoreDescriptor - The keystore descriptor.

Returns:

This builder.

withExecutorService

public HttpServerOptions.Builder withExecutorService(ExecutorService aExecutorService)

Specified by:

withExecutorService in interface ExecutorServiceAccessor.ExecutorServiceBuilder<HttpServerOptions.Builder>

withRealm

public HttpServerOptions.Builder withRealm(String aRealm)

Specified by:

withRealm in interface RealmAccessor.RealmBuilder<HttpServerOptions.Builder>

withBaseLocator

public HttpServerOptions.Builder withBaseLocator(String aBaseLocator)

Specified by:

withBaseLocator in interface BaseLocatorAccessor.BaseLocatorBuilder<HttpServerOptions.Builder>

build

public HttpServerOptions build()

Creates the configured HttpServerOptions.

Overrides:

build in class Options.Builder

Returns:

The constructed HttpServerOptions.