org.jboss.modcluster.mcmp.impl

Class DefaultMCMPHandler

java.lang.Object

org.jboss.modcluster.mcmp.impl.DefaultMCMPHandler

All Implemented Interfaces:

MCMPHandler

@ThreadSafe
public class DefaultMCMPHandler
extends Object
implements MCMPHandler

Default implementation of MCMPHandler.

Author:

Jean-Frederic Clere, Brian Stansberry, Paul Ferraro

Constructor Summary

Constructors

Constructor and Description
DefaultMCMPHandler(MCMPHandlerConfiguration config, ResetRequestSource source, MCMPRequestFactory requestFactory, MCMPResponseParser responseParser)

Method Summary

Modifier and Type	Method and Description
void	addProxy(InetSocketAddress socketAddress) Add a proxy to the list of those with which this handler communicates.
void	addProxy(InetSocketAddress socketAddress, boolean established) Add a proxy to the list of those with which this handler communicates.
void	addProxy(ProxyConfiguration proxyConfiguration) Add a proxy to the list of those with which this handler communicates.
void	addProxy(ProxyConfiguration proxyConfiguration, boolean established) Add a proxy to the list of those with which this handler communicates.
Set<MCMPServerState>	getProxyStates() Get the state of all proxies
void	init(Collection<ProxyConfiguration> proxies, MCMPConnectionListener connectionListener) Initialization method for MCMP handler.
boolean	isProxyHealthOK() Convenience method that checks whether the status of all proxies is OK.
void	markProxiesInError() Reset any proxies whose status is OK down to ERROR, which will trigger a refresh of their configuration.
void	removeProxy(InetSocketAddress socketAddress) Remove a proxy from the list of those with which this handler communicates.
void	reset() Reset any proxies whose status is DOWN up to ERROR, where the configuration will be refreshed.
Map<MCMPServerState,String>	sendRequest(MCMPRequest request) Send a request to all healthy proxies.
Map<MCMPServerState,List<String>>	sendRequests(List<MCMPRequest> requests) Send a list of requests to all healthy proxies, with all requests in the list sent to each proxy before moving on to the next.
void	shutdown() Perform any shut down work.
void	status() Perform periodic processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMCMPHandler

public DefaultMCMPHandler(MCMPHandlerConfiguration config,
                          ResetRequestSource source,
                          MCMPRequestFactory requestFactory,
                          MCMPResponseParser responseParser)

Method Detail

init

public void init(Collection<ProxyConfiguration> proxies,
                 MCMPConnectionListener connectionListener)

Initialization method for MCMP handler.

Specified by:

init in interface MCMPHandler

Parameters:

proxies - a collection of initial ProxyConfigurations

connectionListener - connection listener

See Also:

org.jboss.modcluster.mcmp.MCMPHandler#init(java.util.List)

shutdown

public void shutdown()

Perform any shut down work.

Specified by:

shutdown in interface MCMPHandler

See Also:

MCMPHandler.shutdown()

addProxy

public void addProxy(InetSocketAddress socketAddress)

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

Same as addProxy(address, port, false.

Specified by:

addProxy in interface MCMPHandler

Parameters:

socketAddress - InetSocketAddress on which the proxy listens for MCMP requests

See Also:

MCMPHandler.addProxy(java.net.InetSocketAddress)

addProxy

public void addProxy(ProxyConfiguration proxyConfiguration)

Description copied from interface: MCMPHandler

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

Same as addProxy(proxyConfiguration, false).

Specified by:

addProxy in interface MCMPHandler

Parameters:

proxyConfiguration - ProxyConfiguration defining address on which the proxy listens for MCMP requests and optional local address to bind connections to

addProxy

public void addProxy(InetSocketAddress socketAddress,
                     boolean established)

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

Specified by:

addProxy in interface MCMPHandler

Parameters:

socketAddress - InetSocketAddress on which the proxy listens for MCMP requests

established - true if the proxy should be considered established, false otherwise.

See Also:

MCMPHandler.addProxy(java.net.InetSocketAddress, boolean)

addProxy

public void addProxy(ProxyConfiguration proxyConfiguration,
                     boolean established)

Description copied from interface: MCMPHandler

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

Specified by:

addProxy in interface MCMPHandler

Parameters:

proxyConfiguration - ProxyConfiguration defining address on which the proxy listens for MCMP requests and optional local address to bind connections to

established - true if the proxy should be considered established, false otherwise.

removeProxy

public void removeProxy(InetSocketAddress socketAddress)

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

Specified by:

removeProxy in interface MCMPHandler

Parameters:

socketAddress - InetSocketAddress on which the proxy listens for MCMP requests

See Also:

MCMPHandler.removeProxy(java.net.InetSocketAddress)

getProxyStates

public Set<MCMPServerState> getProxyStates()

Get the state of all proxies

Specified by:

getProxyStates in interface MCMPHandler

Returns:

a set of status objects indicating the status of this handler's communication with all proxies.

See Also:

MCMPHandler.getProxyStates()

isProxyHealthOK

public boolean isProxyHealthOK()

Convenience method that checks whether the status of all proxies is OK.

Specified by:

isProxyHealthOK in interface MCMPHandler

Returns:

true if all proxies are OK, false otherwise

See Also:

MCMPHandler.isProxyHealthOK()

markProxiesInError

public void markProxiesInError()

Reset any proxies whose status is OK down to ERROR, which will trigger a refresh of their configuration.

Specified by:

markProxiesInError in interface MCMPHandler

See Also:

MCMPHandler.markProxiesInError()

reset

public void reset()

Reset any proxies whose status is DOWN up to ERROR, where the configuration will be refreshed.

Specified by:

reset in interface MCMPHandler

See Also:

MCMPHandler.reset()

status

public void status()

Perform periodic processing. Update the list of proxies to reflect any calls to addProxy(...) or removeProxy(...). Attempt to establish communication with any proxies whose state is ERROR. If successful and a ResetRequestSource has been provided, update the proxy with the list of requests provided by the source.

Specified by:

status in interface MCMPHandler

See Also:

MCMPHandler.status()

sendRequest

public Map<MCMPServerState,String> sendRequest(MCMPRequest request)

Send a request to all healthy proxies.

Specified by:

sendRequest in interface MCMPHandler

Parameters:

request - the request. Cannot be null

See Also:

MCMPHandler.sendRequest(org.jboss.modcluster.mcmp.MCMPRequest)

sendRequests

public Map<MCMPServerState,List<String>> sendRequests(List<MCMPRequest> requests)

Send a list of requests to all healthy proxies, with all requests in the list sent to each proxy before moving on to the next.

Specified by:

sendRequests in interface MCMPHandler

Parameters:

requests - the requests. Cannot be null

See Also:

MCMPHandler.sendRequests(java.util.List)