org.ow2.proactive.resourcemanager.rmnode

Class AbstractRMNode

java.lang.Object

org.ow2.proactive.resourcemanager.rmnode.AbstractRMNode

All Implemented Interfaces:

Serializable, Comparable<RMNode>, RMNode

Direct Known Subclasses:

RMDeployingNode, RMNodeImpl

public abstract class AbstractRMNode
extends Object
implements RMNode, Serializable

Defines abstractions common to all RM node implementations.

Since:

16/01/17

See Also:

RMDeployingNode, RMNodeImpl, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected RMNodeEvent	addEvent The add event
protected boolean	isLocked Status associated to a ProActive Node.
protected RMNodeEvent	lastEvent The last event
protected Client	lockedBy Defines who has locked the node.
protected long	lockTime Defines the time at which the node has been locked.
protected String	nodeName Name of the node
protected NodeSource	nodeSource NodeSource Stub that handles the node
protected String	nodeSourceName Name of the NodeSource that handles the RMNode
protected Client	provider client registered the node in the resource manager
protected NodeState	state State of the node
protected long	stateChangeTime Time stamp of the latest state change
protected Map<String,String>	usageInfo

Constructor Summary

Constructors

Constructor and Description
AbstractRMNode()
AbstractRMNode(NodeSource nodeSource, String nodeName, String nodeURL, Client provider)

Method Summary

Modifier and Type	Method and Description
protected void	changeState(NodeState newState)
void	copyLockStatusFrom(RMNode node)
RMNodeEvent	createNodeEvent()
RMNodeEvent	createNodeEvent(RMEventType eventType, NodeState previousNodeState, String initiator)
boolean	equals(Object rmNode)
RMNodeEvent	getAddEvent() Returns the id of the add event RMNodeEvent.
RMNodeEvent	getLastEvent() Returns the id of the last event RMNodeEvent.
Client	getLockedBy() Returns the client who has locked the node.
protected String	getLockStatus()
long	getLockTime() Returns the timestamp at which the node has been locked.
String	getNodeName() Returns the name of the node.
NodeSource	getNodeSource() Returns the Stub of the NodeSource that handles the node.
String	getNodeSourceName() Returns the NodeSource name of the node.
String	getNodeURL() Returns the unique ID of the node.
Client	getProvider() Gets the provider of the node (who created and deployed it)
NodeState	getState() Returns the node state
long	getStateChangeTime() Returns the time of the last node state change.
Map<String,String>	getUsageInfo()
int	hashCode()
boolean	isLocked() Returns a boolean saying whether the node is locked or not.
void	lock(Client client) Set the node locked.
long	millisSinceStateChanged()
void	setAddEvent(RMNodeEvent addEvent)
void	setLastEvent(RMNodeEvent lastEvent)
void	setNodeSource(NodeSource nodeSource) Sets the Stub of the NodeSource to the specified value.
void	setStateChangeTime(long time)
void	setUsageInfo(Map<String,String> usageInfo)
protected RMNodeDescriptor	toNodeDescriptor()
String	toString()
void	unlock(Client client) Unlock the node.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ow2.proactive.resourcemanager.rmnode.RMNode

addToken, clean, executeScript, getAdminPermission, getDescriptorVMName, getHostName, getJMXUrl, getJmxUrls, getNode, getNodeInfo, getNodeTags, getNodeTokens, getOwner, getScriptStatus, getUserPermission, getVNodeName, isBusy, isConfiguring, isDeploying, isDown, isFree, isProtectedByToken, isToRemove, removeToken, setBusy, setBusy, setConfiguring, setDown, setFree, setJMXUrl, setNodeTags, setNodeTokens, setProtectedByToken, setToRemove

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

addEvent

protected RMNodeEvent addEvent

The add event

isLocked

protected volatile boolean isLocked

Status associated to a ProActive Node. When a Node is locked, it is no longer eligible for Tasks execution. A ProActive node can be locked whatever its state is.

lastEvent

protected RMNodeEvent lastEvent

The last event

lockedBy

protected volatile Client lockedBy

Defines who has locked the node. This field has a meaning when isLocked is true only.

lockTime

protected volatile long lockTime

Defines the time at which the node has been locked. This field has a meaning when isLocked is true only.

nodeName

protected final String nodeName

Name of the node

nodeSource

protected NodeSource nodeSource

NodeSource Stub that handles the node

nodeSourceName

protected String nodeSourceName

Name of the NodeSource that handles the RMNode

provider

protected Client provider

client registered the node in the resource manager

state

protected NodeState state

