Support for embedded Tomcat 8 container parallel to the current Tomcat 7

pom.xml

@@ -22,6 +22,7 @@
 		<module>spring-boot-starters</module>
 		<module>spring-boot-cli</module>
 		<module>spring-boot-integration-tests</module>
+		<module>spring-boot-containers/spring-boot-tomcat8</module>
 	</modules>
 	<build>
 		<plugins>

spring-boot-containers/spring-boot-tomcat8/pom.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-parent</artifactId>
+		<version>0.5.0.BUILD-SNAPSHOT</version>
+		<relativePath>../../spring-boot-parent</relativePath>
+	</parent>
+	<artifactId>spring-boot-tomcat8</artifactId>
+	<packaging>jar</packaging>
+	<properties>
+		<main.basedir>${basedir}/../..</main.basedir>
+		<tomcat8.version>8.0.0-RC1</tomcat8.version>
+	</properties>
+	<dependencies>
+		<!-- Compile -->
+		<dependency>
+			<groupId>${project.groupId}</groupId>
+			<artifactId>spring-boot</artifactId>
+			<version>${project.version}</version>
+		</dependency>
+		<!-- Optional -->
+		<dependency>
+			<groupId>org.apache.tomcat.embed</groupId>
+			<artifactId>tomcat-embed-core</artifactId>
+			<version>${tomcat8.version}</version>
+			<optional>true</optional>
+		</dependency>
+		<!-- Test -->
+	</dependencies>
+	<build>
+		<plugins>
+			<plugin>
+				<artifactId>maven-jar-plugin</artifactId>
+				<executions>
+					<execution>
+						<goals>
+							<goal>test-jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+</project>

spring-boot-containers/spring-boot-tomcat8/src/main/java/org/springframework/boot/context/embedded/tomcat8/ServletContextInitializerLifecycleListener.java

+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.context.embedded.tomcat8;
+
+import javax.servlet.ServletException;
+
+import org.apache.catalina.Lifecycle;
+import org.apache.catalina.LifecycleEvent;
+import org.apache.catalina.LifecycleListener;
+import org.apache.catalina.core.StandardContext;
+import org.springframework.boot.context.embedded.ServletContextInitializer;
+import org.springframework.util.Assert;
+
+/**
+ * Tomcat {@link LifecycleListener} that calls {@link ServletContextInitializer}s.
+ * 
+ * @author Phillip Webb
+ */
+public class ServletContextInitializerLifecycleListener implements LifecycleListener {
+
+	private ServletContextInitializer[] initializers;
+
+	/**
+	 * Create a new {@link ServletContextInitializerLifecycleListener} instance with the
+	 * specified initializers.
+	 * @param initializers the initializers to call
+	 */
+	public ServletContextInitializerLifecycleListener(
+			ServletContextInitializer... initializers) {
+		this.initializers = initializers;
+	}
+
+	@Override
+	public void lifecycleEvent(LifecycleEvent event) {
+		if (Lifecycle.CONFIGURE_START_EVENT.equals(event.getType())) {
+			Assert.isInstanceOf(StandardContext.class, event.getSource());
+			StandardContext standardContext = (StandardContext) event.getSource();
+			for (ServletContextInitializer initializer : this.initializers) {
+				try {
+					initializer.onStartup(standardContext.getServletContext());
+				}
+				catch (ServletException ex) {
+					throw new IllegalStateException(ex);
+				}
+			}
+		}
+	}
+
+}

spring-boot-containers/spring-boot-tomcat8/src/main/java/org/springframework/boot/context/embedded/tomcat8/TomcatContextCustomizer.java

+/*
+ * Copyright 2012-2013 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.context.embedded.tomcat8;
+
+import org.apache.catalina.Context;
+
+/**
+ * @author Dave Syer
+ */
+public interface TomcatContextCustomizer {
+
+	/**
+	 * @param context the context to customize
+	 */
+	void customize(Context context);
+
+}

spring-boot-containers/spring-boot-tomcat8/src/main/java/org/springframework/boot/context/embedded/tomcat8/TomcatEmbeddedServletContainer.java

