Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename {DefaultWeb=>StandardServlet}Environment

Browse Source 
Issue: SPR-8348
This commit is contained in:
Chris Beams
2011-05-20 03:55:56 +00:00
parent c06752ef72
commit f893b62a9b
14 changed files with 102 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
org.springframework.web/src/main/java/org/springframework/web/context/support/AbstractRefreshableWebApplicationContext.java
View File

@@ -132,11 +132,11 @@ public abstract class AbstractRefreshableWebApplicationContext extends AbstractR
}
/**
* Create and return a new {@link DefaultWebEnvironment}.
* Create and return a new {@link StandardServletEnvironment}.
*/
@Override
protected ConfigurableEnvironment createEnvironment() {
return new DefaultWebEnvironment();
return new StandardServletEnvironment();
}

4
org.springframework.web/src/main/java/org/springframework/web/context/support/GenericWebApplicationContext.java
View File

@@ -118,11 +118,11 @@ public class GenericWebApplicationContext extends GenericApplicationContext
/**
* Create and return a new {@link DefaultWebEnvironment}.
* Create and return a new {@link StandardServletEnvironment}.
*/
@Override
protected ConfigurableEnvironment createEnvironment() {
return new DefaultWebEnvironment();
return new StandardServletEnvironment();
}
/**

2
org.springframework.web/src/main/java/org/springframework/web/context/support/ServletContextPropertyPlaceholderConfigurer.java
View File

@@ -59,7 +59,7 @@ import org.springframework.web.context.ServletContextAware;
* @see javax.servlet.ServletContext#getInitParameter(String)
* @see javax.servlet.ServletContext#getAttribute(String)
* @deprecated in Spring 3.1 in favor of {@link org.springframework.context.support.PropertySourcesPlaceholderConfigurer}
* in conjunction with {@link org.springframework.web.context.support.DefaultWebEnvironment}.
* in conjunction with {@link org.springframework.web.context.support.StandardServletEnvironment}.
*/
@Deprecated
public class ServletContextPropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer

32
org.springframework.web/src/main/java/org/springframework/web/context/support/DefaultWebEnvironment.java → org.springframework.web/src/main/java/org/springframework/web/context/support/StandardServletEnvironment.java
View File

