org.springframework.web.context.support
Class StandardServletEnvironment

java.lang.Object
  org.springframework.core.env.AbstractEnvironment
      org.springframework.core.env.StandardEnvironment
          org.springframework.web.context.support.StandardServletEnvironment

All Implemented Interfaces:

ConfigurableEnvironment, ConfigurablePropertyResolver, Environment, PropertyResolver

public class StandardServletEnvironment
extends StandardEnvironment

Environment implementation to be used by Servlet-based web applications. All web-related (servlet-based) ApplicationContext classes initialize an instance by default.

Contributes ServletConfig- and ServletContext-based PropertySource instances. See the customizePropertySources(org.springframework.core.env.MutablePropertySources) method for details.

After initial bootstrapping, property sources will be searched for the presence of a "jndiPropertySourceEnabled" property; if found, a JndiPropertySource will be added to this environment's PropertySources, with precedence higher than system properties and environment variables, but lower than that of ServletContext and ServletConfig init params.

Since:

3.1

Author:

Chris Beams

See Also:

StandardEnvironment, StandardPortletEnvironment

Field Summary

static String	SERVLET_CONFIG_PROPERTY_SOURCE_NAME Servlet config init parameters property source name: "servletConfigInitParams"
static String	SERVLET_CONTEXT_PROPERTY_SOURCE_NAME Servlet context init parameters property source name: "servletContextInitParams"

Fields inherited from class org.springframework.core.env.StandardEnvironment

SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME

Fields inherited from class org.springframework.core.env.AbstractEnvironment

ACTIVE_PROFILES_PROPERTY_NAME, DEFAULT_PROFILES_PROPERTY_NAME, logger, RESERVED_DEFAULT_PROFILE_NAME

Constructor Summary

StandardServletEnvironment()

Method Summary

protected void

customizePropertySources(MutablePropertySources propertySources) Customize the set of property sources with those contributed by superclasses as well as those appropriate for standard servlet-based environments: "servletConfigInitParams" "servletContextInitParams" (optionally) "jndiPropertySource"

Methods inherited from class org.springframework.core.env.AbstractEnvironment

acceptsProfiles, containsProperty, doGetActiveProfiles, doGetDefaultProfiles, getActiveProfiles, getConversionService, getDefaultProfiles, getProperty, getProperty, getProperty, getProperty, getPropertyAsClass, getPropertySources, getRequiredProperty, getRequiredProperty, getReservedDefaultProfiles, getSystemEnvironment, getSystemProperties, resolvePlaceholders, resolveRequiredPlaceholders, setActiveProfiles, setConversionService, setDefaultProfiles, setPlaceholderPrefix, setPlaceholderSuffix, setRequiredProperties, setValueSeparator, toString, validateRequiredProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SERVLET_CONTEXT_PROPERTY_SOURCE_NAME

public static final String SERVLET_CONTEXT_PROPERTY_SOURCE_NAME

Servlet context init parameters property source name: "servletContextInitParams"

See Also:

Constant Field Values

SERVLET_CONFIG_PROPERTY_SOURCE_NAME

public static final String SERVLET_CONFIG_PROPERTY_SOURCE_NAME

Servlet config init parameters property source name: "servletConfigInitParams"

See Also:

Constant Field Values

Constructor Detail

StandardServletEnvironment

public StandardServletEnvironment()

Method Detail

customizePropertySources

protected void customizePropertySources(MutablePropertySources propertySources)

Customize the set of property sources with those contributed by superclasses as well as those appropriate for standard servlet-based environments:

• "servletConfigInitParams"
• "servletContextInitParams"
• (optionally) "jndiPropertySource"

Properties present in "servletConfigInitParams" will take precedence over those in "servletContextInitParams".

Properties in any of the above will take precedence over system properties and environment variables contributed by the StandardEnvironment superclass.

The Servlet-related property sources are added as stubs for now, and will be fully initialized once the actual ServletConfig and ServletContext objects are available.

If the "jndiPropertySourceEnabled" property is present in any of the default property sources, a JndiPropertySource will be added as well, with precedence lower than servlet property sources, but higher than system properties and environment variables.

Overrides:

customizePropertySources in class StandardEnvironment

See Also:

StandardEnvironment.customizePropertySources(org.springframework.core.env.MutablePropertySources), AbstractEnvironment.customizePropertySources(org.springframework.core.env.MutablePropertySources), ServletConfigPropertySource, ServletContextPropertySource, JndiPropertySource, AbstractApplicationContext.initPropertySources(), WebApplicationContextUtils.initServletPropertySources(org.springframework.core.env.MutablePropertySources, javax.servlet.ServletContext)