org.opennms.netmgt.collection.support.builder

Class NodeLevelResource

java.lang.Object

org.opennms.netmgt.collection.support.builder.AbstractResource

org.opennms.netmgt.collection.support.builder.NodeLevelResource

All Implemented Interfaces:

Resource

public class NodeLevelResource
extends AbstractResource

Constructor Summary

Constructors

Constructor and Description
NodeLevelResource(int nodeId)
NodeLevelResource(int nodeId, String path) Deprecated. use a GenericTypeResource instead

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getInstance() Returns a unique name for the instance of this resource.
String	getLabel(CollectionResource resource) Returns a unique label for the instance of this resource.
int	getNodeId()
Resource	getParent()
String	getPath()
ResourcePath	getPath(CollectionResource resource) Retrieves the path of the resource, relative to the repository root.
String	getTypeName() Returns the type name associated with the resource.
String	getUnmodifiedInstance() Returns the original unmodified unique name for the instance of this resource.
int	hashCode()
String	toString()

Methods inherited from class org.opennms.netmgt.collection.support.builder.AbstractResource

getTimestamp, resolve, setTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NodeLevelResource

public NodeLevelResource(int nodeId)

NodeLevelResource

public NodeLevelResource(int nodeId,
                         String path)

Deprecated. use a GenericTypeResource instead

Allows node level resources to live in a sub-directory of the node directory when the path is set to a non-null value. This is generally not recommend, and these cases should be modeled using GenericTypeResources instead, however it exists for backwards compatibility with the JMX collector.

Parameters:

nodeId - the node id

path - sub-directory of the node directory

Method Detail

getNodeId

public int getNodeId()

getPath

public String getPath()

getParent

public Resource getParent()

getInstance

public String getInstance()

Description copied from interface: Resource

Returns a unique name for the instance of this resource. Used by the IndexStorageStrategy

Returns:

instance name

getUnmodifiedInstance

public String getUnmodifiedInstance()

Description copied from interface: Resource

Returns the original unmodified unique name for the instance of this resource. Used by the ObjectNameStorageStrategy

Returns:

instance name

getPath

public ResourcePath getPath(CollectionResource resource)

Description copied from interface: Resource

Retrieves the path of the resource, relative to the repository root.

Parameters:

resource - Used by the GenericTypeResource in order to determine the instance name.

Returns:

relative path

getLabel

public String getLabel(CollectionResource resource)

Description copied from interface: Resource

Returns a unique label for the instance of this resource. This label is used by threshd to generate a unique id on a per resource basis, grouped by node. See CollectionResourceWrapper

Returns:

a String object.

getTypeName

public String getTypeName()

Description copied from interface: Resource

Returns the type name associated with the resource. Used for thresholding.

Returns:

type name

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object