Source for javax.management.NotificationBroadcaster

   1: /* NotificationBroadcaster.java -- Interface for broadcasters.
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.management;
  39: 
  40: /**
  41:  * <p>
  42:  * Represents a bean that can emit notifications when
  43:  * events occur.  Other beans can use this interface
  44:  * to add themselves to the list of recipients of such
  45:  * notifications.
  46:  * </p>
  47:  * <p>
  48:  * <strong>Note</strong>: New classes should use
  49:  * {@link NotificationEmitter}, a subinterface of this,
  50:  * in preference to using this interface directly.
  51:  * </p>
  52:  *
  53:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  54:  * @since 1.5
  55:  */
  56: public interface NotificationBroadcaster
  57: {
  58: 
  59:   /**
  60:    * Registers the specified listener as a new recipient of
  61:    * notifications from this bean.  If non-null, the filter
  62:    * argument will be used to select which notifications are
  63:    * delivered.  The supplied object will also be passed to
  64:    * the recipient with each notification.  This should not
  65:    * be modified by the broadcaster, but instead should be
  66:    * passed unmodified to the listener.
  67:    *
  68:    * @param listener the new listener, who will receive
  69:    *                 notifications from this broadcasting bean.
  70:    * @param filter a filter to determine which notifications are
  71:    *               delivered to the listener, or <code>null</code>
  72:    *               if no filtering is required.
  73:    * @param passback an object to be passed to the listener with
  74:    *                 each notification.
  75:    * @throws IllegalArgumentException if <code>listener</code> is
  76:    *                                  <code>null</code>.
  77:    * @see #removeNotificationListener(NotificationListener)
  78:    */
  79:   void addNotificationListener(NotificationListener listener,
  80:                                NotificationFilter filter,
  81:                                Object passback)
  82:     throws IllegalArgumentException;
  83: 
  84:   /**
  85:    * Returns an array describing the notifications this
  86:    * bean may send to its registered listeners.  Ideally, this
  87:    * array should be complete, but in some cases, this may
  88:    * not be possible.  However, be aware that some listeners
  89:    * may expect this to be so.
  90:    *
  91:    * @return the array of possible notifications.
  92:    */
  93:   MBeanNotificationInfo[] getNotificationInfo();
  94: 
  95:   /**
  96:    * Removes the specified listener from the list of recipients
  97:    * of notifications from this bean.  This includes all combinations
  98:    * of filters and passback objects registered for this listener.
  99:    * For more specific removal of listeners, see the subinterface
 100:    * {@link NotificationEmitter}.
 101:    *
 102:    * @param listener the listener to remove.
 103:    * @throws ListenerNotFoundException if the specified listener
 104:    *                                   is not registered with this bean.
 105:    * @see #addNotificationListener(NotificationListener, NotificationFilter,
 106:    *                               java.lang.Object)
 107:    */
 108:   void removeNotificationListener(NotificationListener listener)
 109:     throws ListenerNotFoundException;
 110: 
 111: }