Class RestServerConfigurationBuilder

java.lang.Object

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

org.infinispan.rest.configuration.RestServerConfigurationBuilder

All Implemented Interfaces:

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

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

RestServerConfigurationBuilder.

Since:

5.3

Author:

Tristan Tarrant

Field Summary

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

attributes, ipFilter, ssl

Constructor Summary

Constructors

Constructor	Description
RestServerConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
RestServerConfigurationBuilder	addAll(List<io.netty.handler.codec.http.cors.CorsConfig> corsConfig)
AttributeSet	attributes()
RestAuthenticationConfigurationBuilder	authentication()
RestServerConfiguration	build()	Builds a configuration object
RestServerConfiguration	build(boolean validate)
RestServerConfigurationBuilder	compressionLevel(int compressLevel)
RestServerConfigurationBuilder	compressionThreshold(int compressThreshold)
RestServerConfigurationBuilder	contextPath(String contextPath)
CorsConfigurationBuilder	cors()
RestServerConfiguration	create()	Create the configuration bean
RestServerConfigurationBuilder	defaultCacheName(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(String maxContentLength)	The maximum size a request can be, if exceeded the request will be rejected and possibly forcibly close the socket
Builder<?>	read(RestServerConfiguration template, Combine combine)	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(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, implicitConnector, implicitConnector, ioThreads, ipFilter, maxContentLength, name, name, port, port, socketBinding, socketBinding, ssl, startTransport, startTransport

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset

Constructor Details

RestServerConfigurationBuilder

public RestServerConfigurationBuilder()

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<RestServerConfiguration>

extendedHeaders

public RestServerConfigurationBuilder extendedHeaders(ExtendedHeaders extendedHeaders)

contextPath

public RestServerConfigurationBuilder contextPath(String contextPath)

maxContentLength

public RestServerConfigurationBuilder maxContentLength(String maxContentLength)

Description copied from interface: ProtocolServerConfigurationChildBuilder

The maximum size a request can be, if exceeded the request will be rejected and possibly forcibly close the socket

Specified by:

maxContentLength in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

Overrides:

maxContentLength in class ProtocolServerConfigurationBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

Parameters:

maxContentLength - the maximum size a request can be, valid values are handled by ByteQuantity

Returns:

this builder

compressionLevel

public RestServerConfigurationBuilder compressionLevel(int compressLevel)

compressionThreshold

public RestServerConfigurationBuilder compressionThreshold(int compressThreshold)

authentication

public RestAuthenticationConfigurationBuilder authentication()

Specified by:

authentication in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

encryption

public EncryptionConfigurationBuilder encryption()

addAll

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

staticResources

public RestServerConfigurationBuilder staticResources(Path dir)

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, RestAuthenticationConfiguration>

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,
 Combine combine)

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, RestAuthenticationConfiguration>

Parameters:

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

combine - the way attributes and children of this instance and the template should be combined.

build

public RestServerConfiguration build()

Description copied from interface: ProtocolServerConfigurationChildBuilder

Builds a configuration object

Specified by:

build in interface ProtocolServerConfigurationChildBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

build

public RestServerConfiguration build(boolean validate)

self

public RestServerConfigurationBuilder self()

Specified by:

self in interface Self<RestServerConfigurationBuilder>

defaultCacheName

public RestServerConfigurationBuilder defaultCacheName(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, RestAuthenticationConfiguration>

Overrides:

defaultCacheName in class ProtocolServerConfigurationBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

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, RestAuthenticationConfiguration>

Overrides:

idleTimeout in class ProtocolServerConfigurationBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

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, RestAuthenticationConfiguration>

Overrides:

tcpNoDelay in class ProtocolServerConfigurationBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

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, RestAuthenticationConfiguration>

Overrides:

tcpKeepAlive in class ProtocolServerConfigurationBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

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, RestAuthenticationConfiguration>

Overrides:

recvBufSize in class ProtocolServerConfigurationBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>

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, RestAuthenticationConfiguration>

Overrides:

sendBufSize in class ProtocolServerConfigurationBuilder<RestServerConfiguration, RestServerConfigurationBuilder, RestAuthenticationConfiguration>