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

public Class ModCluster

extends Object
Class Inheritance
Static Imports
org.wildfly.common.Assert.checkNotNullParam

Author
Emanuel Muckenhuber

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final int
private final ModClusterContainer
private final boolean
private final NodeHealthChecker
private final long
private final int
private final int
private final int
private final boolean
private final String
private final long
private final int
private final boolean
private final RouteParsingStrategy
private final String
private final long
private final boolean
private final XnioWorker

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public static ModCluster.Builder
builder(final XnioWorker worker)

public static ModCluster.Builder
builder(final XnioWorker worker, final UndertowClient client)

public static ModCluster.Builder
builder(final XnioWorker worker, final UndertowClient client, final XnioSsl xnioSsl)

public HttpHandler

Returns:

the proxy handler
createProxyHandler
()

Get the handler proxying the requests.

public HttpHandler

Returns:

the proxy handler
createProxyHandler
(HttpHandler next)

Get the handler proxying the requests.

public int
protected ModClusterContainer
public ModClusterController
public NodeHealthChecker
public long
public int
public HttpHandler

Returns:

the proxy handler
getProxyHandler
()
Deprecated

Get the handler proxying the requests.

public long
public int
protected String
public long
public boolean
public boolean
public boolean
public String
public RouteParsingStrategy
public synchronized void
start()

Start

public synchronized void
stop()

Stop

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cacheConnectionsback to summary
private final int cacheConnections
containerback to summary
private final ModClusterContainer container
deterministicFailoverback to summary
private final boolean deterministicFailover
healthCheckerback to summary
private final NodeHealthChecker healthChecker
healthCheckIntervalback to summary
private final long healthCheckInterval
maxConnectionsback to summary
private final int maxConnections
maxRequestTimeback to summary
private final int maxRequestTime
maxRetriesback to summary
private final int maxRetries
queueNewRequestsback to summary
private final boolean queueNewRequests
rankedAffinityDelimiterback to summary
private final String rankedAffinityDelimiter
removeBrokenNodesback to summary
private final long removeBrokenNodes
requestQueueSizeback to summary
private final int requestQueueSize
reuseXForwardedback to summary
private final boolean reuseXForwarded
routeParsingStrategyback to summary
private final RouteParsingStrategy routeParsingStrategy
serverIDback to summary
private final String serverID
ttlback to summary
private final long ttl
useAliasback to summary
private final boolean useAlias
xnioWorkerback to summary
private final XnioWorker xnioWorker

Constructor Detail

ModClusterback to summary
pack-priv ModCluster(ModCluster.Builder builder)

Method Detail

builderback to summary
public static ModCluster.Builder builder(final XnioWorker worker)
builderback to summary
public static ModCluster.Builder builder(final XnioWorker worker, final UndertowClient client)
builderback to summary
public static ModCluster.Builder builder(final XnioWorker worker, final UndertowClient client, final XnioSsl xnioSsl)
createProxyHandlerback to summary
public HttpHandler createProxyHandler()

Get the handler proxying the requests.

Returns:HttpHandler

the proxy handler

createProxyHandlerback to summary
public HttpHandler createProxyHandler(HttpHandler next)

Get the handler proxying the requests.

Returns:HttpHandler

the proxy handler

getCacheConnectionsback to summary
public int getCacheConnections()
getContainerback to summary
protected ModClusterContainer getContainer()
getControllerback to summary
public ModClusterController getController()
getHealthCheckerback to summary
public NodeHealthChecker getHealthChecker()
getHealthCheckIntervalback to summary
public long getHealthCheckInterval()
getMaxConnectionsback to summary
public int getMaxConnections()
getProxyHandlerback to summary
public HttpHandler getProxyHandler()

Deprecated

Get the handler proxying the requests.

Returns:HttpHandler

the proxy handler

Annotations
@Deprecated
getRemoveBrokenNodesback to summary
public long getRemoveBrokenNodes()
getRequestQueueSizeback to summary
public int getRequestQueueSize()
getServerIDback to summary
protected String getServerID()
getTtlback to summary
public long getTtl()
isDeterministicFailoverback to summary
public boolean isDeterministicFailover()
isQueueNewRequestsback to summary
public boolean isQueueNewRequests()
isUseAliasback to summary
public boolean isUseAlias()
rankedAffinityDelimiterback to summary
public String rankedAffinityDelimiter()
routeParsingStrategyback to summary
public RouteParsingStrategy routeParsingStrategy()
startback to summary
public synchronized void start()

Start

stopback to summary
public synchronized void stop()

Stop

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

public Class ModCluster.Builder

extends Object
Class Inheritance
  • java.lang.Object
  • io.undertow.server.handlers.proxy.mod_cluster.ModCluster.Builder

Field Summary

Modifier and TypeField and Description
private int
private final UndertowClient
private OptionMap
private boolean
private NodeHealthChecker
private long
private int
private int
private int
private boolean
private String
private long
private int
private boolean
private RouteParsingStrategy
private long
private boolean
private final XnioSsl
private final XnioWorker

Constructor Summary

AccessConstructor and Description
private
Builder(XnioWorker xnioWorker, UndertowClient client, XnioSsl xnioSsl)

Method Summary

