org.opennms.netmgt.collectd.tca

Class TcaCollectionResource

java.lang.Object

org.opennms.netmgt.collectd.AbstractCollectionResource

org.opennms.netmgt.collectd.tca.TcaCollectionResource

All Implemented Interfaces:

CollectionResource, ResourceIdentifier

public class TcaCollectionResource
extends AbstractCollectionResource

The Class TcaCollectionResource.

The resource type is fixed to juniperTcaEntry

This requires to define a datacollection-group like this:

 <datacollection-group name="Juniper TCA">
    <resourceType name="juniperTcaEntry" label="Juniper TCA Entry" resourceLabel="Peer ${index}">
     <persistenceSelectorStrategy class="org.opennms.netmgt.collectd.PersistAllSelectorStrategy"/>
     <storageStrategy class="org.opennms.netmgt.dao.support.IndexStorageStrategy"/>
   </resourceType>
 </datacollection-group>
 

Note: the persistenceSelectorStrategy and storageStrategy won't be used by the collector.

Author:

Alejandro Galue

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_TYPE_NAME The Constant RESOURCE_TYPE_NAME.

Fields inherited from class org.opennms.netmgt.collectd.AbstractCollectionResource

m_agent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TcaCollectionResource(CollectionAgent agent, String peerAddress) Instantiates a new TCA collection resource.

Method Summary

Methods

Modifier and Type	Method and Description
String	getInstance() Returns the name of the instance this CollectionResource represents.
String	getLabel() getLabel
String	getParent() Returns the name of the parent resource.
File	getResourceDir(RrdRepository repository) getResourceDir
String	getResourceTypeName() Returns a string which indicates what type of resource.
TimeKeeper	getTimeKeeper() Returns a not-null time tracker instance when this resource requires to use a special timestamp when updating RRDs/JRBs.
int	getType() getType
boolean	rescanNeeded() rescanNeeded
void	setAttributeValue(TcaCollectionAttributeType type, String value) Sets the attribute value.
void	setTimeKeeper(TimeKeeper timeKeeper) Sets the time keeper.
boolean	shouldPersist(ServiceParameters params) shouldPersist
String	toString()

Methods inherited from class org.opennms.netmgt.collectd.AbstractCollectionResource

addAttribute, getGroup, getOwnerName, visit

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_TYPE_NAME

public static final String RESOURCE_TYPE_NAME

The Constant RESOURCE_TYPE_NAME.

See Also:

Constant Field Values

Constructor Detail

TcaCollectionResource

protected TcaCollectionResource(CollectionAgent agent,
                     String peerAddress)

Instantiates a new TCA collection resource.

Parameters:

agent - the collection agent

peerAddress - the TCA peer address

Method Detail

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

Returns:

a String object.

getParent

public String getParent()

Description copied from interface: CollectionResource

Returns the name of the parent resource.

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

Returns:

a String object.

getLabel

public String getLabel()

Description copied from class: AbstractCollectionResource

getLabel

Specified by:

getLabel in interface CollectionResource

Overrides:

getLabel in class AbstractCollectionResource

Returns:

a String object.

getType

public int getType()

Description copied from class: AbstractCollectionResource

getType

Specified by:

getType in interface CollectionResource

Specified by:

getType in class AbstractCollectionResource

Returns:

a int.

rescanNeeded

public boolean rescanNeeded()

Description copied from class: AbstractCollectionResource

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Specified by:

rescanNeeded in class AbstractCollectionResource

Returns:

a boolean.

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Description copied from class: AbstractCollectionResource

shouldPersist

Specified by:

shouldPersist in interface CollectionResource

Specified by:

shouldPersist in class AbstractCollectionResource

Parameters:

params - a org.opennms.netmgt.collectd.ServiceParameters object.

Returns:

a boolean.

toString

public String toString()

Overrides:

toString in class Object

getResourceDir

public File getResourceDir(RrdRepository repository)

Description copied from class: AbstractCollectionResource

getResourceDir

Specified by:

getResourceDir in interface ResourceIdentifier

Overrides:

getResourceDir in class AbstractCollectionResource

Parameters:

repository - a RrdRepository object.

Returns:

a File object.

getTimeKeeper

public TimeKeeper getTimeKeeper()

Description copied from interface: CollectionResource

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

Specified by:

getTimeKeeper in interface CollectionResource

Overrides:

getTimeKeeper in class AbstractCollectionResource

Returns:

a TimeKeeper object.

setTimeKeeper

public void setTimeKeeper(TimeKeeper timeKeeper)

Sets the time keeper.

Parameters:

timeKeeper - the new time keeper

setAttributeValue

public void setAttributeValue(TcaCollectionAttributeType type,
                     String value)

Sets the attribute value.

Parameters:

type - the type

value - the value