java.lang.Object
- javax.management.StandardMBean
- - javax.management.StandardEmitterMBean

All Implemented Interfaces:: DynamicMBean, MBeanRegistration, NotificationBroadcaster, NotificationEmitter

public class StandardEmitterMBean
extends StandardMBean
implements NotificationEmitter

An MBean whose management interface is determined by reflection on a Java interface, and that emits notifications.

The following example shows how to use the public constructor StandardEmitterMBean(implementation, mbeanInterface, emitter) to create an MBean emitting notifications with any implementation class name Impl, with a management interface defined (as for current Standard MBeans) by any interface Intf, and with any implementation of the interface NotificationEmitter. The example uses the class NotificationBroadcasterSupport as an implementation of the interface NotificationEmitter.

     MBeanServer mbs;
     ...
     final String[] types = new String[] {"sun.disc.space","sun.disc.alarm"};
     final MBeanNotificationInfo info = new MBeanNotificationInfo(
                                          types,
                                          Notification.class.getName(),
                                          "Notification about disc info.");
     final NotificationEmitter emitter =
                    new NotificationBroadcasterSupport(info);

     final Intf impl = new Impl(...);
     final Object mbean = new StandardEmitterMBean(
                                     impl, Intf.class, emitter);
     mbs.registerMBean(mbean, objectName);

Since:: 1.6
See Also:: StandardMBean

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`StandardEmitterMBean(Class<?> mbeanInterface, boolean isMXBean, NotificationEmitter emitter)` Make an MBean whose management interface is specified by `mbeanInterface`, and where notifications are handled by the given `NotificationEmitter`.
`protected`	`StandardEmitterMBean(Class<?> mbeanInterface, NotificationEmitter emitter)` Make an MBean whose management interface is specified by `mbeanInterface`, and where notifications are handled by the given `NotificationEmitter`.
	`StandardEmitterMBean(T implementation, Class<T> mbeanInterface, boolean isMXBean, NotificationEmitter emitter)` Make an MBean whose management interface is specified by `mbeanInterface`, with the given implementation and where notifications are handled by the given `NotificationEmitter`.
	`StandardEmitterMBean(T implementation, Class<T> mbeanInterface, NotificationEmitter emitter)` Make an MBean whose management interface is specified by `mbeanInterface`, with the given implementation and where notifications are handled by the given `NotificationEmitter`.

StandardEmitterMBean (Java Platform SE 7 ) Home of API Java Contents Haut

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)` Adds a listener to this MBean.
`MBeanNotificationInfo[]`	`getNotificationInfo()` Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
`void`	`removeNotificationListener(NotificationListener listener)` Removes a listener from this MBean.
`void`	`removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)` Removes a listener from this MBean.
`void`	`sendNotification(Notification n)` Sends a notification.

StandardEmitterMBean (Java Platform SE 7 ) Home of API Java Contents Haut

Methods inherited from class javax.management.StandardMBean
cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StandardEmitterMBean
```
public StandardEmitterMBean(T implementation,
                    Class<T> mbeanInterface,
                    NotificationEmitter emitter)
```
    Make an MBean whose management interface is specified by mbeanInterface, with the given implementation and where notifications are handled by the given NotificationEmitter. The resultant MBean implements the NotificationEmitter interface by forwarding its methods to emitter. It is legal and useful for implementation and emitter to be the same object.
    
    If emitter is an instance of NotificationBroadcasterSupport then the MBean's sendNotification method will call emitter.sendNotification.
    
    The array returned by getNotificationInfo() on the new MBean is a copy of the array returned by emitter.getNotificationInfo() at the time of construction. If the array returned by emitter.getNotificationInfo() later changes, that will have no effect on this object's getNotificationInfo().
    
    Parameters:
    implementation - the implementation of the MBean interface.
    mbeanInterface - a Standard MBean interface.
    emitter - the object that will handle notifications.
    
    Throws:
    
    IllegalArgumentException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if the given implementation does not implement the specified interface, or if emitter is null.
  - StandardEmitterMBean
```
public StandardEmitterMBean(T implementation,
                    Class<T> mbeanInterface,
                    boolean isMXBean,
                    NotificationEmitter emitter)
```
    Make an MBean whose management interface is specified by mbeanInterface, with the given implementation and where notifications are handled by the given NotificationEmitter. This constructor can be used to make either Standard MBeans or MXBeans. The resultant MBean implements the NotificationEmitter interface by forwarding its methods to emitter. It is legal and useful for implementation and emitter to be the same object.
    
    If emitter is an instance of NotificationBroadcasterSupport then the MBean's sendNotification method will call emitter.sendNotification.
    
    The array returned by getNotificationInfo() on the new MBean is a copy of the array returned by emitter.getNotificationInfo() at the time of construction. If the array returned by emitter.getNotificationInfo() later changes, that will have no effect on this object's getNotificationInfo().
    
    Parameters:
    implementation - the implementation of the MBean interface.
    mbeanInterface - a Standard MBean interface.
    isMXBean - If true, the mbeanInterface parameter names an MXBean interface and the resultant MBean is an MXBean.
    emitter - the object that will handle notifications.
    
    Throws:
    
    IllegalArgumentException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if the given implementation does not implement the specified interface, or if emitter is null.
  - StandardEmitterMBean
```
protected StandardEmitterMBean(Class<?> mbeanInterface,
                    NotificationEmitter emitter)
