Package org.opennms.netmgt.dao.support

Class InterfaceSnmpByIfIndexResourceType

java.lang.Object

org.opennms.netmgt.dao.support.InterfaceSnmpByIfIndexResourceType

All Implemented Interfaces:

OnmsResourceType

public class InterfaceSnmpByIfIndexResourceType
extends java.lang.Object
implements OnmsResourceType

This resource type provides an alias for the InterfaceSnmpResourceType, allowing SNMP interfaces to be queried using the ifIndex instead of the interface name as stored in the metric repository. i.e. interfaceSnmpByIfIndex[2] vs interfaceSnmp[em1-74867ad4b828]

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InterfaceSnmpByIfIndexResourceType(InterfaceSnmpResourceType interfaceSnmpResourceType)

Method Summary

Modifier and Type	Method	Description
OnmsResource	getChildByName(OnmsResource parent, java.lang.String name)	Retrieves a child resource with the given name from the parent.
java.lang.String	getLabel()	Provides a human-friendly label for this resource type.
java.lang.String	getLinkForResource(OnmsResource resource)	getLinkForResource
java.lang.String	getName()	Provides a unique name for this resource type.
java.util.List<OnmsResource>	getResourcesForParent(OnmsResource parent)	Returns the set of resources that are available on the given parent.
boolean	isResourceTypeOnParent(OnmsResource parent)	Returns true if one on more instances of the resource type are present on the parent resource.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

InterfaceSnmpByIfIndexResourceType

protected InterfaceSnmpByIfIndexResourceType(InterfaceSnmpResourceType interfaceSnmpResourceType)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: OnmsResourceType

Provides a unique name for this resource type.

Specified by:

getName in interface OnmsResourceType

Returns:

unique name

getLabel

public java.lang.String getLabel()

Description copied from interface: OnmsResourceType

Provides a human-friendly label for this resource type. It is particularly used in the webUI to describe this resource type.

Specified by:

getLabel in interface OnmsResourceType

Returns:

human-friendly label

getLinkForResource

public java.lang.String getLinkForResource(OnmsResource resource)

getLinkForResource

Specified by:

getLinkForResource in interface OnmsResourceType

Parameters:

resource - a OnmsResource object.

Returns:

a String object.

isResourceTypeOnParent

public boolean isResourceTypeOnParent(OnmsResource parent)

Description copied from interface: OnmsResourceType

Returns true if one on more instances of the resource type are present on the parent resource. Top-level resource types should always return false.

Specified by:

isResourceTypeOnParent in interface OnmsResourceType

getResourcesForParent

public java.util.List<OnmsResource> getResourcesForParent(OnmsResource parent)

Description copied from interface: OnmsResourceType

Returns the set of resources that are available on the given parent. If none are available, i.e. isResourceTypeOnParent() would return false, then an empty list should be returned. Top-level resource types should return the set of top-level resources when parent is null.

Specified by:

getResourcesForParent in interface OnmsResourceType

getChildByName

public OnmsResource getChildByName(OnmsResource parent,
                                   java.lang.String name)

Retrieves a child resource with the given name from the parent.

Specified by:

getChildByName in interface OnmsResourceType

Returns:

null if no resource with the given name was found