Package org.jboss.modcluster.config.impl

Class ModClusterConfig

java.lang.Object

org.jboss.modcluster.config.impl.ModClusterConfig

All Implemented Interfaces:

AdvertiseConfiguration, BalancerConfiguration, MCMPHandlerConfiguration, NodeConfiguration, SSLConfiguration

Direct Known Subclasses:

ModClusterListener

public class ModClusterConfig
extends Object
implements BalancerConfiguration, MCMPHandlerConfiguration, NodeConfiguration, SSLConfiguration, AdvertiseConfiguration

Java bean implementing the various configuration interfaces.

Author:

Brian Stansberry, Radoslav Husar

Field Summary

Fields inherited from interface org.jboss.modcluster.config.AdvertiseConfiguration

DEFAULT_SOCKET_ADDRESS

Constructor Summary

Constructors

Constructor	Description
ModClusterConfig()

Method Summary

Modifier and Type	Method	Description
Boolean	getAdvertise()	Receive advertisements from httpd proxies (default is to use advertisements if the proxyList is not set).
NetworkInterface	getAdvertiseInterface()	Multicast-enabled NetworkInterface to listen for advertisements.
String	getAdvertiseSecurityKey()	Advertise security key.
InetSocketAddress	getAdvertiseSocketAddress()
ThreadFactory	getAdvertiseThreadFactory()
String	getBalancer()	Name of the balancer.
Map<String,Set<String>>	getExcludedContextsPerHost()	Returns a list of contexts that should never be enabled in mod_cluster.
boolean	getFlushPackets()	Allows controlling flushing of packets.
int	getFlushWait()	Time to wait before flushing packets.
JvmRouteFactory	getJvmRouteFactory()	Factory for generating jvm route
String	getLoadBalancingGroup()	Indicates the group of servers to which this node belongs.
int	getMaxAttempts()	Maximum number of attempts to send the request to the backend server.
int	getNodeTimeout()	Maximum time on seconds for idle connections the proxy will wait to connect to the node.
int	getPing()	Time to wait for a pong answer to a ping.
Collection<InetSocketAddress>	getProxies()	Deprecated.
Collection<ProxyConfiguration>	getProxyConfigurations()	Gets list of proxies as a collection of ProxyConfigurations.
String	getProxyURL()	URL prefix.
SessionDrainingStrategy	getSessionDrainingStrategy()
int	getSmax()	Soft maximum inactive connection count.
SocketFactory	getSocketFactory()	Configuration of the socket factory, supply SSL socket factory to use SSL to connect to the proxy.
int	getSocketTimeout()	Connection timeout for communication with the proxy.
String	getSslCertificateEncodingAlgorithm()	Certificate encoding algorithm.
String	getSslCiphers()	SSL ciphers.
String	getSslCrlFile()	Certificate revocation list.
String	getSslKeyAlias()	Key alias.
String	getSslKeyStore()	SSL keystore.
String	getSslKeyStorePassword()	SSL keystore password.
String	getSslKeyStoreProvider()	Keystore provider.
String	getSslKeyStoreType()	Keystore type.
String	getSslProtocol()	SSL protocol.
String	getSslTrustAlgorithm()	Truststore algorithm.
int	getSslTrustMaxCertLength()	Trust max certificate length.
String	getSslTrustStore()	Trust store file.
String	getSslTrustStorePassword()	Trust store password.
String	getSslTrustStoreProvider()	Trust store provider.
String	getSslTrustStoreType()	Trust store type.
boolean	getStickySession()	Enables sticky sessions.
boolean	getStickySessionForce()	Return an error when the request cannot be routed to the right node.
boolean	getStickySessionRemove()	Remove session when the request cannot be routed to the right node.
long	getStopContextTimeout()	Returns the number of MCMPHandlerConfiguration.getStopContextTimeoutUnit() to wait for pending requests to complete when stopping a context.
TimeUnit	getStopContextTimeoutUnit()	Returns the unit of time to which MCMPHandlerConfiguration.getStopContextTimeout() pertains.
int	getTtl()	Maximum time on seconds for idle connections above smax.
int	getWorkerTimeout()	Timeout to wait for an available worker (default is no wait).
boolean	isAutoEnableContexts()	Indicates whether or not to automatically enable contexts.
boolean	isSsl()	Deprecated.
void	setAdvertise(Boolean advertise)
void	setAdvertiseInterface(InetAddress advertiseInterfaceAddress)
void	setAdvertiseInterface(NetworkInterface advertiseInterface)
void	setAdvertiseSecurityKey(String advertiseSecurityKey)
void	setAdvertiseSocketAddress(InetSocketAddress address)
void	setAdvertiseThreadFactory(ThreadFactory advertiseThreadFactory)
void	setAutoEnableContexts(boolean autoEnableContexts)
void	setBalancer(String balancer)
void	setExcludedContextsPerHost(Map<String,Set<String>> excludedContexts)
void	setFlushPackets(boolean flushPackets)
void	setFlushWait(int flushWait)
void	setJvmRouteFactory(JvmRouteFactory jvmRouteFactory)
void	setLoadBalancingGroup(String loadBalancingGroup)
void	setMaxAttempts(int maxAttempts)
void	setNodeTimeout(int nodeTimeout)
void	setPing(int ping)
void	setProxies(Collection<InetSocketAddress> proxies)	Deprecated. Since 1.3.1.Final use setProxyConfigurations(java.util.Collection) instead.
void	setProxyConfigurations(Collection<ProxyConfiguration> proxyConfigurations)
void	setProxyURL(String proxyURL)
void	setSessionDrainingStrategy(SessionDrainingStrategy sessionDrainingStrategy)
void	setSmax(int smax)
void	setSocketTimeout(int socketTimeout)
void	setSsl(boolean ssl)
void	setSslCertificateEncodingAlgorithm(String sslCertificateEncodingAlgorithm)
void	setSslCiphers(String sslCiphers)
void	setSslCrlFile(String sslCrlFile)
void	setSslKeyAlias(String sslKeyAlias)
void	setSslKeyStore(String sslKeyStore)
void	setSslKeyStorePassword(String sslKeyStorePassword)
void	setSslKeyStoreProvider(String sslKeyStoreProvider)
void	setSslKeyStoreType(String sslKeyStoreType)
void	setSslProtocol(String sslProtocol)
void	setSslTrustAlgorithm(String sslTrustAlgorithm)
void	setSslTrustMaxCertLength(int sslTrustMaxCertLength)
void	setSslTrustStore(String sslTrustStore)
void	setSslTrustStorePassword(String sslTrustStorePassword)
void	setSslTrustStoreProvider(String sslTrustStoreProvider)
void	setSslTrustStoreType(String sslTrustStoreType)
void	setStickySession(boolean stickySession)
void	setStickySessionForce(boolean stickySessionForce)
void	setStickySessionRemove(boolean stickySessionRemove)
void	setStopContextTimeout(int stopContextTimeout)
void	setStopContextTimeoutUnit(TimeUnit stopContextTimeoutUnit)
void	setTtl(int ttl)
void	setWorkerTimeout(int workerTimeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModClusterConfig

public ModClusterConfig()

Method Detail

getAdvertise

public Boolean getAdvertise()

Description copied from interface: MCMPHandlerConfiguration

Receive advertisements from httpd proxies (default is to use advertisements if the proxyList is not set).

Specified by:

getAdvertise in interface MCMPHandlerConfiguration

setAdvertise

public void setAdvertise(Boolean advertise)

getAdvertiseSocketAddress

public InetSocketAddress getAdvertiseSocketAddress()

Specified by:

getAdvertiseSocketAddress in interface AdvertiseConfiguration

setAdvertiseSocketAddress

public void setAdvertiseSocketAddress(InetSocketAddress address)

getAdvertiseInterface

public NetworkInterface getAdvertiseInterface()

Description copied from interface: AdvertiseConfiguration

Multicast-enabled NetworkInterface to listen for advertisements.

Specified by:

getAdvertiseInterface in interface AdvertiseConfiguration

setAdvertiseInterface

public void setAdvertiseInterface(NetworkInterface advertiseInterface)

setAdvertiseInterface

public void setAdvertiseInterface(InetAddress advertiseInterfaceAddress)

getAdvertiseSecurityKey

public String getAdvertiseSecurityKey()

Description copied from interface: AdvertiseConfiguration

Advertise security key.

Specified by:

getAdvertiseSecurityKey in interface AdvertiseConfiguration

setAdvertiseSecurityKey

public void setAdvertiseSecurityKey(String advertiseSecurityKey)

getAdvertiseThreadFactory

public ThreadFactory getAdvertiseThreadFactory()

Specified by:

getAdvertiseThreadFactory in interface AdvertiseConfiguration

setAdvertiseThreadFactory

public void setAdvertiseThreadFactory(ThreadFactory advertiseThreadFactory)

getProxyConfigurations

public Collection<ProxyConfiguration> getProxyConfigurations()

Description copied from interface: MCMPHandlerConfiguration

Gets list of proxies as a collection of ProxyConfigurations.

Specified by:

getProxyConfigurations in interface MCMPHandlerConfiguration

Returns:

list of proxies as a collection of ProxyConfigurations

setProxyConfigurations

public void setProxyConfigurations(Collection<ProxyConfiguration> proxyConfigurations)

getProxies

@Deprecated
public Collection<InetSocketAddress> getProxies()

Deprecated.

Description copied from interface: MCMPHandlerConfiguration

Gets list of proxies as a collection of InetSocketAddresses.

Specified by:

getProxies in interface MCMPHandlerConfiguration

Returns:

list of proxies as a collection of InetSocketAddresses

setProxies

@Deprecated
public void setProxies(Collection<InetSocketAddress> proxies)

Deprecated.

Since 1.3.1.Final use setProxyConfigurations(java.util.Collection) instead.

getProxyURL

public String getProxyURL()

Description copied from interface: MCMPHandlerConfiguration

URL prefix.

Specified by:

getProxyURL in interface MCMPHandlerConfiguration

setProxyURL

public void setProxyURL(String proxyURL)

getSocketTimeout

public int getSocketTimeout()

Description copied from interface: MCMPHandlerConfiguration

Connection timeout for communication with the proxy.

Specified by:

getSocketTimeout in interface MCMPHandlerConfiguration

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

isSsl

@Deprecated
public boolean isSsl()

Deprecated.

Description copied from interface: MCMPHandlerConfiguration

SSL client cert usage to connect to the proxy.

Specified by:

isSsl in interface MCMPHandlerConfiguration

setSsl

public void setSsl(boolean ssl)

getSocketFactory

public SocketFactory getSocketFactory()

Description copied from interface: MCMPHandlerConfiguration

Configuration of the socket factory, supply SSL socket factory to use SSL to connect to the proxy.

Specified by:

getSocketFactory in interface MCMPHandlerConfiguration

getExcludedContextsPerHost

public Map<String,Set<String>> getExcludedContextsPerHost()

Description copied from interface: MCMPHandlerConfiguration

Returns a list of contexts that should never be enabled in mod_cluster. Contexts may be

Specified by:

getExcludedContextsPerHost in interface MCMPHandlerConfiguration

Returns:

a comma delimited list of contexts of the form "[host:]context"

setExcludedContextsPerHost

public void setExcludedContextsPerHost(Map<String,Set<String>> excludedContexts)

isAutoEnableContexts

public boolean isAutoEnableContexts()

Description copied from interface: MCMPHandlerConfiguration

Indicates whether or not to automatically enable contexts. If false, context will need to be enabled manually.

Specified by:

isAutoEnableContexts in interface MCMPHandlerConfiguration

Returns:

true, if contexts should auto-enable, false otherwise.

setAutoEnableContexts

public void setAutoEnableContexts(boolean autoEnableContexts)

getStopContextTimeout

public long getStopContextTimeout()

Description copied from interface: MCMPHandlerConfiguration

Returns the number of MCMPHandlerConfiguration.getStopContextTimeoutUnit() to wait for pending requests to complete when stopping a context.

Specified by:

getStopContextTimeout in interface MCMPHandlerConfiguration

Returns:

timeout in seconds.

setStopContextTimeout

public void setStopContextTimeout(int stopContextTimeout)

getStopContextTimeoutUnit

public TimeUnit getStopContextTimeoutUnit()

Description copied from interface: MCMPHandlerConfiguration

Returns the unit of time to which MCMPHandlerConfiguration.getStopContextTimeout() pertains.

Specified by:

getStopContextTimeoutUnit in interface MCMPHandlerConfiguration

Returns:

a unit of time

setStopContextTimeoutUnit

public void setStopContextTimeoutUnit(TimeUnit stopContextTimeoutUnit)

getJvmRouteFactory

public JvmRouteFactory getJvmRouteFactory()

Description copied from interface: MCMPHandlerConfiguration

Factory for generating jvm route

Specified by:

getJvmRouteFactory in interface MCMPHandlerConfiguration

setJvmRouteFactory

public void setJvmRouteFactory(JvmRouteFactory jvmRouteFactory)

getSessionDrainingStrategy

public SessionDrainingStrategy getSessionDrainingStrategy()

Specified by:

getSessionDrainingStrategy in interface MCMPHandlerConfiguration

setSessionDrainingStrategy

public void setSessionDrainingStrategy(SessionDrainingStrategy sessionDrainingStrategy)

getSslCiphers

public String getSslCiphers()

Description copied from interface: SSLConfiguration

SSL ciphers.

Specified by:

getSslCiphers in interface SSLConfiguration

setSslCiphers

public void setSslCiphers(String sslCiphers)

getSslProtocol

public String getSslProtocol()

Description copied from interface: SSLConfiguration

SSL protocol.

Specified by:

getSslProtocol in interface SSLConfiguration

setSslProtocol

public void setSslProtocol(String sslProtocol)

getSslCertificateEncodingAlgorithm

public String getSslCertificateEncodingAlgorithm()

Description copied from interface: SSLConfiguration

Certificate encoding algorithm.

Specified by:

getSslCertificateEncodingAlgorithm in interface SSLConfiguration

setSslCertificateEncodingAlgorithm

public void setSslCertificateEncodingAlgorithm(String sslCertificateEncodingAlgorithm)

getSslKeyStore

public String getSslKeyStore()

Description copied from interface: SSLConfiguration

SSL keystore.

Specified by:

getSslKeyStore in interface SSLConfiguration

setSslKeyStore

public void setSslKeyStore(String sslKeyStore)

getSslKeyStorePassword

public String getSslKeyStorePassword()

Description copied from interface: SSLConfiguration

SSL keystore password.

Specified by:

getSslKeyStorePassword in interface SSLConfiguration

setSslKeyStorePassword

public void setSslKeyStorePassword(String sslKeyStorePassword)

getSslKeyStoreType

public String getSslKeyStoreType()

Description copied from interface: SSLConfiguration

Keystore type.

Specified by:

getSslKeyStoreType in interface SSLConfiguration

setSslKeyStoreType

public void setSslKeyStoreType(String sslKeyStoreType)

getSslKeyStoreProvider

public String getSslKeyStoreProvider()

Description copied from interface: SSLConfiguration

Keystore provider.

Specified by:

getSslKeyStoreProvider in interface SSLConfiguration

setSslKeyStoreProvider

public void setSslKeyStoreProvider(String sslKeyStoreProvider)

getSslTrustAlgorithm

public String getSslTrustAlgorithm()

Description copied from interface: SSLConfiguration

Truststore algorithm.

Specified by:

getSslTrustAlgorithm in interface SSLConfiguration

setSslTrustAlgorithm

public void setSslTrustAlgorithm(String sslTrustAlgorithm)

getSslKeyAlias

public String getSslKeyAlias()

Description copied from interface: SSLConfiguration

Key alias.

Specified by:

getSslKeyAlias in interface SSLConfiguration

setSslKeyAlias

public void setSslKeyAlias(String sslKeyAlias)

getSslCrlFile

public String getSslCrlFile()

Description copied from interface: SSLConfiguration

Certificate revocation list.

Specified by:

getSslCrlFile in interface SSLConfiguration

setSslCrlFile

public void setSslCrlFile(String sslCrlFile)

getSslTrustMaxCertLength

public int getSslTrustMaxCertLength()

Description copied from interface: SSLConfiguration

Trust max certificate length.

Specified by:

getSslTrustMaxCertLength in interface SSLConfiguration

setSslTrustMaxCertLength

public void setSslTrustMaxCertLength(int sslTrustMaxCertLength)

getSslTrustStore

public String getSslTrustStore()

Description copied from interface: SSLConfiguration

Trust store file.

Specified by:

getSslTrustStore in interface SSLConfiguration

setSslTrustStore

public void setSslTrustStore(String sslTrustStore)

getSslTrustStorePassword

public String getSslTrustStorePassword()

Description copied from interface: SSLConfiguration

Trust store password.

Specified by:

getSslTrustStorePassword in interface SSLConfiguration

setSslTrustStorePassword

public void setSslTrustStorePassword(String sslTrustStorePassword)

getSslTrustStoreType

public String getSslTrustStoreType()

Description copied from interface: SSLConfiguration

Trust store type.

Specified by:

getSslTrustStoreType in interface SSLConfiguration

setSslTrustStoreType

public void setSslTrustStoreType(String sslTrustStoreType)

getSslTrustStoreProvider

public String getSslTrustStoreProvider()

Description copied from interface: SSLConfiguration

Trust store provider.

Specified by:

getSslTrustStoreProvider in interface SSLConfiguration

setSslTrustStoreProvider

public void setSslTrustStoreProvider(String sslTrustStoreProvider)

getLoadBalancingGroup

public String getLoadBalancingGroup()

Description copied from interface: NodeConfiguration

Indicates the group of servers to which this node belongs. If defined, mod_cluster will always attempt to failover a given request to a node in the same group as the failed node. This property is equivalent to the mod_jk domain directive.

Specified by:

getLoadBalancingGroup in interface NodeConfiguration

setLoadBalancingGroup

public void setLoadBalancingGroup(String loadBalancingGroup)

getFlushPackets

public boolean getFlushPackets()

Description copied from interface: NodeConfiguration

Allows controlling flushing of packets.

Specified by:

getFlushPackets in interface NodeConfiguration

setFlushPackets

public void setFlushPackets(boolean flushPackets)

getFlushWait

public int getFlushWait()

Description copied from interface: NodeConfiguration

Time to wait before flushing packets.

Specified by:

getFlushWait in interface NodeConfiguration

setFlushWait

public void setFlushWait(int flushWait)

getPing

public int getPing()

Description copied from interface: NodeConfiguration

Time to wait for a pong answer to a ping.

Specified by:

getPing in interface NodeConfiguration

setPing

public void setPing(int ping)

getSmax

public int getSmax()

Description copied from interface: NodeConfiguration

Soft maximum inactive connection count.

Specified by:

getSmax in interface NodeConfiguration

setSmax

public void setSmax(int smax)

getTtl

public int getTtl()

Description copied from interface: NodeConfiguration

Maximum time on seconds for idle connections above smax.

Specified by:

getTtl in interface NodeConfiguration

setTtl

public void setTtl(int ttl)

getNodeTimeout

public int getNodeTimeout()

Description copied from interface: NodeConfiguration

Maximum time on seconds for idle connections the proxy will wait to connect to the node.

Specified by:

getNodeTimeout in interface NodeConfiguration

setNodeTimeout

public void setNodeTimeout(int nodeTimeout)

getBalancer

public String getBalancer()

Description copied from interface: NodeConfiguration

Name of the balancer.

Specified by:

getBalancer in interface NodeConfiguration

setBalancer

public void setBalancer(String balancer)

getStickySession

public boolean getStickySession()

Description copied from interface: BalancerConfiguration

Enables sticky sessions.

Specified by:

getStickySession in interface BalancerConfiguration

setStickySession

public void setStickySession(boolean stickySession)

getStickySessionRemove

public boolean getStickySessionRemove()

Description copied from interface: BalancerConfiguration

Remove session when the request cannot be routed to the right node.

Specified by:

getStickySessionRemove in interface BalancerConfiguration

setStickySessionRemove

public void setStickySessionRemove(boolean stickySessionRemove)

getStickySessionForce

public boolean getStickySessionForce()

Description copied from interface: BalancerConfiguration

Return an error when the request cannot be routed to the right node.

Specified by:

getStickySessionForce in interface BalancerConfiguration

setStickySessionForce

public void setStickySessionForce(boolean stickySessionForce)

getWorkerTimeout

public int getWorkerTimeout()

Description copied from interface: BalancerConfiguration

Timeout to wait for an available worker (default is no wait).

Specified by:

getWorkerTimeout in interface BalancerConfiguration

setWorkerTimeout

public void setWorkerTimeout(int workerTimeout)

getMaxAttempts

public int getMaxAttempts()

Description copied from interface: BalancerConfiguration

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

Specified by:

getMaxAttempts in interface BalancerConfiguration

setMaxAttempts

public void setMaxAttempts(int maxAttempts)