org.ow2.proactive.resourcemanager.nodesource.infrastructure

Class HostsFileBasedInfrastructureManager

java.lang.Object

org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

org.ow2.proactive.resourcemanager.nodesource.infrastructure.HostsFileBasedInfrastructureManager

All Implemented Interfaces:

Serializable, NodeSourcePlugin

Direct Known Subclasses:

AutoUpdateInfrastructure, CLIInfrastructure, SSHInfrastructure, SSHInfrastructureV2

public abstract class HostsFileBasedInfrastructureManager
extends InfrastructureManager

Abstract infrastructure Manager implementation based on hosts list file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HostsFileBasedInfrastructureManager.NodeNameBuilder Utility class to encapsulate node name building and node name parsing.

Nested classes/interfaces inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

InfrastructureManager.PersistedInfraVariablesHandler<T>, InfrastructureManager.RMDeployingNodeAccessor

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_NODE_DEPLOYMENT_FAILURE_THRESHOLD
protected static int	DEFAULT_NODE_TIMEOUT
protected static long	DEFAULT_WAIT_TIME_BETWEEN_NODE_DEPLOYMENT_FAILURES
protected File	hostsList
protected static org.apache.log4j.Logger	logger
protected int	maxDeploymentFailure
protected HostsFileBasedInfrastructureManager.NodeNameBuilder	nodeNameBuilder
protected int	nodeTimeOut
protected long	waitBetweenDeploymentFailures

Fields inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

ELASTIC, nodeSource, persistedInfraVariables, readLock, RM_URL_KEY, writeLock

Constructor Summary

Constructors

Constructor and Description
HostsFileBasedInfrastructureManager()

Method Summary

Modifier and Type	Method and Description
void	acquireAllNodes() Check if any host is available and acquire the nodes of available hosts
void	acquireNode() Acquire the nodes of available hosts
protected void	addTimeouts(List<String> nodesUrl)
protected boolean	anyTimedOut(List<String> nodesUrl)
protected void	configure(Object... parameters) Configures the infrastructure.
Map<Integer,String>	getSectionDescriptions()
protected void	initializePersistedInfraVariables() This method should initialize a value in the runtime variables map for all the runtime variables that will be used in the class.
protected abstract void	killNodeImpl(org.objectweb.proactive.core.node.Node node, InetAddress host) Kills the node passed as parameter
protected void	notifyAcquiredNode(org.objectweb.proactive.core.node.Node node) Parent IM notifies about a new node registration
protected void	notifyDeployingNodeLost(String pnURL) This method is called by Infrastructure Manager in case of a deploying node removal.
void	notifyDownNode(String nodeName, String nodeUrl, org.objectweb.proactive.core.node.Node node) Define what needs to be done in an infrastructure implementation when a node is detected as down.
void	onDownNodeReconnection(org.objectweb.proactive.core.node.Node node) Called by the system every time a node that is DOWN reconnects and changes its status to FREE or BUSY.
protected void	readHosts(File f) Internal host file parser
void	removeNode(org.objectweb.proactive.core.node.Node node) Removes the node from the resource manager.
protected void	removeTimeouts(List<String> nodesUrl)
protected abstract void	startNodeImpl(HostTracker hostTracker, int nbNodes, List<String> depNodeURLs) Launch the node on the host passed as parameter
protected void	startNodeImplWithRetries(HostTracker hostTracker, int nbNodes, int retries)
String	toString()

Methods inherited from class org.ow2.proactive.resourcemanager.nodesource.infrastructure.InfrastructureManager

acquireAllNodes, acquireNodes, acquireNodes, addDeployingNode, addDeployingNodeWithLockAndPersist, addLostNodeWithLockAndPersist, addMultipleDeployingNodes, buildDeployingNodeURL, checkAllNodesAreAcquiredAndDo, checkNodeIsAcquiredAndDo, declareDeployingNodeLost, getDefaultCommandLineBuilder, getDeployingAndLostNodes, getDeployingNodesWithLock, getDeployingOrLostNode, getDescription, getEmptyCommandLineBuilder, getLostNodesWithLock, getMeta, getPersistedDeployingNodesUrl, getPersistedInfraVariable, getPersistedLostNodesUrl, getRmUrl, internalConfigure, internalNotifyDownNode, internalRegisterAcquiredNode, internalRemoveDeployingNode, internalRemoveNode, internalShutDown, isShutDown, isUsingDeployingNode, multipleDeclareDeployingNodeLost, persistInfrastructureVariables, reconfigure, recoverPersistedInfraVariables, removeDownNodePriorToNotify, searchForNotAcquiredRmNode, setNodeSource, setPersistedInfraVariable, setPersistedNodeSourceData, setRmDbManager, setRmUrl, shutDown, update, updateDeployingNodeDescription

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.log4j.Logger logger

DEFAULT_NODE_TIMEOUT

protected static final int DEFAULT_NODE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_NODE_DEPLOYMENT_FAILURE_THRESHOLD

protected static final int DEFAULT_NODE_DEPLOYMENT_FAILURE_THRESHOLD

See Also:

Constant Field Values

