org.opennms.netmgt.collection.support

Class CollectionResourceWrapper

java.lang.Object

org.opennms.netmgt.collection.support.CollectionResourceWrapper

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public class CollectionResourceWrapper
extends Object
implements CollectionResource

Delegates the visit calls to the wrapped resource. Allows individual functions to be intercepted.

Author:

jwhite

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 and Description
CollectionResourceWrapper(CollectionResource wrapped)

Method Summary

Modifier and Type	Method and Description
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	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.
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.
String	getUnmodifiedInstance() Returns the unmodified instance string this CollectionResource represents.
boolean	rescanNeeded() rescanNeeded
boolean	shouldPersist(ServiceParameters params) Determines whether the attribute should be persisted.
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, toString, wait, wait, wait

Constructor Detail

CollectionResourceWrapper

public CollectionResourceWrapper(CollectionResource wrapped)

Method Detail

getOwnerName

public String getOwnerName()

getOwnerName

Specified by:

getOwnerName in interface ResourceIdentifier

Returns:

a String object.

getPath

public ResourcePath getPath()

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

Specified by:

getPath in interface ResourceIdentifier

Returns:

ResourcePath 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.

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.

rescanNeeded

public boolean rescanNeeded()

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Returns:

a boolean.

getResourceTypeName

public String getResourceTypeName()

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.

getParent

public ResourcePath getParent()

Returns the name of the parent resource.

Specified by:

getParent in interface CollectionResource

Returns:

a String object.

getInstance

public String getInstance()

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.

getUnmodifiedInstance

public String getUnmodifiedInstance()

Returns the unmodified instance string this CollectionResource represents.

Specified by:

getUnmodifiedInstance in interface CollectionResource

Returns:

a String object.

getInterfaceLabel

public String getInterfaceLabel()

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.

getTimeKeeper

public TimeKeeper getTimeKeeper()

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.