org.jboss.modcluster

Class ModClusterService

java.lang.Object

org.jboss.modcluster.ModClusterService

All Implemented Interfaces:

ContainerEventHandler, LoadBalanceFactorProvider, ContextFilter, MCMPConnectionListener, ModClusterServiceMBean

public class ModClusterService
extends Object
implements ModClusterServiceMBean, ContainerEventHandler, LoadBalanceFactorProvider, MCMPConnectionListener, ContextFilter

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT

Constructor Summary

Constructors

Modifier	Constructor and Description
	ModClusterService(ModClusterConfig config, LoadBalanceFactorProvider loadBalanceFactorProvider)
	ModClusterService(ModClusterConfig config, LoadBalanceFactorProviderFactory loadBalanceFactorProviderFactory)
	ModClusterService(ModClusterConfiguration config, LoadBalanceFactorProvider loadBalanceFactorProvider)
protected	ModClusterService(NodeConfiguration nodeConfig, BalancerConfiguration balancerConfig, MCMPHandlerConfiguration mcmpConfig, AdvertiseConfiguration advertiseConfig, LoadBalanceFactorProviderFactory loadBalanceFactorProviderFactory, MCMPRequestFactory requestFactory, MCMPResponseParser responseParser, ResetRequestSource resetRequestSource, MCMPHandler mcmpHandler, AdvertiseListenerFactory listenerFactory)

Method Summary

Modifier and Type	Method and Description
void	add(Context context)
void	addProxy(String host, int port) Add a proxy to the list of those with which this handler communicates.
protected void	config(Engine engine) Configures the specified engine.
void	connectionEstablished(InetAddress localAddress)
boolean	disable() Disable all webapps for all engines.
boolean	disableContext(String host, String path) Disables the webapp with the specified host and context path.
boolean	enable() Enable all webapps for all engines.
boolean	enableContext(String host, String path) Enables the webapp with the specified host and context path.
protected void	establishJvmRoute(Engine engine)
Set<String>	getExcludedContexts(Host host) Returns the contexts that will *not* be registered in any proxy for the given host.
int	getLoadBalanceFactor(Engine engine)
Map<InetSocketAddress,String>	getProxyConfiguration()
Map<InetSocketAddress,String>	getProxyInfo()
void	init(Server server) Triggers the initialization of mod_cluster.
boolean	isAutoEnableContexts() Indicates when contexts should auto-enable by default.
boolean	isEstablished()
Map<InetSocketAddress,String>	ping()
Map<InetSocketAddress,String>	ping(String jvmRoute)
Map<InetSocketAddress,String>	ping(String scheme, String host, int port)
void	refresh() Refresh configuration.
void	remove(Context context)
protected void	removeAll(Engine engine) Sends REMOVE-APP *, if engine was initialized
void	removeProxy(String host, int port) Remove a proxy from the list of those with which this handler communicates.
void	reset()
void	shutdown() Triggers the shutdown of mod_cluster.
void	start(Context context)
void	start(Server server) Indicates the servlet container has been started.
void	status(Engine engine)
void	stop(Context context)
boolean	stop(long timeout, TimeUnit unit)
void	stop(Server server)
boolean	stopContext(String host, String path, long timeout, TimeUnit unit)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

Constructor Detail

ModClusterService

public ModClusterService(ModClusterConfiguration config,
                         LoadBalanceFactorProvider loadBalanceFactorProvider)

ModClusterService

public ModClusterService(ModClusterConfig config,
                         LoadBalanceFactorProvider loadBalanceFactorProvider)

ModClusterService

public ModClusterService(ModClusterConfig config,
                         LoadBalanceFactorProviderFactory loadBalanceFactorProviderFactory)

ModClusterService

protected ModClusterService(NodeConfiguration nodeConfig,
                            BalancerConfiguration balancerConfig,
                            MCMPHandlerConfiguration mcmpConfig,
                            AdvertiseConfiguration advertiseConfig,
                            LoadBalanceFactorProviderFactory loadBalanceFactorProviderFactory,
                            MCMPRequestFactory requestFactory,
                            MCMPResponseParser responseParser,
                            ResetRequestSource resetRequestSource,
                            MCMPHandler mcmpHandler,
                            AdvertiseListenerFactory listenerFactory)

Method Detail

init

public void init(Server server)

