org.springframework.web.context Documentation Differences

This file contains all the changes in documentation in the package org.springframework.web.context as colored differences. Deletions are shown like this, and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Specialization of ConfigurableEnvironment allowing initialization of servlet-related org.springframework.core.env.PropertySource objects at the earliest moment that the ServletContext and (optionally) ServletConfig become available. @author Chris Beams @since 3.1.2 @see ConfigurableWebApplicationContext#getEnvironment()

Replace any org.springframework.core.env.PropertySource.StubPropertySource stub property source instances acting as placeholders with real servlet context/config property sources using the given parameters. @param servletContext the ServletContext (may not be {@code null}) @param servletConfig the ServletContextServletConfig ({@code null} if not available) @see org.springframework.web.context.support.WebApplicationContextUtils#initServletPropertySources( org.springframework.core.env.MutablePropertySources, ServletContext, ServletConfig)

Create a new {@code ContextLoaderListener} that will create a web application context based on the "contextClass" and "contextConfigLocation" servlet context-params. See ContextLoader superclass documentation for details on default values for each.

This constructor is typically used when declaring {@code ContextLoaderListener} as a {@code } within {@code web.xml}, where a no-arg constructor is required.

The created application context will be registered into the ServletContext under the attribute name WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE and the Spring application context will be closed when the .contextDestroyed lifecycle method is invoked on this listener. @see ContextLoader @see #ContextLoaderListener(WebApplicationContext) @see #contextInitialized(ServletContextEvent) @see #contextDestroyed(ServletContextEvent)

Create a new {@code ContextLoaderListener} with the given application context. This constructor is useful in Servlet 3.0+ environments where instance-based registration of listeners is possible through the javax.servlet.ServletContext.addListener API.

The context may or may not yet be org.springframework.context.ConfigurableApplicationContext#refresh() refreshed. If itit (a) is an implementation implementation of ConfigurableWebApplicationContext andand (b) has not already been refreshed (the recommended approach), then the following will occur:

• If the given context has not already been assigned an org.springframework.context.ConfigurableApplicationContext#setId id, one will be assigned to it
• {@code ServletContext} and {@code ServletConfig} objects will be delegated to the application context
• .customizeContext will be called
• Any ApplicationContextInitializerss specified through the the "contextInitializerClasses" init-param will be applied.
• refresh() will be called

If the context has already been refreshed or does not implement {@code ConfigurableWebApplicationContext}, none of the above will occur under the assumption that the user has performed these actions (or not) per his or her specific needs.

See org.springframework.web.WebApplicationInitializer for usage examples.

In any case, the given application context will be registered into the ServletContext under the attribute name WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE and the Spring application context will be closed when the .contextDestroyed lifecycle method is invoked on this listener. @param context the application context to manage @see #contextInitialized(ServletContextEvent) @see #contextDestroyed(ServletContextEvent)