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

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HotRodServerConfigurationBuilder, MemcachedServerConfigurationBuilder, RespServerConfigurationBuilder, RestServerConfigurationBuilder

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final AttributeSet	attributes
protected final IpFilterConfigurationBuilder<T,S,A>	ipFilter
protected final SslConfigurationBuilder<T,S,A>	ssl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProtocolServerConfigurationBuilder(int port, AttributeSet attributes)

Method Summary

Modifier and Type	Method	Description
S	adminOperationsHandler(AdminOperationsHandler handler)	Indicates the AdminOperationsHandler which will be used to handle admin operations
S	defaultCacheName(String defaultCacheName)	Specifies the cache to use as a default cache for the protocol
String	host()
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
boolean	implicitConnector()
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
String	maxContentLength()
S	maxContentLength(String maxContentLength)	The maximum size a request can be, if exceeded the request will be rejected and possibly forcibly close the socket
String	name()
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.
int	port()
S	port(int port)	Specifies the port on which this server will listen
Builder<?>	read(T template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
S	recvBufSize(int recvBufSize)	Sets the size of the receive buffer
S	sendBufSize(int sendBufSize)	Sets the size of the send buffer
String	socketBinding()
S	socketBinding(String name)	Indicates the name of socket binding which will be used
SslConfigurationBuilder	ssl()	Configures SSL
boolean	startTransport()
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.
void	validate()	Validate the data in this builder before building the configuration bean

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

attributes, create, read, reset

Methods inherited from interface org.infinispan.server.core.configuration.ProtocolServerConfigurationChildBuilder

authentication, build

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

self

Field Details

attributes

protected final AttributeSet attributes

ssl

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

ipFilter

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

Constructor Details

ProtocolServerConfigurationBuilder

protected ProtocolServerConfigurationBuilder(int port,
 AttributeSet attributes)

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>

name

public String name()

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>

host

public String host()

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>

port

public int port()

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>

ssl

public SslConfigurationBuilder 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>

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>

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>

startTransport

public boolean startTransport()

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>

socketBinding

public String socketBinding()

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>

implicitConnector

public boolean implicitConnector()

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

maxContentLength

public String maxContentLength()

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<T extends ProtocolServerConfiguration<T,A>>

read

public Builder<?> read(T 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<T extends ProtocolServerConfiguration<T,A>>

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.