org.springframework.jmx.access
Class MBeanProxyFactoryBean

java.lang.Object
  extended by org.springframework.jmx.access.MBeanClientInterceptor
      extended by org.springframework.jmx.access.MBeanProxyFactoryBean
All Implemented Interfaces:
Advice, Interceptor, MethodInterceptor, DisposableBean, FactoryBean, InitializingBean

public class MBeanProxyFactoryBean
extends MBeanClientInterceptor
implements FactoryBean, InitializingBean

Creates a proxy to a managed resource running either locally or remotely. The proxyInterface property defines the interface that the generated proxy should 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
MBeanProxyFactoryBean()
           
 
Method Summary
 void afterPropertiesSet()
          Checks that the proxyInterface has been specified and then generates the proxy for the target MBean.
 Object getObject()
          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, or null if not known in advance.
 boolean isSingleton()
          Is the bean managed by this factory a singleton or a prototype?
 void setProxyInterface(Class managementInterface)
          Set the interface that the generated proxy will implement.
 
Methods inherited from class org.springframework.jmx.access.MBeanClientInterceptor
destroy, invoke, setConnectOnStartup, setObjectName, 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(Class managementInterface)
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.String)

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

public 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 method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:
getObject in interface FactoryBean
Returns:
an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)
See Also:
FactoryBeanNotInitializedException

getObjectType

public 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 to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this 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
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)

isSingleton

public boolean isSingleton()
Description copied from interface: FactoryBean
Is the bean managed by this factory a singleton or a prototype? 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.

Specified by:
isSingleton in interface FactoryBean
Returns:
if this bean is a singleton
See Also:
FactoryBean.getObject()


Copyright (c) 2002-2006 The Spring Framework Project.