Class ObjectFactoryCreatingFactoryBean

  extended by org.springframework.beans.factory.config.AbstractFactoryBean
      extended by org.springframework.beans.factory.config.ObjectFactoryCreatingFactoryBean
All Implemented Interfaces:
BeanFactoryAware, FactoryBean, InitializingBean

public class ObjectFactoryCreatingFactoryBean
extends AbstractFactoryBean
implements BeanFactoryAware

FactoryBean which returns a value which is an ObjectFactory that returns a bean from the BeanFactory. As such, this may be used to avoid having a client bean directly calling getBean() the BeanFactory to get a prototype bean out of the BeanFactory, a violation of inversion of control. Instead, with the use of this class, the client bean can be fed an ObjectFactory as a property which directly returns only the one target (usually prototype) bean.

A Sample config in an XML BeanFactory might look as follows:


   <!-- Prototype bean since we have state -->
   <bean id="myService" class="a.b.c.MyService" singleton="false">
   <bean id="myServiceFactory" class="org.springframework.beans.factory.config.ObjectFactoryCreatingFactoryBean">
     <property name="targetBeanName"><idref local="myService"/></property>
   <bean id="clientBean" class="a.b.c.MyClientBean">
     <property name="myServiceFactory"><ref local="myServiceFactory"/></property>


Colin Sampaleanu
See Also:

Field Summary
Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
Constructor Summary
Method Summary
protected  Object createInstance()
          Template method that subclasses must override to construct the object returned by this factory.
 Class getObjectType()
          Return the type of object that this FactoryBean creates, or null if not known in advance.
 void setBeanFactory(BeanFactory beanFactory)
          Callback that supplies the owning factory to a bean instance.
 void setTargetBeanName(String targetBeanName)
          Set the name of the target bean.
Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
afterPropertiesSet, getObject, isSingleton, setSingleton
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public ObjectFactoryCreatingFactoryBean()
Method Detail


public void setTargetBeanName(String targetBeanName)
Set the name of the target bean. The target has to be a prototype bean.


public void setBeanFactory(BeanFactory beanFactory)
Description copied from interface: BeanFactoryAware
Callback that supplies the owning factory to a bean instance.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method.

Specified by:
setBeanFactory in interface BeanFactoryAware
beanFactory - owning BeanFactory (may not be null). The bean can immediately call methods on the factory.
See Also:


protected Object createInstance()
Description copied from class: AbstractFactoryBean
Template method that subclasses must override to construct the object returned by this factory.

Invoked on initialization of this FactoryBean in case of a singleton; else, on each getObject() call.

Specified by:
createInstance in class AbstractFactoryBean
the object returned by this factory
See Also:


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
the type of object that this FactoryBean creates, or null if not known at the time of the call
See Also:

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