001/* MBeanRegistration.java -- Interface for beans to hook into registration. 002 Copyright (C) 2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.management; 039 040/** 041 * Beans may implement this interface in order to perform 042 * operations immediately prior to or after their registration 043 * or deregistration. 044 * 045 * @author Andrew John Hughes (gnu_andrew@member.fsf.org) 046 * @since 1.5 047 */ 048public interface MBeanRegistration 049{ 050 051 /** 052 * This method is called following deregistration of the bean 053 * by the server. 054 */ 055 void postDeregister(); 056 057 /** 058 * This method is called following both successful and unsuccessful 059 * attempts to register the bean. The supplied boolean value indicates 060 * the result of the attempt relative to this call. 061 * 062 * @param successful true if the registration was successful. 063 */ 064 void postRegister(Boolean successful); 065 066 /** 067 * This method is called prior to de-registration, and may throw 068 * an exception. 069 * 070 * @throws Exception if something goes wrong during the bean's pre-deregistration 071 * operation. The server will re-throw this exception 072 * as an {@link MBeanRegistrationException}. 073 */ 074 void preDeregister() 075 throws Exception; 076 077 /** 078 * This method is called prior to registration, with a reference to the 079 * server and {@link ObjectName} supplied to the server for registration. 080 * This method may be used to replace this name by one chosen by the bean. 081 * Such behaviour is expected if the supplied name is <code>null</code>, 082 * but may occur in all cases. The method may throw an exception, which 083 * will cause registration to be aborted. 084 * 085 * @param server the server with which the bean is being registered. 086 * @param name the name the server was supplied with for registration, 087 * which may be <code>null</code>. 088 * @throws Exception if something goes wrong during the bean's pre-registration 089 * operation. The server will re-throw this exception 090 * as an {@link MBeanRegistrationException}. 091 */ 092 ObjectName preRegister(MBeanServer server, ObjectName name) 093 throws Exception; 094 095}