Package org.opennms.netmgt.collection.api

Interface CollectionResource

    • Method Detail

      • rescanNeeded

        boolean rescanNeeded()

        rescanNeeded

        Returns:
        a boolean.

      • getResourceTypeName

        java.lang.String getResourceTypeName()
        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

        ResourcePath getParent()
        Returns the name of the parent resource.
        Returns:
        a String object.

      • getInstance

        java.lang.String getInstance()
        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.
        Returns:
        a String object.

      • getUnmodifiedInstance

        java.lang.String getUnmodifiedInstance()
        Returns the unmodified instance string this CollectionResource represents.
        Returns:
        a String object.

      • getInterfaceLabel

        java.lang.String getInterfaceLabel()
        Returns a unique label for each resource depending on resource type. This label is the same label used when constructing the resource ID.
        Returns:
        a String object.

      • getTimeKeeper

        TimeKeeper getTimeKeeper()
        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.
        Returns:
        a TimeKeeper object or null to indicate that DefaultTimeKeeper should be used.