*
* The interceptor is registered under the
* {@link org.jboss.mx.service.ServiceConstants#JBOSSMX_DOMAIN JBOSSMX_DOMAIN}
* name. An interceptor's object name contains a type property and
* a name property. Property type always contains string
* 'Interceptor' as its value. Interceptor's name is used as a value
* for the name property. Therefore, an interceptor created with
* name 'Bart' can be found from the MBean server under object name:
*
* {@link org.jboss.mx.service.ServiceConstants#JBOSSMX_DOMAIN JBOSSMX_DOMAIN}:type=Interceptor,name=Bart,*
*
*
*
* If the log reference has not been set for this interceptor when it is
* registered, this implementation will register a log MBean via the system
* log manager under {@link org.jboss.mx.service.ServiceConstants#JBOSSMX_DOMAIN JBOSSMX}
* domain (see {@link org.jboss.mx.logging.SystemLogManager SystemLogManager}
* for details). The log instance's name will match the pattern:
*
* "JBossMX.Interceptor.<interceptor name>"
*
*
*
* @param server MBean server where this shared interceptor is registered
*/
public synchronized ObjectName register(MBeanServer server)
throws InterceptorNameConflictException
{
// store MBean server reference
this.server = server;
// check if log instance has been set
if (log == null)
log = Logger.getLogger("JBossMX.Interceptor." + name);
try
{
// store the object name for later use
objectName = createObjectName();
// query the server for this name
Set names = server.queryNames(objectName, null /* NO QUERY EXPR. */);
// if the query returns a non empty set, throw an exception
if (names.size() > 0)
throw new InterceptorNameConflictException(
"A shared interceptor named '" + name + "' already registered " +
"to this MBean server (" + AgentID.get(server) + ")"
);
// register the interceptor to server
ModelMBean rmm = RequiredModelMBeanInstantiator.instantiate();
rmm.setManagedResource(this, ModelMBeanConstants.OBJECT_REF);
rmm.setModelMBeanInfo(getManagementInterface());
server.registerMBean(rmm, objectName);
// mark the interceptor as shared
isShared = true;
}
catch (InstanceAlreadyExistsException e)
{
// we already checked that the instance doesn't exist with a query,
// however it is possible it was created by another thread before we
// actually had a chance to register
throw new InterceptorNameConflictException(
"A shared interceptor named '" + name + "' already registered " +
"to this MBean server (" + AgentID.get(server) + ")"
);
}
catch (Exception e)
{
// anything else indicates there's something much more wrong if
// we can't register a simple MBean, so just log an error
if (log != null)
log.error(e.toString(), e);
}
return objectName;
}
/**
* This method is part of the interceptor MBean's registration lifecycle.
* It is called before the MBean is registered to the server. Concrete
* interceptor implementations can override this method to provide
* initialization code that should be executed before the interceptor
* is registered. * * Any exception that is propagated from this method to its caller will * cancel the interceptor registration. * * @throws Exception if you want to cancel the interceptor registration */ public void init() throws Exception {} /** * This method is part of the interceptor MBean's registration lifecycle. * It is called after the MBean is registered to the server. Concrete * interceptor implementations can override this method to provide * initialization code that should be executed once the MBean server and * object name references for this interceptor have been resolved. */ public void start() {} /** * This method is part of the interceptor MBean's registration lifecycle. * It is called before the MBean is unregistered from the server. Concrete * interceptor implementations can override this method to provide * cleanup code that should be executed before the interceptor is * unregistered.
*
* Any exception that is propagated from this method to its caller will
* cancel the interceptor unregistration.
*
* @throws Exception if you want to cancel the interceptor unregistration
*/
public void stop() throws Exception {}
/**
* This method is part of the interceptor MBean's registration lifecycle.
* It is called after the MBean has been unregistered from the server. Concrete
* interceptor implementations can override this method to provide
* cleanup code that should be executed once the interceptor is no longer
* registered to the MBean server.
*/
public void destroy() {}
// MBeanRegistration implementation ------------------------------
public ObjectName preRegister(MBeanServer server, ObjectName oname) throws Exception
{
this.server = server;
if (oname == null)
this.objectName = createObjectName();
else
this.objectName = oname;
init();
return objectName;
}
public void postRegister(Boolean registrationSuccesful) {
isShared = true;
start();
}
public void preDeregister() throws Exception {
stop();
isShared = false;
objectName = null;
}
public void postDeregister() {
destroy();
}
// AbstractInterceptor overrides ---------------------------------
/**
* Shared interceptors allows their name to be set only before they have
* been registered to the MBean server. After that the name is fixed and
* any attempt to invoke this method to change the name will yield a
* IllegalArgumentException.
*
* @param name name of this shared interceptor
*
* @throws IllegalArgumentException if there was an attempt to change the
* name after the interceptor had been registered to the server
*/
public synchronized void setName(String name)
{
if (isShared())
throw new IllegalArgumentException("Cannot change the interceptor name. Already registered.");
this.name = name;
}
// Object overrides ----------------------------------------------
/**
* Returns a string representation of this interceptor instance.
*
* @return string representation
*/
public String toString()
{
String className = getClass().getName();
int index = className.lastIndexOf('.');
return className.substring((index < 0) ? 0 : index) + "[" +
"name=" + name + "SHARED " + objectName + "]";
}
// Protected -----------------------------------------------------
/**
* Creates an object name for this interceptor. The object name contains a
* type property and a name property. Property type
* always contains string 'Interceptor' as its value. Interceptor's
* name is used as a value for the name property. Therefore, an
* interceptor created with name 'Bart' will generate an object name
* matching to pattern:
*
* {@link org.jboss.mx.service.ServiceConstants#JBOSSMX_DOMAIN JBOSSMX_DOMAIN}:type=Interceptor,name=Bart,*
*
*
*
* @return generated object name for this interceptor
*
* @throws MalformedObjectNameException if the object name could not be
* created
*/
protected ObjectName createObjectName() throws MalformedObjectNameException
{
// create the object name for this shared interceptor
Hashtable props = new Hashtable(2);
props.put("type", "Interceptor");
props.put("name", name);
props.put("ID", "0");
return new ObjectName(ServiceConstants.JBOSSMX_DOMAIN, props);
}
// Private -------------------------------------------------------
private ModelMBeanInfo getManagementInterface()
{
return new ModelMBeanInfoSupport(
this.getClass().getName(), // resource object class name
"Interceptor invocation interface", // description of the MBean
null, // attributes
null, // constructors
new ModelMBeanOperationInfo[] // operations
{
new ModelMBeanOperationInfo(
"invoke", // name
"Shared interceptor invoke operation.", // description
new MBeanParameterInfo[] // arguments
{
new MBeanParameterInfo(
"invocation", // name
Invocation.class.getName(), // type
"The invocation object." // description
)
},
Object.class.getName(), // return type
MBeanOperationInfo.ACTION_INFO // impact
)
},
null // notifications
);
}
}