DEFAULT_WAIT_TIME_BETWEEN_NODE_DEPLOYMENT_FAILURES

protected static final long DEFAULT_WAIT_TIME_BETWEEN_NODE_DEPLOYMENT_FAILURES

See Also:

Constant Field Values

hostsList

protected File hostsList

nodeTimeOut

protected int nodeTimeOut

maxDeploymentFailure

protected int maxDeploymentFailure

waitBetweenDeploymentFailures

protected long waitBetweenDeploymentFailures

nodeNameBuilder

protected HostsFileBasedInfrastructureManager.NodeNameBuilder nodeNameBuilder

Constructor Detail

HostsFileBasedInfrastructureManager

public HostsFileBasedInfrastructureManager()

Method Detail

getSectionDescriptions

public Map<Integer,String> getSectionDescriptions()

Specified by:

getSectionDescriptions in interface NodeSourcePlugin

Overrides:

getSectionDescriptions in class InfrastructureManager

initializePersistedInfraVariables

protected void initializePersistedInfraVariables()

Description copied from class: InfrastructureManager

This method should initialize a value in the runtime variables map for all the runtime variables that will be used in the class. It is called at initialization time of the infrastructure, just before the InfrastructureManager.configure(Object...) method. This method runs with the write lock acquired.

Specified by:

initializePersistedInfraVariables in class InfrastructureManager

configure

protected void configure(Object... parameters)

Configures the infrastructure. parameters[0] = hosts list file content parameters[1] = timeout of the node deployment parameters[2] = max deployment failure parameters[3] = wait time between failures

Specified by:

configure in class InfrastructureManager

Parameters:

parameters - of the infrastructure manager

readHosts

protected void readHosts(File f)
                  throws IOException

Internal host file parser

File format: one host per line, optionally followed by a space and an integer describing the maximum number of runtimes (1 if not specified). Example:

 example.com
 example.org 5
 example.net 3
 

Parameters:

f - the file from which hosts names are to be extracted

Throws:

IOException - parsing failed

acquireAllNodes

public void acquireAllNodes()

Check if any host is available and acquire the nodes of available hosts

Specified by:

acquireAllNodes in class InfrastructureManager

acquireNode

public void acquireNode()

Acquire the nodes of available hosts

Specified by:

acquireNode in class InfrastructureManager

notifyDeployingNodeLost

protected void notifyDeployingNodeLost(String pnURL)

This method is called by Infrastructure Manager in case of a deploying node removal. We take advantage of it to specify to the remote process control loop of the removal. This one will then exit.

Overrides:

notifyDeployingNodeLost in class InfrastructureManager

Parameters:

pnURL - the deploying node's URL for which one the timeout occurred.

notifyAcquiredNode

protected void notifyAcquiredNode(org.objectweb.proactive.core.node.Node node)
                           throws RMException

Parent IM notifies about a new node registration

Specified by:

notifyAcquiredNode in class InfrastructureManager

Parameters:

node - the newly registered node

Throws:

RMException - if the implementation does not approve the node acquisition request

removeNode

public void removeNode(org.objectweb.proactive.core.node.Node node)

Removes the node from the resource manager.

Specified by:

removeNode in class InfrastructureManager

Parameters:

node - the node to release.

notifyDownNode

public void notifyDownNode(String nodeName,
                           String nodeUrl,
                           org.objectweb.proactive.core.node.Node node)

Define what needs to be done in an infrastructure implementation when a node is detected as down.

Specified by:

notifyDownNode in class InfrastructureManager

node - the ProActive Programming Node that is down.

onDownNodeReconnection

public void onDownNodeReconnection(org.objectweb.proactive.core.node.Node node)

Description copied from class: InfrastructureManager

Called by the system every time a node that is DOWN reconnects and changes its status to FREE or BUSY.

Overrides:

onDownNodeReconnection in class InfrastructureManager

Parameters:

node - the node that has reconnected.

startNodeImplWithRetries

protected void startNodeImplWithRetries(HostTracker hostTracker,
                                        int nbNodes,
                                        int retries)
                                 throws RMException

Throws:

RMException

anyTimedOut

protected boolean anyTimedOut(List<String> nodesUrl)

removeTimeouts

protected void removeTimeouts(List<String> nodesUrl)

addTimeouts

protected void addTimeouts(List<String> nodesUrl)

startNodeImpl

protected abstract void startNodeImpl(HostTracker hostTracker,
                                      int nbNodes,
                                      List<String> depNodeURLs)
                               throws RMException

Launch the node on the host passed as parameter

Parameters:

hostTracker - The host on which one the node will be started

nbNodes - number of nodes to deploy

depNodeURLs - list of deploying or lost nodes urls created

Throws:

RMException - If the node hasn't been started. Very important to take care of that in implementations to keep the infrastructure in a coherent state.

killNodeImpl

protected abstract void killNodeImpl(org.objectweb.proactive.core.node.Node node,
                                     InetAddress host)
                              throws RMException

Kills the node passed as parameter

Parameters:

node - The node to kill

host - The host of the node

Throws:

RMException - if a problem occurred while removing

toString

public String toString()

Overrides:

toString in class Object