javax.management
Interface MBeanRegistration

All Known Subinterfaces:

MBeanInvoker, SharedInterceptor

All Known Implementing Classes:

AbstractMBeanInvoker, AbstractSharedInterceptor, CounterMonitor, GaugeMonitor, HeirarchicalLoaderRepository3, MLet, ModelMBeanInvoker, Monitor, PrivateMLet, RawDynamicInvoker, RelationService, RelationSupport, RequiredModelMBean, RequiredModelMBeanInvoker, StringMonitor, Timer, UnifiedLoaderRepository3, XMBean

public interface MBeanRegistration

This interface is implemented by an MBean that wants to perform operations pre and post registration and deregistration.

The preRegister method is called by the MBeanServer before registration.

The postRegister method is called by the MBeanServer after registration.

The preDeregister method is called by the MBeanServer before deregistration.

The postDeregister method is called by the MBeanServer after deregistration.

Version:

$Revision: 1.3.30.1 $

Author:

Adrian Brock.

Method Summary

void	postDeregister() This method is called by the MBeanServer after deregistration takes place.
void	postRegister(Boolean registrationDone) This method is called by the MBeanServer after registration takes place or when registration fails.
void	preDeregister() This method is called by the MBeanServer before deregistration takes place.
ObjectName	preRegister(MBeanServer server, ObjectName name) This method is called by the MBeanServer before registration takes place.

Method Detail

preRegister

ObjectName preRegister(MBeanServer server,
                       ObjectName name)
                       throws Exception

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.

The MBean can stop the registration by throwing an exception.The exception is forwarded to the invoker wrapped in an MBeanRegistrationException.

Parameters:

MBeanServer - the MBeanServer the MBean is about to be registered with.

ObjectName - the suggested ObjectName supplied by the MBeanServer.

Returns:

the actual ObjectName to register this MBean with.

Throws:

Exception - for any error, the MBean is not registered.

postRegister

void postRegister(Boolean registrationDone)

This method is called by the MBeanServer after registration takes place or when registration fails.

Parameters:

registrationDone - the MBeanServer passes true when the MBean was registered, false otherwise.

preDeregister

void preDeregister()
                   throws Exception

This method is called by the MBeanServer before deregistration takes place.

The MBean can throw an exception, this will stop the deregistration. The exception is forwarded to the invoker wrapped in an MBeanRegistrationException.

Throws:

Exception

postDeregister

void postDeregister()

This method is called by the MBeanServer after deregistration takes place.