org.opennms.netmgt.rtc.datablock
Class RTCNode

java.lang.Object
  org.opennms.netmgt.rtc.datablock.RTCNode

public class RTCNode
extends Object

The main unit for the RTCManager.

RTCNode is the main data unit for the RTCManager - these datablocks are created initially as data is read from the database and later if a 'nodeGainedService' is received - each node maintains its node id, ip address, service name and a list of 'RTCNodeSvcTime's

Also, each node knows and maintains a list of categories that this tuple belongs to

Author:

Sowmya Kumaraswamy , OpenNMS.org

See Also:

RTCNodeSvcTime, RTCNodeSvcTimesList

Constructor Summary

RTCNode()
Default constructor.

RTCNode(long nodeid, String ip, String svcName)
Constructor.

RTCNode(RTCNodeKey key)

Method Summary

void	addCategory(String catLabel) Add to the category list for this node.
void	addSvcTime(long losttime, long regainedtime) Add a new 'RTCNodeSvcTime' entry for this node.
boolean	belongsTo(String catLabel) Check if this node belongs to the category.
boolean	equals(Object o) Compare RTCNodes.
List	getCategories() Return the list of categories this node belongs to.
long	getDownTime(String cat, long curTime, long rollingWindow) Get the down time.
String	getIP() Return the IP address.
long	getNodeID() Return the node ID.
List	getServiceTimes() Return the list of service times for this node.
String	getSvcName() Return the service name.
double	getValue(String cat, long curTime, long rollingWindow) Get the avaialability.
boolean	isServiceCurrentlyDown() Return if the service is currently up/down.
void	nodeLostService(long t) Add a node lost service time.
void	nodeRegainedService(long t) Add a node regained service time.
void	removeCategory(String catLabel) Remove a category from the node's context.
void	setIP(String ipStr) Set the IP address.
void	setNodeID(long id) Set the node ID.
void	setSvcName(String svcName) Set the service name.
String	toString() String represenatation.

Methods inherited from class java.lang.Object

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

Constructor Detail

RTCNode

public RTCNode()

Default constructor. Initializes all values

RTCNode

public RTCNode(RTCNodeKey key)

RTCNode

public RTCNode(long nodeid,
               String ip,
               String svcName)

Constructor.

Parameters:

nodeid - the node id

ip - the IP address

svcName - the service

Method Detail

setNodeID

public void setNodeID(long id)

Set the node ID.

Parameters:

id - the node ID

setSvcName

public void setSvcName(String svcName)

Set the service name.

Parameters:

svcName - the service name

setIP

public void setIP(String ipStr)

Set the IP address.

Parameters:

ipStr - the ip address

addSvcTime

public void addSvcTime(long losttime,
                       long regainedtime)

Add a new 'RTCNodeSvcTime' entry for this node.

Parameters:

losttime - time at which service was lost

regainedtime - time at which service was regained

addCategory

public void addCategory(String catLabel)

Add to the category list for this node.

Parameters:

catLabel - category label of the category this node has been added to

removeCategory

public void removeCategory(String catLabel)

Remove a category from the node's context.

Parameters:

catLabel - category label of the category this node has been added to

nodeLostService

public void nodeLostService(long t)

Add a node lost service time. Add a losttime entry to the service times list - create a new service time entry in the list

Parameters:

t - the time at which service was lost

nodeRegainedService

public void nodeRegainedService(long t)

Add a node regained service time. Add a regained time entry to the service times list - set the regained time in the last serice time entry in the list

Parameters:

t - the time at which node regained service

getNodeID

public long getNodeID()

Return the node ID.

Returns:

the node ID

getSvcName

public String getSvcName()

Return the service name.

Returns:

the service name

getIP

public String getIP()

Return the IP address.

Returns:

the IP address

getServiceTimes

public List getServiceTimes()

Return the list of service times for this node.

Returns:

the list of service times for this node

belongsTo

public boolean belongsTo(String catLabel)

Check if this node belongs to the category.

Parameters:

catLabel - category label

Returns:

true if the node belongs to this category, false otherwise

getCategories

public List getCategories()

Return the list of categories this node belongs to.

Returns:

list of categories for the node.

getDownTime

public long getDownTime(String cat,
                        long curTime,
                        long rollingWindow)

Get the down time. Return the total outage time for this node in the 'rollingWindow' milliseconds since 'curTime' for the category

Parameters:

cat - the category in the context which of which downtime is needed

curTime - the start time (or current time) from which we go back rollinWindow interval

rollingWindow - the window for which downtime is required

Returns:

the total outage time for this node

getValue

public double getValue(String cat,
                       long curTime,
                       long rollingWindow)

Get the avaialability. Return the total availability for this node in the last 'rollingWindow' milliseconds since 'curTime' for the category

Parameters:

cat - the category in the context which of which availability is needed

curTime - the start time (or current time) from which we go back rollinWindow interval

rollingWindow - the window for which availability is required

Returns:

the value for this node

isServiceCurrentlyDown

public boolean isServiceCurrentlyDown()

Return if the service is currently up/down.

Returns:

if the service is currently up/down

equals

public boolean equals(Object o)

Compare RTCNodes. Overrides the 'equals()' method in the superclass

Overrides:

equals in class Object

Returns:

true if all the attributes are equal

toString

public String toString()

String represenatation. Returns a string representation of this object that has the nodeid/ip/servicename details

Overrides:

toString in class Object

Returns:

the string representation of this object