+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.context.embedded.tomcat8;
+
+import org.apache.catalina.LifecycleException;
+import org.apache.catalina.connector.Connector;
+import org.apache.catalina.startup.Tomcat;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.boot.context.embedded.EmbeddedServletContainer;
+import org.springframework.boot.context.embedded.EmbeddedServletContainerException;
+import org.springframework.util.Assert;
+
+/**
+ * {@link EmbeddedServletContainer} that can be used to control an embedded Tomcat server.
+ * Usually this class should be created using the
+ * {@link TomcatEmbeddedServletContainerFactory} and not directly.
+ * 
+ * @author Phillip Webb
+ * @author Dave Syer
+ * @see TomcatEmbeddedServletContainerFactory
+ */
+public class TomcatEmbeddedServletContainer implements EmbeddedServletContainer {
+
+	private final Log logger = LogFactory.getLog(TomcatEmbeddedServletContainer.class);
+
+	private static int containerCounter = 0;
+
+	private final Tomcat tomcat;
+
+	/**
+	 * Create a new {@link TomcatEmbeddedServletContainer} instance.
+	 * @param tomcat the underlying Tomcat server
+	 */
+	public TomcatEmbeddedServletContainer(Tomcat tomcat) {
+		Assert.notNull(tomcat, "Tomcat Server must not be null");
+		this.tomcat = tomcat;
+		initialize();
+	}
+
+	private synchronized void initialize() throws EmbeddedServletContainerException {
+		try {
+			this.tomcat.start();
+			// Unlike Jetty, all Tomcat threads are daemon threads. We create a
+			// blocking non-daemon to stop immediate shutdown
+			Thread awaitThread = new Thread("container-" + (containerCounter++)) {
+				@Override
+				public void run() {
+					TomcatEmbeddedServletContainer.this.tomcat.getServer().await();
+				};
+			};
+			awaitThread.setDaemon(false);
+			awaitThread.start();
+		}
+		catch (Exception ex) {
+			throw new EmbeddedServletContainerException(
+					"Unable to start embdedded Tomcat", ex);
+		}
+	}
+
+	@Override
+	public void start() throws EmbeddedServletContainerException {
+		Connector connector = this.tomcat.getConnector();
+		if (connector != null) {
+			try {
+				connector.getProtocolHandler().resume();
+			}
+			catch (Exception e) {
+				this.logger.error("Cannot start connector: ", e);
+			}
+		}
+	}
+
+	@Override
+	public synchronized void stop() throws EmbeddedServletContainerException {
+		try {
+			try {
+				this.tomcat.stop();
+			}
+			catch (LifecycleException ex) {
+				// swallow and continue
+			}
+			this.tomcat.destroy();
+		}
+		catch (Exception ex) {
+			throw new EmbeddedServletContainerException(
+					"Unable to stop embdedded Tomcat", ex);
+		}
+	}
+
+	/**
+	 * Returns access to the underlying Tomcat server.
+	 */
+	public Tomcat getTomcat() {
+		return this.tomcat;
+	}
+
+}

spring-boot-containers/spring-boot-tomcat8/src/main/java/org/springframework/boot/context/embedded/tomcat8/TomcatEmbeddedWebappClassLoader.java

+package org.springframework.boot.context.embedded.tomcat8;
+
+/*
+ * Copyright 2012-2013 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.catalina.loader.WebappClassLoader;
+
+/**
+ * Extension of Tomcat's {@link WebappClassLoader} that does not consider the
+ * {@link ClassLoader#getSystemClassLoader() system classloader}. This is required to to
+ * ensure that any custom context classloader is always used (as is the case with some
+ * executable archives).
+ * 
+ * @author Phillip Webb
+ */
+public class TomcatEmbeddedWebappClassLoader extends WebappClassLoader {
+
+	public TomcatEmbeddedWebappClassLoader() {
+		super();
+	}
+
+	public TomcatEmbeddedWebappClassLoader(ClassLoader parent) {
+		super(parent);
+	}
+
+	@Override
+	public synchronized Class<?> loadClass(String name, boolean resolve)
+			throws ClassNotFoundException {
+
+		Class<?> resultClass = null;
+
+		// Check local class caches
+		resultClass = (resultClass == null ? findLoadedClass0(name) : resultClass);
+		resultClass = (resultClass == null ? findLoadedClass(name) : resultClass);
+		if (resultClass != null) {
+			return resolveIfNecessary(resultClass, resolve);
+		}
+
+		// Check security
+		checkPackageAccess(name);
+
+		// Perform the actual load
+		boolean delegateLoad = (this.delegate || filter(name));
+
+		if (delegateLoad) {
+			resultClass = (resultClass == null ? loadFromParent(name) : resultClass);
+		}
+		resultClass = (resultClass == null ? findClassIgnoringNotFound(name)
+				: resultClass);
+		if (!delegateLoad) {
+			resultClass = (resultClass == null ? loadFromParent(name) : resultClass);
+		}
+
+		if (resultClass == null) {
+			throw new ClassNotFoundException(name);
+		}
+
+		return resolveIfNecessary(resultClass, resolve);
+	}
+
+	private Class<?> resolveIfNecessary(Class<?> resultClass, boolean resolve) {
+		if (resolve) {
+			resolveClass(resultClass);
+		}
+		return (resultClass);
+	}
+
+	private Class<?> loadFromParent(String name) {
+		if (this.parent == null) {
+			return null;
+		}
+		try {
+			return Class.forName(name, false, this.parent);
+		}
+		catch (ClassNotFoundException e) {
+			return null;
+		}
+	}
+
+	private Class<?> findClassIgnoringNotFound(String name) {
+		try {
+			return findClass(name);
+		}
+		catch (ClassNotFoundException e) {
+			return null;
+		}
+	}
+
+	private void checkPackageAccess(String name) throws ClassNotFoundException {
+		if (this.securityManager != null && name.lastIndexOf('.') >= 0) {
+			try {
+				this.securityManager.checkPackageAccess(name.substring(0,
+						name.lastIndexOf('.')));
+			}
+			catch (SecurityException se) {
+				throw new ClassNotFoundException("Security Violation, attempt to use "
+						+ "Restricted Class: " + name, se);
+			}
+		}
+	}
+
+}

spring-boot-containers/spring-boot-tomcat8/src/main/java/org/springframework/boot/context/embedded/tomcat8/package-info.java

+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Support for Tomcat {@link org.springframework.boot.context.embedded.EmbeddedServletContainer EmbeddedServletContainers}.
+ */
+package org.springframework.boot.context.embedded.tomcat8;
+