@@ -32,20 +32,22 @@ import org.springframework.jndi.JndiPropertySource;
* applications. All web-related (servlet-based) {@code ApplicationContext} classes
* initialize an instance by default.
*
* <p>Contributes {@code ServletConfig}- and {@code ServletContext}-based {@link PropertySource}
* instances. See the {@link #DefaultWebEnvironment()} constructor for details.
* <p>Contributes {@code ServletConfig}- and {@code ServletContext}-based
* {@link PropertySource} instances. See the {@link #customizePropertySources} method
* for details.
*
* <p>After initial bootstrapping, property sources will be searched for the presence of a
* "jndiPropertySourceEnabled" property; if found, a {@link JndiPropertySource} will be added
* to this environment's {@link PropertySources}, with precedence higher than system properties
* and environment variables, but lower than that of ServletContext and ServletConfig init params.
* "jndiPropertySourceEnabled" property; if found, a {@link JndiPropertySource} will be
* added to this environment's {@link PropertySources}, with precedence higher than system
* properties and environment variables, but lower than that of ServletContext and
* ServletConfig init params.
*
* @author Chris Beams
* @since 3.1
* @see StandardEnvironment
* @see DefaultPortletEnvironment
*/
public class DefaultWebEnvironment extends StandardEnvironment {
public class StandardServletEnvironment extends StandardEnvironment {
/** Servlet context init parameters property source name: {@value} */
public static final String SERVLET_CONTEXT_PROPERTY_SOURCE_NAME = "servletContextInitParams";
@@ -63,15 +65,17 @@ public class DefaultWebEnvironment extends StandardEnvironment {
* </ul>
* <p>Properties present in {@value #SERVLET_CONFIG_PROPERTY_SOURCE_NAME} will
* take precedence over those in {@value #SERVLET_CONTEXT_PROPERTY_SOURCE_NAME}.
* <p>Properties in any of the above will take precedence over system properties and environment
* variables contributed by the {@link StandardEnvironment} superclass.
* <p>The {@code Servlet}-related property sources are added as stubs for now, and will be
* {@linkplain WebApplicationContextUtils#initServletPropertySources fully initialized}
* once the actual {@link ServletConfig} and {@link ServletContext} objects are available.
* <p>Properties in any of the above will take precedence over system properties and
* environment variables contributed by the {@link StandardEnvironment} superclass.
* <p>The {@code Servlet}-related property sources are added as stubs for now, and
* will be {@linkplain WebApplicationContextUtils#initServletPropertySources fully
* initialized} once the actual {@link ServletConfig} and {@link ServletContext}
* objects are available.
* <p>If the {@link JndiPropertySource#JNDI_PROPERTY_SOURCE_ENABLED_FLAG "jndiPropertySourceEnabled"}
* property is present in any of the default property sources, a {@link JndiPropertySource} will
* be added as well, with precedence lower than servlet property sources, but higher than system
* properties and environment variables.
* property is present in any of the default property sources, a
* {@link JndiPropertySource} will be added as well, with precedence lower than
* servlet property sources, but higher than system properties and environment
* variables.
* @see StandardEnvironment#customizePropertySources
* @see ServletConfigPropertySource
* @see ServletContextPropertySource

4
org.springframework.web/src/main/java/org/springframework/web/context/support/StaticWebApplicationContext.java
View File

@@ -160,11 +160,11 @@ public class StaticWebApplicationContext extends StaticApplicationContext
}
/**
* Create and return a new {@link DefaultWebEnvironment}.
* Create and return a new {@link StandardServletEnvironment}.
*/
@Override
protected ConfigurableEnvironment createEnvironment() {
return new DefaultWebEnvironment();
return new StandardServletEnvironment();
}
/**

12
org.springframework.web/src/main/java/org/springframework/web/context/support/WebApplicationContextUtils.java
View File

@@ -247,13 +247,13 @@ public abstract class WebApplicationContextUtils {
public static void initServletPropertySources(
MutablePropertySources propertySources, ServletContext servletContext, ServletConfig servletConfig) {
Assert.notNull(propertySources, "propertySources must not be null");
if(servletContext != null && propertySources.contains(DefaultWebEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)) {
propertySources.replace(DefaultWebEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME,
new ServletContextPropertySource(DefaultWebEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME, servletContext));
if(servletContext != null && propertySources.contains(StandardServletEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)) {
propertySources.replace(StandardServletEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME,
new ServletContextPropertySource(StandardServletEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME, servletContext));
}
if(servletConfig != null && propertySources.contains(DefaultWebEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)) {
propertySources.replace(DefaultWebEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME,
new ServletConfigPropertySource(DefaultWebEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME, servletConfig));
if(servletConfig != null && propertySources.contains(StandardServletEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)) {
propertySources.replace(StandardServletEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME,
new ServletConfigPropertySource(StandardServletEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME, servletConfig));
}
}

6
org.springframework.web/src/main/java/org/springframework/web/filter/GenericFilterBean.java
View File

@@ -44,7 +44,7 @@ import org.springframework.core.io.ResourceLoader;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.web.context.ServletContextAware;
import org.springframework.web.context.support.DefaultWebEnvironment;
import org.springframework.web.context.support.StandardServletEnvironment;
import org.springframework.web.context.support.ServletContextResourceLoader;
import org.springframework.web.util.NestedServletException;
@@ -91,7 +91,7 @@ public abstract class GenericFilterBean implements
private String beanName;
private Environment environment = new DefaultWebEnvironment();
private Environment environment = new StandardServletEnvironment();
private ServletContext servletContext;
@@ -109,7 +109,7 @@ public abstract class GenericFilterBean implements
/**
* {@inheritDoc}
* <p>Any environment set here overrides the {@link DefaultWebEnvironment}
* <p>Any environment set here overrides the {@link StandardServletEnvironment}
* provided by default.
*/
public void setEnvironment(Environment environment) {

26
org.springframework.web/src/test/java/org/springframework/web/context/support/DefaultWebEnvironmentTests.java → org.springframework.web/src/test/java/org/springframework/web/context/support/StandardServletEnvironmentTests.java
View File

@@ -27,14 +27,20 @@ import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
import org.springframework.jndi.JndiPropertySource;
public class DefaultWebEnvironmentTests {
/**
* Unit tests for {@link StandardServletEnvironment}.
*
* @author Chris Beams
* @since 3.1
*/
public class StandardServletEnvironmentTests {
@Test
public void propertySourceOrder() {
ConfigurableEnvironment env = new DefaultWebEnvironment();
ConfigurableEnvironment env = new StandardServletEnvironment();
MutablePropertySources sources = env.getPropertySources();
assertThat(sources.precedenceOf(PropertySource.named(DefaultWebEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)), equalTo(0));
assertThat(sources.precedenceOf(PropertySource.named(DefaultWebEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)), equalTo(1));
assertThat(sources.precedenceOf(PropertySource.named(StandardServletEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)), equalTo(0));
assertThat(sources.precedenceOf(PropertySource.named(StandardServletEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)), equalTo(1));
assertThat(sources.precedenceOf(PropertySource.named(StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME)), equalTo(2));
assertThat(sources.precedenceOf(PropertySource.named(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME)), equalTo(3));
assertThat(sources.size(), is(4));
@@ -43,11 +49,11 @@ public class DefaultWebEnvironmentTests {
@Test
public void propertySourceOrder_jndiPropertySourceEnabled() {
System.setProperty(JndiPropertySource.JNDI_PROPERTY_SOURCE_ENABLED_FLAG, "true");
ConfigurableEnvironment env = new DefaultWebEnvironment();
ConfigurableEnvironment env = new StandardServletEnvironment();
MutablePropertySources sources = env.getPropertySources();
assertThat(sources.precedenceOf(PropertySource.named(DefaultWebEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)), equalTo(0));
assertThat(sources.precedenceOf(PropertySource.named(DefaultWebEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)), equalTo(1));
assertThat(sources.precedenceOf(PropertySource.named(StandardServletEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)), equalTo(0));
assertThat(sources.precedenceOf(PropertySource.named(StandardServletEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)), equalTo(1));
assertThat(sources.precedenceOf(PropertySource.named(JndiPropertySource.JNDI_PROPERTY_SOURCE_NAME)), equalTo(2));
assertThat(sources.precedenceOf(PropertySource.named(StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME)), equalTo(3));
assertThat(sources.precedenceOf(PropertySource.named(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME)), equalTo(4));
@@ -59,11 +65,11 @@ public class DefaultWebEnvironmentTests {
@Test
public void propertySourceOrder_jndiPropertySourceEnabledIsFalse() {
System.setProperty(JndiPropertySource.JNDI_PROPERTY_SOURCE_ENABLED_FLAG, "false");
ConfigurableEnvironment env = new DefaultWebEnvironment();
ConfigurableEnvironment env = new StandardServletEnvironment();
MutablePropertySources sources = env.getPropertySources();
assertThat(sources.precedenceOf(PropertySource.named(DefaultWebEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)), equalTo(0));
assertThat(sources.precedenceOf(PropertySource.named(DefaultWebEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)), equalTo(1));
assertThat(sources.precedenceOf(PropertySource.named(StandardServletEnvironment.SERVLET_CONFIG_PROPERTY_SOURCE_NAME)), equalTo(0));
assertThat(sources.precedenceOf(PropertySource.named(StandardServletEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)), equalTo(1));
//assertThat(sources.precedenceOf(PropertySource.named(JndiPropertySource.JNDI_PROPERTY_SOURCE_NAME)), equalTo(2));
assertThat(sources.precedenceOf(PropertySource.named(StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME)), equalTo(2));
assertThat(sources.precedenceOf(PropertySource.named(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME)), equalTo(3));