Proxy (BOM: * : All 2.6.1.Final-SNAPSHOT API)

java.lang.Object
- org.wildfly.swarm.config.modcluster.Proxy<T>

```
public class Proxy<T extends Proxy<T>>
extends Object
```
Proxy resource coupled with single Undertow listener (and server) specifying load balancer discovery, its configuration and load balance factor provider. Multiple proxy configuration can be specified.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Proxy.ProxyResources
Child mutators for Proxy

static class Proxy.SessionDrainingStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`Proxy.ProxyResources` Child mutators for Proxy
`static class`	`Proxy.SessionDrainingStrategy`

Constructor Summary

Constructors
Constructor and Description

Proxy(String key)

Constructors
Constructor and Description
`Proxy(String key)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener
`Boolean`	`advertise()` Whether to enable multicast-based advertise mechanism.
`T`	`advertise(Boolean value)` Whether to enable multicast-based advertise mechanism.
`String`	`advertiseSecurityKey()` If specified, reverse proxy advertisements checksums will be verified using this value as a salt.
`T`	`advertiseSecurityKey(String value)` If specified, reverse proxy advertisements checksums will be verified using this value as a salt.
`String`	`advertiseSocket()` Name of socket binding to use for the advertise socket.
`T`	`advertiseSocket(String value)` Name of socket binding to use for the advertise socket.
`Boolean`	`autoEnableContexts()` If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).
`T`	`autoEnableContexts(Boolean value)` If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).
`String`	`balancer()` The name of the balancer on the reverse proxy to register with.
`T`	`balancer(String value)` The name of the balancer on the reverse proxy to register with.
`T`	`configurationSsl()` Configuration and runtime operations for mod_cluster subsystem.
`T`	`configurationSsl(ConfigurationSsl value)` Configuration and runtime operations for mod_cluster subsystem.
`T`	`configurationSsl(ConfigurationSslConsumer consumer)` Configuration and runtime operations for mod_cluster subsystem.
`T`	`configurationSsl(ConfigurationSslSupplier supplier)` Configuration and runtime operations for mod_cluster subsystem.
`String`	`connector()` Deprecated. Deprecated. Functions as alias for the 'listener' attribute.
`T`	`connector(String value)` Deprecated. Deprecated. Functions as alias for the 'listener' attribute.
`T`	`dynamicLoadProvider()` Configuration and runtime operations for mod_cluster subsystem.
`T`	`dynamicLoadProvider(DynamicLoadProvider value)` Configuration and runtime operations for mod_cluster subsystem.
`T`	`dynamicLoadProvider(DynamicLoadProviderConsumer consumer)` Configuration and runtime operations for mod_cluster subsystem.
`T`	`dynamicLoadProvider(DynamicLoadProviderSupplier supplier)` Configuration and runtime operations for mod_cluster subsystem.
`String`	`excludedContexts()` List of contexts to exclude from registration with the reverse proxies.
`T`	`excludedContexts(String value)` List of contexts to exclude from registration with the reverse proxies.
`Boolean`	`flushPackets()` Whether to enable packet flushing on the reverse proxy.
`T`	`flushPackets(Boolean value)` Whether to enable packet flushing on the reverse proxy.
`Integer`	`flushWait()` Time to wait before flushing packets on the reverse proxy.
`T`	`flushWait(Integer value)` Time to wait before flushing packets on the reverse proxy.
`String`	`getKey()`
`String`	`listener()` The name of Undertow listener that will be registered with the reverse proxy.
`T`	`listener(String value)` The name of Undertow listener that will be registered with the reverse proxy.
`String`	`loadBalancingGroup()` Name of the load balancing group this node belongs to.
`T`	`loadBalancingGroup(String value)` Name of the load balancing group this node belongs to.
`Integer`	`maxAttempts()` Maximum number of failover attempts by reverse proxy when sending the request to the backend server.
`T`	`maxAttempts(Integer value)` Maximum number of failover attempts by reverse proxy when sending the request to the backend server.
`Integer`	`nodeTimeout()` Timeout (in seconds) for proxy connections to a node.
`T`	`nodeTimeout(Integer value)` Timeout (in seconds) for proxy connections to a node.
`Integer`	`ping()` Number of seconds for which to wait for a pong answer to a ping.
`T`	`ping(Integer value)` Number of seconds for which to wait for a pong answer to a ping.
`List<String>`	`proxies()` List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
`T`	`proxies(List<String> value)` List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
`T`	`proxies(String... args)` List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
`T`	`proxy(String value)` List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
`String`	`proxyList()` Deprecated. The 'proxy-list' attribute has been deprecated in favor of proxies (list of references to outbound-socket-binding)
`T`	`proxyList(String value)` Deprecated. The 'proxy-list' attribute has been deprecated in favor of proxies (list of references to outbound-socket-binding)
`String`	`proxyUrl()` Base URL for MCMP requests.
`T`	`proxyUrl(String value)` Base URL for MCMP requests.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener
`Proxy.SessionDrainingStrategy`	`sessionDrainingStrategy()` Session draining strategy used during undeployment of a web application.
`T`	`sessionDrainingStrategy(Proxy.SessionDrainingStrategy value)` Session draining strategy used during undeployment of a web application.
`T`	`simpleLoadProvider()` Simple load provider returns constant pre-configured load balancing factor.
`T`	`simpleLoadProvider(SimpleLoadProvider value)` Simple load provider returns constant pre-configured load balancing factor.
`T`	`simpleLoadProvider(SimpleLoadProviderConsumer consumer)` Simple load provider returns constant pre-configured load balancing factor.
`T`	`simpleLoadProvider(SimpleLoadProviderSupplier supplier)` Simple load provider returns constant pre-configured load balancing factor.
`Integer`	`smax()` Soft maximum idle connection count for reverse proxy.
`T`	`smax(Integer value)` Soft maximum idle connection count for reverse proxy.
`Integer`	`socketTimeout()` Timeout to wait for the reverse proxy to answer a MCMP message.
`T`	`socketTimeout(Integer value)` Timeout to wait for the reverse proxy to answer a MCMP message.
`String`	`sslContext()` Reference to the SSLContext to be used by mod_cluster.
`T`	`sslContext(String value)` Reference to the SSLContext to be used by mod_cluster.
`Integer`	`statusInterval()` Number of seconds a STATUS message is sent from the application server to the proxy.
`T`	`statusInterval(Integer value)` Number of seconds a STATUS message is sent from the application server to the proxy.
`Boolean`	`stickySession()` Indicates whether subsequent requests for a given session should be routed to the same node, if possible.
`T`	`stickySession(Boolean value)` Indicates whether subsequent requests for a given session should be routed to the same node, if possible.
`Boolean`	`stickySessionForce()` Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck.
`T`	`stickySessionForce(Boolean value)` Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck.
`Boolean`	`stickySessionRemove()` Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck.
`T`	`stickySessionRemove(Boolean value)` Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck.
`Integer`	`stopContextTimeout()` Maximum time to wait for context to process pending requests.
`T`	`stopContextTimeout(Integer value)` Maximum time to wait for context to process pending requests.
`Proxy.ProxyResources`	`subresources()`
`Integer`	`ttl()` Time to live (in seconds) for idle connections above smax.
`T`	`ttl(Integer value)` Time to live (in seconds) for idle connections above smax.
`Integer`	`workerTimeout()` Number of seconds to wait for a worker to become available to handle a request.
`T`	`workerTimeout(Integer value)` Number of seconds to wait for a worker to become available to handle a request.

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

- Constructor Detail
  - Proxy
```
public Proxy(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a property change listener
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property change listener
  - subresources
```
public Proxy.ProxyResources subresources()
```
  - configurationSsl
```
public T configurationSsl(ConfigurationSsl value)
```
    Configuration and runtime operations for mod_cluster subsystem.
  - configurationSsl
```
public T configurationSsl(ConfigurationSslConsumer consumer)
```
    Configuration and runtime operations for mod_cluster subsystem.
  - configurationSsl
```
public T configurationSsl()
```
    Configuration and runtime operations for mod_cluster subsystem.
  - configurationSsl
```
public T configurationSsl(ConfigurationSslSupplier supplier)
```
    Configuration and runtime operations for mod_cluster subsystem.
  - dynamicLoadProvider
```
public T dynamicLoadProvider(DynamicLoadProvider value)
```
    Configuration and runtime operations for mod_cluster subsystem.
  - dynamicLoadProvider
```
public T dynamicLoadProvider(DynamicLoadProviderConsumer consumer)
```
    Configuration and runtime operations for mod_cluster subsystem.
  - dynamicLoadProvider
```
public T dynamicLoadProvider()
```
    Configuration and runtime operations for mod_cluster subsystem.
  - dynamicLoadProvider
```
public T dynamicLoadProvider(DynamicLoadProviderSupplier supplier)
```
    Configuration and runtime operations for mod_cluster subsystem.
  - simpleLoadProvider
```
public T simpleLoadProvider(SimpleLoadProvider value)
```
    Simple load provider returns constant pre-configured load balancing factor.
  - simpleLoadProvider
```
public T simpleLoadProvider(SimpleLoadProviderConsumer consumer)
```
    Simple load provider returns constant pre-configured load balancing factor.
  - simpleLoadProvider
```
public T simpleLoadProvider()
```
    Simple load provider returns constant pre-configured load balancing factor.
  - simpleLoadProvider
```
public T simpleLoadProvider(SimpleLoadProviderSupplier supplier)
```
    Simple load provider returns constant pre-configured load balancing factor.
  - advertise
```
public Boolean advertise()
```
    Whether to enable multicast-based advertise mechanism.
  - advertise
```
public T advertise(Boolean value)
```
    Whether to enable multicast-based advertise mechanism.
  - advertiseSecurityKey
```
public String advertiseSecurityKey()
```
    If specified, reverse proxy advertisements checksums will be verified using this value as a salt.
  - advertiseSecurityKey
```
public T advertiseSecurityKey(String value)
```
    If specified, reverse proxy advertisements checksums will be verified using this value as a salt.
  - advertiseSocket
```
public String advertiseSocket()
```
    Name of socket binding to use for the advertise socket.
  - advertiseSocket
```
public T advertiseSocket(String value)
```
    Name of socket binding to use for the advertise socket.
  - autoEnableContexts
```
public Boolean autoEnableContexts()
```
    If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).
  - autoEnableContexts
