Skip to content

Commit

Permalink
Ensure DispatcherServlet is available in a deployed WAR
Browse files Browse the repository at this point in the history
The DispatcherServletAutoConfiguration had a condition on it that
meant it wasn't used at all if there was no EmbeddedServletContainerFactory.
It's amazing that any WAR ever deployed.

Also added some info logging to servlet and filter registrations.
  • Loading branch information
Dave Syer committed Feb 19, 2014
1 parent d984cc0 commit 6631dd0
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,9 @@
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
import org.springframework.boot.context.embedded.EmbeddedServletContainerFactory;
import org.springframework.boot.context.web.SpringBootServletInitializer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ConditionContext;
Expand All @@ -51,7 +49,6 @@
@Configuration
@ConditionalOnWebApplication
@ConditionalOnClass(DispatcherServlet.class)
@ConditionalOnBean(EmbeddedServletContainerFactory.class)
@AutoConfigureAfter(EmbeddedServletContainerAutoConfiguration.class)
public class DispatcherServletAutoConfiguration {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,12 @@ protected Collection<ServletContextInitializer> getServletContextInitializerBean
ServletContextInitializer initializer = initializerBean.getValue();
initializers.add(initializer);
if (initializer instanceof ServletRegistrationBean) {
servletRegistrations.add(((ServletRegistrationBean) initializer)
.getServlet());
ServletRegistrationBean servlet = (ServletRegistrationBean) initializer;
servletRegistrations.add(servlet.getServlet());
}
if (initializer instanceof FilterRegistrationBean) {
filterRegistrations.add(((FilterRegistrationBean) initializer)
.getFilter());
FilterRegistrationBean filter = (FilterRegistrationBean) initializer;
filterRegistrations.add(filter.getFilter());
}
if (initializer instanceof ServletListenerRegistrationBean) {
listenerRegistrations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import javax.servlet.ServletContext;
import javax.servlet.ServletException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.util.Assert;

/**
Expand All @@ -48,6 +50,8 @@
*/
public class FilterRegistrationBean extends RegistrationBean {

private static Log logger = LogFactory.getLog(FilterRegistrationBean.class);

static final EnumSet<DispatcherType> ASYNC_DISPATCHER_TYPES = EnumSet.of(
DispatcherType.FORWARD, DispatcherType.INCLUDE, DispatcherType.REQUEST,
DispatcherType.ASYNC);
Expand Down Expand Up @@ -248,15 +252,21 @@ protected void configure(FilterRegistration.Dynamic registration) {
servletNames.addAll(this.servletNames);

if (servletNames.isEmpty() && this.urlPatterns.isEmpty()) {
logger.info("Mapping filter: '" + registration.getName() + "' to: "
+ Arrays.asList(DEFAULT_URL_MAPPINGS));
registration.addMappingForUrlPatterns(dispatcherTypes, this.matchAfter,
DEFAULT_URL_MAPPINGS);
}
else {
if (servletNames.size() > 0) {
logger.info("Mapping filter: '" + registration.getName()
+ "' to servlets: " + servletNames);
registration.addMappingForServletNames(dispatcherTypes, this.matchAfter,
servletNames.toArray(new String[servletNames.size()]));
}
if (this.urlPatterns.size() > 0) {
logger.info("Mapping filter: '" + registration.getName() + "' to urls: "
+ this.urlPatterns);
registration.addMappingForUrlPatterns(dispatcherTypes, this.matchAfter,
this.urlPatterns.toArray(new String[this.urlPatterns.size()]));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.util.Assert;

/**
Expand All @@ -45,6 +47,8 @@
*/
public class ServletRegistrationBean extends RegistrationBean {

private static Log logger = LogFactory.getLog(ServletRegistrationBean.class);

private static final String[] DEFAULT_MAPPINGS = { "/*" };

private Servlet servlet;
Expand Down Expand Up @@ -152,6 +156,7 @@ public String getServletName() {
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
Assert.notNull(this.servlet, "Servlet must not be null");
logger.info("Mapping servlet: '" + getServletName() + "' to " + this.urlMappings);
configure(servletContext.addServlet(getServletName(), this.servlet));
}

Expand Down

0 comments on commit 6631dd0

Please sign in to comment.