org.opennms.alec.engine.api.Engine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.opennms.alec.engine.api Show documentation
The newest version!
/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2018 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2018 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing 
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.alec.engine.api;

import java.util.List;

import org.opennms.alec.datasource.api.Alarm;
import org.opennms.alec.datasource.api.AlarmFeedback;
import org.opennms.alec.datasource.api.AlarmFeedbackHandler;
import org.opennms.alec.datasource.api.AlarmHandler;
import org.opennms.alec.datasource.api.InventoryHandler;
import org.opennms.alec.datasource.api.InventoryObject;
import org.opennms.alec.datasource.api.Situation;
import org.opennms.alec.datasource.api.SituationHandler;

/**
 * An engine that consumes {@link Alarm alarms}, {@link InventoryObject inventory} and
 * {@link AlarmFeedback alarm feedback} to produce correlated {@link Situation situations}.
 */
public interface Engine extends AlarmHandler, InventoryHandler, AlarmFeedbackHandler {

    void init(List alarms, List alarmFeedback, List situations,
              List inventory);

    long getTickResolutionMs();

    void tick(long timestampInMillis);

    void destroy();

    /**
     * Passes the reference to the SituationHandler.
     * The SituationHandler exposes onSituation() callback for creating and updating Situations.
     *
     * @param handler
     */
    void registerSituationHandler(SituationHandler handler);

    /**
     * Delete the situation with the given situation Id.
     *
     * @param situationId the situation Id
     * @throws InterruptedException if the thread is interrupted while waiting for the engine to init
     */
    void deleteSituation(String situationId) throws InterruptedException;
}