Spring Framework

org.springframework.jmx.export.assembler
Class InterfaceBasedMBeanInfoAssembler

java.lang.Object
  extended by org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
      extended by org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
          extended by org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler
              extended by org.springframework.jmx.export.assembler.InterfaceBasedMBeanInfoAssembler
All Implemented Interfaces:
Aware, BeanClassLoaderAware, InitializingBean, MBeanInfoAssembler

public class InterfaceBasedMBeanInfoAssembler
extends AbstractConfigurableMBeanInfoAssembler
implements BeanClassLoaderAware, InitializingBean

Subclass of AbstractReflectiveMBeanInfoAssembler that allows for the management interface of a bean to be defined using arbitrary interfaces. Any methods or properties that are defined in those interfaces are exposed as MBean operations and attributes.

By default, this class votes on the inclusion of each operation or attribute based on the interfaces implemented by the bean class. However, you can supply an array of interfaces via the managedInterfaces property that will be used instead. If you have multiple beans and you wish each bean to use a different set of interfaces, then you can map bean keys (that is the name used to pass the bean to the MBeanExporter) to a list of interface names using the interfaceMappings property.

If you specify values for both interfaceMappings and managedInterfaces, Spring will attempt to find interfaces in the mappings first. If no interfaces for the bean are found, it will use the interfaces defined by managedInterfaces.

Since:
1.2
Author:
Rob Harrop, Juergen Hoeller
See Also:
setManagedInterfaces(java.lang.Class[]), setInterfaceMappings(java.util.Properties), MethodNameBasedMBeanInfoAssembler, SimpleReflectiveMBeanInfoAssembler, MBeanExporter

Field Summary
 
Fields inherited from class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
ATTRIBUTE_OPERATION_VISIBILITY, FIELD_CLASS, FIELD_CURRENCY_TIME_LIMIT, FIELD_DEFAULT, FIELD_DISPLAY_NAME, FIELD_GET_METHOD, FIELD_LOG, FIELD_LOG_FILE, FIELD_METRIC_CATEGORY, FIELD_METRIC_TYPE, FIELD_PERSIST_LOCATION, FIELD_PERSIST_NAME, FIELD_PERSIST_PERIOD, FIELD_PERSIST_POLICY, FIELD_ROLE, FIELD_SET_METHOD, FIELD_UNITS, FIELD_VISIBILITY, ROLE_GETTER, ROLE_OPERATION, ROLE_SETTER
 
Constructor Summary
InterfaceBasedMBeanInfoAssembler()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
protected  boolean includeOperation(java.lang.reflect.Method method, java.lang.String beanKey)
          Check to see if the Method is declared in one of the configured interfaces and that it is public.
protected  boolean includeReadAttribute(java.lang.reflect.Method method, java.lang.String beanKey)
          Check to see if the Method is declared in one of the configured interfaces and that it is public.
protected  boolean includeWriteAttribute(java.lang.reflect.Method method, java.lang.String beanKey)
          Check to see if the Method is declared in one of the configured interfaces and that it is public.
 void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
          Callback that supplies the bean class loader to a bean instance.
 void setInterfaceMappings(java.util.Properties mappings)
          Set the mappings of bean keys to a comma-separated list of interface names.
 void setManagedInterfaces(java.lang.Class[] managedInterfaces)
          Set the array of interfaces to use for creating the management info.
 
Methods inherited from class org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler
getNotificationInfo, setNotificationInfoMappings, setNotificationInfos
 
Methods inherited from class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
applyCurrencyTimeLimit, applyDefaultCurrencyTimeLimit, createModelMBeanOperationInfo, getAttributeDescription, getAttributeInfo, getClassForDescriptor, getDefaultCurrencyTimeLimit, getOperationDescription, getOperationInfo, getOperationParameters, isExposeClassDescriptor, isUseStrictCasing, populateAttributeDescriptor, populateMBeanDescriptor, populateOperationDescriptor, setDefaultCurrencyTimeLimit, setExposeClassDescriptor, setUseStrictCasing
 
Methods inherited from class org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
checkManagedBean, getClassName, getClassToExpose, getClassToExpose, getConstructorInfo, getDescription, getMBeanInfo, getTargetClass
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InterfaceBasedMBeanInfoAssembler

public InterfaceBasedMBeanInfoAssembler()
Method Detail

setManagedInterfaces

public void setManagedInterfaces(java.lang.Class[] managedInterfaces)
Set the array of interfaces to use for creating the management info. These interfaces will be used for a bean if no entry corresponding to that bean is found in the interfaceMappings property.

Parameters:
managedInterfaces - an array of classes indicating the interfaces to use. Each entry MUST be an interface.
See Also:
setInterfaceMappings(java.util.Properties)

setInterfaceMappings

public void setInterfaceMappings(java.util.Properties mappings)
Set the mappings of bean keys to a comma-separated list of interface names.

The property key should match the bean key and the property value should match the list of interface names. When searching for interfaces for a bean, Spring will check these mappings first.

Parameters:
mappings - the mappins of bean keys to interface names

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
Description copied from interface: BeanClassLoaderAware
Callback that supplies the bean class loader to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean.afterPropertiesSet() method or a custom init-method.

Specified by:
setBeanClassLoader in interface BeanClassLoaderAware
Parameters:
beanClassLoader - the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via ClassUtils.getDefaultClassLoader()

afterPropertiesSet

public void afterPropertiesSet()
Description copied from interface: InitializingBean
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:
afterPropertiesSet in interface InitializingBean

includeReadAttribute

protected boolean includeReadAttribute(java.lang.reflect.Method method,
                                       java.lang.String beanKey)
Check to see if the Method is declared in one of the configured interfaces and that it is public.

Specified by:
includeReadAttribute in class AbstractReflectiveMBeanInfoAssembler
Parameters:
method - the accessor Method.
beanKey - the key associated with the MBean in the beans Map.
Returns:
true if the Method is declared in one of the configured interfaces, otherwise false.

includeWriteAttribute

protected boolean includeWriteAttribute(java.lang.reflect.Method method,
                                        java.lang.String beanKey)
Check to see if the Method is declared in one of the configured interfaces and that it is public.

Specified by:
includeWriteAttribute in class AbstractReflectiveMBeanInfoAssembler
Parameters:
method - the mutator Method.
beanKey - the key associated with the MBean in the beans Map.
Returns:
true if the Method is declared in one of the configured interfaces, otherwise false.

includeOperation

protected boolean includeOperation(java.lang.reflect.Method method,
                                   java.lang.String beanKey)
Check to see if the Method is declared in one of the configured interfaces and that it is public.

Specified by:
includeOperation in class AbstractReflectiveMBeanInfoAssembler
Parameters:
method - the operation Method.
beanKey - the key associated with the MBean in the beans Map.
Returns:
true if the Method is declared in one of the configured interfaces, otherwise false.

Spring Framework