org.springframework.jmx.access

Class MBeanProxyFactoryBean

java.lang.Object

org.springframework.jmx.access.MBeanClientInterceptor

org.springframework.jmx.access.MBeanProxyFactoryBean

All Implemented Interfaces:

Advice, Interceptor, MethodInterceptor, Aware, BeanClassLoaderAware, DisposableBean, FactoryBean<java.lang.Object>, InitializingBean

public class MBeanProxyFactoryBean
extends MBeanClientInterceptor
implements FactoryBean<java.lang.Object>, BeanClassLoaderAware, InitializingBean

Creates a proxy to a managed resource running either locally or remotely. The "proxyInterface" property defines the interface that the generated proxy is supposed to implement. This interface should define methods and properties that correspond to operations and attributes in the management interface of the resource you wish to proxy.

There is no need for the managed resource to implement the proxy interface, although you may find it convenient to do. It is not required that every operation and attribute in the management interface is matched by a corresponding property or method in the proxy interface.

Attempting to invoke or access any method or property on the proxy interface that does not correspond to the management interface will lead to an InvalidInvocationException.

Since:

1.2

Author:

Rob Harrop, Juergen Hoeller

See Also:

MBeanClientInterceptor, InvalidInvocationException

Field Summary

Fields inherited from class org.springframework.jmx.access.MBeanClientInterceptor

logger

Constructor Summary

Constructors

Constructor and Description
MBeanProxyFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Checks that the proxyInterface has been specified and then generates the proxy for the target MBean.
java.lang.Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
java.lang.Class<?>	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?
void	setBeanClassLoader(java.lang.ClassLoader classLoader) Callback that supplies the bean class loader to a bean instance.
void	setProxyInterface(java.lang.Class<?> proxyInterface) Set the interface that the generated proxy will implement.

Methods inherited from class org.springframework.jmx.access.MBeanClientInterceptor

convertResultValueIfNecessary, destroy, doInvoke, getEnvironment, getManagementInterface, handleConnectFailure, invoke, isPrepared, prepare, setAgentId, setConnectOnStartup, setEnvironment, setManagementInterface, setObjectName, setRefreshOnConnectFailure, setServer, setServiceUrl, setUseStrictCasing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MBeanProxyFactoryBean

public MBeanProxyFactoryBean()

Method Detail

setProxyInterface

public void setProxyInterface(java.lang.Class<?> proxyInterface)

Set the interface that the generated proxy will implement.

This will usually be a management interface that matches the target MBean, exposing bean property setters and getters for MBean attributes and conventional Java methods for MBean operations.

See Also:

MBeanClientInterceptor.setObjectName(java.lang.Object)

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

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

Overrides:

setBeanClassLoader in class MBeanClientInterceptor

Parameters:

classLoader - the owning class loader

afterPropertiesSet

public void afterPropertiesSet()
                        throws MBeanServerNotFoundException,
                               MBeanInfoRetrievalException

Checks that the proxyInterface has been specified and then generates the proxy for the target MBean.

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class MBeanClientInterceptor

Throws:

MBeanServerNotFoundException

MBeanInfoRetrievalException

getObject

@Nullable
public java.lang.Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Specified by:

getObject in interface FactoryBean<java.lang.Object>

Returns:

an instance of the bean (can be null)

See Also:

FactoryBeanNotInitializedException

getObjectType

public java.lang.Class<?> getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Specified by:

getObjectType in interface FactoryBean<java.lang.Object>

Returns:

the type of object that this FactoryBean creates, or null if not known at the time of the call

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class<T>)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Specified by:

isSingleton in interface FactoryBean<java.lang.Object>

Returns:

whether the exposed object is a singleton

See Also:

FactoryBean.getObject(), SmartFactoryBean.isPrototype()