org.springframework.beans.factory.config

Class MethodInvokingBean

java.lang.Object

org.springframework.util.MethodInvoker

org.springframework.beans.support.ArgumentConvertingMethodInvoker

org.springframework.beans.factory.config.MethodInvokingBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, InitializingBean

Direct Known Subclasses:

MethodInvokingFactoryBean

public class MethodInvokingBean
extends ArgumentConvertingMethodInvoker
implements BeanClassLoaderAware, BeanFactoryAware, InitializingBean

Simple method invoker bean: just invoking a target method, not expecting a result to expose to the container (in contrast to MethodInvokingFactoryBean).

This invoker supports any kind of target method. A static method may be specified by setting the targetMethod property to a String representing the static method name, with targetClass specifying the Class that the static method is defined on. Alternatively, a target instance method may be specified, by setting the targetObject property as the target object, and the targetMethod property as the name of the method to call on that target object. Arguments for the method invocation may be specified by setting the arguments property.

This class depends on afterPropertiesSet() being called once all properties have been set, as per the InitializingBean contract.

An example (in an XML based bean factory definition) of a bean definition which uses this class to call a static initialization method:

 <bean id="myObject" class="org.springframework.beans.factory.config.MethodInvokingBean">
   <property name="staticMethod" value="com.whatever.MyClass.init"/>
 </bean>

An example of calling an instance method to start some server bean:

 <bean id="myStarter" class="org.springframework.beans.factory.config.MethodInvokingBean">
   <property name="targetObject" ref="myServer"/>
   <property name="targetMethod" value="start"/>
 </bean>

Since:

4.0.3

Author:

Juergen Hoeller

See Also:

MethodInvokingFactoryBean, MethodInvoker

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.ClassLoader	beanClassLoader
private ConfigurableBeanFactory	beanFactory

Constructor Summary

Constructors

Constructor and Description
MethodInvokingBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
protected TypeConverter	getDefaultTypeConverter() Obtain the TypeConverter from the BeanFactory that this bean runs in, if possible.
protected java.lang.Object	invokeWithTargetException() Perform the invocation and convert InvocationTargetException into the underlying target exception.
protected java.lang.Class<?>	resolveClassName(java.lang.String className) Resolve the given class name into a Class.
void	setBeanClassLoader(java.lang.ClassLoader classLoader) Callback that supplies the bean class loader to a bean instance.
void	setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.

Methods inherited from class org.springframework.beans.support.ArgumentConvertingMethodInvoker

doFindMatchingMethod, findMatchingMethod, getTypeConverter, registerCustomEditor, setTypeConverter

Methods inherited from class org.springframework.util.MethodInvoker

getArguments, getPreparedMethod, getTargetClass, getTargetMethod, getTargetObject, getTypeDifferenceWeight, invoke, isPrepared, prepare, setArguments, setStaticMethod, setTargetClass, setTargetMethod, setTargetObject

Methods inherited from class java.lang.Object

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

Field Detail

beanClassLoader

private java.lang.ClassLoader beanClassLoader

beanFactory

private ConfigurableBeanFactory beanFactory

Constructor Detail

MethodInvokingBean

public MethodInvokingBean()

Method Detail

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

Parameters:

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

resolveClassName

protected java.lang.Class<?> resolveClassName(java.lang.String className)
                                       throws java.lang.ClassNotFoundException

Description copied from class: MethodInvoker

Resolve the given class name into a Class.

The default implementations uses ClassUtils.forName, using the thread context class loader.

Overrides:

resolveClassName in class MethodInvoker

Parameters:

className - the class name to resolve

Returns:

the resolved Class

Throws:

java.lang.ClassNotFoundException - if the class name was invalid

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Description copied from interface: BeanFactoryAware

Callback that supplies the owning factory to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - owning BeanFactory (never null). The bean can immediately call methods on the factory.

See Also:

BeanInitializationException

getDefaultTypeConverter

protected TypeConverter getDefaultTypeConverter()

Obtain the TypeConverter from the BeanFactory that this bean runs in, if possible.

Overrides:

getDefaultTypeConverter in class ArgumentConvertingMethodInvoker

See Also:

ConfigurableBeanFactory.getTypeConverter()

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Description copied from interface: InitializingBean

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.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

java.lang.Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.

invokeWithTargetException

protected java.lang.Object invokeWithTargetException()
                                              throws java.lang.Exception

Perform the invocation and convert InvocationTargetException into the underlying target exception.

Throws:

java.lang.Exception