Package org.opennms.nrtg.api.model

Interface CollectionJob

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    DefaultCollectionJob
    public interface CollectionJob
extends java.io.Serializable

    Defines a collection job for a satellite.

    The smallest sensible job unit to collect in one action.

    A set of metrics from one interface in one technology at one time.

    The satellite calls the responsible protocol handler. The protocol handler can optimize the collection of metrics depending on protocol specifics (one/multiple connection, one/multiple session, one/multiple call ...).

    Author:
    Simon Walter

    • Method Detail

      • getAllMetrics

        java.util.Set<java.lang.String> getAllMetrics()

      • setMetricValue

        void setMetricValue​(java.lang.String metricId,
                    java.lang.String metricType,
                    java.lang.String value)
             throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException

      • setMetricValue

        void setMetricValue​(java.lang.String metricId,
                    java.lang.String value)
             throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException

      • getMetricValue

        java.lang.String getMetricValue​(java.lang.String metricId)
                         throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException

      • addMetric

        void addMetric​(java.lang.String metricId,
               java.util.Set<java.lang.String> destinationSet,
               java.lang.String onmsLogicMetricId)
        throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException

      • setParameters

        void setParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)

      • getParameters

        java.util.Map<java.lang.String,​java.lang.Object> getParameters()

      • setId

        void setId​(java.lang.String id)

      • getId

        java.lang.String getId()

      • setNodeId

        void setNodeId​(int nodeId)

      • getNodeId

        int getNodeId()

      • setSite

        void setSite​(java.lang.String site)

      • getSite

        java.lang.String getSite()

      • setCreationTimestamp

        void setCreationTimestamp​(java.util.Date creationTimestamp)

      • getCreationTimestamp

        java.util.Date getCreationTimestamp()

      • setFinishedTimestamp

        void setFinishedTimestamp​(java.util.Date finishedTimestamp)

      • getFinishedTimestamp

        java.util.Date getFinishedTimestamp()

      • setNetInterface

        void setNetInterface​(java.lang.String theInterface)

      • getNetInterface

        java.lang.String getNetInterface()

      • getService

        java.lang.String getService()

      • setService

        void setService​(java.lang.String service)

      • getMeasurementSetsByDestination

        java.util.Map<java.lang.String,​MeasurementSet> getMeasurementSetsByDestination()

      • setProtocolConfiguration

        void setProtocolConfiguration​(java.lang.String configurationString)

      • getProtocolConfiguration

        java.lang.String getProtocolConfiguration()

      • getMetricType

        java.lang.String getMetricType​(java.lang.String metricId)
                        throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException

      • getOnmsLogicMetricId

        java.lang.String getOnmsLogicMetricId​(java.lang.String metricId)