Class AbstractProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

java.lang.Object

org.infinispan.server.core.configuration.AbstractProtocolServerConfigurationChildBuilder<T,S,A>

All Implemented Interfaces:

Self<S>, ProtocolServerConfigurationChildBuilder<T,S,A>

Direct Known Subclasses:

IpFilterConfigurationBuilder, RespAuthenticationConfigurationBuilder, RestAuthenticationConfigurationBuilder, SslConfigurationBuilder

public abstract class AbstractProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>
extends Object
implements ProtocolServerConfigurationChildBuilder<T,S,A>

Helper

Since:

9.1

Author:

Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field	Description
protected final ProtocolServerConfigurationChildBuilder<T,S,A>	builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProtocolServerConfigurationChildBuilder(ProtocolServerConfigurationChildBuilder<T,S,A> builder)

Method Summary

Modifier and Type	Method	Description
S	adminOperationsHandler(AdminOperationsHandler handler)	Indicates the AdminOperationsHandler which will be used to handle admin operations
AuthenticationConfigurationBuilder<A>	authentication()
T	build()	Builds a configuration object
S	defaultCacheName(String defaultCacheName)	Specifies the cache to use as a default cache for the protocol
S	host(String host)	Specifies the host or IP address on which this server will listen
S	idleTimeout(int idleTimeout)	Specifies the maximum time that connections from client will be kept open without activity
S	implicitConnector(boolean implicitConnector)	Indicates whether this connector was added implicitly
S	ioThreads(int ioThreads)	Sets the number of I/O threads
IpFilterConfigurationBuilder<T,S,A>	ipFilter()	Configures the IP filter rules
S	maxContentLength(String maxContentLength)	The maximum size a request can be, if exceeded the request will be rejected and possibly forcibly close the socket
S	name(String name)	Specifies a custom name for this protocol server in order to easily distinguish it from others of the same type on the same server, e.g. via JMX.
S	port(int port)	Specifies the port on which this server will listen
S	recvBufSize(int recvBufSize)	Sets the size of the receive buffer
S	sendBufSize(int sendBufSize)	Sets the size of the send buffer
S	socketBinding(String name)	Indicates the name of socket binding which will be used
SslConfigurationBuilder<T,S,A>	ssl()	Configures SSL
S	startTransport(boolean startTransport)	Indicates whether transport implementation should or should not be started.
S	tcpKeepAlive(boolean tcpKeepAlive)	Affects TCP KEEPALIVE on the TCP stack.
S	tcpNoDelay(boolean tcpNoDelay)	Affects TCP NODELAY on the TCP stack.

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.Self

self

Field Details

builder

protected final ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration> builder

Constructor Details

AbstractProtocolServerConfigurationChildBuilder

protected AbstractProtocolServerConfigurationChildBuilder(ProtocolServerConfigurationChildBuilder<T,S,A> builder)

Method Details

defaultCacheName

public S 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<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

name

public S name(String name)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Specifies a custom name for this protocol server in order to easily distinguish it from others of the same type on the same server, e.g. via JMX. Defaults to the empty string. The name should be the same across the cluster.

Specified by:

name in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

host

public S host(String host)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Specifies the host or IP address on which this server will listen

Specified by:

host in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

port

public S port(int port)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Specifies the port on which this server will listen

Specified by:

port in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

idleTimeout

public S 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<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

tcpNoDelay

public S tcpNoDelay(boolean tcpNoDelay)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Affects TCP NODELAY on the TCP stack. Defaults to enabled

Specified by:

tcpNoDelay in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

tcpKeepAlive

public S tcpKeepAlive(boolean tcpKeepAlive)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Affects TCP KEEPALIVE on the TCP stack. Defaults to disabled

Specified by:

tcpKeepAlive in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

recvBufSize

public S recvBufSize(int recvBufSize)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Sets the size of the receive buffer

Specified by:

recvBufSize in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

sendBufSize

public S sendBufSize(int sendBufSize)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Sets the size of the send buffer

Specified by:

sendBufSize in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

authentication

public AuthenticationConfigurationBuilder<A> authentication()

Specified by:

authentication in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

ssl

public SslConfigurationBuilder<T,S,A> ssl()

Description copied from interface: ProtocolServerConfigurationChildBuilder

Configures SSL

Specified by:

ssl in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

ioThreads

public S ioThreads(int ioThreads)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Sets the number of I/O threads

Specified by:

ioThreads in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

startTransport

public S startTransport(boolean startTransport)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Indicates whether transport implementation should or should not be started.

Specified by:

startTransport in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

adminOperationsHandler

public S adminOperationsHandler(AdminOperationsHandler handler)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Indicates the AdminOperationsHandler which will be used to handle admin operations

Specified by:

adminOperationsHandler in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

socketBinding

public S socketBinding(String name)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Indicates the name of socket binding which will be used

Specified by:

socketBinding in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

ipFilter

public IpFilterConfigurationBuilder<T,S,A> ipFilter()

Description copied from interface: ProtocolServerConfigurationChildBuilder

Configures the IP filter rules

Specified by:

ipFilter in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

implicitConnector

public S implicitConnector(boolean implicitConnector)

Description copied from interface: ProtocolServerConfigurationChildBuilder

Indicates whether this connector was added implicitly

Specified by:

implicitConnector in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

maxContentLength

public S 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<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

Parameters:

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

Returns:

this builder

build

public T build()

Description copied from interface: ProtocolServerConfigurationChildBuilder

Builds a configuration object

Specified by:

build in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>