Add display-name option

Allow the display-name of the application to be customized when deployed in an embedded container via the `server.display-name` property. Closes spring-projectsgh-2600
Eviradnus · May 15, 2015 · 62a2dd6 · 62a2dd6
1 parent 0a9b8cb
commit 62a2dd6
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 0 deletions.
diff --git a/...oconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java b/...oconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java
@@ -80,6 +80,11 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer, Ord
 	 */
 	private String contextPath;
 
+	/**
+	 * Display name of the application.
+	 */
+	private String displayName = "application";
+
 	@NestedConfigurationProperty
 	private Ssl ssl;
 
@@ -122,6 +127,14 @@ public void setContextPath(String contextPath) {
 		this.contextPath = contextPath;
 	}
 
+	public String getDisplayName() {
+		return this.displayName;
+	}
+
+	public void setDisplayName(String displayName) {
+		this.displayName = displayName;
+	}
+
 	public String getServletPath() {
 		return this.servletPath;
 	}
@@ -213,6 +226,9 @@ public void customize(ConfigurableEmbeddedServletContainer container) {
 		if (getContextPath() != null) {
 			container.setContextPath(getContextPath());
 		}
+		if (getDisplayName() != null) {
+			container.setDisplayName(getDisplayName());
+		}
 		if (getSessionTimeout() != null) {
 			container.setSessionTimeout(getSessionTimeout());
 		}

diff --git a/...igure/src/test/java/org/springframework/boot/autoconfigure/web/ServerPropertiesTests.java b/...igure/src/test/java/org/springframework/boot/autoconfigure/web/ServerPropertiesTests.java
@@ -112,6 +112,21 @@ public void testCustomizeTomcat() throws Exception {
 		verify(factory, never()).setContextPath("");
 	}
 
+	@Test
+	public void testDefaultDisplayName() throws Exception {
+		ConfigurableEmbeddedServletContainer factory = mock(ConfigurableEmbeddedServletContainer.class);
+		this.properties.customize(factory);
+		verify(factory).setDisplayName("application");
+	}
+
+	@Test
+	public void testCustomizeDisplayName() throws Exception {
+		ConfigurableEmbeddedServletContainer factory = mock(ConfigurableEmbeddedServletContainer.class);
+		this.properties.setDisplayName("TestName");
+		this.properties.customize(factory);
+		verify(factory).setDisplayName("TestName");
+	}
+
 	@Test
 	public void testCustomizeTomcatPort() throws Exception {
 		ConfigurableEmbeddedServletContainer factory = mock(ConfigurableEmbeddedServletContainer.class);
@@ -136,6 +151,18 @@ public void testCustomizeTomcatHeaderSize() throws Exception {
 		assertEquals(9999, this.properties.getTomcat().getMaxHttpHeaderSize());
 	}
 
+	@Test
+	public void customizeTomcatDisplayName() throws Exception {
+		Map<String, String> map = new HashMap<String, String>();
+		map.put("server.display-name", "MyBootApp");
+		bindProperties(map);
+
+		TomcatEmbeddedServletContainerFactory container = new TomcatEmbeddedServletContainerFactory();
+		this.properties.customize(container);
+
+		assertEquals("MyBootApp", container.getDisplayName());
+	}
+
 	@Test
 	public void disableTomcatRemoteIpValve() throws Exception {
 		Map<String, String> map = new HashMap<String, String>();

diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
@@ -61,6 +61,7 @@ content into your application; rather pick only the properties that you need.
 	server.jsp-servlet.init-parameters.*= # Init parameters used to configure the JSP servlet
 	server.jsp-servlet.registered=true # Whether or not the JSP servlet is registered
 	server.servlet-path= # the servlet path, defaults to '/'
+	server.display-name= # the display name of the application
 	server.ssl.enabled=true # if SSL support is enabled
 	server.ssl.client-auth= # want or need
 	server.ssl.key-alias=

diff --git a/...g/springframework/boot/context/embedded/AbstractConfigurableEmbeddedServletContainer.java b/...g/springframework/boot/context/embedded/AbstractConfigurableEmbeddedServletContainer.java
@@ -34,6 +34,7 @@
  * @author Phillip Webb
  * @author Dave Syer
  * @author Andy Wilkinson
+ * @author Stephane Nicoll
  * @see AbstractEmbeddedServletContainerFactory
  */
 public abstract class AbstractConfigurableEmbeddedServletContainer implements
@@ -44,6 +45,8 @@ public abstract class AbstractConfigurableEmbeddedServletContainer implements
 
 	private String contextPath = "";
 
+	private String displayName;
+
 	private boolean registerDefaultServlet = true;
 
 	private int port = 8080;
@@ -120,6 +123,15 @@ public String getContextPath() {
 		return this.contextPath;
 	}
 
+	@Override
+	public void setDisplayName(String displayName) {
+		this.displayName = displayName;
+	}
+
+	public String getDisplayName() {
+		return this.displayName;
+	}
+
 	@Override
 	public void setPort(int port) {
 		this.port = port;

diff --git a/.../java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java b/.../java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java
@@ -28,6 +28,7 @@
  *
  * @author Dave Syer
  * @author Andy Wilkinson
+ * @author Stephane Nicoll
  * @see EmbeddedServletContainerFactory
  * @see EmbeddedServletContainerCustomizer
  */
@@ -41,6 +42,12 @@ public interface ConfigurableEmbeddedServletContainer {
 	 */
 	void setContextPath(String contextPath);
 
+	/**
+	 * Sets the display name of the application deployed in the embedded servlet container.
+	 * @param displayName the displayName to set
+	 */
+	void setDisplayName(String displayName);
+
 	/**
 	 * Sets the port that the embedded servlet container should listen on. If not
 	 * specified port '8080' will be used. Use port -1 to disable auto-start (i.e start

diff --git a/...org/springframework/boot/context/embedded/jetty/JettyEmbeddedServletContainerFactory.java b/...org/springframework/boot/context/embedded/jetty/JettyEmbeddedServletContainerFactory.java
@@ -231,6 +231,7 @@ protected final void configureWebAppContext(WebAppContext context,
 		}
 		String contextPath = getContextPath();
 		context.setContextPath(StringUtils.hasLength(contextPath) ? contextPath : "/");
+		context.setDisplayName(getDisplayName());
 		configureDocumentRoot(context);
 		if (isRegisterDefaultServlet()) {
 			addDefaultServlet(context);

diff --git a/...g/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactory.java b/...g/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactory.java
@@ -161,6 +161,7 @@ protected void prepareContext(Host host, ServletContextInitializer[] initializer
 		docBase = (docBase != null ? docBase : createTempDir("tomcat-docbase"));
 		TomcatEmbeddedContext context = new TomcatEmbeddedContext();
 		context.setName(getContextPath());
+		context.setDisplayName(getDisplayName());
 		context.setPath(getContextPath());
 		context.setDocBase(docBase.getAbsolutePath());
 		context.addLifecycleListener(new FixContextListener());

diff --git a/...ringframework/boot/context/embedded/undertow/UndertowEmbeddedServletContainerFactory.java b/...ringframework/boot/context/embedded/undertow/UndertowEmbeddedServletContainerFactory.java
@@ -325,6 +325,7 @@ private DeploymentManager createDeploymentManager(
 				initializers);
 		deployment.setClassLoader(getServletClassLoader());
 		deployment.setContextPath(getContextPath());
+		deployment.setDisplayName(getDisplayName());
 		deployment.setDeploymentName("spring-boot");
 		if (isRegisterDefaultServlet()) {
 			deployment.addServlet(Servlets.servlet("default", DefaultServlet.class));