ModCluster (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.undertow.configuration.ModCluster

```
public class ModCluster
extends Object
```
A mod-cluster front end load balancer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ModCluster.ModClusterResources
Child mutators for ModCluster

Nested Classes
Modifier and Type	Class and Description
`class`	`ModCluster.ModClusterResources` Child mutators for ModCluster

Constructor Summary

Constructors
Constructor and Description

ModCluster(String key)

Constructors
Constructor and Description
`ModCluster(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`advertiseFrequency()` The frequency (in milliseconds) that mod-cluster advertises itself on the network
`ModCluster`	`advertiseFrequency(Integer value)` The frequency (in milliseconds) that mod-cluster advertises itself on the network
`String`	`advertisePath()` The path that mod-cluster is registered under, defaults to /
`ModCluster`	`advertisePath(String value)` The path that mod-cluster is registered under, defaults to /
`String`	`advertiseProtocol()` The protocol that is in use, defaults to HTTP
`ModCluster`	`advertiseProtocol(String value)` The protocol that is in use, defaults to HTTP
`String`	`advertiseSocketBinding()` The multicast group that is used to advertise
`ModCluster`	`advertiseSocketBinding(String value)` The multicast group that is used to advertise
`ModCluster`	`balancer(Balancer value)` Add the org.wildfly.swarm.config.undertow.configuration.mod_cluster.Balancer object to the list of subresources
`ModCluster`	`balancers(List<Balancer> value)` Add all org.wildfly.swarm.config.undertow.configuration.mod_cluster.Balancer objects to this subresource
`Integer`	`brokenNodeTimeout()` The amount of time that must elapse before a broken node is removed from the table
`ModCluster`	`brokenNodeTimeout(Integer value)` The amount of time that must elapse before a broken node is removed from the table
`Integer`	`cachedConnectionsPerThread()` The number of connections that will be kept alive indefinitely
`ModCluster`	`cachedConnectionsPerThread(Integer value)` The number of connections that will be kept alive indefinitely
`Integer`	`connectionIdleTimeout()` The amount of time a connection can be idle before it will be closed.
`ModCluster`	`connectionIdleTimeout(Integer value)` The amount of time a connection can be idle before it will be closed.
`Integer`	`connectionsPerThread()` The number of connections that will be maintained to backend servers, per IO thread.
`ModCluster`	`connectionsPerThread(Integer value)` The number of connections that will be maintained to backend servers, per IO thread.
`String`	`getKey()`
`Integer`	`healthCheckInterval()` The frequency of health check pings to backend nodes
`ModCluster`	`healthCheckInterval(Integer value)` The frequency of health check pings to backend nodes
`String`	`managementAccessPredicate()` A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands.
`ModCluster`	`managementAccessPredicate(String value)` A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands.
`String`	`managementSocketBinding()` The socket binding of the mod_cluster management port.
`ModCluster`	`managementSocketBinding(String value)` The socket binding of the mod_cluster management port.
`Integer`	`maxRequestTime()` The max amount of time that a request to a backend node can take before it is killed
`ModCluster`	`maxRequestTime(Integer value)` The max amount of time that a request to a backend node can take before it is killed
`Integer`	`requestQueueSize()` The number of requests that can be queued if the connection pool is full before requests are rejected with a 503
`ModCluster`	`requestQueueSize(Integer value)` The number of requests that can be queued if the connection pool is full before requests are rejected with a 503
`String`	`securityKey()` The security key that is used for the mod-cluster group.
`ModCluster`	`securityKey(String value)` The security key that is used for the mod-cluster group.
`String`	`securityRealm()` The security realm that provides the SSL configuration
`ModCluster`	`securityRealm(String value)` The security realm that provides the SSL configuration
`ModCluster.ModClusterResources`	`subresources()`
`Boolean`	`useAlias()` If an alias check is performed
`ModCluster`	`useAlias(Boolean value)` If an alias check is performed
`String`	`worker()` The XNIO worker that is used to send the advertise notifications
`ModCluster`	`worker(String value)` The XNIO worker that is used to send the advertise notifications

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

- Constructor Detail
  - ModCluster
```
public ModCluster(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - advertiseFrequency
```
public Integer advertiseFrequency()
```
    The frequency (in milliseconds) that mod-cluster advertises itself on the network
  - advertiseFrequency
```
public ModCluster advertiseFrequency(Integer value)
```
    The frequency (in milliseconds) that mod-cluster advertises itself on the network
  - advertisePath
```
public String advertisePath()
```
    The path that mod-cluster is registered under, defaults to /
  - advertisePath
```
public ModCluster advertisePath(String value)
```
    The path that mod-cluster is registered under, defaults to /
  - advertiseProtocol
```
public String advertiseProtocol()
```
    The protocol that is in use, defaults to HTTP
  - advertiseProtocol
```
public ModCluster advertiseProtocol(String value)
```
    The protocol that is in use, defaults to HTTP
  - advertiseSocketBinding
```
public String advertiseSocketBinding()
```
    The multicast group that is used to advertise
  - advertiseSocketBinding
```
public ModCluster advertiseSocketBinding(String value)
```
    The multicast group that is used to advertise
  - brokenNodeTimeout
```
public Integer brokenNodeTimeout()
```
    The amount of time that must elapse before a broken node is removed from the table
  - brokenNodeTimeout
```
public ModCluster brokenNodeTimeout(Integer value)
```
    The amount of time that must elapse before a broken node is removed from the table
  - cachedConnectionsPerThread
```
public Integer cachedConnectionsPerThread()
```
    The number of connections that will be kept alive indefinitely
  - cachedConnectionsPerThread
```
public ModCluster cachedConnectionsPerThread(Integer value)
```
    The number of connections that will be kept alive indefinitely
  - connectionIdleTimeout
```
public Integer connectionIdleTimeout()
```
    The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)
  - connectionIdleTimeout
```
public ModCluster connectionIdleTimeout(Integer value)
```
    The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)
  - connectionsPerThread
