If {@code null}, a new environment will be initialized via + * Set the {@code Environment} for this application context. + *
Default value is determined by {@link #createEnvironment()}. Replacing the + * default with this method is one option but configuration through {@link + * #getEnvironment()} should also be considered. In either case, such modifications + * should be performed before {@link #refresh()}. + * @see org.springframework.context.support.AbstractApplicationContext#createEnvironment + */ + @Override + public void setEnvironment(ConfigurableEnvironment environment) { + this.environment = environment; + } + + /** + * Return the {@code Environment} for this application context in configurable + * form, allowing for further customization. + *
If none specified, a default environment will be initialized via * {@link #createEnvironment()}. */ @Override @@ -294,16 +308,12 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader } /** - * {@inheritDoc} - *
Default value is determined by {@link #createEnvironment()}. Replacing the - * default with this method is one option but configuration through {@link - * #getEnvironment()} should also be considered. In either case, such modifications - * should be performed before {@link #refresh()}. - * @see org.springframework.context.support.AbstractApplicationContext#createEnvironment + * Create and return a new {@link StandardEnvironment}. + *
Subclasses may override this method in order to supply + * a custom {@link ConfigurableEnvironment} implementation. */ - @Override - public void setEnvironment(ConfigurableEnvironment environment) { - this.environment = environment; + protected ConfigurableEnvironment createEnvironment() { + return new StandardEnvironment(); } /** @@ -444,7 +454,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader //--------------------------------------------------------------------- /** - * {@inheritDoc} + * Set the parent of this application context. *
The parent {@linkplain ApplicationContext#getEnvironment() environment} is * {@linkplain ConfigurableEnvironment#merge(ConfigurableEnvironment) merged} with * this (child) application context environment if the parent is non-{@code null} and @@ -495,15 +505,6 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader return this.applicationListeners; } - /** - * Create and return a new {@link StandardEnvironment}. - *
Subclasses may override this method in order to supply - * a custom {@link ConfigurableEnvironment} implementation. - */ - protected ConfigurableEnvironment createEnvironment() { - return new StandardEnvironment(); - } - @Override public void refresh() throws BeansException, IllegalStateException { synchronized (this.startupShutdownMonitor) { @@ -935,13 +936,9 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * DisposableBean callback for destruction of this instance. - * Only called when the ApplicationContext itself is running - * as a bean in another BeanFactory or ApplicationContext, - * which is rather unusual. - *
The {@code close} method is the native way to - * shut down an ApplicationContext. + *
The {@link #close()} method is the native way to shut down
+ * an ApplicationContext, which this method simply delegates to.
* @see #close()
- * @see org.springframework.beans.factory.access.SingletonBeanFactoryLocator
*/
@Override
public void destroy() {
diff --git a/spring-core/src/main/java/org/springframework/core/env/EnvironmentCapable.java b/spring-core/src/main/java/org/springframework/core/env/EnvironmentCapable.java
index 7d6ca3875fc..b1000487210 100644
--- a/spring-core/src/main/java/org/springframework/core/env/EnvironmentCapable.java
+++ b/spring-core/src/main/java/org/springframework/core/env/EnvironmentCapable.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -41,7 +41,8 @@ package org.springframework.core.env;
public interface EnvironmentCapable {
/**
- * Return the {@link Environment} associated with this component.
+ * Return the {@link Environment} associated with this component
+ * (may be {@code null} or a default environment).
*/
Environment getEnvironment();
diff --git a/spring-web/src/main/java/org/springframework/web/filter/GenericFilterBean.java b/spring-web/src/main/java/org/springframework/web/filter/GenericFilterBean.java
index 1ba6be4f231..bbea6275cc3 100644
--- a/spring-web/src/main/java/org/springframework/web/filter/GenericFilterBean.java
+++ b/spring-web/src/main/java/org/springframework/web/filter/GenericFilterBean.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -38,10 +38,12 @@ import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
+import org.springframework.core.env.EnvironmentCapable;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceEditor;
import org.springframework.core.io.ResourceLoader;
import org.springframework.util.Assert;
+import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.context.ServletContextAware;
import org.springframework.web.context.support.ServletContextResourceLoader;
@@ -75,25 +77,21 @@ import org.springframework.web.util.NestedServletException;
* @see #initFilterBean
* @see #doFilter
*/
-public abstract class GenericFilterBean implements
- Filter, BeanNameAware, EnvironmentAware, ServletContextAware, InitializingBean, DisposableBean {
+public abstract class GenericFilterBean implements Filter, BeanNameAware, EnvironmentAware,
+ EnvironmentCapable, ServletContextAware, InitializingBean, DisposableBean {
/** Logger available to subclasses */
protected final Log logger = LogFactory.getLog(getClass());
- /**
- * Set of required properties (Strings) that must be supplied as
- * config parameters to this filter.
- */
- private final Set Any environment set here overrides the {@link StandardServletEnvironment}
* provided by default.
* This {@code Environment} object is used only for resolving placeholders in
* resource paths passed into init-parameters for this filter. If no init-params are
* used, this {@code Environment} can be essentially ignored.
- * @see #init(FilterConfig)
*/
@Override
public void setEnvironment(Environment environment) {
this.environment = environment;
}
+ /**
+ * Return the {@link Environment} associated with this filter.
+ * If none specified, a default environment will be initialized via
+ * {@link #createEnvironment()}.
+ * @since 4.3.9
+ */
+ @Override
+ public Environment getEnvironment() {
+ if (this.environment == null) {
+ this.environment = createEnvironment();
+ }
+ return this.environment;
+ }
+
+ /**
+ * Create and return a new {@link StandardServletEnvironment}.
+ * Subclasses may override this in order to configure the environment or
+ * specialize the environment type returned.
+ * @since 4.3.9
+ */
+ protected Environment createEnvironment() {
+ return new StandardServletEnvironment();
+ }
+
/**
* Stores the ServletContext that the bean factory runs in.
* Only relevant in case of initialization as bean, to have a ServletContext
@@ -130,7 +151,7 @@ public abstract class GenericFilterBean implements
* @see #getServletContext()
*/
@Override
- public final void setServletContext(ServletContext servletContext) {
+ public void setServletContext(ServletContext servletContext) {
this.servletContext = servletContext;
}
@@ -147,6 +168,16 @@ public abstract class GenericFilterBean implements
initFilterBean();
}
+ /**
+ * Subclasses may override this to perform custom filter shutdown.
+ * Note: This method will be called from standard filter destruction
+ * as well as filter bean destruction in a Spring application context.
+ * This default implementation is empty.
+ */
+ @Override
+ public void destroy() {
+ }
+
/**
* Subclasses can invoke this method to specify that this property
@@ -180,19 +211,25 @@ public abstract class GenericFilterBean implements
this.filterConfig = filterConfig;
// Set bean properties from init parameters.
- try {
- PropertyValues pvs = new FilterConfigPropertyValues(filterConfig, this.requiredProperties);
- BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
- ResourceLoader resourceLoader = new ServletContextResourceLoader(filterConfig.getServletContext());
- bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, this.environment));
- initBeanWrapper(bw);
- bw.setPropertyValues(pvs, true);
- }
- catch (BeansException ex) {
- String msg = "Failed to set bean properties on filter '" +
- filterConfig.getFilterName() + "': " + ex.getMessage();
- logger.error(msg, ex);
- throw new NestedServletException(msg, ex);
+ PropertyValues pvs = new FilterConfigPropertyValues(filterConfig, this.requiredProperties);
+ if (!pvs.isEmpty()) {
+ try {
+ BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
+ ResourceLoader resourceLoader = new ServletContextResourceLoader(filterConfig.getServletContext());
+ Environment env = this.environment;
+ if (env == null) {
+ env = new StandardServletEnvironment();
+ }
+ bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, env));
+ initBeanWrapper(bw);
+ bw.setPropertyValues(pvs, true);
+ }
+ catch (BeansException ex) {
+ String msg = "Failed to set bean properties on filter '" +
+ filterConfig.getFilterName() + "': " + ex.getMessage();
+ logger.error(msg, ex);
+ throw new NestedServletException(msg, ex);
+ }
}
// Let subclasses do whatever initialization they like.
@@ -214,6 +251,20 @@ public abstract class GenericFilterBean implements
protected void initBeanWrapper(BeanWrapper bw) throws BeansException {
}
+ /**
+ * Subclasses may override this to perform custom initialization.
+ * All bean properties of this filter will have been set before this
+ * method is invoked.
+ * Note: This method will be called from standard filter initialization
+ * as well as filter bean initialization in a Spring application context.
+ * Filter name and ServletContext will be available in both cases.
+ * This default implementation is empty.
+ * @throws ServletException if subclass initialization fails
+ * @see #getFilterName()
+ * @see #getServletContext()
+ */
+ protected void initFilterBean() throws ServletException {
+ }
/**
* Make the FilterConfig of this filter available, if any.
@@ -258,32 +309,6 @@ public abstract class GenericFilterBean implements
}
- /**
- * Subclasses may override this to perform custom initialization.
- * All bean properties of this filter will have been set before this
- * method is invoked.
- * Note: This method will be called from standard filter initialization
- * as well as filter bean initialization in a Spring application context.
- * Filter name and ServletContext will be available in both cases.
- * This default implementation is empty.
- * @throws ServletException if subclass initialization fails
- * @see #getFilterName()
- * @see #getServletContext()
- */
- protected void initFilterBean() throws ServletException {
- }
-
- /**
- * Subclasses may override this to perform custom filter shutdown.
- * Note: This method will be called from standard filter destruction
- * as well as filter bean destruction in a Spring application context.
- * This default implementation is empty.
- */
- @Override
- public void destroy() {
- }
-
-
/**
* PropertyValues implementation created from FilterConfig init parameters.
*/
@@ -298,14 +323,14 @@ public abstract class GenericFilterBean implements
* @throws ServletException if any required properties are missing
*/
public FilterConfigPropertyValues(FilterConfig config, Set Any environment set here overrides the {@link StandardServletEnvironment}
+ * provided by default.
+ * @throws IllegalArgumentException if environment is not assignable to
+ * {@code ConfigurableEnvironment}
+ */
+ @Override
+ public void setEnvironment(Environment environment) {
+ Assert.isInstanceOf(ConfigurableEnvironment.class, environment, "ConfigurableEnvironment required");
+ this.environment = (ConfigurableEnvironment) environment;
+ }
+
+ /**
+ * Return the {@link Environment} associated with this servlet.
+ * If none specified, a default environment will be initialized via
+ * {@link #createEnvironment()}.
+ */
+ @Override
+ public ConfigurableEnvironment getEnvironment() {
+ if (this.environment == null) {
+ this.environment = createEnvironment();
+ }
+ return this.environment;
+ }
+
+ /**
+ * Create and return a new {@link StandardServletEnvironment}.
+ * Subclasses may override this in order to configure the environment or
+ * specialize the environment type returned.
+ */
+ protected ConfigurableEnvironment createEnvironment() {
+ return new StandardServletEnvironment();
+ }
+
/**
* Map config parameters onto bean properties of this servlet, and
* invoke subclass initialization.
@@ -119,19 +150,21 @@ public abstract class HttpServletBean extends HttpServlet implements Environment
}
// Set bean properties from init parameters.
- try {
- PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
- BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
- ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
- bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
- initBeanWrapper(bw);
- bw.setPropertyValues(pvs, true);
- }
- catch (BeansException ex) {
- if (logger.isErrorEnabled()) {
- logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
+ PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
+ if (!pvs.isEmpty()) {
+ try {
+ BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
+ ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
+ bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
+ initBeanWrapper(bw);
+ bw.setPropertyValues(pvs, true);
+ }
+ catch (BeansException ex) {
+ if (logger.isErrorEnabled()) {
+ logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
+ }
+ throw ex;
}
- throw ex;
}
// Let subclasses do whatever initialization they like.
@@ -153,6 +186,15 @@ public abstract class HttpServletBean extends HttpServlet implements Environment
protected void initBeanWrapper(BeanWrapper bw) throws BeansException {
}
+ /**
+ * Subclasses may override this to perform custom initialization.
+ * All bean properties of this servlet will have been set before this
+ * method is invoked.
+ * This default implementation is empty.
+ * @throws ServletException if subclass initialization fails
+ */
+ protected void initServletBean() throws ServletException {
+ }
/**
* Overridden method that simply returns {@code null} when no
@@ -175,49 +217,6 @@ public abstract class HttpServletBean extends HttpServlet implements Environment
}
- /**
- * Subclasses may override this to perform custom initialization.
- * All bean properties of this servlet will have been set before this
- * method is invoked.
- * This default implementation is empty.
- * @throws ServletException if subclass initialization fails
- */
- protected void initServletBean() throws ServletException {
- }
-
- /**
- * {@inheritDoc}
- * @throws IllegalArgumentException if environment is not assignable to
- * {@code ConfigurableEnvironment}.
- */
- @Override
- public void setEnvironment(Environment environment) {
- Assert.isInstanceOf(ConfigurableEnvironment.class, environment, "ConfigurableEnvironment required");
- this.environment = (ConfigurableEnvironment) environment;
- }
-
- /**
- * {@inheritDoc}
- * If {@code null}, a new environment will be initialized via
- * {@link #createEnvironment()}.
- */
- @Override
- public ConfigurableEnvironment getEnvironment() {
- if (this.environment == null) {
- this.environment = this.createEnvironment();
- }
- return this.environment;
- }
-
- /**
- * Create and return a new {@link StandardServletEnvironment}. Subclasses may override
- * in order to configure the environment or specialize the environment type returned.
- */
- protected ConfigurableEnvironment createEnvironment() {
- return new StandardServletEnvironment();
- }
-
-
/**
* PropertyValues implementation created from ServletConfig init parameters.
*/
@@ -231,9 +230,9 @@ public abstract class HttpServletBean extends HttpServlet implements Environment
* @throws ServletException if any required properties are missing
*/
public ServletConfigPropertyValues(ServletConfig config, Set