```
public T autoEnableContexts(Boolean value)
```
    If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).
  - balancer
```
public String balancer()
```
    The name of the balancer on the reverse proxy to register with.
  - balancer
```
public T balancer(String value)
```
    The name of the balancer on the reverse proxy to register with.
  - connector
```
@Deprecated
public String connector()
```
    Deprecated. Deprecated. Functions as alias for the 'listener' attribute.
    
    The name of Undertow listener that will be registered with the reverse proxy.
  - connector
```
@Deprecated
public T connector(String value)
```
    Deprecated. Deprecated. Functions as alias for the 'listener' attribute.
    
    The name of Undertow listener that will be registered with the reverse proxy.
  - excludedContexts
```
public String excludedContexts()
```
    List of contexts to exclude from registration with the reverse proxies.
  - excludedContexts
```
public T excludedContexts(String value)
```
    List of contexts to exclude from registration with the reverse proxies.
  - flushPackets
```
public Boolean flushPackets()
```
    Whether to enable packet flushing on the reverse proxy.
  - flushPackets
```
public T flushPackets(Boolean value)
```
    Whether to enable packet flushing on the reverse proxy.
  - flushWait
```
public Integer flushWait()
```
    Time to wait before flushing packets on the reverse proxy.
  - flushWait
```
public T flushWait(Integer value)
```
    Time to wait before flushing packets on the reverse proxy.
  - listener