```
public Integer connectionsPerThread()
```
    The number of connections that will be maintained to backend servers, per IO thread. Defaults to 10.
  - connectionsPerThread
```
public ModCluster connectionsPerThread(Integer value)
```
    The number of connections that will be maintained to backend servers, per IO thread. Defaults to 10.
  - healthCheckInterval
```
public Integer healthCheckInterval()
```
    The frequency of health check pings to backend nodes
  - healthCheckInterval
```
public ModCluster healthCheckInterval(Integer value)
```
    The frequency of health check pings to backend nodes
  - managementAccessPredicate
```
public String managementAccessPredicate()
```
    A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding
  - managementAccessPredicate
```
public ModCluster managementAccessPredicate(String value)
```
    A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding
  - managementSocketBinding
```
public String managementSocketBinding()
```
    The socket binding of the mod_cluster management port. When using mod_cluster two HTTP listeners should be defined, a public one to handle requests, and one bound to the internal network to handle mod cluster commands. This socket binding should correspond to the internal listener, and should not be publicly accessible
  - managementSocketBinding
```
public ModCluster managementSocketBinding(String value)
```
    The socket binding of the mod_cluster management port. When using mod_cluster two HTTP listeners should be defined, a public one to handle requests, and one bound to the internal network to handle mod cluster commands. This socket binding should correspond to the internal listener, and should not be publicly accessible
  - maxRequestTime
```
public Integer maxRequestTime()
```
    The max amount of time that a request to a backend node can take before it is killed
  - maxRequestTime
```
public ModCluster maxRequestTime(Integer value)
```
    The max amount of time that a request to a backend node can take before it is killed
  - requestQueueSize
```
public Integer requestQueueSize()
```
    The number of requests that can be queued if the connection pool is full before requests are rejected with a 503
  - requestQueueSize
```
public ModCluster requestQueueSize(Integer value)
```
    The number of requests that can be queued if the connection pool is full before requests are rejected with a 503
  - securityKey
```
public String securityKey()
```
    The security key that is used for the mod-cluster group. All members must use the same security key.
  - securityKey
```
public ModCluster securityKey(String value)
```
    The security key that is used for the mod-cluster group. All members must use the same security key.
  - securityRealm
```
public String securityRealm()
```
    The security realm that provides the SSL configuration
  - securityRealm
```
public ModCluster securityRealm(String value)
```
    The security realm that provides the SSL configuration
  - useAlias
```
public Boolean useAlias()
```
    If an alias check is performed
  - useAlias
```
public ModCluster useAlias(Boolean value)
```
    If an alias check is performed
  - worker
```
public String worker()
```
    The XNIO worker that is used to send the advertise notifications
  - worker
```
public ModCluster worker(String value)
```
    The XNIO worker that is used to send the advertise notifications
  - subresources
```
public ModCluster.ModClusterResources subresources()
```
  - balancers
```
public ModCluster balancers(List<Balancer> value)
```
    Add all org.wildfly.swarm.config.undertow.configuration.mod_cluster.Balancer objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.undertow.configuration.mod_cluster.Balancer objects.
    
    Returns:
    
    this
  - balancer
```
public ModCluster balancer(Balancer value)
```
    Add the org.wildfly.swarm.config.undertow.configuration.mod_cluster.Balancer object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.undertow.configuration.mod_cluster.Balancer to add
    
    Returns:
    
    this

Class ModCluster

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModCluster

Method Detail

getKey

advertiseFrequency

advertiseFrequency

advertisePath

advertisePath

advertiseProtocol

advertiseProtocol

advertiseSocketBinding

advertiseSocketBinding

brokenNodeTimeout

brokenNodeTimeout

cachedConnectionsPerThread

cachedConnectionsPerThread

connectionIdleTimeout

connectionIdleTimeout

connectionsPerThread

connectionsPerThread

healthCheckInterval

healthCheckInterval

managementAccessPredicate

managementAccessPredicate

managementSocketBinding

managementSocketBinding

maxRequestTime

maxRequestTime

requestQueueSize

requestQueueSize

securityKey

securityKey

securityRealm

securityRealm

useAlias

useAlias

worker

worker

subresources

balancers

balancer