org.apache.oodt.cas.resource.monitor

Interface Monitor

All Known Implementing Classes:

AssignmentMonitor, GangliaResourceMonitor, QueueMuxMonitor

public interface Monitor

Version:

$Revision$

The Job Monitor interface.

Author:

woollard, bfoster

Method Summary

Modifier and Type	Method and Description
void	addNode(ResourceNode node) Adds a new ResourceNode for this Monitor to manage (if node already exist, then should perform update)
boolean	assignLoad(ResourceNode node, int loadValue)
int	getLoad(ResourceNode node) Gets the load on a resource node available to the resource manager.
ResourceNode	getNodeById(String nodeId) Gets the ResourceNode with the given nodeId.
ResourceNode	getNodeByURL(URL ipAddr) Returns the ResourceNode with the given ipAddr.
List	getNodes()
boolean	reduceLoad(ResourceNode node, int loadValue) Reduces the load on a particular ResourceNode by the given loadValue.
void	removeNodeById(String nodeId) Remove ResourceNode from this Monitor

Method Detail

getLoad

int getLoad(ResourceNode node)
     throws MonitorException

Gets the load on a resource node available to the resource manager.

Parameters:

node - The ResourceNode to obtain the load for.

Returns:

An integer respresentation of the load on a ResourceNode.

Throws:

MonitorException - If there is any error obtaining the load.

getNodes

List getNodes()
       throws MonitorException

Returns:

A List of the ResourceNodes known to the resource manager.

Throws:

MonitorException - If any error occurs getting the List of ResourceNodes.

getNodeById

ResourceNode getNodeById(String nodeId)
                  throws MonitorException

Gets the ResourceNode with the given nodeId.

Returns:

The ResourceNode for the corresponding nodeId.

Throws:

MonitorException - If any error occurs.

getNodeByURL

ResourceNode getNodeByURL(URL ipAddr)
                   throws MonitorException

Returns the ResourceNode with the given ipAddr.

Parameters:

ipAddr - The URL of the ResourceNode to return.

Returns:

The ResourceNode with the given ipAddr.

Throws:

MonitorException - If any error occurs.

reduceLoad

boolean reduceLoad(ResourceNode node,
                   int loadValue)
            throws MonitorException

Reduces the load on a particular ResourceNode by the given loadValue.

Parameters:

node - The ResourceNode to reduce the load on.

loadValue - The amount of reduction.

Returns:

True if successfully reduced, false otherwise.

Throws:

MonitorException - If any error occurs.

assignLoad

boolean assignLoad(ResourceNode node,
                   int loadValue)
            throws MonitorException

Parameters:

node - The ResourceNode to assign load to.

loadValue - The integer load to assign to the given ResourceNode.

Returns:

True if the Monitor was able to assign the load, false otherwise.

Throws:

MonitorException - If any error occurs assigning the load.

addNode

void addNode(ResourceNode node)
      throws MonitorException

Adds a new ResourceNode for this Monitor to manage (if node already exist, then should perform update)

Parameters:

node - The new ResourceNode to manage

Throws:

MonitorException

removeNodeById

void removeNodeById(String nodeId)
             throws MonitorException

Remove ResourceNode from this Monitor

Parameters:

nodeId - The id of the ResourceNode to remove

Throws:

MonitorException