org.springframework.web.context.support: abstract public class: WebApplicationContextUtils

org.springframework.web.context.support
abstract public class: WebApplicationContextUtils [javadoc | source]

java.lang.Object
   org.springframework.web.context.support.WebApplicationContextUtils

Convenience methods for retrieving the root org.springframework.web.context.WebApplicationContext for a given ServletContext. This is e.g. useful for accessing a Spring context from within custom web views or Struts actions.

Note that there are more convenient ways of accessing the root context for many web frameworks, either part of Spring or available as external library. This helper class is just the most generic way to access the root context.

Also see:

org.springframework.web.context.ContextLoader

org.springframework.web.servlet.FrameworkServlet

org.springframework.web.servlet.DispatcherServlet

org.springframework.web.struts.ActionSupport

org.springframework.web.struts.DelegatingActionProxy

org.springframework.web.jsf.FacesContextUtils

org.springframework.web.jsf.DelegatingVariableResolver

author: Juergen - Hoeller

Method from org.springframework.web.context.support.WebApplicationContextUtils Summary:
getRequiredWebApplicationContext, getWebApplicationContext, getWebApplicationContext, registerWebApplicationScopes

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.web.context.support.WebApplicationContextUtils Detail:
public static WebApplicationContext getRequiredWebApplicationContext(ServletContext sc) throws IllegalStateException { WebApplicationContext wac = getWebApplicationContext(sc); if (wac == null) { throw new IllegalStateException("No WebApplicationContext found: no ContextLoaderListener registered?"); } return wac; } Find the root WebApplicationContext for this web application, which is typically loaded via org.springframework.web.context.ContextLoaderListener or org.springframework.web.context.ContextLoaderServlet . Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
public static WebApplicationContext getWebApplicationContext(ServletContext sc) { return getWebApplicationContext(sc, WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE); } Find the root WebApplicationContext for this web application, which is typically loaded via org.springframework.web.context.ContextLoaderListener or org.springframework.web.context.ContextLoaderServlet . Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
public static WebApplicationContext getWebApplicationContext(ServletContext sc, String attrName) { Assert.notNull(sc, "ServletContext must not be null"); Object attr = sc.getAttribute(attrName); if (attr == null) { return null; } if (attr instanceof RuntimeException) { throw (RuntimeException) attr; } if (attr instanceof Error) { throw (Error) attr; } if (attr instanceof Exception) { IllegalStateException ex = new IllegalStateException(); ex.initCause((Exception) attr); throw ex; } if (!(attr instanceof WebApplicationContext)) { throw new IllegalStateException("Context attribute is not of type WebApplicationContext: " + attr); } return (WebApplicationContext) attr; } Find a custom WebApplicationContext for this web application.
public static void registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory) { beanFactory.registerScope(WebApplicationContext.SCOPE_REQUEST, new RequestScope()); beanFactory.registerScope(WebApplicationContext.SCOPE_SESSION, new SessionScope(false)); beanFactory.registerScope(WebApplicationContext.SCOPE_GLOBAL_SESSION, new SessionScope(true)); beanFactory.registerResolvableDependency(ServletRequest.class, new ObjectFactory() { public Object getObject() { RequestAttributes requestAttr = RequestContextHolder.currentRequestAttributes(); if (!(requestAttr instanceof ServletRequestAttributes)) { throw new IllegalStateException("Current request is not a servlet request"); } return ((ServletRequestAttributes) requestAttr).getRequest(); } }); beanFactory.registerResolvableDependency(HttpSession.class, new ObjectFactory() { public Object getObject() { RequestAttributes requestAttr = RequestContextHolder.currentRequestAttributes(); if (!(requestAttr instanceof ServletRequestAttributes)) { throw new IllegalStateException("Current request is not a servlet request"); } return ((ServletRequestAttributes) requestAttr).getRequest().getSession(); } }); } Register web-specific scopes with the given BeanFactory, as used by the WebApplicationContext.

Method from org.springframework.web.context.support.WebApplicationContextUtils Detail:

 public static WebApplicationContext getRequiredWebApplicationContext(ServletContext sc) throws IllegalStateException {
		WebApplicationContext wac = getWebApplicationContext(sc);
		if (wac == null) {
			throw new IllegalStateException("No WebApplicationContext found: no ContextLoaderListener registered?");
		}
		return wac;
}

org.springframework.web.context.ContextLoaderListener

org.springframework.web.context.ContextLoaderServlet

Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.

 public static WebApplicationContext getWebApplicationContext(ServletContext sc) {
		return getWebApplicationContext(sc, WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE);
}

org.springframework.web.context.ContextLoaderListener

org.springframework.web.context.ContextLoaderServlet

Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.

 public static WebApplicationContext getWebApplicationContext(ServletContext sc,
    String attrName) {
		Assert.notNull(sc, "ServletContext must not be null");
		Object attr = sc.getAttribute(attrName);
		if (attr == null) {
			return null;
		}
		if (attr instanceof RuntimeException) {
			throw (RuntimeException) attr;
		}
		if (attr instanceof Error) {
			throw (Error) attr;
		}
		if (attr instanceof Exception) {
			IllegalStateException ex = new IllegalStateException();
			ex.initCause((Exception) attr);
			throw ex;
		}
		if (!(attr instanceof WebApplicationContext)) {
			throw new IllegalStateException("Context attribute is not of type WebApplicationContext: " + attr);
		}
		return (WebApplicationContext) attr;
}

Find a custom WebApplicationContext for this web application.

 public static  void registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory) {
		beanFactory.registerScope(WebApplicationContext.SCOPE_REQUEST, new RequestScope());
		beanFactory.registerScope(WebApplicationContext.SCOPE_SESSION, new SessionScope(false));
		beanFactory.registerScope(WebApplicationContext.SCOPE_GLOBAL_SESSION, new SessionScope(true));
		beanFactory.registerResolvableDependency(ServletRequest.class, new ObjectFactory() {
			public Object getObject() {
				RequestAttributes requestAttr = RequestContextHolder.currentRequestAttributes();
				if (!(requestAttr instanceof ServletRequestAttributes)) {
					throw new IllegalStateException("Current request is not a servlet request");
				}
				return ((ServletRequestAttributes) requestAttr).getRequest();
			}
		});
		beanFactory.registerResolvableDependency(HttpSession.class, new ObjectFactory() {
			public Object getObject() {
				RequestAttributes requestAttr = RequestContextHolder.currentRequestAttributes();
				if (!(requestAttr instanceof ServletRequestAttributes)) {
					throw new IllegalStateException("Current request is not a servlet request");
				}
				return ((ServletRequestAttributes) requestAttr).getRequest().getSession();
			}
		});
}