Modifier and Type	Class and Description
public static class	Balancer.BalancerBuilder

Field Summary

Modifier and Type	Field and Description
private final int	id
private static final AtomicInteger	idGen
private final int	maxRetries Maximum number of failover attempts to send the request to the backend server.
private final String	name Name of the balancer.
private final boolean	stickySession `true`: use JVMRoute to stick a request to a node, `false`: ignore JVMRoute.
private final String	stickySessionCookie Name of the cookie containing the session-id. Max size: 30 Default: "JSESSIONID"
private final boolean	stickySessionForce `true`: Return an error if the request can't be routed according to JVMRoute, `false`: Route it to another node.
private final String	stickySessionPath Name of the parameter containing the session-id. Max size: 30.
private final boolean	stickySessionRemove `true`: remove the session-id (cookie or parameter) when the request can't be routed to the right node.
private final int	waitWorker value in seconds: time to wait for an available worker.

Access	Constructor and Description
pack-priv	Balancer(Balancer.BalancerBuilder b)

Method Summary

Modifier and Type	Method and Description
pack-priv static Balancer.BalancerBuilder	builder()
public int	getId()
public int	getMaxattempts() Deprecated
public int	getMaxRetries()
public String	getName()
public String	getStickySessionCookie()
public String	getStickySessionPath()
public int	getWaitWorker()
public boolean	isStickySession()
public boolean	isStickySessionForce()
public boolean	isStickySessionRemove()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

id	back to summary
private final int id

idGen	back to summary
private static final AtomicInteger idGen

maxRetries	back to summary
private final int maxRetries Maximum number of failover attempts to send the request to the backend server. Default: "1"

name	back to summary
private final String name Name of the balancer. max size: 40, Default: "mycluster"

stickySession	back to summary
private final boolean stickySession `true`: use JVMRoute to stick a request to a node, `false`: ignore JVMRoute. Default: `true`

stickySessionCookie	back to summary
private final String stickySessionCookie Name of the cookie containing the session-id. Max size: 30 Default: "JSESSIONID"

stickySessionForce	back to summary
private final boolean stickySessionForce `true`: Return an error if the request can't be routed according to JVMRoute, `false`: Route it to another node. Default: `true`

stickySessionPath	back to summary
private final String stickySessionPath Name of the parameter containing the session-id. Max size: 30. Default: "jsessionid"

stickySessionRemove	back to summary
private final boolean stickySessionRemove `true`: remove the session-id (cookie or parameter) when the request can't be routed to the right node. `false`: send it anyway. Default: `false`

waitWorker	back to summary
private final int waitWorker value in seconds: time to wait for an available worker. Default: "0" no wait.

Balancer	back to summary
pack-priv Balancer(Balancer.BalancerBuilder b)

Method Detail

builder	back to summary
pack-priv static Balancer.BalancerBuilder builder()

getId	back to summary
public int getId()

getMaxattempts	back to summary
public int getMaxattempts() Deprecated Annotations @Deprecated

getMaxRetries	back to summary
public int getMaxRetries()

getName	back to summary
public String getName()

getStickySessionCookie	back to summary
public String getStickySessionCookie()

getStickySessionPath	back to summary
public String getStickySessionPath()

getWaitWorker	back to summary
public int getWaitWorker()

isStickySession	back to summary
public boolean isStickySession()

isStickySessionForce	back to summary
public boolean isStickySessionForce()

isStickySessionRemove	back to summary
public boolean isStickySessionRemove()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

io.undertow.server.handlers.proxy.mod_cluster back to summary

public final Class Balancer.BalancerBuilder

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.proxy.mod_cluster.Balancer.BalancerBuilder

Field Summary

Modifier and Type	Field and Description
private int	maxRetries
private String	name
private boolean	stickySession
private String	stickySessionCookie
private boolean	stickySessionForce
private String	stickySessionPath
private boolean	stickySessionRemove
private int	waitWorker

Constructor Summary

Access	Constructor and Description
public	BalancerBuilder()

