Package org.opennms.netmgt.collection.api

Class LatencyCollectionResource

java.lang.Object

org.opennms.netmgt.collection.api.LatencyCollectionResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public class LatencyCollectionResource
extends java.lang.Object
implements CollectionResource

LatencyCollectionResource class.

Version:

$Id: $

Author:

Alejandro Galue

Field Summary

Fields inherited from interface org.opennms.netmgt.collection.api.CollectionResource

RESOURCE_TYPE_IF, RESOURCE_TYPE_LATENCY, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Constructor	Description
LatencyCollectionResource(java.lang.String serviceName, java.lang.String ipAddress, java.lang.String location)	Constructor for LatencyCollectionResource.

Method Summary

Modifier and Type	Method	Description
void	addAttribute(CollectionAttribute attr)	Adds the given attribute into the collection for this resource
AttributeGroup	getGroup(AttributeGroupType groupType)	Finds, or creates, and returns the AttributeGroup for the given group Type
java.lang.String	getInstance()	getInstance
java.lang.String	getInterfaceLabel()	getLabel
java.lang.String	getIpAddress()	getIpAddress
java.lang.String	getOwnerName()	getOwnerName
ResourcePath	getParent()	Returns the name of the parent resource.
ResourcePath	getPath()	Retrieves path for the resource, relative to the root of the associated RrdRepository.
java.lang.String	getResourceTypeName()	getResourceTypeName
java.lang.String	getServiceName()	getServiceName
TimeKeeper	getTimeKeeper()	Returns a not-null TimeKeeper instance when this resource requires to use a special timestamp when updating RRDs/JRBs.
java.lang.String	getUnmodifiedInstance()	getUnmodifiedInstance
boolean	rescanNeeded()	rescanNeeded
boolean	shouldPersist(ServiceParameters params)	Determines whether the attribute should be persisted.
java.lang.String	toString()
void	visit(CollectionSetVisitor visitor)	Provide a way to visit all the values in the CollectionSet, for any appropriate purposes (persisting, thresholding, or others) The expectation is that calling this method will ultimately call visitResource, visitGroup and visitAttribute (as appropriate)

Methods inherited from class java.lang.Object

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

Constructor Detail

LatencyCollectionResource

public LatencyCollectionResource(java.lang.String serviceName,
                                 java.lang.String ipAddress,
                                 java.lang.String location)

Constructor for LatencyCollectionResource.

Parameters:

serviceName - a String object.

ipAddress - a String object.

location - a String object.

Method Detail

getInstance

public java.lang.String getInstance()

getInstance

Specified by:

getInstance in interface CollectionResource

Returns:

a String object.

getUnmodifiedInstance

public java.lang.String getUnmodifiedInstance()

getUnmodifiedInstance

Specified by:

getUnmodifiedInstance in interface CollectionResource

Returns:

a String object.

getServiceName

public java.lang.String getServiceName()

getServiceName

Returns:

a String object.

getIpAddress

public java.lang.String getIpAddress()

getIpAddress

Returns:

a String object.

getInterfaceLabel

public java.lang.String getInterfaceLabel()

getLabel

Specified by:

getInterfaceLabel in interface CollectionResource

Returns:

a String object.

getResourceTypeName

public java.lang.String getResourceTypeName()

getResourceTypeName

Specified by:

getResourceTypeName in interface CollectionResource

Returns:

a String object.

rescanNeeded

public boolean rescanNeeded()

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Returns:

a boolean.

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Determines whether the attribute should be persisted.

Specified by:

shouldPersist in interface Persistable

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

addAttribute

public void addAttribute(CollectionAttribute attr)

Adds the given attribute into the collection for this resource

Parameters:

attr - The Attribute to add

getGroup

public final AttributeGroup getGroup(AttributeGroupType groupType)

Finds, or creates, and returns the AttributeGroup for the given group Type

Parameters:

groupType - a AttributeGroupType object.

Returns:

a AttributeGroup object.

visit

public void visit(CollectionSetVisitor visitor)

Provide a way to visit all the values in the CollectionSet, for any appropriate purposes (persisting, thresholding, or others) The expectation is that calling this method will ultimately call visitResource, visitGroup and visitAttribute (as appropriate)

Specified by:

visit in interface CollectionVisitable

Parameters:

visitor - a CollectionSetVisitor object.

getOwnerName

public java.lang.String getOwnerName()

getOwnerName

Specified by:

getOwnerName in interface ResourceIdentifier

Returns:

a String object.

getPath

public ResourcePath getPath()

Description copied from interface: ResourceIdentifier

Retrieves path for the resource, relative to the root of the associated RrdRepository.

Specified by:

getPath in interface ResourceIdentifier

Returns:

ResourcePath object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getParent

public ResourcePath getParent()

Description copied from interface: CollectionResource

Returns the name of the parent resource.

Specified by:

getParent in interface CollectionResource

Returns:

a String object.

getTimeKeeper

public TimeKeeper getTimeKeeper()

Description copied from interface: CollectionResource

Returns a not-null TimeKeeper instance when this resource requires to use a special timestamp when updating RRDs/JRBs. If the resource doesn't need a special TimeKeeper it should return null.

Specified by:

getTimeKeeper in interface CollectionResource

Returns:

a TimeKeeper object or null to indicate that DefaultTimeKeeper should be used.