Save This Page
Home » spring-framework-2.5.4 » org.springframework » beans » factory » config » [javadoc | source]
org.springframework.beans.factory.config
public class: ObjectFactoryCreatingFactoryBean [javadoc | source]
java.lang.Object
   org.springframework.beans.factory.config.AbstractFactoryBean
      org.springframework.beans.factory.config.ObjectFactoryCreatingFactoryBean

All Implemented Interfaces:
    DisposableBean, BeanFactoryAware, InitializingBean, FactoryBean

A org.springframework.beans.factory.FactoryBean implementation that returns a value which is an org.springframework.beans.factory.ObjectFactory that in turn returns a bean sourced from a org.springframework.beans.factory.BeanFactory .

As such, this may be used to avoid having a client object directly calling org.springframework.beans.factory.BeanFactory#getBean(String) to get a (typically prototype) bean from a org.springframework.beans.factory.BeanFactory , which would be a violation of the inversion of control principle. Instead, with the use of this class, the client object can be fed an org.springframework.beans.factory.ObjectFactory instance as a property which directly returns only the one target bean (again, which is typically a prototype bean).

A sample config in an XML-based org.springframework.beans.factory.BeanFactory might look as follows:

<beans>

<!-- 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>

<bean id="clientBean" class="a.b.c.MyClientBean">
<property name="myServiceFactory" ref="myServiceFactory"/>
</bean>

</beans>

The attendant MyClientBean class implementation might look something like this:

package a.b.c;

import org.springframework.beans.factory.ObjectFactory;

public class MyClientBean {

private ObjectFactory myServiceFactory;

public void setMyServiceFactory(ObjectFactory myServiceFactory) {
this.myServiceFactory = myServiceFactory;
}

public void someBusinessMethod() {
// get a 'fresh', brand new MyService instance
MyService service = this.myServiceFactory.getObject();
// use the service object to effect the business logic...
}
}

An alternate approach to this application of an object creational pattern would be to use the ServiceLocatorFactoryBean to source (prototype) beans. The ServiceLocatorFactoryBean approach has the advantage of the fact that one doesn't have to depend on any Spring-specific interface such as org.springframework.beans.factory.ObjectFactory , but has the disadvantage of requiring runtime class generation. Please do consult the ServiceLocatorFactoryBean JavaDoc for a fuller discussion of this issue.

Fields inherited from org.springframework.beans.factory.config.AbstractFactoryBean:
logger
Method from org.springframework.beans.factory.config.ObjectFactoryCreatingFactoryBean Summary:
afterPropertiesSet,   createInstance,   getObjectType,   getTargetBean,   setTargetBeanName
Methods from org.springframework.beans.factory.config.AbstractFactoryBean:
afterPropertiesSet,   createInstance,   destroy,   destroyInstance,   getBeanFactory,   getBeanTypeConverter,   getEarlySingletonInterfaces,   getObject,   getObjectType,   isSingleton,   setBeanFactory,   setSingleton
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.beans.factory.config.ObjectFactoryCreatingFactoryBean Detail:
 public  void afterPropertiesSet() throws Exception 
 protected Object createInstance() 
 public Class getObjectType() 
 protected Object getTargetBean(String targetBeanName) 
    Template method for obtaining a target bean instance. Called by the exposed ObjectFactory's getObject() method.
 public  void setTargetBeanName(String targetBeanName) 
    Set the name of the target bean.

    The target does not have to be a prototype bean, but realisticially always will be (because if the target bean were a singleton, then said singleton bean could simply be injected straight into the dependent object, thus obviating the need for the extra level of indirection afforded by the approach encapsulated by this class). Please note that no exception will be thrown if the supplied targetBeanName does not reference a prototype bean.