Top Description Inners Fields Constructors Methods
io.undertow.server.handlers.proxy.mod_cluster

public Class NodeConfig

extends Object
Class Inheritance
Imports
io.undertow.UndertowLogger, java.net.URI, .URISyntaxException

The node configuration.
Authors
Nabil Benothman, Emanuel Muckenhuber

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final String
balancer

The balancer configuration to use.

private final int
private final URI
connectionURI

The connection URI.

private final String
domain

The failover domain.

private boolean
flushPackets

Tell how to flush the packets.

private final int
flushwait

Time to wait before flushing.

private final String
jvmRoute

The JVM Route.

private final int
private final int
ping

Time to wait for a pong answer to a ping.

private final boolean
private final int
private final int
timeout

Max time the proxy will wait for the backend connection.

private final long
ttl

max time in milliseconds to life for connection above smax.

private final int

Constructor Summary

AccessConstructor and Description
pack-priv
NodeConfig(NodeConfig.NodeBuilder b, final URI connectionURI)

Method Summary

Modifier and TypeMethod and Description
public static NodeConfig.NodeBuilder
builder(ModCluster modCluster)

public String

Returns:

the balancer
getBalancer
()

Getter for balancer

public int

Returns:

the number of cached connections
getCacheConnections
()

Get the amount of connections which should be kept alive in the connection pool.

public URI

Returns:

the connection URI
getConnectionURI
()

Get the connection URI.

public String

Returns:

the domain
getDomain
()

Getter for domain

public int

Returns:

the flushwait
getFlushwait
()

Getter for flushwait

public String
public int

Returns:

the max connections limit
getMaxConnections
()

Get the maximum connection limit for a nodes thread-pool.

public int

Returns:

the ping
getPing
()

Getter for ping

public int

Returns:

the queue size for requests
getRequestQueueSize
()

Get the max queue size for requests.

public int

Returns:

the smax
getSmax
()

Getter for smax

public int

Returns:

the timeout
getTimeout
()

Getter for timeout

public long

Returns:

the ttl
getTtl
()

Getter for ttl

public boolean
public boolean

Returns:

true if requests without a session id can be queued
isQueueNewRequests
()

Flag indicating whether requests without a session can be queued.

public void
setFlushPackets(boolean flushPackets)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

balancerback to summary
private final String balancer

The balancer configuration to use.

cacheConnectionsback to summary
private final int cacheConnections
connectionURIback to summary
private final URI connectionURI

The connection URI.

domainback to summary
private final String domain

The failover domain.

flushPacketsback to summary
private boolean flushPackets

Tell how to flush the packets. On: Send immediately, Auto wait for flushwait time before sending, Off don't flush. Default: "Off"

flushwaitback to summary
private final int flushwait

Time to wait before flushing. Value in milliseconds. Default: 10

jvmRouteback to summary
private final String jvmRoute

The JVM Route.

maxConnectionsback to summary
private final int maxConnections
pingback to summary
private final int ping

Time to wait for a pong answer to a ping. 0 means we don't try to ping before sending. Value in seconds Default: 10 (10_000 in milliseconds)

queueNewRequestsback to summary
private final boolean queueNewRequests
requestQueueSizeback to summary
private final int requestQueueSize
timeoutback to summary
private final int timeout

Max time the proxy will wait for the backend connection. Default 0 no timeout value in seconds.

ttlback to summary
private final long ttl

max time in milliseconds to life for connection above smax. Default 60 seconds (60,000 in milliseconds).

waitWorkerback to summary
private final int waitWorker

Constructor Detail

NodeConfigback to summary
pack-priv NodeConfig(NodeConfig.NodeBuilder b, final URI connectionURI)

Method Detail

builderback to summary
public static NodeConfig.NodeBuilder builder(ModCluster modCluster)
getBalancerback to summary
public String getBalancer()

Getter for balancer

Returns:String

the balancer

getCacheConnectionsback to summary
public int getCacheConnections()

Get the amount of connections which should be kept alive in the connection pool.

Returns:int

the number of cached connections

getConnectionURIback to summary
public URI getConnectionURI()

Get the connection URI.

Returns:URI

the connection URI

getDomainback to summary
public String getDomain()

Getter for domain

Returns:String

the domain

getFlushwaitback to summary
public int getFlushwait()

Getter for flushwait

Returns:int

the flushwait

getJvmRouteback to summary
public String getJvmRoute()
getMaxConnectionsback to summary
public int getMaxConnections()

Get the maximum connection limit for a nodes thread-pool.

Returns:int

the max connections limit

getPingback to summary
public int getPing()

Getter for ping

Returns:int

the ping

getRequestQueueSizeback to summary
public int getRequestQueueSize()

Get the max queue size for requests.

Returns:int

the queue size for requests

getSmaxback to summary
public int getSmax()

Getter for smax

Returns:int

the smax

getTimeoutback to summary
public int getTimeout()

Getter for timeout

