public class

InterfaceBasedMBeanInfoAssembler

extends AbstractConfigurableMBeanInfoAssembler
implements BeanClassLoaderAware InitializingBean
java.lang.Object
   ↳ org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
     ↳ org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
       ↳ org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler
         ↳ org.springframework.jmx.export.assembler.InterfaceBasedMBeanInfoAssembler

Class Overview

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.

See Also

Summary

[Expand]
Inherited Constants
From class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
Public Constructors
InterfaceBasedMBeanInfoAssembler()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void setBeanClassLoader(ClassLoader beanClassLoader)
Callback that supplies the bean class loader to a bean instance.
void setInterfaceMappings(Properties mappings)
Set the mappings of bean keys to a comma-separated list of interface names.
void setManagedInterfaces(Class[] managedInterfaces)
Set the array of interfaces to use for creating the management info.
Protected Methods
boolean includeOperation(Method method, String beanKey)
Check to see if the Method is declared in one of the configured interfaces and that it is public.
boolean includeReadAttribute(Method method, String beanKey)
Check to see if the Method is declared in one of the configured interfaces and that it is public.
boolean includeWriteAttribute(Method method, String beanKey)
Check to see if the Method is declared in one of the configured interfaces and that it is public.
[Expand]
Inherited Methods
From class org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler
From class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
From class org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
From class java.lang.Object
From interface org.springframework.beans.factory.BeanClassLoaderAware
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.jmx.export.assembler.MBeanInfoAssembler

Public Constructors

public InterfaceBasedMBeanInfoAssembler ()

Public Methods

public void afterPropertiesSet ()

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.

public void setBeanClassLoader (ClassLoader beanClassLoader)

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 afterPropertiesSet() method or a custom init-method.

Parameters
beanClassLoader the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via getDefaultClassLoader()

public void setInterfaceMappings (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

public void setManagedInterfaces (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

Protected Methods

protected boolean includeOperation (Method method, String beanKey)

Check to see if the Method is declared in one of the configured interfaces and that it is public.

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.

protected boolean includeReadAttribute (Method method, String beanKey)

Check to see if the Method is declared in one of the configured interfaces and that it is public.

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.

protected boolean includeWriteAttribute (Method method, String beanKey)

Check to see if the Method is declared in one of the configured interfaces and that it is public.

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.