Balancer (api 0.3.3 API)

java.lang.Object
- org.wildfly.swarm.config.undertow.subsystem.configuration.modCluster.balancer.Balancer<T>

public class Balancer<T extends Balancer>
extends Object

Runtime representation of a mod_cluster balancer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Balancer.BalancerResources
Child mutators for Balancer

Nested Classes
Modifier and Type	Class and Description
`class`	`Balancer.BalancerResources` Child mutators for Balancer

Constructor Summary

Constructors
Constructor and Description

Balancer(String key)

Constructors
Constructor and Description
`Balancer(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getKey()`
`T`	`loadBalancingGroup(LoadBalancingGroup value)` Add the LoadBalancingGroup object to the list of subresources
`T`	`loadBalancingGroups(List<LoadBalancingGroup> value)` Add all LoadBalancingGroup objects to this subresource
`Integer`	`maxAttempts()` The number of attempts to send the request to a backend server
`T`	`maxAttempts(Integer value)` The number of attempts to send the request to a backend server
`T`	`node(Node value)` Add the Node object to the list of subresources
`T`	`nodes(List<Node> value)` Add all Node objects to this subresource
`Boolean`	`stickySession()` If sticky sessions are enabled
`T`	`stickySession(Boolean value)` If sticky sessions are enabled
`String`	`stickySessionCookie()` The session cookie name
`T`	`stickySessionCookie(String value)` The session cookie name
`Boolean`	`stickySessionForce()` If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node
`T`	`stickySessionForce(Boolean value)` If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node
`String`	`stickySessionPath()` The path of the sticky session cookie
`T`	`stickySessionPath(String value)` The path of the sticky session cookie
`Boolean`	`stickySessionRemove()` Remove the session cookie if the request cannot be routed to the correct host
`T`	`stickySessionRemove(Boolean value)` Remove the session cookie if the request cannot be routed to the correct host
`Balancer.BalancerResources`	`subresources()`
`Integer`	`waitWorker()` The number of seconds to wait for an available worker
`T`	`waitWorker(Integer value)` The number of seconds to wait for an available worker

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

- Constructor Detail
  - Balancer
```
public Balancer(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - maxAttempts
```
public Integer maxAttempts()
```
    The number of attempts to send the request to a backend server
  - maxAttempts
```
public T maxAttempts(Integer value)
```
    The number of attempts to send the request to a backend server
  - stickySession
```
public Boolean stickySession()
```
    If sticky sessions are enabled
  - stickySession
```
public T stickySession(Boolean value)
```
    If sticky sessions are enabled
  - stickySessionCookie
```
public String stickySessionCookie()
```
    The session cookie name
  - stickySessionCookie
```
public T stickySessionCookie(String value)
```
    The session cookie name
  - stickySessionForce
```
public Boolean stickySessionForce()
```
    If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node
  - stickySessionForce
```
public T stickySessionForce(Boolean value)
```
    If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node
  - stickySessionPath
```
public String stickySessionPath()
```
    The path of the sticky session cookie
  - stickySessionPath
```
public T stickySessionPath(String value)
```
    The path of the sticky session cookie
  - stickySessionRemove
```
public Boolean stickySessionRemove()
```
    Remove the session cookie if the request cannot be routed to the correct host
  - stickySessionRemove
```
public T stickySessionRemove(Boolean value)
```
    Remove the session cookie if the request cannot be routed to the correct host
  - waitWorker
```
public Integer waitWorker()
```
    The number of seconds to wait for an available worker
  - waitWorker
```
public T waitWorker(Integer value)
```
    The number of seconds to wait for an available worker
  - subresources
```
public Balancer.BalancerResources subresources()
```
  - nodes
```
public T nodes(List<Node> value)
```
    Add all Node objects to this subresource
    
    Parameters:
    
    value - List of Node objects.
    
    Returns:
    
    this
  - node
```
public T node(Node value)
```
    Add the Node object to the list of subresources
    
    Parameters:
    
    value - The Node to add
    
    Returns:
    
    this
  - loadBalancingGroups
```
public T loadBalancingGroups(List<LoadBalancingGroup> value)
```
    Add all LoadBalancingGroup objects to this subresource
    
    Parameters:
    
    value - List of LoadBalancingGroup objects.
    
    Returns:
    
    this
  - loadBalancingGroup
```
public T loadBalancingGroup(LoadBalancingGroup value)
```
    Add the LoadBalancingGroup object to the list of subresources
    
    Parameters:
    
    value - The LoadBalancingGroup to add
    
    Returns:
    
    this

Class Balancer<T extends Balancer>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Balancer

Method Detail

getKey

maxAttempts

maxAttempts

stickySession

stickySession

stickySessionCookie

stickySessionCookie

stickySessionForce

stickySessionForce

stickySessionPath

stickySessionPath

stickySessionRemove

stickySessionRemove

waitWorker

waitWorker

subresources

nodes

node

loadBalancingGroups

loadBalancingGroup