Spring Context 6.1.4 · org.springframework.jmx.access.MBeanProxyFactoryBean

public Class MBeanProxyFactoryBean

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.

Modifier and Type	Field and Description
private ClassLoader	beanClassLoader Hides org.springframework.jmx.access.MBeanClientInterceptor.beanClassLoader.
private Object	mbeanProxy
private Class<?>	proxyInterface

Modifier and Type

Field and Description

private ClassLoader

beanClassLoader

Hides org.springframework.jmx.access.MBeanClientInterceptor.beanClassLoader.

private Object

mbeanProxy

private Class<?>

proxyInterface

Constructor Summary

Access	Constructor and Description
public	MBeanProxyFactoryBean()

Modifier and Type	Method and Description
public void	afterPropertiesSet() Overrides org.springframework.jmx.access.MBeanClientInterceptor.afterPropertiesSet. Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Checks that the `proxyInterface` has been specified and then generates the proxy for the target MBean.
public Object	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<?>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
public void	setBeanClassLoader(ClassLoader the owning class loader classLoader) Overrides org.springframework.jmx.access.MBeanClientInterceptor.setBeanClassLoader. Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Callback that supplies the bean `class loader` to a bean instance.
public void	setProxyInterface(Class<?> proxyInterface) Set the interface that the generated proxy will implement.

Modifier and Type

Method and Description

public void

afterPropertiesSet()

Overrides org.springframework.jmx.access.MBeanClientInterceptor.afterPropertiesSet.

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

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

public Object

getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

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

public Class<?>

getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

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

public boolean

isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton?

public void

setBeanClassLoader(ClassLoader

the owning class loader

classLoader)

Overrides org.springframework.jmx.access.MBeanClientInterceptor.setBeanClassLoader.

Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

Callback that supplies the bean class loader to a bean instance.

public void

setProxyInterface(Class<?> proxyInterface)

Set the interface that the generated proxy will implement.

beanClassLoader	back to summary
private ClassLoader beanClassLoader Hides org.springframework.jmx.access.MBeanClientInterceptor.beanClassLoader. Annotations @Nullable

beanClassLoader

back to summary

private ClassLoader beanClassLoader

Hides org.springframework.jmx.access.MBeanClientInterceptor.beanClassLoader.

Annotations

@Nullable

mbeanProxy	back to summary
private Object mbeanProxy Annotations @Nullable

mbeanProxy

back to summary

private Object mbeanProxy

Annotations

@Nullable

proxyInterface	back to summary
private Class<?> proxyInterface Annotations @Nullable

proxyInterface

back to summary

private Class<?> proxyInterface

Annotations

@Nullable

Constructor Detail

MBeanProxyFactoryBean	back to summary
public MBeanProxyFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() throws MBeanServerNotFoundException, MBeanInfoRetrievalException Overrides org.springframework.jmx.access.MBeanClientInterceptor.afterPropertiesSet. Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Checks that the `proxyInterface` has been specified and then generates the proxy for the target MBean. Annotations @Override

public void afterPropertiesSet() throws MBeanServerNotFoundException, MBeanInfoRetrievalException

Overrides org.springframework.jmx.access.MBeanClientInterceptor.afterPropertiesSet.

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

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

Annotations

@Override

getObject back to summary

getObject	back to summary
public Object getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. 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. Returns:Object an instance of the bean (can be `null`) Annotations @Override @Nullable

public Object getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

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.

Returns:Object

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<?> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. 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. Returns:Class<?> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<?> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

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.

Returns:Class<?>

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

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `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. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will 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.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

setBeanClassLoader back to summary

setBeanClassLoader	back to summary
public void setBeanClassLoader(ClassLoader classLoader) Overrides org.springframework.jmx.access.MBeanClientInterceptor.setBeanClassLoader. Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. 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. Parameters classLoader:ClassLoader the owning class loader Annotations @Override

public void setBeanClassLoader(ClassLoader classLoader)

Overrides org.springframework.jmx.access.MBeanClientInterceptor.setBeanClassLoader.

Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

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.

Parameters

classLoader:ClassLoader: the owning class loader

Annotations

@Override

setProxyInterface back to summary

setProxyInterface	back to summary
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. See Also `setObjectName`

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.

See Also: setObjectName

public Class MBeanProxyFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail