Package org.infinispan.rest.configuration

Class RestServerConfigurationBuilder

java.lang.Object

org.infinispan.server.core.configuration.ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

org.infinispan.rest.configuration.RestServerConfigurationBuilder

All Implemented Interfaces:

Builder<RestServerConfiguration>, Self<RestServerConfigurationBuilder>, ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

public class RestServerConfigurationBuilder
extends ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>
implements Builder<RestServerConfiguration>

RestServerConfigurationBuilder.

Since:

5.3

Author:

Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field	Description
static int	CROSS_ORIGIN_ALT_PORT
static int	CROSS_ORIGIN_PORT
static java.lang.String	DEFAULT_NAME
static int	DEFAULT_PORT
static java.lang.String	SERVER_HOME
static java.lang.String	STATIC_RESOURCES_PATH

Fields inherited from class org.infinispan.server.core.configuration.ProtocolServerConfigurationBuilder

attributes, ssl

Constructor Summary

Constructors

Constructor	Description
RestServerConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
RestServerConfigurationBuilder	addAll(java.util.List<io.netty.handler.codec.http.cors.CorsConfig> corsConfig)
AuthenticationConfigurationBuilder	authentication()
RestServerConfiguration	build()	Builds a configuration object
RestServerConfiguration	build(boolean validate)
RestServerConfigurationBuilder	compressionLevel(int compressLevel)
RestServerConfigurationBuilder	contextPath(java.lang.String contextPath)
CorsConfigurationBuilder	cors()
RestServerConfigurationBuilder	corsAllowForLocalhost(java.util.Set<java.lang.String> schemes, int... ports)
RestServerConfiguration	create()	Create the configuration bean
RestServerConfigurationBuilder	defaultCacheName(java.lang.String defaultCacheName)	Specifies the cache to use as a default cache for the protocol
EncryptionConfigurationBuilder	encryption()
RestServerConfigurationBuilder	extendedHeaders(ExtendedHeaders extendedHeaders)
RestServerConfigurationBuilder	idleTimeout(int idleTimeout)	Specifies the maximum time that connections from client will be kept open without activity
RestServerConfigurationBuilder	maxContentLength(int maxContentLength)
Builder<?>	read(RestServerConfiguration template)	Reads the configuration from an already created configuration bean into this builder.
RestServerConfigurationBuilder	recvBufSize(int recvBufSize)	Sets the size of the receive buffer
RestServerConfigurationBuilder	self()
RestServerConfigurationBuilder	sendBufSize(int sendBufSize)	Sets the size of the send buffer
RestServerConfigurationBuilder	staticResources(java.nio.file.Path dir)
RestServerConfigurationBuilder	tcpKeepAlive(boolean tcpKeepAlive)	Affects TCP KEEPALIVE on the TCP stack.
RestServerConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay)	Affects TCP NODELAY on the TCP stack.
void	validate()	Validate the data in this builder before building the configuration bean

Methods inherited from class org.infinispan.server.core.configuration.ProtocolServerConfigurationBuilder

adminOperationsHandler, host, host, ioThreads, name, name, port, port, socketBinding, ssl, startTransport, workerThreads

Methods inherited from class java.lang.Object

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

Field Detail

CROSS_ORIGIN_PORT

public static final int CROSS_ORIGIN_PORT

See Also:

Constant Field Values

CROSS_ORIGIN_ALT_PORT

public static final int CROSS_ORIGIN_ALT_PORT

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

See Also:

Constant Field Values

SERVER_HOME

public static final java.lang.String SERVER_HOME

See Also:

Constant Field Values

STATIC_RESOURCES_PATH

public static final java.lang.String STATIC_RESOURCES_PATH

See Also:

Constant Field Values

Constructor Detail

RestServerConfigurationBuilder

public RestServerConfigurationBuilder()

Method Detail

extendedHeaders

public RestServerConfigurationBuilder extendedHeaders(ExtendedHeaders extendedHeaders)

contextPath

public RestServerConfigurationBuilder contextPath(java.lang.String contextPath)

maxContentLength

public RestServerConfigurationBuilder maxContentLength(int maxContentLength)

compressionLevel

public RestServerConfigurationBuilder compressionLevel(int compressLevel)

corsAllowForLocalhost

public RestServerConfigurationBuilder corsAllowForLocalhost(java.util.Set<java.lang.String> schemes,
                                                            int... ports)

encryption

public EncryptionConfigurationBuilder encryption()

addAll

public RestServerConfigurationBuilder addAll(java.util.List<io.netty.handler.codec.http.cors.CorsConfig> corsConfig)

staticResources

public RestServerConfigurationBuilder staticResources(java.nio.file.Path dir)

authentication

public AuthenticationConfigurationBuilder authentication()

cors

public CorsConfigurationBuilder cors()

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<RestServerConfiguration>

Overrides:

validate in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

create

public RestServerConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<RestServerConfiguration>

Returns:

read

public Builder<?> read(RestServerConfiguration template)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<RestServerConfiguration>

Overrides:

read in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

Parameters:

template - the configuration from which to "clone" this config if needed.

build

public RestServerConfiguration build()

Description copied from interface: ProtocolServerConfigurationChildBuilder

Builds a configuration object

Specified by:

build in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

build

public RestServerConfiguration build(boolean validate)

self

public RestServerConfigurationBuilder self()

Specified by:

self in interface Self<RestServerConfigurationBuilder>

defaultCacheName

public RestServerConfigurationBuilder defaultCacheName(java.lang.String defaultCacheName)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Specifies the cache to use as a default cache for the protocol

Specified by:

defaultCacheName in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

Overrides:

defaultCacheName in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

idleTimeout

public RestServerConfigurationBuilder idleTimeout(int idleTimeout)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Specifies the maximum time that connections from client will be kept open without activity

Specified by:

idleTimeout in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

Overrides:

idleTimeout in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

tcpNoDelay

public RestServerConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Affects TCP NODELAY on the TCP stack. Defaults to enabled

Specified by:

tcpNoDelay in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

Overrides:

tcpNoDelay in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

tcpKeepAlive

public RestServerConfigurationBuilder tcpKeepAlive(boolean tcpKeepAlive)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Affects TCP KEEPALIVE on the TCP stack. Defaults to disabled

Specified by:

tcpKeepAlive in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

Overrides:

tcpKeepAlive in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

recvBufSize

public RestServerConfigurationBuilder recvBufSize(int recvBufSize)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Sets the size of the receive buffer

Specified by:

recvBufSize in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

Overrides:

recvBufSize in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

sendBufSize

public RestServerConfigurationBuilder sendBufSize(int sendBufSize)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Sets the size of the send buffer

Specified by:

sendBufSize in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration,RestServerConfigurationBuilder>

Overrides:

sendBufSize in class ProtocolServerConfigurationBuilder<RestServerConfiguration,RestServerConfigurationBuilder>