ProtocolServerConfigurationBuilder (Red Hat Data Grid 7.2.0 API)

java.lang.Object
- org.infinispan.server.core.configuration.ProtocolServerConfigurationBuilder<T,S>

All Implemented Interfaces:: Builder<T>, Self<S>, ProtocolServerConfigurationChildBuilder<T,S>

Direct Known Subclasses:: HotRodServerConfigurationBuilder, MemcachedServerConfigurationBuilder, RestServerConfigurationBuilder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected AdminOperationsHandler`	`adminOperationsHandler`
`protected String`	`defaultCacheName`
`protected String`	`host`
`protected int`	`idleTimeout`
`protected Set<String>`	`ignoredCaches`
`protected String`	`name`
`protected int`	`port`
`protected int`	`recvBufSize`
`protected int`	`sendBufSize`
`protected SslConfigurationBuilder<T,S>`	`ssl`
`protected boolean`	`startTransport`
`protected boolean`	`tcpKeepAlive`
`protected boolean`	`tcpNoDelay`
`protected int`	`workerThreads`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ProtocolServerConfigurationBuilder(int port)

Constructors
Modifier	Constructor and Description
`protected`	`ProtocolServerConfigurationBuilder(int port)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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
`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`	`ignoredCaches(Set<String> ignoredCaches)` Sets the caches to be ignored
`String`	`name()`
`S`	`name(String name)` Specifies a custom name for this server in order to easily distinguish it from other servers, e.g.
`S`	`port(int port)` Specifies the port on which this server will listen
`Builder<?>`	`read(T template)` 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
`SslConfigurationBuilder`	`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.
`void`	`validate()` Validate the data in this builder before building the configuration bean
`S`	`workerThreads(int workerThreads)` Sets the number of worker threads

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

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

- Field Detail
  - defaultCacheName
```
protected String defaultCacheName
```
  - name
```
protected String name
```
  - host
```
protected String host
```
  - port
```
protected int port
```
  - idleTimeout
```
protected int idleTimeout
```
  - recvBufSize
```
protected int recvBufSize
```
  - sendBufSize
```
protected int sendBufSize
```
  - ssl
```
protected final SslConfigurationBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>> ssl
```
  - tcpNoDelay
```
protected boolean tcpNoDelay
```
  - tcpKeepAlive
```
protected boolean tcpKeepAlive
```
  - workerThreads
```
protected int workerThreads
```
  - ignoredCaches
```
protected Set<String> ignoredCaches
```
  - startTransport
```
protected boolean startTransport
```
  - adminOperationsHandler
```
protected AdminOperationsHandler adminOperationsHandler
```
- Constructor Detail
  - ProtocolServerConfigurationBuilder
```
protected ProtocolServerConfigurationBuilder(int port)
```
- Method Detail
  - ignoredCaches
```
public S ignoredCaches(Set<String> ignoredCaches)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Sets the caches to be ignored
    
    Specified by:
    
    ignoredCaches in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - name
```
public S name(String name)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Specifies a custom name for this server in order to easily distinguish it from other servers, e.g. via JMX. Defaults to the empty string.
    
    Specified by:
    
    name in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - ssl
```
public SslConfigurationBuilder ssl()
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Configures SSL
    
    Specified by:
    
    ssl in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - workerThreads
```
public S workerThreads(int workerThreads)
```
    Description copied from interface: ProtocolServerConfigurationChildBuilder
    
    Sets the number of worker threads
    
    Specified by:
    
    workerThreads in interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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,S extends ProtocolServerConfigurationChildBuilder<T,S>>
  - 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>
  - read
```
public Builder<?> read(T 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<T extends ProtocolServerConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

Field Detail

defaultCacheName

name

host

port

idleTimeout

recvBufSize

sendBufSize

ssl

tcpNoDelay

tcpKeepAlive

workerThreads

ignoredCaches

startTransport

adminOperationsHandler

Constructor Detail

ProtocolServerConfigurationBuilder

Method Detail

ignoredCaches

defaultCacheName

name

name

host

port

idleTimeout

tcpNoDelay

tcpKeepAlive

recvBufSize

sendBufSize

ssl

workerThreads

startTransport

adminOperationsHandler

validate

read