Source for javax.management.MBeanRegistration

   1: /* MBeanRegistration.java -- Interface for beans to hook into registration.
   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:  * Beans may implement this interface in order to perform
  42:  * operations immediately prior to or after their registration
  43:  * or deregistration.
  44:  *
  45:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  46:  * @since 1.5
  47:  */
  48: public interface MBeanRegistration
  49: {
  50: 
  51:   /**
  52:    * This method is called following deregistration of the bean
  53:    * by the server.
  54:    */
  55:   void postDeregister();
  56: 
  57:   /**
  58:    * This method is called following both successful and unsuccessful
  59:    * attempts to register the bean.  The supplied boolean value indicates
  60:    * the result of the attempt relative to this call.
  61:    *
  62:    * @param successful true if the registration was successful.
  63:    */
  64:   void postRegister(Boolean successful);
  65: 
  66:   /**
  67:    * This method is called prior to de-registration, and may throw
  68:    * an exception.
  69:    *
  70:    * @throws Exception if something goes wrong during the bean's pre-deregistration
  71:    *                   operation.  The server will re-throw this exception
  72:    *                   as an {@link MBeanRegistrationException}.
  73:    */
  74:   void preDeregister()
  75:     throws Exception;
  76: 
  77:   /**
  78:    * This method is called prior to registration, with a reference to the
  79:    * server and {@link ObjectName} supplied to the server for registration.
  80:    * This method may be used to replace this name by one chosen by the bean.
  81:    * Such behaviour is expected if the supplied name is <code>null</code>,
  82:    * but may occur in all cases.  The method may throw an exception, which
  83:    * will cause registration to be aborted.
  84:    *
  85:    * @param server the server with which the bean is being registered.
  86:    * @param name the name the server was supplied with for registration,
  87:    *             which may be <code>null</code>.
  88:    * @throws Exception if something goes wrong during the bean's pre-registration
  89:    *                   operation.  The server will re-throw this exception
  90:    *                   as an {@link MBeanRegistrationException}.
  91:    */
  92:   ObjectName preRegister(MBeanServer server, ObjectName name)
  93:     throws Exception;
  94: 
  95: }