Modifier and TypeMethod and Description
public ModCluster
public ModCluster.Builder
setCacheConnections(int cacheConnections)

public ModCluster.Builder
setClientOptions(OptionMap clientOptions)

public ModCluster.Builder
setDeterministicFailover(boolean deterministicFailover)

public ModCluster.Builder
public ModCluster.Builder
setHealthCheckInterval(long healthCheckInterval)

public ModCluster.Builder
setMaxConnections(int maxConnections)

public ModCluster.Builder
setMaxRequestTime(int maxRequestTime)

public ModCluster.Builder
setMaxRetries(int maxRetries)

public ModCluster.Builder
setQueueNewRequests(boolean queueNewRequests)

public ModCluster.Builder

Returns:

this builder
setRankedAffinityDelimiter
(String
delimiter splitting multiple routes; typically a "."
rankedAffinityDelimiter
)

Configures ranked affinity delimiter used for splitting multiple encoded routes when RouteParsingStrategy#RANKED is specified.

public ModCluster.Builder
setRemoveBrokenNodes(long removeBrokenNodes)

public ModCluster.Builder
setRequestQueueSize(int requestQueueSize)

public ModCluster.Builder
setReuseXForwarded(boolean reuseXForwarded)

public ModCluster.Builder

Returns:

this builder
setRouteParsingStrategy
(RouteParsingStrategy
strategy to use for parsing routes
routeParsingStrategy
)

Configures route parsing strategy to support none, single or ranked affinity.

public ModCluster.Builder
setTtl(long ttl)

public ModCluster.Builder
setUseAlias(boolean useAlias)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cacheConnectionsback to summary
private int cacheConnections
clientback to summary
private final UndertowClient client
clientOptionsback to summary
private OptionMap clientOptions
deterministicFailoverback to summary
private boolean deterministicFailover
healthCheckerback to summary
private NodeHealthChecker healthChecker
healthCheckIntervalback to summary
private long healthCheckInterval
maxConnectionsback to summary
private int maxConnections
maxRequestTimeback to summary
private int maxRequestTime
maxRetriesback to summary
private int maxRetries
queueNewRequestsback to summary
private boolean queueNewRequests
rankedAffinityDelimiterback to summary
private String rankedAffinityDelimiter
removeBrokenNodesback to summary
private long removeBrokenNodes
requestQueueSizeback to summary
private int requestQueueSize
reuseXForwardedback to summary
private boolean reuseXForwarded
routeParsingStrategyback to summary
private RouteParsingStrategy routeParsingStrategy
ttlback to summary
private long ttl
useAliasback to summary
private boolean useAlias
xnioSslback to summary
private final XnioSsl xnioSsl
xnioWorkerback to summary
private final XnioWorker xnioWorker

Constructor Detail

Builderback to summary
private Builder(XnioWorker xnioWorker, UndertowClient client, XnioSsl xnioSsl)

Method Detail

buildback to summary
public ModCluster build()
setCacheConnectionsback to summary
public ModCluster.Builder setCacheConnections(int cacheConnections)
setClientOptionsback to summary
public ModCluster.Builder setClientOptions(OptionMap clientOptions)
setDeterministicFailoverback to summary
public ModCluster.Builder setDeterministicFailover(boolean deterministicFailover)
setHealthCheckerback to summary
public ModCluster.Builder setHealthChecker(NodeHealthChecker healthChecker)
setHealthCheckIntervalback to summary
public ModCluster.Builder setHealthCheckInterval(long healthCheckInterval)
setMaxConnectionsback to summary
public ModCluster.Builder setMaxConnections(int maxConnections)
setMaxRequestTimeback to summary
public ModCluster.Builder setMaxRequestTime(int maxRequestTime)
setMaxRetriesback to summary
public ModCluster.Builder setMaxRetries(int maxRetries)
setQueueNewRequestsback to summary
public ModCluster.Builder setQueueNewRequests(boolean queueNewRequests)
setRankedAffinityDelimiterback to summary
public ModCluster.Builder setRankedAffinityDelimiter(String rankedAffinityDelimiter)

Configures ranked affinity delimiter used for splitting multiple encoded routes when RouteParsingStrategy#RANKED is specified. Web requests will have an affinity for the first available node in the list.

Parameters
rankedAffinityDelimiter:String

delimiter splitting multiple routes; typically a "."

Returns:ModCluster.Builder

this builder

setRemoveBrokenNodesback to summary
public ModCluster.Builder setRemoveBrokenNodes(long removeBrokenNodes)
setRequestQueueSizeback to summary
public ModCluster.Builder setRequestQueueSize(int requestQueueSize)
setReuseXForwardedback to summary
public ModCluster.Builder setReuseXForwarded(boolean reuseXForwarded)
setRouteParsingStrategyback to summary
public ModCluster.Builder setRouteParsingStrategy(RouteParsingStrategy routeParsingStrategy)

Configures route parsing strategy to support none, single or ranked affinity.

Parameters
routeParsingStrategy:RouteParsingStrategy

strategy to use for parsing routes

Returns:ModCluster.Builder

this builder

setTtlback to summary
public ModCluster.Builder setTtl(long ttl)
setUseAliasback to summary
public ModCluster.Builder setUseAlias(boolean useAlias)