core/api/src/main/java/org/onosproject/alarm/AlarmProvider.java

/*
 * Copyright 2018-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.onosproject.alarm;

import org.onosproject.net.DeviceId;
import org.onosproject.net.provider.Provider;

/**
 * Abstraction of an entity capable of supplying alarms collected from
 * network devices.
 */
public interface AlarmProvider extends Provider {

    /**
     * Triggers an asynchronous discovery of the alarms on the specified device,
     * intended to refresh internal alarm model for the device. An indirect
     * result of this should be a event sent later with discovery result
     * ie a set of alarms.
     *
     * @param deviceId ID of device to be probed
     */
    void triggerProbe(DeviceId deviceId);
}