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<Object>,InitializingBean
public class MBeanProxyFactoryBean extends MBeanClientInterceptor implements FactoryBean<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 Description MBeanProxyFactoryBean()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidafterPropertiesSet()Checks that theproxyInterfacehas been specified and then generates the proxy for the target MBean.ObjectgetObject()Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>getObjectType()Return the type of object that this FactoryBean creates, ornullif not known in advance.booleanisSingleton()Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()always return the same object (a reference that can be cached)?voidsetBeanClassLoader(ClassLoader classLoader)Callback that supplies the beanclass loaderto a bean instance.voidsetProxyInterface(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
Constructor Detail
MBeanProxyFactoryBean
public MBeanProxyFactoryBean()
Method Detail
setProxyInterface
public void setProxyInterface(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.
setBeanClassLoader
public void setBeanClassLoader(ClassLoader classLoader)
Description copied from interface:BeanClassLoaderAwareCallback that supplies the beanclass loaderto a bean instance.Invoked after the population of normal bean properties but before an initialization callback such as
InitializingBean'sInitializingBean.afterPropertiesSet()method or a custom init-method.- Specified by:
setBeanClassLoaderin interfaceBeanClassLoaderAware- Overrides:
setBeanClassLoaderin classMBeanClientInterceptor- Parameters:
classLoader- the owning class loader; may benullin which case a defaultClassLoadermust be used, for example theClassLoaderobtained viaClassUtils.getDefaultClassLoader()
afterPropertiesSet
public void afterPropertiesSet() throws MBeanServerNotFoundException, MBeanInfoRetrievalException
Checks that theproxyInterfacehas been specified and then generates the proxy for the target MBean.- Specified by:
afterPropertiesSetin interfaceInitializingBean- Overrides:
afterPropertiesSetin classMBeanClientInterceptor- Throws:
MBeanServerNotFoundExceptionMBeanInfoRetrievalException
getObject
public Object getObject()
Description copied from interface:FactoryBeanReturn 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
nullobjects. 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:
getObjectin interfaceFactoryBean<Object>- Returns:
- an instance of the bean (can be
null) - See Also:
FactoryBeanNotInitializedException
getObjectType
public Class<?> getObjectType()
Description copied from interface:FactoryBeanReturn the type of object that this FactoryBean creates, ornullif 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
nullhere. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.- Specified by:
getObjectTypein interfaceFactoryBean<Object>- Returns:
- the type of object that this FactoryBean creates, or
nullif not known at the time of the call - See Also:
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
isSingleton
public boolean isSingleton()
Description copied from interface:FactoryBeanIs the object managed by this factory a singleton? That is, willFactoryBean.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 returntrueunless 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
falsedoes not necessarily indicate that returned objects are independent instances. An implementation of the extendedSmartFactoryBeaninterface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()method. PlainFactoryBeanimplementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()implementation returnsfalse.- Specified by:
isSingletonin interfaceFactoryBean<Object>- Returns:
- whether the exposed object is a singleton
- See Also:
FactoryBean.getObject(),SmartFactoryBean.isPrototype()