From c481d2e9fb200175eff3593f31fb02b3decd0a4d Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Fri, 20 May 2011 03:57:35 +0000 Subject: [PATCH] Rename {Default=>Standard}PortletEnvironment Issue: SPR-8348 --- .../core/env/EnvironmentIntegrationTests.java | 11 +++++----- .../web/portlet/GenericPortletBean.java | 6 ++--- ...tRefreshablePortletApplicationContext.java | 4 ++-- .../PortletApplicationContextUtils.java | 12 +++++----- ...t.java => StandardPortletEnvironment.java} | 22 +++++++++---------- .../StaticPortletApplicationContext.java | 4 ++-- .../support/StandardServletEnvironment.java | 2 +- 7 files changed, 31 insertions(+), 30 deletions(-) rename org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/{DefaultPortletEnvironment.java => StandardPortletEnvironment.java} (84%) diff --git a/org.springframework.integration-tests/src/test/java/org/springframework/core/env/EnvironmentIntegrationTests.java b/org.springframework.integration-tests/src/test/java/org/springframework/core/env/EnvironmentIntegrationTests.java index c6e1e414f74..4272719b621 100644 --- a/org.springframework.integration-tests/src/test/java/org/springframework/core/env/EnvironmentIntegrationTests.java +++ b/org.springframework.integration-tests/src/test/java/org/springframework/core/env/EnvironmentIntegrationTests.java @@ -74,7 +74,7 @@ import org.springframework.web.context.support.GenericWebApplicationContext; import org.springframework.web.context.support.StaticWebApplicationContext; import org.springframework.web.context.support.XmlWebApplicationContext; import org.springframework.web.portlet.context.AbstractRefreshablePortletApplicationContext; -import org.springframework.web.portlet.context.DefaultPortletEnvironment; +import org.springframework.web.portlet.context.StandardPortletEnvironment; import org.springframework.web.portlet.context.StaticPortletApplicationContext; import org.springframework.web.portlet.context.XmlPortletApplicationContext; @@ -556,7 +556,7 @@ public class EnvironmentIntegrationTests { public void staticPortletApplicationContext() { StaticPortletApplicationContext ctx = new StaticPortletApplicationContext(); - assertHasDefaultPortletEnvironment(ctx); + assertHasStandardPortletEnvironment(ctx); registerEnvironmentBeanDefinition(ctx); @@ -633,16 +633,17 @@ public class EnvironmentIntegrationTests { } private void assertHasStandardServletEnvironment(WebApplicationContext ctx) { - // ensure a default web environment exists + // ensure a default servlet environment exists Environment defaultEnv = ctx.getEnvironment(); assertThat(defaultEnv, notNullValue()); assertThat(defaultEnv, instanceOf(StandardServletEnvironment.class)); } - private void assertHasDefaultPortletEnvironment(WebApplicationContext ctx) { + private void assertHasStandardPortletEnvironment(WebApplicationContext ctx) { + // ensure a default portlet environment exists Environment defaultEnv = ctx.getEnvironment(); assertThat(defaultEnv, notNullValue()); - assertThat(defaultEnv, instanceOf(DefaultPortletEnvironment.class)); + assertThat(defaultEnv, instanceOf(StandardPortletEnvironment.class)); } private void assertHasEnvironment(ApplicationContext ctx, Environment expectedEnv) { diff --git a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/GenericPortletBean.java b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/GenericPortletBean.java index 7336e282ea6..bc0b8fead88 100644 --- a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/GenericPortletBean.java +++ b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/GenericPortletBean.java @@ -39,7 +39,7 @@ import org.springframework.core.io.Resource; import org.springframework.core.io.ResourceEditor; import org.springframework.core.io.ResourceLoader; import org.springframework.util.StringUtils; -import org.springframework.web.portlet.context.DefaultPortletEnvironment; +import org.springframework.web.portlet.context.StandardPortletEnvironment; import org.springframework.web.portlet.context.PortletContextResourceLoader; /** @@ -76,7 +76,7 @@ public abstract class GenericPortletBean extends GenericPortlet implements Envir */ private final Set requiredProperties = new HashSet(); - private Environment environment = new DefaultPortletEnvironment(); + private Environment environment = new StandardPortletEnvironment(); /** @@ -167,7 +167,7 @@ public abstract class GenericPortletBean extends GenericPortlet implements Envir /** * {@inheritDoc} - *

Any environment set here overrides the {@link DefaultPortletEnvironment} + *

Any environment set here overrides the {@link StandardPortletEnvironment} * provided by default. */ public void setEnvironment(Environment environment) { diff --git a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/AbstractRefreshablePortletApplicationContext.java b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/AbstractRefreshablePortletApplicationContext.java index c55cddaecd3..4269eed798d 100644 --- a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/AbstractRefreshablePortletApplicationContext.java +++ b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/AbstractRefreshablePortletApplicationContext.java @@ -152,11 +152,11 @@ public abstract class AbstractRefreshablePortletApplicationContext extends Abstr } /** - * Create and return a new {@link DefaultPortletEnvironment}. + * Create and return a new {@link StandardPortletEnvironment}. */ @Override protected ConfigurableEnvironment createEnvironment() { - return new DefaultPortletEnvironment(); + return new StandardPortletEnvironment(); } /** diff --git a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/PortletApplicationContextUtils.java b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/PortletApplicationContextUtils.java index 9a1ff5880d8..ef1bebd2112 100644 --- a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/PortletApplicationContextUtils.java +++ b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/PortletApplicationContextUtils.java @@ -200,13 +200,13 @@ public abstract class PortletApplicationContextUtils { WebApplicationContextUtils.initServletPropertySources(propertySources, servletContext); - if(portletContext != null && propertySources.contains(DefaultPortletEnvironment.PORTLET_CONTEXT_PROPERTY_SOURCE_NAME)) { - propertySources.replace(DefaultPortletEnvironment.PORTLET_CONTEXT_PROPERTY_SOURCE_NAME, - new PortletContextPropertySource(DefaultPortletEnvironment.PORTLET_CONTEXT_PROPERTY_SOURCE_NAME, portletContext)); + if(portletContext != null && propertySources.contains(StandardPortletEnvironment.PORTLET_CONTEXT_PROPERTY_SOURCE_NAME)) { + propertySources.replace(StandardPortletEnvironment.PORTLET_CONTEXT_PROPERTY_SOURCE_NAME, + new PortletContextPropertySource(StandardPortletEnvironment.PORTLET_CONTEXT_PROPERTY_SOURCE_NAME, portletContext)); } - if(portletConfig != null && propertySources.contains(DefaultPortletEnvironment.PORTLET_CONFIG_PROPERTY_SOURCE_NAME)) { - propertySources.replace(DefaultPortletEnvironment.PORTLET_CONFIG_PROPERTY_SOURCE_NAME, - new PortletConfigPropertySource(DefaultPortletEnvironment.PORTLET_CONFIG_PROPERTY_SOURCE_NAME, portletConfig)); + if(portletConfig != null && propertySources.contains(StandardPortletEnvironment.PORTLET_CONFIG_PROPERTY_SOURCE_NAME)) { + propertySources.replace(StandardPortletEnvironment.PORTLET_CONFIG_PROPERTY_SOURCE_NAME, + new PortletConfigPropertySource(StandardPortletEnvironment.PORTLET_CONFIG_PROPERTY_SOURCE_NAME, portletConfig)); } } diff --git a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/DefaultPortletEnvironment.java b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/StandardPortletEnvironment.java similarity index 84% rename from org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/DefaultPortletEnvironment.java rename to org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/StandardPortletEnvironment.java index c4def113c00..c4f241bc113 100644 --- a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/DefaultPortletEnvironment.java +++ b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/StandardPortletEnvironment.java @@ -32,16 +32,16 @@ import org.springframework.web.context.support.StandardServletEnvironment; * applications. All Portlet-related {@code ApplicationContext} classes initialize an instance * by default. * - *

Contributes {@code ServletContext}-, {@code PortletContext}-, and {@code PortletConfig}-based - * {@link PropertySource} instances. See the {@link #DefaultPortletEnvironment()} constructor - * for details. + *

Contributes {@code ServletContext}-, {@code PortletContext}-, and + * {@code PortletConfig}-based {@link PropertySource} instances. See the + * {@link #customizePropertySources} method for details. * * @author Chris Beams * @since 3.1 * @see StandardEnvironment * @see StandardServletEnvironment */ -public class DefaultPortletEnvironment extends StandardEnvironment { +public class StandardPortletEnvironment extends StandardEnvironment { /** Portlet context init parameters property source name: {@value} */ public static final String PORTLET_CONTEXT_PROPERTY_SOURCE_NAME = "portletContextInitParams"; @@ -59,14 +59,14 @@ public class DefaultPortletEnvironment extends StandardEnvironment { * *

Properties present in {@value #PORTLET_CONFIG_PROPERTY_SOURCE_NAME} will * take precedence over those in {@value #PORTLET_CONTEXT_PROPERTY_SOURCE_NAME}, - * which takes precedence over those in - * {@linkplain StandardServletEnvironment#SERVLET_CONTEXT_PROPERTY_SOURCE_NAME "servletContextInitParams"}. - *

Properties in any of the above will take precedence over system properties and environment - * variables contributed by the {@link StandardEnvironment} superclass. + * which takes precedence over those in {@linkplain + * StandardServletEnvironment#SERVLET_CONTEXT_PROPERTY_SOURCE_NAME "servletContextInitParams"}. + *

Properties in any of the above will take precedence over system properties and + * environment variables contributed by the {@link StandardEnvironment} superclass. *

The property sources are added as stubs for now, and will be - * {@linkplain PortletApplicationContextUtils#initPortletPropertySources fully initialized} - * once the actual {@link PortletConfig}, {@link PortletContext}, and {@link ServletContext} - * objects are available. + * {@linkplain PortletApplicationContextUtils#initPortletPropertySources fully + * initialized} once the actual {@link PortletConfig}, {@link PortletContext}, and + * {@link ServletContext} objects are available. * @see StandardEnvironment#customizePropertySources * @see PortletConfigPropertySource * @see PortletContextPropertySource diff --git a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/StaticPortletApplicationContext.java b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/StaticPortletApplicationContext.java index cac5932f5ff..56011eb7cd5 100644 --- a/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/StaticPortletApplicationContext.java +++ b/org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/StaticPortletApplicationContext.java @@ -65,11 +65,11 @@ public class StaticPortletApplicationContext extends StaticApplicationContext /** - * Return a new {@link DefaultPortletEnvironment} + * Return a new {@link StandardPortletEnvironment} */ @Override protected ConfigurableEnvironment createEnvironment() { - return new DefaultPortletEnvironment(); + return new StandardPortletEnvironment(); } /** diff --git a/org.springframework.web/src/main/java/org/springframework/web/context/support/StandardServletEnvironment.java b/org.springframework.web/src/main/java/org/springframework/web/context/support/StandardServletEnvironment.java index 63c247ef2ee..c23d62ec237 100644 --- a/org.springframework.web/src/main/java/org/springframework/web/context/support/StandardServletEnvironment.java +++ b/org.springframework.web/src/main/java/org/springframework/web/context/support/StandardServletEnvironment.java @@ -45,7 +45,7 @@ import org.springframework.jndi.JndiPropertySource; * @author Chris Beams * @since 3.1 * @see StandardEnvironment - * @see DefaultPortletEnvironment + * @see StandardPortletEnvironment */ public class StandardServletEnvironment extends StandardEnvironment {