org.springframework.jmx.export.notification.NotificationPublisher Maven / Gradle / Ivy
Show all versions of spring-context Show documentation
/*
* Copyright 2002-2012 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.springframework.jmx.export.notification;
import javax.management.Notification;
/**
* Simple interface allowing Spring-managed MBeans to publish JMX notifications
* without being aware of how those notifications are being transmitted to the
* {@link javax.management.MBeanServer}.
*
* Managed resources can access a {@code NotificationPublisher} by
* implementing the {@link NotificationPublisherAware} interface. After a particular
* managed resource instance is registered with the {@link javax.management.MBeanServer},
* Spring will inject a {@code NotificationPublisher} instance into it if that
* resource implements the {@link NotificationPublisherAware} inteface.
*
*
Each managed resource instance will have a distinct instance of a
* {@code NotificationPublisher} implementation. This instance will keep
* track of all the {@link javax.management.NotificationListener NotificationListeners}
* registered for a particular mananaged resource.
*
*
Any existing, user-defined MBeans should use standard JMX APIs for notification
* publication; this interface is intended for use only by Spring-created MBeans.
*
* @author Rob Harrop
* @since 2.0
* @see NotificationPublisherAware
* @see org.springframework.jmx.export.MBeanExporter
*/
public interface NotificationPublisher {
/**
* Send the specified {@link javax.management.Notification} to all registered
* {@link javax.management.NotificationListener NotificationListeners}.
* Managed resources are not responsible for managing the list
* of registered {@link javax.management.NotificationListener NotificationListeners};
* that is performed automatically.
* @param notification the JMX Notification to send
* @throws UnableToSendNotificationException if sending failed
*/
void sendNotification(Notification notification) throws UnableToSendNotificationException;
}