Method Summary

Modifier and Type	Method and Description
public Balancer	build()
public int	getMaxattempts() Deprecated for removal since 2.0.4. Use `BalancerBuilder#getMaxRetries()`.
public int	getMaxRetries()
public String	getName()
public String	getStickySessionCookie()
public String	getStickySessionPath()
public int	getWaitWorker()
public boolean	isStickySession()
public boolean	isStickySessionForce()
public boolean	isStickySessionRemove()
public Balancer.BalancerBuilder	setMaxattempts(int maxattempts) Deprecated for removal since 2.0.4. Use `BalancerBuilder#setMaxRetries(int)`.
public Balancer.BalancerBuilder	setMaxRetries(int number of failover attempts maxRetries) Maximum number of failover attempts to send the request to the backend server.
public Balancer.BalancerBuilder	setName(String name)
public Balancer.BalancerBuilder	setStickySession(boolean stickySession)
public Balancer.BalancerBuilder	setStickySessionCookie(String stickySessionCookie)
public Balancer.BalancerBuilder	setStickySessionForce(boolean stickySessionForce)
public Balancer.BalancerBuilder	setStickySessionPath(String stickySessionPath)
public Balancer.BalancerBuilder	setStickySessionRemove(boolean stickySessionRemove)
public Balancer.BalancerBuilder	setWaitWorker(int waitWorker)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

maxRetries	back to summary
private int maxRetries

name	back to summary
private String name

stickySession	back to summary
private boolean stickySession

stickySessionCookie	back to summary
private String stickySessionCookie

stickySessionForce	back to summary
private boolean stickySessionForce

stickySessionPath	back to summary
private String stickySessionPath

stickySessionRemove	back to summary
private boolean stickySessionRemove

waitWorker	back to summary
private int waitWorker

Constructor Detail

BalancerBuilder	back to summary
public BalancerBuilder()

Method Detail

build	back to summary
public Balancer build()

getMaxattempts	back to summary
public int getMaxattempts() Deprecated for removal since 2.0.4. Use `BalancerBuilder#getMaxRetries()`. Annotations @Deprecated since:2.0.4 forRemoval:true

getMaxRetries	back to summary
public int getMaxRetries()

getName	back to summary
public String getName()

getStickySessionCookie	back to summary
public String getStickySessionCookie()

getStickySessionPath	back to summary
public String getStickySessionPath()

getWaitWorker	back to summary
public int getWaitWorker()

isStickySession	back to summary
public boolean isStickySession()

isStickySessionForce	back to summary
public boolean isStickySessionForce()

isStickySessionRemove	back to summary
public boolean isStickySessionRemove()

setMaxattempts	back to summary
public Balancer.BalancerBuilder setMaxattempts(int maxattempts) Deprecated for removal since 2.0.4. Use `BalancerBuilder#setMaxRetries(int)`. Annotations @Deprecated since:2.0.4 forRemoval:true

setMaxRetries

back to summary

public Balancer.BalancerBuilder setMaxRetries(int maxRetries)

Maximum number of failover attempts to send the request to the backend server.

Parameters

maxRetries:int: number of failover attempts

setName	back to summary
public Balancer.BalancerBuilder setName(String name)

setStickySession	back to summary
public Balancer.BalancerBuilder setStickySession(boolean stickySession)

setStickySessionCookie	back to summary
public Balancer.BalancerBuilder setStickySessionCookie(String stickySessionCookie)

setStickySessionForce	back to summary
public Balancer.BalancerBuilder setStickySessionForce(boolean stickySessionForce)

setStickySessionPath	back to summary
public Balancer.BalancerBuilder setStickySessionPath(String stickySessionPath)

setStickySessionRemove	back to summary
public Balancer.BalancerBuilder setStickySessionRemove(boolean stickySessionRemove)

setWaitWorker	back to summary
public Balancer.BalancerBuilder setWaitWorker(int waitWorker)

public Class Balancer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Balancer.BalancerBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail