Commit 32b817e7 authored by Stephane Nicoll's avatar Stephane Nicoll

Merge pull request #11242 from izeye:polish-20171202

* pr/11242:
  Polish
parents eec9597d 2c204f21
...@@ -74,7 +74,7 @@ public class ServerProperties { ...@@ -74,7 +74,7 @@ public class ServerProperties {
private String displayName = "application"; private String displayName = "application";
@NestedConfigurationProperty @NestedConfigurationProperty
private ErrorProperties error = new ErrorProperties(); private final ErrorProperties error = new ErrorProperties();
/** /**
* Whether X-Forwarded-* headers should be applied to the HttpRequest. * Whether X-Forwarded-* headers should be applied to the HttpRequest.
...@@ -104,10 +104,10 @@ public class ServerProperties { ...@@ -104,10 +104,10 @@ public class ServerProperties {
private Ssl ssl; private Ssl ssl;
@NestedConfigurationProperty @NestedConfigurationProperty
private Compression compression = new Compression(); private final Compression compression = new Compression();
@NestedConfigurationProperty @NestedConfigurationProperty
private Http2 http2 = new Http2(); private final Http2 http2 = new Http2();
private Servlet servlet = new Servlet(); private Servlet servlet = new Servlet();
......
...@@ -43,8 +43,8 @@ import org.springframework.core.Ordered; ...@@ -43,8 +43,8 @@ import org.springframework.core.Ordered;
* dependencies in the BOM (and its transitives) will be added to the dependency * dependencies in the BOM (and its transitives) will be added to the dependency
* management lookup, so an app can use just the artifact id (e.g. "spring-jdbc") in a * management lookup, so an app can use just the artifact id (e.g. "spring-jdbc") in a
* {@code @Grab}. To install, implement the missing methods and list the class in * {@code @Grab}. To install, implement the missing methods and list the class in
* {@code META-INF/services/org.springframework.boot.cli.compiler.SpringBootAstTransformation} * {@code META-INF/services/org.springframework.boot.cli.compiler.SpringBootAstTransformation}.
* . The {@link #getOrder()} value needs to be before * The {@link #getOrder()} value needs to be before
* {@link DependencyManagementBomTransformation#ORDER}. * {@link DependencyManagementBomTransformation#ORDER}.
* *
* @author Dave Syer * @author Dave Syer
......
...@@ -40,7 +40,7 @@ public class DevToolsProperties { ...@@ -40,7 +40,7 @@ public class DevToolsProperties {
private Livereload livereload = new Livereload(); private Livereload livereload = new Livereload();
@NestedConfigurationProperty @NestedConfigurationProperty
private RemoteDevToolsProperties remote = new RemoteDevToolsProperties(); private final RemoteDevToolsProperties remote = new RemoteDevToolsProperties();
public Restart getRestart() { public Restart getRestart() {
return this.restart; return this.restart;
......
...@@ -46,9 +46,9 @@ content into your application. Rather, pick only the properties that you need. ...@@ -46,9 +46,9 @@ content into your application. Rather, pick only the properties that you need.
logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG` logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`
logging.path= # Location of the log file. For instance, `/var/log` logging.path= # Location of the log file. For instance, `/var/log`
logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup. logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup.
logging.pattern.dateformat= # Appender pattern for log dateformat (default yyyy-MM-dd HH:mm:ss.SSS). Only supported with the default logback setup.
logging.pattern.file= # Appender pattern for output to a file. Supported only with the default Logback setup. logging.pattern.file= # Appender pattern for output to a file. Supported only with the default Logback setup.
logging.pattern.level= # Appender pattern for log level (default: %5p). Supported only with the default Logback setup. logging.pattern.level= # Appender pattern for log level (default: %5p). Supported only with the default Logback setup.
logging.pattern.dateformat= # Appender pattern for log dateformat (default yyyy-MM-dd HH:mm:ss.SSS). Only supported with the default logback setup.
logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized. logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.
# AOP # AOP
...@@ -170,7 +170,7 @@ content into your application. Rather, pick only the properties that you need. ...@@ -170,7 +170,7 @@ content into your application. Rather, pick only the properties that you need.
server.error.include-stacktrace=never # When to include a "stacktrace" attribute. server.error.include-stacktrace=never # When to include a "stacktrace" attribute.
server.error.path=/error # Path of the error controller. server.error.path=/error # Path of the error controller.
server.error.whitelabel.enabled=true # Enable the default error page displayed in browsers in case of a server error. server.error.whitelabel.enabled=true # Enable the default error page displayed in browsers in case of a server error.
server.http2.enabled=true # Whether to enable HTTP/2 support, if the current environment supports it. server.http2.enabled=false # Whether to enable HTTP/2 support, if the current environment supports it.
server.jetty.acceptors= # Number of acceptor threads to use. server.jetty.acceptors= # Number of acceptor threads to use.
server.jetty.accesslog.append=false # Append to log. server.jetty.accesslog.append=false # Append to log.
server.jetty.accesslog.date-format=dd/MMM/yyyy:HH:mm:ss Z # Timestamp format of the request log. server.jetty.accesslog.date-format=dd/MMM/yyyy:HH:mm:ss Z # Timestamp format of the request log.
......
...@@ -729,7 +729,7 @@ out-of-the-box by JDK8. ...@@ -729,7 +729,7 @@ out-of-the-box by JDK8.
[NOTE] [NOTE]
==== ====
Spring Boot does not support `h2c`, the cleartext version of the HTTP/2 protocol. So you Spring Boot does not support `h2c`, the cleartext version of the HTTP/2 protocol. So you
must configure <<howto-configure-ssl, configure SSL first>>. must <<howto-configure-ssl, configure SSL first>>.
==== ====
Currently, only Undertow and Tomcat are supported with this configuration key. Currently, only Undertow and Tomcat are supported with this configuration key.
......
...@@ -238,7 +238,7 @@ public class SpringBootContextLoader extends AbstractContextLoader { ...@@ -238,7 +238,7 @@ public class SpringBootContextLoader extends AbstractContextLoader {
/** /**
* Detect the default configuration classes for the supplied test class. By default * Detect the default configuration classes for the supplied test class. By default
* simply delegates to * simply delegates to
* {@link AnnotationConfigContextLoaderUtils#detectDefaultConfigurationClasses} . * {@link AnnotationConfigContextLoaderUtils#detectDefaultConfigurationClasses}.
* @param declaringClass the test class that declared {@code @ContextConfiguration} * @param declaringClass the test class that declared {@code @ContextConfiguration}
* @return an array of default configuration classes, potentially empty but never * @return an array of default configuration classes, potentially empty but never
* {@code null} * {@code null}
......
...@@ -24,7 +24,7 @@ import java.util.Set; ...@@ -24,7 +24,7 @@ import java.util.Set;
* Helper class for resolving placeholders in texts. Usually applied to file paths. * Helper class for resolving placeholders in texts. Usually applied to file paths.
* <p> * <p>
* A text may contain {@code $ ...} placeholders, to be resolved as system properties: * A text may contain {@code $ ...} placeholders, to be resolved as system properties:
* e.g. {@code $ user.dir} . Default values can be supplied using the ":" separator * e.g. {@code $ user.dir}. Default values can be supplied using the ":" separator
* between key and value. * between key and value.
* <p> * <p>
* Adapted from Spring. * Adapted from Spring.
......
...@@ -416,7 +416,7 @@ public class JettyServletWebServerFactory extends AbstractServletWebServerFactor ...@@ -416,7 +416,7 @@ public class JettyServletWebServerFactory extends AbstractServletWebServerFactor
} }
/** /**
* Factory method called to create the {@link JettyWebServer} . Subclasses can * Factory method called to create the {@link JettyWebServer}. Subclasses can
* override this method to return a different {@link JettyWebServer} or apply * override this method to return a different {@link JettyWebServer} or apply
* additional processing to the Jetty server. * additional processing to the Jetty server.
* @param server the Jetty server. * @param server the Jetty server.
......
...@@ -163,7 +163,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac ...@@ -163,7 +163,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac
/** /**
* Set {@link TomcatContextCustomizer}s that should be applied to the Tomcat * Set {@link TomcatContextCustomizer}s that should be applied to the Tomcat
* {@link Context} . Calling this method will replace any existing customizers. * {@link Context}. Calling this method will replace any existing customizers.
* @param tomcatContextCustomizers the customizers to set * @param tomcatContextCustomizers the customizers to set
*/ */
public void setTomcatContextCustomizers( public void setTomcatContextCustomizers(
...@@ -175,7 +175,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac ...@@ -175,7 +175,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac
/** /**
* Returns a mutable collection of the {@link TomcatContextCustomizer}s that will be * Returns a mutable collection of the {@link TomcatContextCustomizer}s that will be
* applied to the Tomcat {@link Context} . * applied to the Tomcat {@link Context}.
* @return the listeners that will be applied * @return the listeners that will be applied
*/ */
public Collection<TomcatContextCustomizer> getTomcatContextCustomizers() { public Collection<TomcatContextCustomizer> getTomcatContextCustomizers() {
...@@ -196,7 +196,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac ...@@ -196,7 +196,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac
/** /**
* Set {@link TomcatConnectorCustomizer}s that should be applied to the Tomcat * Set {@link TomcatConnectorCustomizer}s that should be applied to the Tomcat
* {@link Connector} . Calling this method will replace any existing customizers. * {@link Connector}. Calling this method will replace any existing customizers.
* @param tomcatConnectorCustomizers the customizers to set * @param tomcatConnectorCustomizers the customizers to set
*/ */
public void setTomcatConnectorCustomizers( public void setTomcatConnectorCustomizers(
...@@ -220,7 +220,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac ...@@ -220,7 +220,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac
/** /**
* Returns a mutable collection of the {@link TomcatConnectorCustomizer}s that will be * Returns a mutable collection of the {@link TomcatConnectorCustomizer}s that will be
* applied to the Tomcat {@link Connector} . * applied to the Tomcat {@link Connector}.
* @return the customizers that will be applied * @return the customizers that will be applied
*/ */
public Collection<TomcatConnectorCustomizer> getTomcatConnectorCustomizers() { public Collection<TomcatConnectorCustomizer> getTomcatConnectorCustomizers() {
...@@ -228,8 +228,8 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac ...@@ -228,8 +228,8 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac
} }
/** /**
* Set {@link LifecycleListener}s that should be applied to the Tomcat {@link Context} * Set {@link LifecycleListener}s that should be applied to the Tomcat {@link Context}.
* . Calling this method will replace any existing listeners. * Calling this method will replace any existing listeners.
* @param contextLifecycleListeners the listeners to set * @param contextLifecycleListeners the listeners to set
*/ */
public void setContextLifecycleListeners( public void setContextLifecycleListeners(
...@@ -241,7 +241,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac ...@@ -241,7 +241,7 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac
/** /**
* Returns a mutable collection of the {@link LifecycleListener}s that will be applied * Returns a mutable collection of the {@link LifecycleListener}s that will be applied
* to the Tomcat {@link Context} . * to the Tomcat {@link Context}.
* @return the context lifecycle listeners that will be applied * @return the context lifecycle listeners that will be applied
*/ */
public Collection<LifecycleListener> getContextLifecycleListeners() { public Collection<LifecycleListener> getContextLifecycleListeners() {
......
...@@ -522,8 +522,8 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto ...@@ -522,8 +522,8 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
} }
/** /**
* Set {@link LifecycleListener}s that should be applied to the Tomcat {@link Context} * Set {@link LifecycleListener}s that should be applied to the Tomcat {@link Context}.
* . Calling this method will replace any existing listeners. * Calling this method will replace any existing listeners.
* @param contextLifecycleListeners the listeners to set * @param contextLifecycleListeners the listeners to set
*/ */
public void setContextLifecycleListeners( public void setContextLifecycleListeners(
...@@ -535,7 +535,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto ...@@ -535,7 +535,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
/** /**
* Returns a mutable collection of the {@link LifecycleListener}s that will be applied * Returns a mutable collection of the {@link LifecycleListener}s that will be applied
* to the Tomcat {@link Context} . * to the Tomcat {@link Context}.
* @return the context lifecycle listeners that will be applied * @return the context lifecycle listeners that will be applied
*/ */
public Collection<LifecycleListener> getContextLifecycleListeners() { public Collection<LifecycleListener> getContextLifecycleListeners() {
...@@ -555,7 +555,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto ...@@ -555,7 +555,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
/** /**
* Set {@link TomcatContextCustomizer}s that should be applied to the Tomcat * Set {@link TomcatContextCustomizer}s that should be applied to the Tomcat
* {@link Context} . Calling this method will replace any existing customizers. * {@link Context}. Calling this method will replace any existing customizers.
* @param tomcatContextCustomizers the customizers to set * @param tomcatContextCustomizers the customizers to set
*/ */
public void setTomcatContextCustomizers( public void setTomcatContextCustomizers(
...@@ -567,7 +567,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto ...@@ -567,7 +567,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
/** /**
* Returns a mutable collection of the {@link TomcatContextCustomizer}s that will be * Returns a mutable collection of the {@link TomcatContextCustomizer}s that will be
* applied to the Tomcat {@link Context} . * applied to the Tomcat {@link Context}.
* @return the listeners that will be applied * @return the listeners that will be applied
*/ */
public Collection<TomcatContextCustomizer> getTomcatContextCustomizers() { public Collection<TomcatContextCustomizer> getTomcatContextCustomizers() {
...@@ -588,7 +588,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto ...@@ -588,7 +588,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
/** /**
* Set {@link TomcatConnectorCustomizer}s that should be applied to the Tomcat * Set {@link TomcatConnectorCustomizer}s that should be applied to the Tomcat
* {@link Connector} . Calling this method will replace any existing customizers. * {@link Connector}. Calling this method will replace any existing customizers.
* @param tomcatConnectorCustomizers the customizers to set * @param tomcatConnectorCustomizers the customizers to set
*/ */
public void setTomcatConnectorCustomizers( public void setTomcatConnectorCustomizers(
...@@ -612,7 +612,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto ...@@ -612,7 +612,7 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
/** /**
* Returns a mutable collection of the {@link TomcatConnectorCustomizer}s that will be * Returns a mutable collection of the {@link TomcatConnectorCustomizer}s that will be
* applied to the Tomcat {@link Connector} . * applied to the Tomcat {@link Connector}.
* @return the customizers that will be applied * @return the customizers that will be applied
*/ */
public Collection<TomcatConnectorCustomizer> getTomcatConnectorCustomizers() { public Collection<TomcatConnectorCustomizer> getTomcatConnectorCustomizers() {
......
...@@ -160,7 +160,7 @@ public class UndertowServletWebServerFactory extends AbstractServletWebServerFac ...@@ -160,7 +160,7 @@ public class UndertowServletWebServerFactory extends AbstractServletWebServerFac
/** /**
* Returns a mutable collection of the {@link UndertowBuilderCustomizer}s that will be * Returns a mutable collection of the {@link UndertowBuilderCustomizer}s that will be
* applied to the Undertow {@link Builder} . * applied to the Undertow {@link Builder}.
* @return the customizers that will be applied * @return the customizers that will be applied
*/ */
public Collection<UndertowBuilderCustomizer> getBuilderCustomizers() { public Collection<UndertowBuilderCustomizer> getBuilderCustomizers() {
...@@ -191,7 +191,7 @@ public class UndertowServletWebServerFactory extends AbstractServletWebServerFac ...@@ -191,7 +191,7 @@ public class UndertowServletWebServerFactory extends AbstractServletWebServerFac
/** /**
* Returns a mutable collection of the {@link UndertowDeploymentInfoCustomizer}s that * Returns a mutable collection of the {@link UndertowDeploymentInfoCustomizer}s that
* will be applied to the Undertow {@link DeploymentInfo} . * will be applied to the Undertow {@link DeploymentInfo}.
* @return the customizers that will be applied * @return the customizers that will be applied
*/ */
public Collection<UndertowDeploymentInfoCustomizer> getDeploymentInfoCustomizers() { public Collection<UndertowDeploymentInfoCustomizer> getDeploymentInfoCustomizers() {
......
...@@ -25,7 +25,7 @@ package org.springframework.boot.web.server; ...@@ -25,7 +25,7 @@ package org.springframework.boot.web.server;
public class Http2 { public class Http2 {
/** /**
* If HTTP/2 protocol is enabled. * Whether to enable HTTP/2 support, if the current environment supports it.
*/ */
private boolean enabled = false; private boolean enabled = false;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment