Interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration>

Type Parameters:
T - the root configuration object returned by the builder. Must extend ProtocolServerConfiguration
S - the sub-builder this is an implementation of. Must extend ProtocolServerConfigurationChildBuilder
All Superinterfaces:
Self<S>
All Known Implementing Classes:
AbstractProtocolServerConfigurationChildBuilder, HotRodServerConfigurationBuilder, IpFilterConfigurationBuilder, MemcachedServerConfigurationBuilder, ProtocolServerConfigurationBuilder, RespAuthenticationConfigurationBuilder, RespServerConfigurationBuilder, RestAuthenticationConfigurationBuilder, RestServerConfigurationBuilder, SslConfigurationBuilder
public interface ProtocolServerConfigurationChildBuilder<T extends ProtocolServerConfiguration<T,A>, S extends ProtocolServerConfigurationChildBuilder<T,S,A>, A extends AuthenticationConfiguration> extends Self<S>
ProtocolServerConfigurationChildBuilder.
Since:
5.3
Author:
Tristan Tarrant

  • Method Details

    • defaultCacheName

      S defaultCacheName(String defaultCacheName)
      Specifies the cache to use as a default cache for the protocol

    • 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. Defaults to the empty string. The name should be the same across the cluster.

    • host

      S host(String host)
      Specifies the host or IP address on which this server will listen

    • port

      S port(int port)
      Specifies the port on which this server will listen

    • idleTimeout

      S idleTimeout(int idleTimeout)
      Specifies the maximum time that connections from client will be kept open without activity

    • tcpNoDelay

      S tcpNoDelay(boolean tcpNoDelay)
      Affects TCP NODELAY on the TCP stack. Defaults to enabled

    • tcpKeepAlive

      S tcpKeepAlive(boolean tcpKeepAlive)
      Affects TCP KEEPALIVE on the TCP stack. Defaults to disabled

    • recvBufSize

      S recvBufSize(int recvBufSize)
      Sets the size of the receive buffer

    • sendBufSize

      S sendBufSize(int sendBufSize)
      Sets the size of the send buffer

    • authentication

      AuthenticationConfigurationBuilder<A> authentication()

    • ssl

      SslConfigurationBuilder<T,S,A> ssl()
      Configures SSL

    • ipFilter

      IpFilterConfigurationBuilder<T,S,A> ipFilter()
      Configures the IP filter rules

    • ioThreads

      S ioThreads(int ioThreads)
      Sets the number of I/O threads

    • startTransport

      S startTransport(boolean startTransport)
      Indicates whether transport implementation should or should not be started.

    • adminOperationsHandler

      S adminOperationsHandler(AdminOperationsHandler handler)
      Indicates the AdminOperationsHandler which will be used to handle admin operations

    • socketBinding

      S socketBinding(String name)
      Indicates the name of socket binding which will be used

    • implicitConnector

      S implicitConnector(boolean implicitConnector)
      Indicates whether this connector was added implicitly

    • 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
      Parameters:
      maxContentLength - the maximum size a request can be, valid values are handled by ByteQuantity
      Returns:
      this builder

    • build

      T build()
      Builds a configuration object