Returns:int

the timeout

getTtlback to summary
public long getTtl()

Getter for ttl

Returns:long

the ttl

isFlushPacketsback to summary
public boolean isFlushPackets()
isQueueNewRequestsback to summary
public boolean isQueueNewRequests()

Flag indicating whether requests without a session can be queued.

Returns:boolean

true if requests without a session id can be queued

setFlushPacketsback to summary
public void setFlushPackets(boolean flushPackets)
io.undertow.server.handlers.proxy.mod_cluster back to summary

public Class NodeConfig.NodeBuilder

extends Object
Class Inheritance
  • java.lang.Object
  • io.undertow.server.handlers.proxy.mod_cluster.NodeConfig.NodeBuilder

Field Summary

Modifier and TypeField and Description
private String
private int
private String
private boolean
private int
private String
private String
private int
private int
private int
private boolean
private int
private int
private long
private String
private int

Constructor Summary

AccessConstructor and Description
pack-priv
NodeBuilder(final ModCluster modCluster)

Method Summary

Modifier and TypeMethod and Description
public NodeConfig
public int
public NodeConfig.NodeBuilder
setBalancer(String balancer)

public NodeConfig.NodeBuilder
setCacheConnections(int cacheConnections)

public NodeConfig.NodeBuilder
setDomain(String domain)

public NodeConfig.NodeBuilder
setFlushPackets(boolean flushPackets)

public NodeConfig.NodeBuilder
setFlushwait(int flushwait)

public NodeConfig.NodeBuilder
setHostname(String hostname)

public NodeConfig.NodeBuilder
setJvmRoute(String jvmRoute)

public NodeConfig.NodeBuilder
setMaxConnections(int maxConnections)

public NodeConfig.NodeBuilder
setPing(int ping)

public NodeConfig.NodeBuilder
setPort(int port)

public NodeConfig.NodeBuilder
setQueueNewRequests(boolean queueNewRequests)

public NodeConfig.NodeBuilder
setRequestQueueSize(int requestQueueSize)

public NodeConfig.NodeBuilder
setSmax(int smax)

public NodeConfig.NodeBuilder
setTimeout(int timeout)

public NodeConfig.NodeBuilder
setTtl(long ttl)

public NodeConfig.NodeBuilder
public void
setWaitWorker(int waitWorker)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

balancerback to summary
private String balancer
cacheConnectionsback to summary
private int cacheConnections
domainback to summary
private String domain
flushPacketsback to summary
private boolean flushPackets
flushwaitback to summary
private int flushwait
hostnameback to summary
private String hostname
jvmRouteback to summary
private String jvmRoute
maxConnectionsback to summary
private int maxConnections
pingback to summary
private int ping
portback to summary
private int port
queueNewRequestsback to summary
private boolean queueNewRequests
requestQueueSizeback to summary
private int requestQueueSize
timeoutback to summary
private int timeout
ttlback to summary
private long ttl
typeback to summary
private String type
waitWorkerback to summary
private int waitWorker

Constructor Detail

NodeBuilderback to summary
pack-priv NodeBuilder(final ModCluster modCluster)

Method Detail

buildback to summary
public NodeConfig build() throws URISyntaxException
getWaitWorkerback to summary
public int getWaitWorker()
setBalancerback to summary
public NodeConfig.NodeBuilder setBalancer(String balancer)
setCacheConnectionsback to summary
public NodeConfig.NodeBuilder setCacheConnections(int cacheConnections)
setDomainback to summary
public NodeConfig.NodeBuilder setDomain(String domain)
setFlushPacketsback to summary
public NodeConfig.NodeBuilder setFlushPackets(boolean flushPackets)
setFlushwaitback to summary
public NodeConfig.NodeBuilder setFlushwait(int flushwait)
setHostnameback to summary
public NodeConfig.NodeBuilder setHostname(String hostname)
setJvmRouteback to summary
public NodeConfig.NodeBuilder setJvmRoute(String jvmRoute)
setMaxConnectionsback to summary
public NodeConfig.NodeBuilder setMaxConnections(int maxConnections)
setPingback to summary
public NodeConfig.NodeBuilder setPing(int ping)
setPortback to summary
public NodeConfig.NodeBuilder setPort(int port)
setQueueNewRequestsback to summary
public NodeConfig.NodeBuilder setQueueNewRequests(boolean queueNewRequests)
setRequestQueueSizeback to summary
public NodeConfig.NodeBuilder setRequestQueueSize(int requestQueueSize)
setSmaxback to summary
public NodeConfig.NodeBuilder setSmax(int smax)
setTimeoutback to summary
public NodeConfig.NodeBuilder setTimeout(int timeout)
setTtlback to summary
public NodeConfig.NodeBuilder setTtl(long ttl)
setTypeback to summary
public NodeConfig.NodeBuilder setType(String type)
setWaitWorkerback to summary
public void setWaitWorker(int waitWorker)