Home » Spring-Framework-090522 » org.springframework » web » context » support » [javadoc | source]
org.springframework.web.context.support
public class: ServletContextPropertyPlaceholderConfigurer [javadoc | source]
java.lang.Object
   org.springframework.core.io.support.PropertiesLoaderSupport
      org.springframework.beans.factory.config.PropertyResourceConfigurer
         org.springframework.beans.factory.config.PropertyPlaceholderConfigurer
            org.springframework.web.context.support.ServletContextPropertyPlaceholderConfigurer

All Implemented Interfaces:
    ServletContextAware, BeanFactoryAware, BeanNameAware, PriorityOrdered, BeanFactoryPostProcessor

Subclass of PropertyPlaceholderConfigurer that resolves placeholders as ServletContext init parameters (that is, web.xml context-param entries).

Can be combined with "locations" and/or "properties" values in addition to web.xml context-params. Alternatively, can be defined without local properties, to resolve all placeholders as web.xml context-params (or JVM system properties).

If a placeholder could not be resolved against the provided local properties within the application, this configurer will fall back to ServletContext parameters. Can also be configured to let ServletContext init parameters override local properties (contextOverride=true).

Optionally supports searching for ServletContext attributes: If turned on, an otherwise unresolvable placeholder will matched against the corresponding ServletContext attribute, using its stringified value if found. This can be used to feed dynamic values into Spring's placeholder resolution.

If not running within a WebApplicationContext (or any other context that is able to satisfy the ServletContextAware callback), this class will behave like the default PropertyPlaceholderConfigurer. This allows for keeping ServletContextPropertyPlaceholderConfigurer definitions in test suites.

Fields inherited from org.springframework.beans.factory.config.PropertyPlaceholderConfigurer:
DEFAULT_PLACEHOLDER_PREFIX,  DEFAULT_PLACEHOLDER_SUFFIX,  SYSTEM_PROPERTIES_MODE_NEVER,  SYSTEM_PROPERTIES_MODE_FALLBACK,  SYSTEM_PROPERTIES_MODE_OVERRIDE
Fields inherited from org.springframework.core.io.support.PropertiesLoaderSupport:
XML_FILE_EXTENSION,  logger
Method from org.springframework.web.context.support.ServletContextPropertyPlaceholderConfigurer Summary:
resolvePlaceholder,   resolvePlaceholder,   setContextOverride,   setSearchContextAttributes,   setServletContext
Methods from org.springframework.beans.factory.config.PropertyPlaceholderConfigurer:
parseStringValue,   processProperties,   resolvePlaceholder,   resolvePlaceholder,   resolveSystemProperty,   setBeanFactory,   setBeanName,   setIgnoreUnresolvablePlaceholders,   setNullValue,   setPlaceholderPrefix,   setPlaceholderSuffix,   setSearchSystemEnvironment,   setSystemPropertiesMode,   setSystemPropertiesModeName
Methods from org.springframework.beans.factory.config.PropertyResourceConfigurer:
convertProperties,   convertPropertyValue,   getOrder,   postProcessBeanFactory,   processProperties,   setOrder
Methods from org.springframework.core.io.support.PropertiesLoaderSupport:
loadProperties,   mergeProperties,   setFileEncoding,   setIgnoreResourceNotFound,   setLocalOverride,   setLocation,   setLocations,   setProperties,   setPropertiesArray,   setPropertiesPersister
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.web.context.support.ServletContextPropertyPlaceholderConfigurer Detail:
 protected String resolvePlaceholder(String placeholder,
    Properties props) 
 protected String resolvePlaceholder(String placeholder,
    ServletContext servletContext,
    boolean searchContextAttributes) 
    Resolves the given placeholder using the init parameters and optionally also the attributes of the given ServletContext.

    Default implementation checks ServletContext attributes before init parameters. Can be overridden to customize this behavior, potentially also applying specific naming patterns for parameters and/or attributes (instead of using the exact placeholder name).

 public  void setContextOverride(boolean contextOverride) 
    Set whether ServletContext init parameters (and optionally also ServletContext attributes) should override local properties within the application. Default is "false": ServletContext settings serve as fallback.

    Note that system properties will still override ServletContext settings, if the system properties mode is set to "SYSTEM_PROPERTIES_MODE_OVERRIDE".

 public  void setSearchContextAttributes(boolean searchContextAttributes) 
    Set whether to search for matching a ServletContext attribute before checking a ServletContext init parameter. Default is "false": only checking init parameters.

    If turned on, the configurer will look for a ServletContext attribute with the same name as the placeholder, and use its stringified value if found. Exposure of such ServletContext attributes can be used to dynamically override init parameters defined in web.xml, for example in a custom context listener.

 public  void setServletContext(ServletContext servletContext) 
    Set the ServletContext to resolve placeholders against. Will be auto-populated when running in a WebApplicationContext.

    If not set, this configurer will simply not resolve placeholders against the ServletContext: It will effectively behave like a plain PropertyPlaceholderConfigurer in such a scenario.