Also see:

org.springframework.web.context.support.XmlWebApplicationContext

 protected WebApplicationContext createWebApplicationContext(WebApplicationContext parent) throws BeansException 
{
		if (logger.isDebugEnabled()) {
			logger.debug("ContextLoaderPlugIn for Struts ActionServlet '" + getServletName() +
					"', module '" + getModulePrefix() + "' will try to create custom WebApplicationContext " +
					"context of class '" + getContextClass().getName() + "', using parent context [" + parent + "]");
		}
		if (!ConfigurableWebApplicationContext.class.isAssignableFrom(getContextClass())) {
			throw new ApplicationContextException(
					"Fatal initialization error in ContextLoaderPlugIn for Struts ActionServlet '" + getServletName() +
					"', module '" + getModulePrefix() + "': custom WebApplicationContext class [" +
					getContextClass().getName() + "] is not of type ConfigurableWebApplicationContext");
		}
		ConfigurableWebApplicationContext wac =
				(ConfigurableWebApplicationContext) BeanUtils.instantiateClass(getContextClass());
		wac.setParent(parent);
		wac.setServletContext(getServletContext());
		wac.setNamespace(getNamespace());
		if (getContextConfigLocation() != null) {
			wac.setConfigLocations(
			    StringUtils.tokenizeToStringArray(
							getContextConfigLocation(), ConfigurableWebApplicationContext.CONFIG_LOCATION_DELIMITERS));
		}
		wac.addBeanFactoryPostProcessor(
				new BeanFactoryPostProcessor() {
					public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
						beanFactory.addBeanPostProcessor(new ActionServletAwareProcessor(getActionServlet()));
						beanFactory.ignoreDependencyType(ActionServlet.class);
					}
				}
		);
		wac.refresh();
		return wac;
}

Instantiate the WebApplicationContext for the ActionServlet, either a default XmlWebApplicationContext or a custom context class if set.

This implementation expects custom contexts to implement ConfigurableWebApplicationContext. Can be overridden in subclasses.

 public  void destroy() 
{
		getServletContext().log("Closing WebApplicationContext of Struts ActionServlet '" +
				getServletName() + "', module '" + getModulePrefix() + "'");
		if (getWebApplicationContext() instanceof ConfigurableApplicationContext) {
			((ConfigurableApplicationContext) getWebApplicationContext()).close();
		}
}

Close the WebApplicationContext of the ActionServlet.

 public final ActionServlet getActionServlet() 
{
		return actionServlet;
}

Return the Struts ActionServlet that this PlugIn is associated with.

 public Class getContextClass() 
{
		return this.contextClass;
}

Return the custom context class.

 public String getContextConfigLocation() 
{
		return this.contextConfigLocation;
}

Return the explicit context config location, if any.

 public final ModuleConfig getModuleConfig() 
{
		return this.moduleConfig;
}

Return the Struts ModuleConfig that this PlugIn is associated with.

 public final String getModulePrefix() 
{
		return this.moduleConfig.getPrefix();
}

Return the prefix of the ModuleConfig that this PlugIn is associated with.

 public String getNamespace() 
{
		if (this.namespace != null) {
			return this.namespace;
		}
		if (this.actionServlet != null) {
			return this.actionServlet.getServletName() + DEFAULT_NAMESPACE_SUFFIX;
		}
		return null;
}

Return the namespace for the ActionServlet, falling back to default scheme if no custom namespace was set: e.g. "test-servlet" for a servlet named "test".

 public final ServletContext getServletContext() 
{
		return this.actionServlet.getServletContext();
}

Return the ServletContext that this PlugIn is associated with.

 public String getServletContextAttributeName() 
{
		return SERVLET_CONTEXT_PREFIX + getModulePrefix();
}

Return the ServletContext attribute name for this PlugIn's WebApplicationContext.

The default implementation returns SERVLET_CONTEXT_PREFIX + module prefix.

 public final String getServletName() 
{
		return this.actionServlet.getServletName();
}

Return the name of the ActionServlet that this PlugIn is associated with.

 public final WebApplicationContext getWebApplicationContext() 
{
		return webApplicationContext;
}

Return this PlugIn's WebApplicationContext.

 public final  void init(ActionServlet actionServlet,
    ModuleConfig moduleConfig) throws ServletException 
{
		long startTime = System.currentTimeMillis();
		if (logger.isInfoEnabled()) {
			logger.info("ContextLoaderPlugIn for Struts ActionServlet '" + actionServlet.getServletName() +
					", module '" + moduleConfig.getPrefix() + "': initialization started");
		}
		this.actionServlet = actionServlet;
		this.moduleConfig = moduleConfig;
		try {
			this.webApplicationContext = initWebApplicationContext();
			onInit();
		}
		catch (RuntimeException ex) {
			logger.error("Context initialization failed", ex);
			throw ex;
		}
		if (logger.isInfoEnabled()) {
			long elapsedTime = System.currentTimeMillis() - startTime;
			logger.info("ContextLoaderPlugIn for Struts ActionServlet '" + actionServlet.getServletName() +
					"', module '" + moduleConfig.getPrefix() + "': initialization completed in " + elapsedTime + " ms");
		}
}

Create the ActionServlet's WebApplicationContext.

 protected WebApplicationContext initWebApplicationContext() throws BeansException, IllegalStateException 
{
		getServletContext().log("Initializing WebApplicationContext for Struts ActionServlet '" +
				getServletName() + "', module '" + getModulePrefix() + "'");
		WebApplicationContext parent = WebApplicationContextUtils.getWebApplicationContext(getServletContext());
		WebApplicationContext wac = createWebApplicationContext(parent);
		if (logger.isInfoEnabled()) {
			logger.info("Using context class '" + wac.getClass().getName() + "' for servlet '" + getServletName() + "'");
		}
		// Publish the context as a servlet context attribute.
		String attrName = getServletContextAttributeName();
		getServletContext().setAttribute(attrName, wac);
		if (logger.isDebugEnabled()) {
			logger.debug("Published WebApplicationContext of Struts ActionServlet '" + getServletName() +
					"', module '" + getModulePrefix() + "' as ServletContext attribute with name [" + attrName + "]");
		}
		return wac;
}

Initialize and publish the WebApplicationContext for the ActionServlet.

Delegates to #createWebApplicationContext for actual creation.

Can be overridden in subclasses. Call getActionServlet() and/or getModuleConfig() to access the Struts configuration that this PlugIn is associated with.

 protected  void onInit() throws ServletException 
{

}

Callback for custom initialization after the context has been set up.

 public  void setContextClass(Class contextClass) 
{
		this.contextClass = contextClass;
}

Set a custom context class. This class must be of type WebApplicationContext, when using the default ContextLoaderPlugIn implementation, the context class must also implement ConfigurableWebApplicationContext.

 public  void setContextClassName(String contextClassName) throws ClassNotFoundException 
{
		this.contextClass = ClassUtils.forName(contextClassName);
}

Set a custom context class by name. This class must be of type WebApplicationContext, when using the default ContextLoaderPlugIn implementation, the context class must also implement ConfigurableWebApplicationContext.

 public  void setContextConfigLocation(String contextConfigLocation) 
{
		this.contextConfigLocation = contextConfigLocation;
}

Set the context config location explicitly, instead of relying on the default location built from the namespace. This location string can consist of multiple locations separated by any number of commas and spaces.

 public  void setNamespace(String namespace) 
{
		this.namespace = namespace;
}

Set a custom namespace for the ActionServlet, to be used for building a default context config location.