State of the node

stateChangeTime

protected long stateChangeTime

Time stamp of the latest state change

usageInfo

protected Map<String,String> usageInfo

Constructor Detail

AbstractRMNode

public AbstractRMNode()

AbstractRMNode

public AbstractRMNode(NodeSource nodeSource,
                      String nodeName,
                      String nodeURL,
                      Client provider)

Method Detail

copyLockStatusFrom

public void copyLockStatusFrom(RMNode node)

createNodeEvent

public RMNodeEvent createNodeEvent()

Specified by:

createNodeEvent in interface RMNode

createNodeEvent

public RMNodeEvent createNodeEvent(RMEventType eventType,
                                   NodeState previousNodeState,
                                   String initiator)

Specified by:

createNodeEvent in interface RMNode

changeState

protected void changeState(NodeState newState)

lock

public void lock(Client client)

Set the node locked.

Specified by:

lock in interface RMNode

Parameters:

client - the client that locks the node.

unlock

public void unlock(Client client)

Unlock the node.

Specified by:

unlock in interface RMNode

Parameters:

client - the client that unlocks the node.

getAddEvent

public RMNodeEvent getAddEvent()

Returns the id of the add event RMNodeEvent.

Specified by:

getAddEvent in interface RMNode

Returns:

the id of the add event

getLastEvent

public RMNodeEvent getLastEvent()

Returns the id of the last event RMNodeEvent.

Specified by:

getLastEvent in interface RMNode

Returns:

the id of the last event

getLockTime

public long getLockTime()

Returns the timestamp at which the node has been locked.

The value returned by this method is meaningful when the node is locked only.

Specified by:

getLockTime in interface RMNode

Returns:

the timestamp at which the node has been locked or -1 if the node is not locked.

See Also:

RMNode.isLocked()

getLockedBy

public Client getLockedBy()

Returns the client who has locked the node.

Specified by:

getLockedBy in interface RMNode

Returns:

the client who has locked the node, or null if the node is not locked.

getLockStatus

protected String getLockStatus()

equals

public boolean equals(Object rmNode)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getNodeName

public String getNodeName()

Returns the name of the node.

Specified by:

getNodeName in interface RMNode

Returns:

the name of the node.

getNodeSource

public NodeSource getNodeSource()

Returns the Stub of the NodeSource that handles the node.

Specified by:

getNodeSource in interface RMNode

Returns:

the stub of the NodeSource that handles the node.

getNodeSourceName

public String getNodeSourceName()

Returns the NodeSource name of the node.

Specified by:

getNodeSourceName in interface RMNode

Returns:

the NodeSource name of the node.

getState

public NodeState getState()

Returns the node state

Specified by:

getState in interface RMNode

Returns:

the node state

getStateChangeTime

public long getStateChangeTime()

Returns the time of the last node state change.

Specified by:

getStateChangeTime in interface RMNode

Returns:

the time of the last node state change

getNodeURL

public String getNodeURL()

Returns the unique ID of the node.

Specified by:

getNodeURL in interface RMNode

Returns:

the unique ID of the node represented by its URL.

getProvider

public Client getProvider()

Gets the provider of the node (who created and deployed it)

Specified by:

getProvider in interface RMNode

Returns:

the node provider

isLocked

public boolean isLocked()

Returns a boolean saying whether the node is locked or not.

Specified by:

isLocked in interface RMNode

Returns:

true if the node is locked, false otherwise.

setAddEvent

public void setAddEvent(RMNodeEvent addEvent)

Specified by:

setAddEvent in interface RMNode

setLastEvent

public void setLastEvent(RMNodeEvent lastEvent)

Specified by:

setLastEvent in interface RMNode

setNodeSource

public void setNodeSource(NodeSource nodeSource)

Sets the Stub of the NodeSource to the specified value.

Specified by:

setNodeSource in interface RMNode

Parameters:

nodeSource - the new NodeSource Stub to use.

toNodeDescriptor

protected RMNodeDescriptor toNodeDescriptor()

toString

public String toString()

Overrides:

toString in class Object

millisSinceStateChanged

public long millisSinceStateChanged()

Specified by:

millisSinceStateChanged in interface RMNode

getUsageInfo

public Map<String,String> getUsageInfo()

Specified by:

getUsageInfo in interface RMNode

setUsageInfo

public void setUsageInfo(Map<String,String> usageInfo)

Specified by:

setUsageInfo in interface RMNode

setStateChangeTime

public void setStateChangeTime(long time)

Specified by:

setStateChangeTime in interface RMNode