org.jboss.modcluster.container.catalina.standalone

Class ModClusterListener

java.lang.Object

org.jboss.modcluster.config.impl.ModClusterConfig

org.jboss.modcluster.container.catalina.standalone.ModClusterListener

All Implemented Interfaces:

org.apache.catalina.LifecycleListener, AdvertiseConfiguration, BalancerConfiguration, MCMPHandlerConfiguration, NodeConfiguration, SSLConfiguration, LoadBalanceFactorProviderFactory, ModClusterServiceMBean

public class ModClusterListener
extends ModClusterConfig
implements org.apache.catalina.LifecycleListener, LoadBalanceFactorProviderFactory, ModClusterServiceMBean

Non-clustered mod_cluster lifecycle listener for use in JBoss Web standalone and Tomcat.

Author:

Paul Ferraro

Field Summary

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

DEFAULT_SOCKET_ADDRESS

Constructor Summary

Constructors

Modifier	Constructor and Description
	ModClusterListener() Constructs a new ModClusterListener
protected	ModClusterListener(ModClusterServiceMBean mbean, org.apache.catalina.LifecycleListener listener)

Method Summary

Methods

Modifier and Type	Method and Description
void	addProxy(String host, int port)
LoadBalanceFactorProvider	createLoadBalanceFactorProvider()
boolean	disable()
boolean	disableContext(String hostName, String contextPath)
boolean	enable()
boolean	enableContext(String hostName, String contextPath)
Class<? extends JvmRouteFactory>	getJvmRouteFactoryClass()
int	getLoadDecayFactor() Returns the factor by which the contribution of historical load values to the load factor calculation should exponentially decay.
int	getLoadHistory() Returns the number of historic load values used when calculating the load factor.
double	getLoadMetricCapacity()
String	getLoadMetricClass() Returns the class name of the configured load metric.
Map<InetSocketAddress,String>	getProxyConfiguration()
String	getProxyConfigurationString()
Map<InetSocketAddress,String>	getProxyInfo()
String	getProxyInfoString()
void	lifecycleEvent(org.apache.catalina.LifecycleEvent event)
Map<InetSocketAddress,String>	ping()
Map<InetSocketAddress,String>	ping(String jvmRoute)
Map<InetSocketAddress,String>	ping(String scheme, String host, int port)
void	refresh()
void	removeProxy(String host, int port)
void	reset()
void	setJvmRouteFactoryClass(Class<? extends JvmRouteFactory> factoryClass)
void	setLoadDecayFactor(int decayFactor) Sets the factor by which the contribution of historical load values to the load factor calculation should exponentially decay.
void	setLoadHistory(int history) Sets the number of historic load values used when calculating the load factor.
void	setLoadMetricCapacity(String capacity) Sets the capacity (i.e.
void	setLoadMetricClass(String loadMetricClass) Sets the class of the desired load metric
boolean	stop(long timeout)
boolean	stop(long timeout, TimeUnit unit)
boolean	stopContext(String host, String path, long timeout)
boolean	stopContext(String host, String path, long timeout, TimeUnit unit)

Methods inherited from class org.jboss.modcluster.config.impl.ModClusterConfig

getAdvertise, getAdvertiseInterface, getAdvertisePort, getAdvertiseSecurityKey, getAdvertiseSocketAddress, getAdvertiseThreadFactory, getBalancer, getExcludedContexts, getExcludedContextsPerHost, getFlushPackets, getFlushWait, getJvmRouteFactory, getLoadBalancingGroup, getMaxAttempts, getNodeTimeout, getPing, getProxies, getProxyConfigurations, getProxyList, getProxyURL, getSessionDrainingStrategy, getSmax, getSocketTimeout, getSslCertificateEncodingAlgorithm, getSslCiphers, getSslCrlFile, getSslKeyAlias, getSslKeyStore, getSslKeyStorePassword, getSslKeyStoreProvider, getSslKeyStoreType, getSslProtocol, getSslTrustAlgorithm, getSslTrustMaxCertLength, getSslTrustStore, getSslTrustStorePassword, getSslTrustStoreProvider, getSslTrustStoreType, getStickySession, getStickySessionForce, getStickySessionRemove, getStopContextTimeout, getStopContextTimeoutUnit, getTtl, getWorkerTimeout, isAutoEnableContexts, isSsl, setAdvertise, setAdvertiseGroupAddress, setAdvertiseGroupAddress, setAdvertiseInterface, setAdvertiseInterface, setAdvertisePort, setAdvertiseSecurityKey, setAdvertiseSocketAddress, setAdvertiseThreadFactory, setAutoEnableContexts, setBalancer, setExcludedContexts, setExcludedContextsPerHost, setFlushPackets, setFlushWait, setJvmRouteFactory, setLoadBalancingGroup, setMaxAttempts, setNodeTimeout, setPing, setProxies, setProxyConfigurations, setProxyList, setProxyURL, setSessionDrainingStrategy, setSessionDrainingStrategy, setSmax, setSocketTimeout, setSsl, setSslCertificateEncodingAlgorithm, setSslCiphers, setSslCrlFile, setSslKeyAlias, setSslKeyStore, setSslKeyStorePassword, setSslKeyStoreProvider, setSslKeyStoreType, setSslProtocol, setSslTrustAlgorithm, setSslTrustMaxCertLength, setSslTrustStore, setSslTrustStorePassword, setSslTrustStoreProvider, setSslTrustStoreType, setStickySession, setStickySessionForce, setStickySessionRemove, setStopContextTimeout, setStopContextTimeoutUnit, setTtl, setWorkerTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

ModClusterListener

public ModClusterListener()

Constructs a new ModClusterListener

ModClusterListener

protected ModClusterListener(ModClusterServiceMBean mbean,
                  org.apache.catalina.LifecycleListener listener)

Method Detail

createLoadBalanceFactorProvider

public LoadBalanceFactorProvider createLoadBalanceFactorProvider()

Specified by:

createLoadBalanceFactorProvider in interface LoadBalanceFactorProviderFactory

See Also:

LoadBalanceFactorProviderFactory.createLoadBalanceFactorProvider()

lifecycleEvent

public void lifecycleEvent(org.apache.catalina.LifecycleEvent event)

Specified by:

lifecycleEvent in interface org.apache.catalina.LifecycleListener

See Also:

LifecycleListener.lifecycleEvent(org.apache.catalina.LifecycleEvent)

getJvmRouteFactoryClass

public Class<? extends JvmRouteFactory> getJvmRouteFactoryClass()

setJvmRouteFactoryClass

public void setJvmRouteFactoryClass(Class<? extends JvmRouteFactory> factoryClass)

getLoadMetricClass

public String getLoadMetricClass()

Returns the class name of the configured load metric.

Returns:

the name of a class implementing LoadMetric

setLoadMetricClass

public void setLoadMetricClass(String loadMetricClass)

Sets the class of the desired load metric

Parameters:

loadMetricClass - a class implementing LoadMetric

Throws:

ClassNotFoundException

getLoadDecayFactor

public int getLoadDecayFactor()

Returns the factor by which the contribution of historical load values to the load factor calculation should exponentially decay.

Returns:

the configured load decay factor

setLoadDecayFactor

public void setLoadDecayFactor(int decayFactor)

Sets the factor by which the contribution of historical load values to the load factor calculation should exponentially decay.

Parameters:

decayFactor - a positive number

getLoadHistory

public int getLoadHistory()

Returns the number of historic load values used when calculating the load factor.

Returns:

the configured load history

setLoadHistory

public void setLoadHistory(int history)

Sets the number of historic load values used when calculating the load factor.

Parameters:

history -

getLoadMetricCapacity

public double getLoadMetricCapacity()

See Also:

LoadMetricConfiguration

setLoadMetricCapacity

public void setLoadMetricCapacity(String capacity)

Sets the capacity (i.e. maximum expected value) of the load values returned by the load metric specified by getLoadMetricClass()

Parameters:

capacity - a load capacity

addProxy

public void addProxy(String host,
            int port)

Specified by:

addProxy in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.addProxy(java.lang.String, int)

disable

public boolean disable()

Specified by:

disable in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.disable()

disableContext

public boolean disableContext(String hostName,
                     String contextPath)

Specified by:

disableContext in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.disableContext(java.lang.String, java.lang.String)

ping

public Map<InetSocketAddress,String> ping()

Specified by:

ping in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.ping()

ping

public Map<InetSocketAddress,String> ping(String jvmRoute)

Specified by:

ping in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.ping(java.lang.String)

ping

public Map<InetSocketAddress,String> ping(String scheme,
                                 String host,
                                 int port)

Specified by:

ping in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.ping(java.lang.String, java.lang.String, int)

enable

public boolean enable()

Specified by:

enable in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.enable()

enableContext

public boolean enableContext(String hostName,
                    String contextPath)

Specified by:

enableContext in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.enableContext(java.lang.String, java.lang.String)

getProxyConfiguration

public Map<InetSocketAddress,String> getProxyConfiguration()

Specified by:

getProxyConfiguration in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.getProxyConfiguration()

getProxyConfigurationString

public String getProxyConfigurationString()

getProxyInfo

public Map<InetSocketAddress,String> getProxyInfo()

Specified by:

getProxyInfo in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.getProxyInfo()

getProxyInfoString

public String getProxyInfoString()

refresh

public void refresh()

Specified by:

refresh in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.refresh()

removeProxy

public void removeProxy(String host,
               int port)

Specified by:

removeProxy in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.removeProxy(java.lang.String, int)

reset

public void reset()

Specified by:

reset in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.reset()

stop

public boolean stop(long timeout,
           TimeUnit unit)

Specified by:

stop in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.stop(long, java.util.concurrent.TimeUnit)

stop

public boolean stop(long timeout)

stopContext

public boolean stopContext(String host,
                  String path,
                  long timeout,
                  TimeUnit unit)

Specified by:

stopContext in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.stopContext(java.lang.String, java.lang.String, long, java.util.concurrent.TimeUnit)

stopContext

public boolean stopContext(String host,
                  String path,
                  long timeout)