org.opennms.netmgt.poller.remote.support

Class DistributedLatencyCollectionResource

java.lang.Object

org.opennms.netmgt.poller.remote.support.DistributedLatencyCollectionResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public class DistributedLatencyCollectionResource
extends Object
implements CollectionResource

Used to persist distributed latency statistics collected by the remote poller.

Author:

jwhite

Field Summary

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

RESOURCE_TYPE_IF, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Constructor and Description
DistributedLatencyCollectionResource(String locationMonitorId, String ipAddress)

Method Summary

Modifier and Type	Method and 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
String	getInstance() Returns the name of the instance this CollectionResource represents.
String	getInterfaceLabel() Returns a unique label for each resource depending on resource type.
String	getIpAddress()
String	getLocationMonitorId()
String	getOwnerName() getOwnerName
String	getParent() Returns the name of the parent resource.
Path	getPath() Retrieves path for the resource, relative to the root of the associated RrdRepository.
String	getResourceTypeName() Returns a string which indicates what type of resource.
TimeKeeper	getTimeKeeper() Returns a not-null TimeKeeper instance when this resource requires to use a special timestamp when updating RRDs/JRBs.
boolean	rescanNeeded() rescanNeeded
boolean	shouldPersist(ServiceParameters params) Determines whether the attribute should be persisted.
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

DistributedLatencyCollectionResource

public DistributedLatencyCollectionResource(String locationMonitorId,
                                            String ipAddress)

Method Detail

getInstance

public String getInstance()

Description copied from interface: CollectionResource

Returns the name of the instance this CollectionResource represents. For node level resources, this will be null to indicate the default instance. For interface level resources, some label unique to the node (ifIndex probably). For Generic resources (e.g. the SNMP GenericIndexResource), this will be some identifying label, probably the index in the table. This value is used by the StorageStrategy implementations to figure out the label for the resource which is used in constructing its RRD directory.

Specified by:

getInstance in interface CollectionResource

Returns:

a String object.

getInterfaceLabel

public String getInterfaceLabel()

Description copied from interface: CollectionResource

Returns a unique label for each resource depending on resource type. This label is the same label used when constructing the resource ID.

Specified by:

getInterfaceLabel in interface CollectionResource

Returns:

a String object.

getResourceTypeName

public String getResourceTypeName()

Description copied from interface: CollectionResource

Returns a string which indicates what type of resource. Will be one of "node" for the node level resource "if" for network interface resources "*" for all other resource types defined in the relevant config files, e.g. hrStorage

Specified by:

getResourceTypeName in interface CollectionResource

Returns:

a String object.

rescanNeeded

public boolean rescanNeeded()

Description copied from interface: CollectionResource

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Returns:

a boolean.

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Description copied from interface: Persistable

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)

Description copied from interface: CollectionVisitable

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 String getOwnerName()

Description copied from interface: ResourceIdentifier

getOwnerName

Specified by:

getOwnerName in interface ResourceIdentifier

Returns:

a String object.

getPath

public Path 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:

Path object.

toString

public String toString()

Overrides:

toString in class Object

getParent

public String 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.

getLocationMonitorId

public String getLocationMonitorId()

getIpAddress

public String getIpAddress()