com.opensymphony.xwork2.spring
Class SpringObjectFactory

java.lang.Object
  extended by com.opensymphony.xwork2.ObjectFactory
      extended by com.opensymphony.xwork2.spring.SpringObjectFactory
All Implemented Interfaces:
Serializable, org.springframework.context.ApplicationContextAware
Direct Known Subclasses:
SpringProxyableObjectFactory

public class SpringObjectFactory
extends ObjectFactory
implements org.springframework.context.ApplicationContextAware

Simple implementation of the ObjectFactory that makes use of Spring's application context if one has been configured, before falling back on the default mechanism of instantiating a new class using the class name.

In order to use this class in your application, you will need to instantiate a copy of this class and set it as XWork's ObjectFactory before the xwork.xml file is parsed. In a servlet environment, this could be done using a ServletContextListener.

Author:
Simon Stewart (sms@lateral.net)
See Also:
Serialized Form

Field Summary
private  boolean alwaysRespectAutowireStrategy
           
protected  org.springframework.context.ApplicationContext appContext
           
protected  int autowireStrategy
           
protected  org.springframework.beans.factory.config.AutowireCapableBeanFactory autoWiringFactory
           
private  Map<String,Object> classes
           
private static Logger LOG
           
private  boolean useClassCache
           
 
Fields inherited from class com.opensymphony.xwork2.ObjectFactory
reflectionProvider
 
Constructor Summary
SpringObjectFactory()
           
 
Method Summary
 Object autoWireBean(Object bean)
           
 Object autoWireBean(Object bean, org.springframework.beans.factory.config.AutowireCapableBeanFactory autoWiringFactory)
           
 Object buildBean(Class clazz, Map<String,Object> extraContext)
          Build a generic Java object of the given type.
 Object buildBean(String beanName, Map<String,Object> extraContext, boolean injectInternal)
          Looks up beans using Spring's application context before falling back to the method defined in the ObjectFactory.
protected  org.springframework.beans.factory.config.AutowireCapableBeanFactory findAutoWiringBeanFactory(org.springframework.context.ApplicationContext context)
          If the given context is assignable to AutowireCapbleBeanFactory or contains a parent or a factory that is, then set the autoWiringFactory appropriately.
 int getAutowireStrategy()
           
 Class getClassInstance(String className)
          Utility method to obtain the class matched to className.
 void initObjectFactory()
          Deprecated. Since 2.1 as it isn't necessary
private  void injectApplicationContext(Object bean)
           
 boolean isNoArgConstructorRequired()
          Allows for ObjectFactory implementations that support Actions without no-arg constructors.
 void setAlwaysRespectAutowireStrategy(boolean alwaysRespectAutowireStrategy)
          Determines if the autowire strategy is always followed when creating beans
 void setApplicationContext(org.springframework.context.ApplicationContext appContext)
          Set the Spring ApplicationContext that should be used to look beans up with.
 void setApplicationContextPath(String ctx)
           
 void setAutowireStrategy(int autowireStrategy)
          Sets the autowiring strategy
 void setUseClassCache(boolean useClassCache)
          Enable / disable caching of classes loaded by Spring.
 
Methods inherited from class com.opensymphony.xwork2.ObjectFactory
buildAction, buildBean, buildInterceptor, buildResult, buildValidator, getObjectFactory, injectInternalBeans, setClassLoader, setContainer, setReflectionProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

private static final Logger LOG

appContext

protected org.springframework.context.ApplicationContext appContext

autoWiringFactory

protected org.springframework.beans.factory.config.AutowireCapableBeanFactory autoWiringFactory

autowireStrategy

protected int autowireStrategy

classes

private final Map<String,Object> classes

useClassCache

private boolean useClassCache

alwaysRespectAutowireStrategy

private boolean alwaysRespectAutowireStrategy
Constructor Detail

SpringObjectFactory

public SpringObjectFactory()
Method Detail

setApplicationContextPath

public void setApplicationContextPath(String ctx)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext appContext)
                           throws org.springframework.beans.BeansException
Set the Spring ApplicationContext that should be used to look beans up with.

Specified by:
setApplicationContext in interface org.springframework.context.ApplicationContextAware
Parameters:
appContext - The Spring ApplicationContext that should be used to look beans up with.
Throws:
org.springframework.beans.BeansException

setAutowireStrategy

public void setAutowireStrategy(int autowireStrategy)
Sets the autowiring strategy

Parameters:
autowireStrategy -

getAutowireStrategy

public int getAutowireStrategy()

findAutoWiringBeanFactory

protected org.springframework.beans.factory.config.AutowireCapableBeanFactory findAutoWiringBeanFactory(org.springframework.context.ApplicationContext context)
If the given context is assignable to AutowireCapbleBeanFactory or contains a parent or a factory that is, then set the autoWiringFactory appropriately.

Parameters:
context -

buildBean

public Object buildBean(String beanName,
                        Map<String,Object> extraContext,
                        boolean injectInternal)
                 throws Exception
Looks up beans using Spring's application context before falling back to the method defined in the ObjectFactory.

Overrides:
buildBean in class ObjectFactory
Parameters:
beanName - The name of the bean to look up in the application context
extraContext -
Returns:
A bean from Spring or the result of calling the overridden method.
Throws:
Exception

buildBean

public Object buildBean(Class clazz,
                        Map<String,Object> extraContext)
                 throws Exception
Description copied from class: ObjectFactory
Build a generic Java object of the given type.

Overrides:
buildBean in class ObjectFactory
Parameters:
clazz -
extraContext -
Throws:
Exception

autoWireBean

public Object autoWireBean(Object bean)

autoWireBean

public Object autoWireBean(Object bean,
                           org.springframework.beans.factory.config.AutowireCapableBeanFactory autoWiringFactory)
Parameters:
bean -
autoWiringFactory -

injectApplicationContext

private void injectApplicationContext(Object bean)

getClassInstance

public Class getClassInstance(String className)
                       throws ClassNotFoundException
Description copied from class: ObjectFactory
Utility method to obtain the class matched to className. Caches look ups so that subsequent lookups will be faster.

Overrides:
getClassInstance in class ObjectFactory
Parameters:
className - The fully qualified name of the class to return
Returns:
The class itself
Throws:
ClassNotFoundException

initObjectFactory

@Deprecated
public void initObjectFactory()
Deprecated. Since 2.1 as it isn't necessary

This method sets the ObjectFactory used by XWork to this object. It's best used as the "init-method" of a Spring bean definition in order to hook Spring and XWork together properly (as an alternative to the org.apache.struts2.spring.lifecycle.SpringObjectFactoryListener)


isNoArgConstructorRequired

public boolean isNoArgConstructorRequired()
Allows for ObjectFactory implementations that support Actions without no-arg constructors.

Overrides:
isNoArgConstructorRequired in class ObjectFactory
Returns:
false

setUseClassCache

public void setUseClassCache(boolean useClassCache)
Enable / disable caching of classes loaded by Spring.

Parameters:
useClassCache -

setAlwaysRespectAutowireStrategy

public void setAlwaysRespectAutowireStrategy(boolean alwaysRespectAutowireStrategy)
Determines if the autowire strategy is always followed when creating beans

Parameters:
alwaysRespectAutowireStrategy - True if the strategy is always used


Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.