```
    Make an MBean whose management interface is specified by mbeanInterface, and where notifications are handled by the given NotificationEmitter. The resultant MBean implements the NotificationEmitter interface by forwarding its methods to emitter.
    
    If emitter is an instance of NotificationBroadcasterSupport then the MBean's sendNotification method will call emitter.sendNotification.
    
    The array returned by getNotificationInfo() on the new MBean is a copy of the array returned by emitter.getNotificationInfo() at the time of construction. If the array returned by emitter.getNotificationInfo() later changes, that will have no effect on this object's getNotificationInfo().
    
    This constructor must be called from a subclass that implements the given mbeanInterface.
    
    Parameters:
    mbeanInterface - a StandardMBean interface.
    emitter - the object that will handle notifications.
    
    Throws:
    
    IllegalArgumentException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if this does not implement the specified interface, or if emitter is null.
  - StandardEmitterMBean
```
protected StandardEmitterMBean(Class<?> mbeanInterface,
                    boolean isMXBean,
                    NotificationEmitter emitter)
```
    Make an MBean whose management interface is specified by mbeanInterface, and where notifications are handled by the given NotificationEmitter. This constructor can be used to make either Standard MBeans or MXBeans. The resultant MBean implements the NotificationEmitter interface by forwarding its methods to emitter.
    
    If emitter is an instance of NotificationBroadcasterSupport then the MBean's sendNotification method will call emitter.sendNotification.
    
    The array returned by getNotificationInfo() on the new MBean is a copy of the array returned by emitter.getNotificationInfo() at the time of construction. If the array returned by emitter.getNotificationInfo() later changes, that will have no effect on this object's getNotificationInfo().
    
    This constructor must be called from a subclass that implements the given mbeanInterface.
    
    Parameters:
    mbeanInterface - a StandardMBean interface.
    isMXBean - If true, the mbeanInterface parameter names an MXBean interface and the resultant MBean is an MXBean.
    emitter - the object that will handle notifications.
    
    Throws:
    
    IllegalArgumentException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if this does not implement the specified interface, or if emitter is null.
- Method Detail
  - removeNotificationListener
```
public void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException
```
    Description copied from interface: NotificationBroadcaster
    
    Removes a listener from this MBean. If the listener has been registered with different handback objects or notification filters, all entries corresponding to the listener will be removed.
    
    Specified by:
    
    removeNotificationListener in interface NotificationBroadcaster
    
    Parameters:
    listener - A listener that was previously added to this MBean.
    
    Throws:
    
    ListenerNotFoundException - The listener is not registered with the MBean.
    See Also:
    NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
  - removeNotificationListener
```
public void removeNotificationListener(NotificationListener listener,
                              NotificationFilter filter,
                              Object handback)
                                throws ListenerNotFoundException
```
    Description copied from interface: NotificationEmitter
    
    Removes a listener from this MBean. The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.
    
    The filter and handback parameters may be null if and only if they are null in a listener to be removed.
    
    Specified by:
    
    removeNotificationListener in interface NotificationEmitter
    
    Parameters:
    listener - A listener that was previously added to this MBean.
    filter - The filter that was specified when the listener was added.
    handback - The handback that was specified when the listener was added.
    
    Throws:
    
    ListenerNotFoundException - The listener is not registered with the MBean, or it is not registered with the given filter and handback.
  - addNotificationListener
```
public void addNotificationListener(NotificationListener listener,
                           NotificationFilter filter,
                           Object handback)
```
    Description copied from interface: NotificationBroadcaster
    
    Adds a listener to this MBean.
    
    Specified by:
    
    addNotificationListener in interface NotificationBroadcaster
    
    Parameters:
    listener - The listener object which will handle the notifications emitted by the broadcaster.
    filter - The filter object. If filter is null, no filtering will be performed before handling notifications.
    handback - An opaque object to be sent back to the listener when a notification is emitted. This object cannot be used by the Notification broadcaster object. It should be resent unchanged with the notification to the listener.
    See Also:
    NotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener)
  - getNotificationInfo
```
public MBeanNotificationInfo[] getNotificationInfo()
```
    Description copied from interface: NotificationBroadcaster
    
    Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
    
    It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning.
    
    Specified by:
    
    getNotificationInfo in interface NotificationBroadcaster
    
    Returns:
    the array of possible notifications.
  - sendNotification
```
public void sendNotification(Notification n)
```
    Sends a notification.
    
    If the emitter parameter to the constructor was an instance of NotificationBroadcasterSupport then this method will call emitter.sendNotification.
    
    Parameters:
    n - the notification to send.
    
    Throws:
    
    ClassCastException - if the emitter parameter to the constructor was not a NotificationBroadcasterSupport.

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/management/StandardEmitterMBean.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

Class StandardEmitterMBean

Constructor Summary

Method Summary

Methods inherited from class javax.management.StandardMBean

Methods inherited from class java.lang.Object

Constructor Detail

StandardEmitterMBean

StandardEmitterMBean

StandardEmitterMBean

StandardEmitterMBean

Method Detail

removeNotificationListener

removeNotificationListener

addNotificationListener

getNotificationInfo

sendNotification

References