Description copied from interface: ContainerEventHandler

Triggers the initialization of mod_cluster. This event should be triggered only once, after the startup of the servlet container, but before triggering the ContainerEventHandler.start(Server) event.

Specified by:

init in interface ContainerEventHandler

Parameters:

server - a server

See Also:

org.jboss.modcluster.ContainerEventHandler#init(java.lang.Object)

getExcludedContexts

public Set<String> getExcludedContexts(Host host)

Returns the contexts that will *not* be registered in any proxy for the given host.

Specified by:

getExcludedContexts in interface ContextFilter

Returns:

a set of context paths excluded for the given host

See Also:

org.jboss.modcluster.mcmp.ContextFilter#getExcludedContexts()

isAutoEnableContexts

public boolean isAutoEnableContexts()

Indicates when contexts should auto-enable by default. If auto-enable is off, then contexts are disabled by default and must be enabled manually.

Specified by:

isAutoEnableContexts in interface ContextFilter

Returns:

true, contexts should be auto-enabled, false otherwise.

See Also:

ContextFilter.isAutoEnableContexts()

shutdown

public void shutdown()

Description copied from interface: ContainerEventHandler

Triggers the shutdown of mod_cluster. Closes any resources created in ContainerEventHandler.init(Server).

Specified by:

shutdown in interface ContainerEventHandler

See Also:

org.jboss.modcluster.ContainerEventHandler#shutdown()

start

public void start(Server server)

Description copied from interface: ContainerEventHandler

Indicates the servlet container has been started. This event triggers the configuration of each servlet engine, and the addition of all web application contexts.

Specified by:

start in interface ContainerEventHandler

Parameters:

server - the started server

See Also:

org.jboss.modcluster.ContainerEventHandler#start(java.lang.Object)

stop

public void stop(Server server)

Specified by:

stop in interface ContainerEventHandler

Parameters:

server - the stopped server

See Also:

org.jboss.modcluster.ContainerEventHandler#stop(org.jboss.modcluster.Server)

config

protected void config(Engine engine)

Configures the specified engine. Sends CONFIG request.

Parameters:

engine -

isEstablished

public boolean isEstablished()

Specified by:

isEstablished in interface MCMPConnectionListener

See Also:

MCMPConnectionListener.isEstablished()

connectionEstablished

public void connectionEstablished(InetAddress localAddress)

Specified by:

connectionEstablished in interface MCMPConnectionListener

See Also:

MCMPConnectionListener.connectionEstablished(java.net.InetAddress)

establishJvmRoute

protected void establishJvmRoute(Engine engine)

add

public void add(Context context)

Specified by:

add in interface ContainerEventHandler

Parameters:

context - the added context

See Also:

org.jboss.modcluster.ContainerEventHandler#add(org.jboss.modcluster.Context)

start

public void start(Context context)

Specified by:

start in interface ContainerEventHandler

Parameters:

context - the started context

See Also:

org.jboss.modcluster.ContainerEventHandler#start(org.jboss.modcluster.Context)

stop

public void stop(Context context)

Specified by:

stop in interface ContainerEventHandler

Parameters:

context - the stopped context

See Also:

org.jboss.modcluster.ContainerEventHandler#stop(org.jboss.modcluster.Context)

remove

public void remove(Context context)

Specified by:

remove in interface ContainerEventHandler

Parameters:

context - the removed context

See Also:

org.jboss.modcluster.ContainerEventHandler#remove(org.jboss.modcluster.Context)

removeAll

protected void removeAll(Engine engine)

Sends REMOVE-APP *, if engine was initialized

Parameters:

engine -

status

public void status(Engine engine)

Specified by:

status in interface ContainerEventHandler

Parameters:

engine - the engine to be processed

See Also:

org.jboss.modcluster.ContainerEventHandler#status(org.jboss.modcluster.Engine)

getLoadBalanceFactor

public int getLoadBalanceFactor(Engine engine)

Specified by:

getLoadBalanceFactor in interface LoadBalanceFactorProvider

See Also:

org.jboss.modcluster.load.LoadBalanceFactorProvider#getLoadBalanceFactor()

addProxy

public void addProxy(String host,
                     int port)

Description copied from interface: ModClusterServiceMBean

Add a proxy to the list of those with which this handler communicates. Communication does not begin until the next call to #status().

Specified by:

