org.opennms.protocols.xml.collector

Class XmlMultiInstanceCollectionResource

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionResource

org.opennms.protocols.xml.collector.XmlCollectionResource

org.opennms.protocols.xml.collector.XmlMultiInstanceCollectionResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public class XmlMultiInstanceCollectionResource
extends XmlCollectionResource

The Class XmlMultiInstanceCollectionResource.

Author:

Alejandro Galue

Field Summary

Fields inherited from class org.opennms.netmgt.collection.support.AbstractCollectionResource

m_agent

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

RESOURCE_TYPE_IF, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Constructor and Description
XmlMultiInstanceCollectionResource(CollectionAgent agent, String instance, XmlResourceType type) Instantiates a new XML Multi-instance collection resource.

Method Summary

Modifier and Type	Method and Description
String	getInstance() Returns the name of the instance this CollectionResource represents.
String	getInterfaceLabel() getInterfaceLabel
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.
boolean	shouldPersist(ServiceParameters params) Resources should be persisted by default.
String	toString()

Methods inherited from class org.opennms.protocols.xml.collector.XmlCollectionResource

getTimeKeeper, setAttributeValue, setTimeKeeper

Methods inherited from class org.opennms.netmgt.collection.support.AbstractCollectionResource

addAttribute, getGroup, getOwnerName, getParent, rescanNeeded, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlMultiInstanceCollectionResource

public XmlMultiInstanceCollectionResource(CollectionAgent agent,
                                          String instance,
                                          XmlResourceType type)

Instantiates a new XML Multi-instance collection resource.

Parameters:

agent - the collection agent

instance - the resource instance

type - the XML resource type

Method Detail

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Description copied from class: AbstractCollectionResource

Resources should be persisted by default. Returns true.

Specified by:

shouldPersist in interface Persistable

Overrides:

shouldPersist in class AbstractCollectionResource

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

getPath

public Path getPath()

Description copied from class: AbstractCollectionResource

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

Specified by:

getPath in interface ResourceIdentifier

Overrides:

getPath in class AbstractCollectionResource

Returns:

Path 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

Specified by:

getResourceTypeName in class XmlCollectionResource

Returns:

a String object.

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

Specified by:

getInstance in class XmlCollectionResource

Returns:

a String object.

toString

public String toString()

Overrides:

toString in class Object

getInterfaceLabel

public String getInterfaceLabel()

Description copied from class: AbstractCollectionResource

getInterfaceLabel

Specified by:

getInterfaceLabel in interface CollectionResource

Overrides:

getInterfaceLabel in class AbstractCollectionResource

Returns:

a String object.