MonitorListener.java

/*
 * Copyright (c) OSGi Alliance (2004, 2012). All Rights Reserved.
 * 
 * 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.osgi.service.monitor;

/**
 * The <code>MonitorListener</code> is used by <code>Monitorable</code> services
 * to send notifications when a <code>StatusVariable</code> value is changed.
 * The <code>MonitorListener</code> should register itself as a service at the
 * OSGi Service Registry. This interface must (only) be implemented by the
 * Monitor Admin component.
 * 
 * @version $Revision: 5673 $
 */
public interface MonitorListener {
    /**
     * Callback for notification of a <code>StatusVariable</code> change.
     * 
     * @param monitorableId the identifier of the <code>Monitorable</code>
     *        instance reporting the change
     * @param statusVariable the <code>StatusVariable</code> that has changed
     * @throws java.lang.IllegalArgumentException if the specified monitorable
     *         ID is invalid (<code>null</code>, empty, or contains illegal
     *         characters) or points to a non-existing <code>Monitorable</code>, 
     *         or if <code>statusVariable</code> is <code>null</code>
     */
    public void updated(String monitorableId, StatusVariable statusVariable)
            throws IllegalArgumentException;
}