org.opennms.netmgt.collectd

Class AliasedResource

java.lang.Object

org.opennms.netmgt.collectd.SnmpCollectionResource

org.opennms.netmgt.collectd.AliasedResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public class AliasedResource
extends SnmpCollectionResource

AliasedResource class.

Version:

$Id: $

Author:

ranger

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
AliasedResource(ResourceType resourceType, String domain, IfInfo ifInfo, String ifAliasComment, String ifAlias) Constructor for AliasedResource.

Method Summary

Modifier and Type	Method and Description
String	getDomain() getDomain
Collection<AttributeGroup>	getGroups() getGroups
IfInfo	getIfInfo() getIfInfo
String	getInstance() getInstance
String	getInterfaceLabel() getLabel
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() getResourceTypeName
int	getSnmpIfType() getType
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	isScheduledForCollection() isScheduledForCollection
boolean	rescanNeeded() rescanNeeded
boolean	shouldPersist(ServiceParameters serviceParameters) Determines whether the attribute should be persisted.
String	toString() 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 org.opennms.netmgt.collectd.SnmpCollectionResource

getCollectionAgent, getGroupType, getOwnerName, getResourceType, getStringAttributes, setAttributeValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasedResource

public AliasedResource(ResourceType resourceType,
                       String domain,
                       IfInfo ifInfo,
                       String ifAliasComment,
                       String ifAlias)

Constructor for AliasedResource.

Parameters:

resourceType - a ResourceType object.

domain - a String object.

ifInfo - a IfInfo object.

ifAliasComment - a String object.

ifAlias - a String object.

Method Detail

getIfInfo

public IfInfo getIfInfo()

getIfInfo

Returns:

a IfInfo object.

getDomain

public String getDomain()

getDomain

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.

Returns:

ResourcePath object.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

rescanNeeded

public boolean rescanNeeded()

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Overrides:

rescanNeeded in class SnmpCollectionResource

Returns:

a boolean.

isScheduledForCollection

public boolean isScheduledForCollection()

isScheduledForCollection

Returns:

a boolean.

shouldPersist

public boolean shouldPersist(ServiceParameters serviceParameters)

Determines whether the attribute should be persisted.

Specified by:

shouldPersist in interface Persistable

Specified by:

shouldPersist in class SnmpCollectionResource

Parameters:

serviceParameters - a ServiceParameters object.

Returns:

a boolean.

getSnmpIfType

public int getSnmpIfType()

getType

Specified by:

getSnmpIfType in class SnmpCollectionResource

Returns:

a int.

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

Overrides:

visit in class SnmpCollectionResource

Parameters:

visitor - a CollectionSetVisitor object.

getGroups

public Collection<AttributeGroup> getGroups()

getGroups

Overrides:

getGroups in class SnmpCollectionResource

Returns:

a Collection object.

getResourceTypeName

public String getResourceTypeName()

getResourceTypeName

Returns:

a String object.

getInstance

public String getInstance()

getInstance

Returns:

a String object.

getUnmodifiedInstance

public String getUnmodifiedInstance()

Description copied from interface: CollectionResource

Returns the unmodified instance string this CollectionResource represents.

Returns:

a String object.

getParent

public ResourcePath getParent()

Description copied from interface: CollectionResource

Returns the name of the parent resource.

Returns:

a String object.

getInterfaceLabel

public String getInterfaceLabel()

getLabel

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

Overrides:

getTimeKeeper in class SnmpCollectionResource

Returns:

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