addProxy in interface ModClusterServiceMBean

Parameters:

host - the hostname of the proxy; a string suitable for passing to InetAddress.getByHost(...)

port - the port on which the proxy listens for MCMP requests

See Also:

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

removeProxy

public void removeProxy(String host,
                        int port)

Description copied from interface: ModClusterServiceMBean

Remove a proxy from the list of those with which this handler communicates. Communication does not end until the next call to #status().

Specified by:

removeProxy in interface ModClusterServiceMBean

Parameters:

host - the hostname of the proxy; a string suitable for passing to InetAddress.getByHost(...)

port - the port on which the proxy listens for MCMP requests

See Also:

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

getProxyConfiguration

public Map<InetSocketAddress,String> getProxyConfiguration()

Specified by:

getProxyConfiguration in interface ModClusterServiceMBean

Returns:

a map of DUMP_RSP responses, grouped by proxy

See Also:

ModClusterServiceMBean.getProxyConfiguration()

getProxyInfo

public Map<InetSocketAddress,String> getProxyInfo()

Specified by:

getProxyInfo in interface ModClusterServiceMBean

Returns:

a map of INFO_RSP responses, grouped by proxy

See Also:

ModClusterServiceMBean.getProxyInfo()

ping

public Map<InetSocketAddress,String> ping()

Specified by:

ping in interface ModClusterServiceMBean

Returns:

a map of PING_RSP responses, grouped by proxy

See Also:

ModClusterServiceMBean.ping()

ping

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

Specified by:

ping in interface ModClusterServiceMBean

Parameters:

jvmRoute - a jvm route.

Returns:

a map of PING_RSP responses, grouped by proxy

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

Parameters:

scheme - (ajp, http or https)

host - (name or ip of a the host)

Returns:

a map of PING_RSP responses, grouped by proxy

See Also:

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

reset

public void reset()

Specified by:

reset in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.reset()

refresh

public void refresh()

Description copied from interface: ModClusterServiceMBean

Refresh configuration.

Specified by:

refresh in interface ModClusterServiceMBean

See Also:

ModClusterServiceMBean.refresh()

disable

public boolean disable()

Description copied from interface: ModClusterServiceMBean

Disable all webapps for all engines.

Specified by:

disable in interface ModClusterServiceMBean

Returns:

true, if all proxies are responding normally, false otherwise

See Also:

ModClusterServiceMBean.disable()

enable

public boolean enable()

Description copied from interface: ModClusterServiceMBean

Enable all webapps for all engines.

Specified by:

enable in interface ModClusterServiceMBean

Returns:

true, if all proxies are responding normally, false otherwise

See Also:

ModClusterServiceMBean.enable()

disableContext

public boolean disableContext(String host,
                              String path)

Description copied from interface: ModClusterServiceMBean

Disables the webapp with the specified host and context path.

Specified by:

disableContext in interface ModClusterServiceMBean

Parameters:

host - host name of the target webapp

path - context path of the target webapp

Returns:

true, if all proxies are responding normally, false otherwise

See Also:

org.jboss.modcluster.ModClusterServiceMBean#disable(java.lang.String, java.lang.String)

enableContext

public boolean enableContext(String host,
                             String path)

Description copied from interface: ModClusterServiceMBean

Enables the webapp with the specified host and context path.

Specified by:

enableContext in interface ModClusterServiceMBean

Parameters:

host - host name of the target webapp

path - context path of the target webapp

Returns:

true, if all proxies are responding normally, false otherwise

See Also:

org.jboss.modcluster.ModClusterServiceMBean#enable(java.lang.String, java.lang.String)

stop

public boolean stop(long timeout,
                    TimeUnit unit)

Specified by:

stop in interface ModClusterServiceMBean

Parameters:

timeout - number of units of time for which to wait for sessions to drain. Negative or zero timeout value will wait forever.

unit - unit of time represented in timeout parameter

Returns:

true, if all contexts stopped successfully, false if sessions fail to drain before specified timeout.

See Also:

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

stopContext

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

Specified by:

stopContext in interface ModClusterServiceMBean

timeout - number of units of time for which to wait for sessions to drain. Negative or zero timeout value will wait forever.

unit - unit of time represented in timeout parameter

Returns:

true, if the specified context was stopped successfully, false if sessions fail to drain before specified timeout.

See Also:

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