```
public String listener()
```
    The name of Undertow listener that will be registered with the reverse proxy.
  - listener
```
public T listener(String value)
```
    The name of Undertow listener that will be registered with the reverse proxy.
  - loadBalancingGroup
```
public String loadBalancingGroup()
```
    Name of the load balancing group this node belongs to.
  - loadBalancingGroup
```
public T loadBalancingGroup(String value)
```
    Name of the load balancing group this node belongs to.
  - maxAttempts
```
public Integer maxAttempts()
```
    Maximum number of failover attempts by reverse proxy when sending the request to the backend server.
  - maxAttempts
```
public T maxAttempts(Integer value)
```
    Maximum number of failover attempts by reverse proxy when sending the request to the backend server.
  - nodeTimeout
```
public Integer nodeTimeout()
```
    Timeout (in seconds) for proxy connections to a node. That is the time mod_cluster will wait for the back-end response before returning an error.
  - nodeTimeout
```
public T nodeTimeout(Integer value)
```
    Timeout (in seconds) for proxy connections to a node. That is the time mod_cluster will wait for the back-end response before returning an error.
  - ping
```
public Integer ping()
```
    Number of seconds for which to wait for a pong answer to a ping.
  - ping
```
public T ping(Integer value)
```
    Number of seconds for which to wait for a pong answer to a ping.
  - proxies
```
public List<String> proxies()
```
    List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
  - proxies
```
public T proxies(List<String> value)
```
    List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
  - proxy
```
public T proxy(String value)
```
    List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
  - proxies
```
public T proxies(String... args)
```
    List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
  - proxyList
