User: ejort
Date: 01/12/15 09:47:15
Modified: src/main/javax/management MBeanRegistration.java
Log:
More javadoc
Revision Changes Path
1.2 +69 -12 jmx/src/main/javax/management/MBeanRegistration.java
Index: MBeanRegistration.java
===================================================================
RCS file: /cvsroot/jboss/jmx/src/main/javax/management/MBeanRegistration.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MBeanRegistration.java 2001/12/03 01:42:58 1.1
+++ MBeanRegistration.java 2001/12/15 17:47:15 1.2
@@ -1,20 +1,77 @@
/*
- * LGPL
+ * JBoss, the OpenSource J2EE webOS
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
*/
package javax.management;
-public interface MBeanRegistration {
-
- public ObjectName preRegister(MBeanServer server,
- ObjectName name)
- throws java.lang.Exception;
-
- public void postRegister(java.lang.Boolean registrationDone);
-
+/**
+ * This interface is implemented by an MBean that wants to perform
+ * operations pre and post registration and deregistration.<p>
+ *
+ * The preRegister method is called by the MBeanServer before registration.<p>
+ *
+ * The postRegister method is called by the MBeanServer after registration.<p>
+ *
+ * The preDeregister method is called by the MBeanServer before deregistration.<p>
+ *
+ * The postDeregister method is called by the MBeanServer after deregistration.<p>
+ *
+ * @author <a href="mailto:[EMAIL PROTECTED]";>Adrian Brock</a>.
+ * @version $Revision: 1.2 $
+ *
+ */
+public interface MBeanRegistration
+{
+ // Constants ---------------------------------------------------
+
+ // Public ------------------------------------------------------
+
+ /**
+ * This method is called by the MBeanServer before registration takes
+ * place. The MBean is passed a reference of the MBeanServer it is
+ * about to be registered with. The MBean must return the ObjectName it
+ * will be registered with. The MBeanServer can pass a suggested object
+ * depending upon how the MBean is registered.<p>
+ *
+ * The MBean can stop the registration by throwing an exception.The
+ * exception is forwarded to the invoker wrapped in an
+ * MBeanRegistrationException.
+ *
+ * @param MBeanServer the MBeanServer the MBean is about to be
+ * registered with.
+ * @param ObjectName the suggested ObjectName supplied by the
+ * MBeanServer.
+ * @return the actual ObjectName to register this MBean with.
+ * @exception Exception for any error, the MBean is not registered.
+ */
+ public ObjectName preRegister(MBeanServer server, ObjectName name)
+ throws Exception;
+
+ /**
+ * This method is called by the MBeanServer after registration takes
+ * place or when registration fails.
+ *
+ * @param registrationDone the MBeanServer passes true when the
+ * MBean was registered, false otherwise.
+ */
+ public void postRegister(Boolean registrationDone);
+
+ /**
+ * This method is called by the MBeanServer before deregistration takes
+ * place.<p>
+ *
+ * The MBean can throw an exception, but this will not stop
+ * deregistration. The exception is forwarded to the invoker wrapped in
+ * an MBeanRegistrationException.
+ */
public void preDeregister()
- throws java.lang.Exception;
+ throws Exception;
+ /**
+ * This method is called by the MBeanServer after deregistration takes
+ * place.
+ */
public void postDeregister();
-
-
}
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/jboss-development
