ThresholdListener.java

/*
 * Copyright to the original author or authors.
 *
 * 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.rioproject.impl.watch;

import org.rioproject.watch.Calculable;
import org.rioproject.watch.ThresholdType;
import org.rioproject.watch.ThresholdValues;

/**
 * Listener for notification that a threshold has been crossed. A
 * ThresholdManager will notify a ThresholdListener if a Threshold has been
 * crossed. The ThresholdListener may take corrective actions to deal with the
 * threshold condition, and/or generate ThresholdEvent notifications.
 *
 * @author Dennis Reedy
 */
public interface ThresholdListener {
    /**
     * Notify for a threshold event
     *
     * @param calculable The current metric
     * @param thresholdValues The current thresholds
     * @param type The type of threshold event, breached or cleared
     */
    void notify(Calculable calculable, ThresholdValues thresholdValues, ThresholdType type);
}