```
@Deprecated
public String proxyList()
```
    Deprecated. The 'proxy-list' attribute has been deprecated in favor of proxies (list of references to outbound-socket-binding)
    
    List of reverse proxies to register with. Format (hostname:port) separated with commas.
  - proxyList
```
@Deprecated
public T proxyList(String value)
```
    Deprecated. The 'proxy-list' attribute has been deprecated in favor of proxies (list of references to outbound-socket-binding)
    
    List of reverse proxies to register with. Format (hostname:port) separated with commas.
  - proxyUrl
```
public String proxyUrl()
```
    Base URL for MCMP requests.
  - proxyUrl
```
public T proxyUrl(String value)
```
    Base URL for MCMP requests.
  - sessionDrainingStrategy
```
public Proxy.SessionDrainingStrategy sessionDrainingStrategy()
```
    Session draining strategy used during undeployment of a web application.
  - sessionDrainingStrategy
```
public T sessionDrainingStrategy(Proxy.SessionDrainingStrategy value)
```
    Session draining strategy used during undeployment of a web application.
  - smax
```
public Integer smax()
```
    Soft maximum idle connection count for reverse proxy.
  - smax
```
public T smax(Integer value)
```
    Soft maximum idle connection count for reverse proxy.
  - socketTimeout
```
public Integer socketTimeout()
```
    Timeout to wait for the reverse proxy to answer a MCMP message.
  - socketTimeout
```
public T socketTimeout(Integer value)
```
    Timeout to wait for the reverse proxy to answer a MCMP message.
  - sslContext
```
public String sslContext()
```
    Reference to the SSLContext to be used by mod_cluster.
  - sslContext
```
public T sslContext(String value)
```
    Reference to the SSLContext to be used by mod_cluster.
  - statusInterval
```
public Integer statusInterval()
```
    Number of seconds a STATUS message is sent from the application server to the proxy.
  - statusInterval
```
public T statusInterval(Integer value)
```
    Number of seconds a STATUS message is sent from the application server to the proxy.
  - stickySession
```
public Boolean stickySession()
```
    Indicates whether subsequent requests for a given session should be routed to the same node, if possible.
  - stickySession
```
public T stickySession(Boolean value)
```
    Indicates whether subsequent requests for a given session should be routed to the same node, if possible.
  - stickySessionForce
```
public Boolean stickySessionForce()
```
    Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.
  - stickySessionForce
```
public T stickySessionForce(Boolean value)
```
    Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.
  - stickySessionRemove
```
public Boolean stickySessionRemove()
```
    Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.
  - stickySessionRemove
```
public T stickySessionRemove(Boolean value)
```
    Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.
  - stopContextTimeout
```
public Integer stopContextTimeout()
```
    Maximum time to wait for context to process pending requests.
  - stopContextTimeout
```
public T stopContextTimeout(Integer value)
```
    Maximum time to wait for context to process pending requests.
  - ttl
```
public Integer ttl()
```
    Time to live (in seconds) for idle connections above smax.
  - ttl
```
public T ttl(Integer value)
```
    Time to live (in seconds) for idle connections above smax.
  - workerTimeout
```
public Integer workerTimeout()
```
    Number of seconds to wait for a worker to become available to handle a request.
  - workerTimeout
```
public T workerTimeout(Integer value)
```
    Number of seconds to wait for a worker to become available to handle a request.

Class Proxy<T extends Proxy<T>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Proxy

Method Detail

getKey

addPropertyChangeListener

removePropertyChangeListener

subresources

configurationSsl

configurationSsl

configurationSsl

configurationSsl

dynamicLoadProvider

dynamicLoadProvider

dynamicLoadProvider

dynamicLoadProvider

simpleLoadProvider

simpleLoadProvider

simpleLoadProvider

simpleLoadProvider

advertise

advertise

advertiseSecurityKey

advertiseSecurityKey

advertiseSocket

advertiseSocket

autoEnableContexts

autoEnableContexts

balancer

balancer

connector

connector

excludedContexts

excludedContexts

flushPackets

flushPackets

flushWait

flushWait

listener

listener

loadBalancingGroup

loadBalancingGroup

maxAttempts

maxAttempts

nodeTimeout

nodeTimeout

ping

ping

proxies

proxies

proxy

proxies

proxyList

proxyList

proxyUrl

proxyUrl

sessionDrainingStrategy

sessionDrainingStrategy

smax

smax

socketTimeout

socketTimeout

sslContext

sslContext

statusInterval

statusInterval

stickySession

stickySession

stickySessionForce

stickySessionForce

stickySessionRemove

stickySessionRemove

stopContextTimeout

stopContextTimeout

ttl

ttl