org.opennms.nrtg.api.model.CollectionJob Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nrtg-api Show documentation

The API contains the models for the NRTG projects. It has models for collection jobs, measurements and protocol collectors.

There is a newer version: 33.0.10

Show newest version

/*
 * Licensed to The OpenNMS Group, Inc (TOG) under one or more
 * contributor license agreements.  See the LICENSE.md file
 * distributed with this work for additional information
 * regarding copyright ownership.
 *
 * TOG licenses this file to You under the GNU Affero General
 * Public License Version 3 (the "License") or (at your option)
 * any later version.  You may not use this file except in
 * compliance with the License.  You may obtain a copy of the
 * License at:
 *
 *      https://www.gnu.org/licenses/agpl-3.0.txt
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied.  See the License for the specific
 * language governing permissions and limitations under the
 * License.
 */
package org.opennms.nrtg.api.model;

import java.io.Serializable;
import java.util.Date;
import java.util.Map;
import java.util.Set;

/**
 * 
 * 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
 */
public interface CollectionJob extends Serializable {

    Set getAllMetrics();

    void setMetricValue(String metricId, String metricType, String value) throws IllegalArgumentException;

    void setMetricValue(String metricId, String value) throws IllegalArgumentException;

    String getMetricValue(String metricId) throws IllegalArgumentException;

    void addMetric(String metricId, Set destinationSet, String onmsLogicMetricId) throws IllegalArgumentException;

    void setParameters(Map parameters);

    Map getParameters();

    MeasurementSet getMeasurementSet();

    void setId(String id);

    String getId();

    void setNodeId(int nodeId);

    int getNodeId();

    void setSite(String site);

    String getSite();

    void setCreationTimestamp(Date creationTimestamp);

    Date getCreationTimestamp();

    void setFinishedTimestamp(Date finishedTimestamp);

    Date getFinishedTimestamp();

    void setNetInterface(String theInterface);

    //ToDo tak change to InetAddress
    String getNetInterface();

    String getService();

    void setService(String service);

    Map getMeasurementSetsByDestination();

    void setProtocolConfiguration(String configurationString);

    String getProtocolConfiguration();

    String getMetricType(String metricId) throws IllegalArgumentException;

    String getOnmsLogicMetricId(String metricId);

}