GitHub-Spring
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge pull request #10870 from Buzzardo/editing_appendix_application_properties 

* gh-10870:
  Align appendix edits with source code
  Make editorial changes to appendix-application-properties.adoc
pull/11091/head
Phillip Webb 8 years ago
parent
e01c92a38a e82913dd5a
commit
69b92df47d
60 changed files with 747 additions and 729 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/CorsEndpointProperties.java
  2. 2
      spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorProperties.java
  3. 4
      spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaProperties.java
  4. 18
      spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java
  5. 8
      spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/StepRegistryProperties.java
  6. 6
      spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java
  7. 72
      spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
  8. 29
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java
  9. 4
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java
  10. 8
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java
  11. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CassandraProperties.java
  12. 10
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.java
  13. 6
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseProperties.java
  14. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jProperties.java
  15. 15
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java
  16. 8
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestProperties.java
  17. 4
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/jest/JestProperties.java
  18. 8
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java
  19. 6
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerProperties.java
  20. 8
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/h2/H2ConsoleProperties.java
  21. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hateoas/HateoasProperties.java
  22. 11
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/http/HttpEncodingProperties.java
  23. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/influx/InfluxDbProperties.java
  24. 12
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java
  25. 10
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java
  26. 6
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jersey/JerseyProperties.java
  27. 18
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsProperties.java
  28. 26
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQProperties.java
  29. 6
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisProperties.java
  30. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/JooqProperties.java
  31. 38
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java
  32. 4
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapProperties.java
  33. 4
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java
  34. 10
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.java
  35. 6
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java
  36. 8
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoProperties.java
  37. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoProperties.java
  38. 15
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaProperties.java
  39. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/reactor/core/ReactorCoreProperties.java
  40. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java
  41. 4
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/SocialProperties.java
  42. 16
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractTemplateViewResolverProperties.java
  43. 6
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java
  44. 11
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafProperties.java
  45. 2
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionProperties.java
  46. 24
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ResourceProperties.java
  47. 74
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java
  48. 10
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/MultipartProperties.java
  49. 18
      spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java
  50. 78
      spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
  51. 8
      spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsProperties.java
  52. 2
      spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsProperties.java
  53. 743
      spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
  54. 2
      spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java
  55. 14
      spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java
  56. 10
      spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/narayana/NarayanaProperties.java
  57. 2
      spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Compression.java
  58. 2
      spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Ssl.java
  59. 2
      spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/Jsp.java
  60. 40
      spring-boot-project/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/CorsEndpointProperties.java
Unescape View File

@ -56,7 +56,7 @@ public class CorsEndpointProperties { @@ -56,7 +56,7 @@ public class CorsEndpointProperties {
private List<String> exposedHeaders = new ArrayList<>();
/**
* Set whether credentials are supported. When not set, credentials are not supported.
* Whether credentials are supported. When not set, credentials are not supported.
*/
private Boolean allowCredentials;

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorProperties.java
Unescape View File

@ -38,7 +38,7 @@ public class HealthIndicatorProperties { @@ -38,7 +38,7 @@ public class HealthIndicatorProperties {
/**
* Mapping of health statuses to HTTP status codes. By default, registered health
* statuses map to sensible defaults (i.e. UP maps to 200).
* statuses map to sensible defaults (for example, UP maps to 200).
*/
private final Map<String, Integer> httpMapping = new HashMap<>();

4
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaProperties.java
Unescape View File

@ -33,12 +33,12 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -33,12 +33,12 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class JolokiaProperties {
/**
* Enable Jolokia.
* Whether to enable Jolokia.
*/
private boolean enabled;
/**
* Path at which Jolokia will be available.
* Path at which Jolokia is available.
*/
private String path = "/jolokia";

18
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java
Unescape View File

@ -30,9 +30,9 @@ public class MetricsProperties { @@ -30,9 +30,9 @@ public class MetricsProperties {
private Web web = new Web();
/**
* Whether or not auto-configured MeterRegistry implementations should be bound to the
* global static registry on Metrics. For testing, set this to 'false' to maximize
* test independence.
* Whether auto-configured MeterRegistry implementations should be bound to the global
* static registry on Metrics. For testing, set this to 'false' to maximize test
* independence.
*/
private boolean useGlobalRegistry = true;
@ -73,8 +73,8 @@ public class MetricsProperties { @@ -73,8 +73,8 @@ public class MetricsProperties {
public static class Client {
/**
* Whether or not instrumented requests record percentiles histogram buckets
* by default.
* Whether instrumented requests record percentiles histogram buckets by
* default.
*/
private boolean recordRequestPercentiles;
@ -104,10 +104,10 @@ public class MetricsProperties { @@ -104,10 +104,10 @@ public class MetricsProperties {
public static class Server {
/**
* Whether or not requests handled by Spring MVC or WebFlux should be
* automatically timed. If the number of time series emitted grows too large
* on account of request mapping timings, disable this and use 'Timed' on a
* per request mapping basis as needed.
* Whether requests handled by Spring MVC or WebFlux should be automatically
* timed. If the number of time series emitted grows too large on account of
* request mapping timings, disable this and use 'Timed' on a per request
* mapping basis as needed.
*/
private boolean autoTimeRequests = true;

8
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/StepRegistryProperties.java
Unescape View File

@ -34,17 +34,17 @@ public abstract class StepRegistryProperties { @@ -34,17 +34,17 @@ public abstract class StepRegistryProperties {
private Duration step = Duration.ofMinutes(1);
/**
* Enable publishing to the backend.
* Whether exporting of metrics to this backend is enabled.
*/
private Boolean enabled;
/**
* Connection timeout for requests to the backend.
* Connection timeout for requests to this backend.
*/
private Duration connectTimeout;
/**
* Read timeout for requests to the backend.
* Read timeout for requests to this backend.
*/
private Duration readTimeout;
@ -54,7 +54,7 @@ public abstract class StepRegistryProperties { @@ -54,7 +54,7 @@ public abstract class StepRegistryProperties {
private Integer numThreads;
/**
* Number of measurements per request to use for the backend. If more measurements
* Number of measurements per request to use for this backend. If more measurements
* are found, then multiple requests will be made.
*/
private Integer batchSize;

6
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java
Unescape View File

@ -47,12 +47,14 @@ public class ManagementServerProperties implements SecurityPrerequisite { @@ -47,12 +47,14 @@ public class ManagementServerProperties implements SecurityPrerequisite {
private Ssl ssl;
/**
* Network address that the management endpoints should bind to.
* Network address that to which the management endpoints should bind to. Requires a
* custom management.server.port.
*/
private InetAddress address;
/**
* Management endpoint context-path.
* Management endpoint context-path. For instance, '/actuator'. Requires a custom
* management.server.port.
*/
private String contextPath = "";

72
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
Unescape View File

@ -24,7 +24,7 @@ @@ -24,7 +24,7 @@
{
"name": "management.endpoint.trace.filter.enabled",
"type": "java.lang.Boolean",
"description": "Enable the trace servlet filter.",
"description": "Whether to enable the trace servlet filter.",
"defaultValue": true,
"deprecation": {
"replacement": "management.trace.filter.enabled",
@ -34,7 +34,7 @@ @@ -34,7 +34,7 @@
{
"name": "management.endpoints.enabled-by-default",
"type": "java.lang.Boolean",
"description": "Enable or disable all endpoints by default."
"description": "Whether to enable or disable all endpoints by default."
},
{
"name": "management.endpoints.jmx.enabled",
@ -67,121 +67,121 @@ @@ -67,121 +67,121 @@
{
"name": "management.cloudfoundry.enabled",
"type": "java.lang.Boolean",
"description": "Enable extended Cloud Foundry actuator endpoints.",
"description": "Whether to enable extended Cloud Foundry actuator endpoints.",
"defaultValue": true
},
{
"name": "management.cloudfoundry.skip-ssl-validation",
"type": "java.lang.Boolean",
"description": "Skip SSL verification for Cloud Foundry actuator endpoint security calls.",
"description": "Whether to skip SSL verification for Cloud Foundry actuator endpoint security calls.",
"defaultValue": false
},
{
"name": "management.health.cassandra.enabled",
"type": "java.lang.Boolean",
"description": "Enable cassandra health check.",
"description": "Whether to enable cassandra health check.",
"defaultValue": true
},
{
"name": "management.health.couchbase.enabled",
"type": "java.lang.Boolean",
"description": "Enable couchbase health check.",
"description": "Whether to enable couchbase health check.",
"defaultValue": true
},
{
"name": "management.health.db.enabled",
"type": "java.lang.Boolean",
"description": "Enable database health check.",
"description": "Whether to enable database health check.",
"defaultValue": true
},
{
"name": "management.health.defaults.enabled",
"type": "java.lang.Boolean",
"description": "Enable default health indicators.",
"description": "Whether to enable default health indicators.",
"defaultValue": true
},
{
"name": "management.health.diskspace.enabled",
"type": "java.lang.Boolean",
"description": "Enable disk space health check.",
"description": "Whether to enable disk space health check.",
"defaultValue": true
},
{
"name": "management.health.elasticsearch.enabled",
"type": "java.lang.Boolean",
"description": "Enable elasticsearch health check.",
"description": "Whether to enable elasticsearch health check.",
"defaultValue": true
},
{
"name": "management.health.jms.enabled",
"type": "java.lang.Boolean",
"description": "Enable JMS health check.",
"description": "Whether to enable JMS health check.",
"defaultValue": true
},
{
"name": "management.health.ldap.enabled",
"type": "java.lang.Boolean",
"description": "Enable LDAP health check.",
"description": "Whether to enable LDAP health check.",
"defaultValue": true
},
{
"name": "management.health.mongo.enabled",
"type": "java.lang.Boolean",
"description": "Enable MongoDB health check.",
"description": "Whether to enable MongoDB health check.",
"defaultValue": true
},
{
"name": "management.health.rabbit.enabled",
"type": "java.lang.Boolean",
"description": "Enable RabbitMQ health check.",
"description": "Whether to enable RabbitMQ health check.",
"defaultValue": true
},
{
"name": "management.health.redis.enabled",
"type": "java.lang.Boolean",
"description": "Enable Redis health check.",
"description": "Whether to enable Redis health check.",
"defaultValue": true
},
{
"name": "management.health.solr.enabled",
"type": "java.lang.Boolean",
"description": "Enable Solr health check.",
"description": "Whether to enable Solr health check.",
"defaultValue": true
},
{
"name": "management.health.mail.enabled",
"type": "java.lang.Boolean",
"description": "Enable Mail health check.",
"description": "Whether to enable Mail health check.",
"defaultValue": true
},
{
"name": "management.health.neo4j.enabled",
"type": "java.lang.Boolean",
"description": "Enable Neo4j health check.",
"description": "Whether to enable Neo4j health check.",
"defaultValue": true
},
{
"name": "management.info.build.enabled",
"type": "java.lang.Boolean",
"description": "Enable build info.",
"description": "Whether to enable build info.",
"defaultValue": true
},
{
"name": "management.info.defaults.enabled",
"type": "java.lang.Boolean",
"description": "Enable default info contributors.",
"description": "Whether to enable default info contributors.",
"defaultValue": true
},
{
"name": "management.info.env.enabled",
"type": "java.lang.Boolean",
"description": "Enable environment info.",
"description": "Whether to enable environment info.",
"defaultValue": true
},
{
"name": "management.info.git.enabled",
"type": "java.lang.Boolean",
"description": "Enable git info.",
"description": "Whether to enable git info.",
"defaultValue": true
},
{
@ -191,7 +191,7 @@ @@ -191,7 +191,7 @@
{
"name": "management.trace.filter.enabled",
"type": "java.lang.Boolean",
"description": "Enable the trace servlet filter.",
"description": "Whether to enable the trace servlet filter.",
"defaultValue": true
},
{
@ -203,7 +203,7 @@ @@ -203,7 +203,7 @@
{
"name": "endpoints.actuator.enabled",
"type": "java.lang.Boolean",
"description": "Enable the endpoint.",
"description": "Whether to enable the endpoint.",
"deprecation": {
"reason": "The \"actuator\" endpoint is no longer available.",
"level": "error"
@ -384,7 +384,7 @@ @@ -384,7 +384,7 @@
{
"name": "endpoints.docs.curies.enabled",
"type": "java.lang.Boolean",
"description": "Enable the curie generation.",
"description": "Whether to enable the curie generation.",
"defaultValue": false,
"deprecation": {
"reason": "The \"docs\" endpoint is no longer available.",
@ -394,7 +394,7 @@ @@ -394,7 +394,7 @@
{
"name": "endpoints.docs.enabled",
"type": "java.lang.Boolean",
"description": "Enable the endpoint.",
"description": "Whether to enable the endpoint.",
"deprecation": {
"reason": "The \"docs\" endpoint is no longer available.",
"level": "error"
@ -421,7 +421,7 @@ @@ -421,7 +421,7 @@
{
"name": "endpoints.dump.enabled",
"type": "java.lang.Boolean",
"description": "Enable the endpoint.",
"description": "Whether to enable the endpoint.",
"deprecation": {
"replacement": "endpoints.threaddump.enabled",
"level": "error"
@ -457,7 +457,7 @@ @@ -457,7 +457,7 @@
{
"name": "endpoints.enabled",
"type": "java.lang.Boolean",
"description": "Enable endpoints.",
"description": "Whether to enable endpoints.",
"defaultValue": true,
"deprecation": {
"replacement": "endpoints.default.enabled",
@ -576,7 +576,7 @@ @@ -576,7 +576,7 @@
{
"name": "endpoints.hypermedia.enabled",
"type": "java.lang.Boolean",
"description": "Enable hypermedia support for endpoints.",
"description": "Whether to enable hypermedia support for endpoints.",
"defaultValue": false,
"deprecation": {
"reason": "Hypermedia support in the Actuator is no longer available.",
@ -622,7 +622,7 @@ @@ -622,7 +622,7 @@
{
"name": "endpoints.jmx.enabled",
"type": "java.lang.Boolean",
"description": "Enable JMX export of all endpoints.",
"description": "Whether to enable JMX export of all endpoints.",
"defaultValue": true,
"deprecation": {
"replacement": "endpoints.default.jmx.enabled",
@ -641,7 +641,7 @@ @@ -641,7 +641,7 @@
{
"name": "endpoints.jmx.unique-names",
"type": "java.lang.Boolean",
"description": "Ensure that ObjectNames are modified in case of conflict.",
"description": "Whether to ensure that ObjectNames are modified in case of conflict.",
"defaultValue": false,
"deprecation": {
"replacement": "management.endpoints.jmx.unique-names",
@ -651,7 +651,7 @@ @@ -651,7 +651,7 @@
{
"name": "endpoints.jolokia.enabled",
"type": "java.lang.Boolean",
"description": "Enable the endpoint.",
"description": "Whether to enable the endpoint.",
"deprecation": {
"replacement": "management.jolokia.enabled",
"level": "error"
@ -776,7 +776,7 @@ @@ -776,7 +776,7 @@
{
"name": "endpoints.metrics.filter.enabled",
"type": "java.lang.Boolean",
"description": "Enable the metrics servlet filter.",
"description": "Whether to enable the metrics servlet filter.",
"defaultValue": true,
"deprecation": {
"reason": "Metrics support is now using Micrometer.",
@ -893,7 +893,7 @@ @@ -893,7 +893,7 @@
{
"name": "management.security.enabled",
"type": "java.lang.Boolean",
"description": "Enable security.",
"description": "Whether to enable security.",
"defaultValue": true,
"deprecation": {
"reason": "A global security auto-configuration is now provided. Provide your own WebSecurityConfigurer bean instead.",
@ -1050,7 +1050,7 @@ @@ -1050,7 +1050,7 @@
{
"name": "management.shell.ssh.enabled",
"type": "java.lang.Boolean",
"description": "Enable CRaSH SSH support.",
"description": "Whether to enable CRaSH SSH support.",
"defaultValue": true,
"deprecation": {
"reason": "CRaSH support is no longer available.",
@ -1089,7 +1089,7 @@ @@ -1089,7 +1089,7 @@
{
"name": "management.shell.telnet.enabled",
"type": "java.lang.Boolean",
"description": "Enable CRaSH telnet support. Enabled by default if the TelnetPlugin is\n available.",
"description": "Whether to enable CRaSH telnet support. Enabled by default if the TelnetPlugin is available.",
"defaultValue": false,
"deprecation": {
"reason": "CRaSH support is no longer available.",

29
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java
Unescape View File

@ -84,17 +84,17 @@ public class RabbitProperties { @@ -84,17 +84,17 @@ public class RabbitProperties {
private Duration requestedHeartbeat;
/**
* Enable publisher confirms.
* Whether to enable publisher confirms.
*/
private boolean publisherConfirms;
/**
* Enable publisher returns.
* Whether to enable publisher returns.
*/
private boolean publisherReturns;
/**
* Connection timeout; zero for infinite.
* Connection timeout. Set it to zero to wait forever.
*/
private Duration connectionTimeout;
@ -310,7 +310,7 @@ public class RabbitProperties { @@ -310,7 +310,7 @@ public class RabbitProperties {
public static class Ssl {
/**
* Enable SSL support.
* Whether to enable SSL support.
*/
private boolean enabled;
@ -345,8 +345,7 @@ public class RabbitProperties { @@ -345,8 +345,7 @@ public class RabbitProperties {
private String trustStorePassword;
/**
* SSL algorithm to use (e.g. TLSv1.1). Default is set automatically by the rabbit
* client library.
* SSL algorithm to use. By default, configured by the Rabbit client library.
*/
private String algorithm;
@ -541,7 +540,7 @@ public class RabbitProperties { @@ -541,7 +540,7 @@ public class RabbitProperties {
public static abstract class AmqpContainer {
/**
* Start the container automatically on startup.
* Whether to start the container automatically on startup.
*/
private boolean autoStartup = true;
@ -557,7 +556,7 @@ public class RabbitProperties { @@ -557,7 +556,7 @@ public class RabbitProperties {
private Integer prefetch;
/**
* Whether rejected deliveries are requeued by default; default true.
* Whether rejected deliveries are re-queued by default. Defaults to true.
*/
private Boolean defaultRequeueRejected;
@ -633,8 +632,9 @@ public class RabbitProperties { @@ -633,8 +632,9 @@ public class RabbitProperties {
private Integer maxConcurrency;
/**
* Number of messages to be processed in a transaction; number of messages between
* acks. For best results it should be less than or equal to the prefetch count.
* Number of messages to be processed in a transaction. That is, the number of
* messages between acks. For best results, it should be less than or equal to the
* prefetch count.
*/
private Integer transactionSize;
@ -689,8 +689,7 @@ public class RabbitProperties { @@ -689,8 +689,7 @@ public class RabbitProperties {
private final Retry retry = new Retry();
/**
* Enable mandatory messages. If a mandatory message cannot be routed to a queue
* by the server, it will return an unroutable message with a Return method.
* Whether to enable mandatory messages.
*/
private Boolean mandatory;
@ -737,7 +736,7 @@ public class RabbitProperties { @@ -737,7 +736,7 @@ public class RabbitProperties {
public static class Retry {
/**
* Whether or not publishing retries are enabled.
* Whether to enable retries in the RabbitTemplate.
*/
private boolean enabled;
@ -752,7 +751,7 @@ public class RabbitProperties { @@ -752,7 +751,7 @@ public class RabbitProperties {
private long initialInterval = 1000L;
/**
* A multiplier to apply to the previous retry interval.
* Multiplier to apply to the previous retry interval.
*/
private double multiplier = 1.0;
@ -806,7 +805,7 @@ public class RabbitProperties { @@ -806,7 +805,7 @@ public class RabbitProperties {
public static class ListenerRetry extends Retry {
/**
* Whether or not retries are stateless or stateful.
* Whether retries are stateless or stateful.
*/
private boolean stateless = true;

4
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java
Unescape View File

@ -81,8 +81,8 @@ public class BatchProperties { @@ -81,8 +81,8 @@ public class BatchProperties {
public static class Job {
/**
* Comma-separated list of job names to execute on startup. By default, all Jobs
* found in the context are executed.
* Comma-separated list of job names to execute on startup (for instance,
* `job1,job2`). By default, all Jobs found in the context are executed.
*/
private String names = "";

8
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java vendored
Unescape View File

@ -36,7 +36,7 @@ import org.springframework.util.Assert; @@ -36,7 +36,7 @@ import org.springframework.util.Assert;
public class CacheProperties {
/**
* Cache type, auto-detected according to the environment by default.
* Cache type. By default, auto-detected according to the environment.
*/
private CacheType type;
@ -120,8 +120,8 @@ public class CacheProperties { @@ -120,8 +120,8 @@ public class CacheProperties {
public static class Caffeine {
/**
* The spec to use to create caches. Check CaffeineSpec for more details on the
* spec format.
* The spec to use to create caches. See CaffeineSpec for more details on the spec
* format.
*/
private String spec;
@ -209,7 +209,7 @@ public class CacheProperties { @@ -209,7 +209,7 @@ public class CacheProperties {
/**
* Fully qualified name of the CachingProvider implementation to use to retrieve
* the JSR-107 compliant cache manager. Only needed if more than one JSR-107
* the JSR-107 compliant cache manager. Needed only if more than one JSR-107
* implementation is available on the classpath.
*/
private String provider;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CassandraProperties.java
Unescape View File

@ -300,7 +300,7 @@ public class CassandraProperties { @@ -300,7 +300,7 @@ public class CassandraProperties {
private Duration heartbeatInterval = Duration.ofSeconds(30);
/**
* Maximum number of requests that get enqueued if no connection is available.
* Maximum number of requests that get queued if no connection is available.
*/
private int maxQueueSize = 256;

10
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.java
Unescape View File

@ -48,20 +48,20 @@ public class MessageSourceProperties { @@ -48,20 +48,20 @@ public class MessageSourceProperties {
private Duration cacheDuration;
/**
* Set whether to fall back to the system Locale if no files for a specific Locale
* have been found. If this is turned off, the only fallback will be the default file
* (e.g. "messages.properties" for basename "messages").
* Whether to fall back to the system Locale if no files for a specific Locale have
* been found. if this is turned off, the only fallback will be the default file (e.g.
* "messages.properties" for basename "messages").
*/
private boolean fallbackToSystemLocale = true;
/**
* Set whether to always apply the MessageFormat rules, parsing even messages without
* Whether to always apply the MessageFormat rules, parsing even messages without
* arguments.
*/
private boolean alwaysUseMessageFormat = false;
/**
* Set whether to use the message code as default message instead of throwing a
* Whether to use the message code as the default message instead of throwing a
* "NoSuchMessageException". Recommended during development only.
*/
private boolean useCodeAsDefaultMessage = false;

6
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseProperties.java
Unescape View File

@ -155,8 +155,8 @@ public class CouchbaseProperties { @@ -155,8 +155,8 @@ public class CouchbaseProperties {
public static class Ssl {
/**
* Enable SSL support. Enabled automatically if a "keyStore" is provided unless
* specified otherwise.
* Whether to enable SSL support. Enabled automatically if a "keyStore" is
* provided unless specified otherwise.
*/
private Boolean enabled;
@ -200,7 +200,7 @@ public class CouchbaseProperties { @@ -200,7 +200,7 @@ public class CouchbaseProperties {
public static class Timeouts {
/**
* Bucket connections timeout.
* Bucket connections timeouts.
*/
private Duration connect = Duration.ofMillis(5000);

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jProperties.java
Unescape View File

@ -158,7 +158,7 @@ public class Neo4jProperties implements ApplicationContextAware { @@ -158,7 +158,7 @@ public class Neo4jProperties implements ApplicationContextAware {
public static class Embedded {
/**
* Enable embedded mode if the embedded driver is available.
* Whether to enable embedded mode if the embedded driver is available.
*/
private boolean enabled = true;

15
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java
Unescape View File

@ -40,7 +40,8 @@ public class RedisProperties { @@ -40,7 +40,8 @@ public class RedisProperties {
private int database = 0;
/**
* Redis url, which will overrule host, port and password if set.
* Connection URL. Overrides host, port, and password. User is ignored. Example:
* redis://user:password@example.com:6379
*/
private String url;
@ -60,7 +61,7 @@ public class RedisProperties { @@ -60,7 +61,7 @@ public class RedisProperties {
private int port = 6379;
/**
* Enable SSL.
* Whether to enable SSL support.
*/
private boolean ssl;
@ -163,8 +164,8 @@ public class RedisProperties { @@ -163,8 +164,8 @@ public class RedisProperties {
public static class Pool {
/**
* Max number of "idle" connections in the pool. Use a negative value to indicate
* an unlimited number of idle connections.
* Maximum number of "idle" connections in the pool. Use a negative value to
* indicate an unlimited number of idle connections.
*/
private int maxIdle = 8;
@ -175,8 +176,8 @@ public class RedisProperties { @@ -175,8 +176,8 @@ public class RedisProperties {
private int minIdle = 0;
/**
* Max number of connections that can be allocated by the pool at a given time.
* Use a negative value for no limit.
* Maximum number of connections that can be allocated by the pool at a given
* time. Use a negative value for no limit.
*/
private int maxActive = 8;
@ -262,7 +263,7 @@ public class RedisProperties { @@ -262,7 +263,7 @@ public class RedisProperties {
public static class Sentinel {
/**
* Name of Redis server.
* Name of the Redis server.
*/
private String master;

8
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestProperties.java
Unescape View File

@ -73,18 +73,18 @@ public class RepositoryRestProperties { @@ -73,18 +73,18 @@ public class RepositoryRestProperties {
private MediaType defaultMediaType;
/**
* Return a response body after creating an entity.
* Whether to return a response body after creating an entity.
*/
private Boolean returnBodyOnCreate;
/**
* Return a response body after updating an entity.
* Whether to return a response body after updating an entity.
*/
private Boolean returnBodyOnUpdate;
/**
* Enable enum value translation via the Spring Data REST default resource bundle.
* Will use the fully qualified enum name as key.
* Whether to enable enum value translation through Spring Data REST default resource
* bundle. Will use the fully qualified enum name as key.
*/
private Boolean enableEnumTranslation;

4
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/jest/JestProperties.java
Unescape View File

@ -39,7 +39,7 @@ public class JestProperties { @@ -39,7 +39,7 @@ public class JestProperties {
Collections.singletonList("http://localhost:9200"));
/**
* Login user.
* Login username.
*/
private String username;
@ -49,7 +49,7 @@ public class JestProperties { @@ -49,7 +49,7 @@ public class JestProperties {
private String password;
/**
* Enable connection requests from multiple execution threads.
* Whether to enable connection requests from multiple execution threads.
*/
private boolean multiThreaded = true;

8
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java
Unescape View File

@ -38,19 +38,19 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -38,19 +38,19 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class FlywayProperties {
/**
* Locations of migrations scripts. Can contain the special "{vendor}" placeholder to
* use vendor-specific locations.
* The locations of migrations scripts. Can contain the special "{vendor}" placeholder
* to use vendor-specific locations.
*/
private List<String> locations = new ArrayList<>(
Collections.singletonList("classpath:db/migration"));
/**
* Check that migration scripts location exists.
* Whether to check that migration scripts location exists.
*/
private boolean checkLocation = true;
/**
* Enable flyway.
* Whether to enable flyway.
*/
private boolean enabled = true;

6
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerProperties.java
Unescape View File

@ -39,7 +39,7 @@ public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties @@ -39,7 +39,7 @@ public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties
public static final String DEFAULT_SUFFIX = ".ftl";
/**
* Well-known FreeMarker keys which will be passed to FreeMarker's Configuration.
* Well-known FreeMarker keys which are passed to FreeMarker's Configuration.
*/
private Map<String, String> settings = new HashMap<>();
@ -49,8 +49,8 @@ public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties @@ -49,8 +49,8 @@ public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties
private String[] templateLoaderPath = new String[] { DEFAULT_TEMPLATE_LOADER_PATH };
/**
* Prefer file system access for template loading. File system access enables hot
* detection of template changes.
* Whether to prefer file system access for template loading. File system access
* enables hot detection of template changes.
*/
private boolean preferFileSystemAccess = true;

8
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/h2/H2ConsoleProperties.java
Unescape View File

@ -31,12 +31,12 @@ import org.springframework.util.Assert; @@ -31,12 +31,12 @@ import org.springframework.util.Assert;
public class H2ConsoleProperties {
/**
* Path at which the console will be available.
* Path at which the console is available.
*/
private String path = "/h2-console";
/**
* Enable the console.
* Whether to enable the console.
*/
private boolean enabled = false;
@ -68,12 +68,12 @@ public class H2ConsoleProperties { @@ -68,12 +68,12 @@ public class H2ConsoleProperties {
public static class Settings {
/**
* Enable trace output.
* Whether to enable trace output.
*/
private boolean trace = false;
/**
* Enable remote access.
* Whether to enable remote access.
*/
private boolean webAllowOthers = false;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hateoas/HateoasProperties.java
Unescape View File

@ -29,7 +29,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -29,7 +29,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class HateoasProperties {
/**
* Specify if application/hal+json responses should be sent to requests that accept
* Whether application/hal+json responses should be sent to requests that accept
* application/json.
*/
private boolean useHalAsDefaultJsonMediaType = true;

11
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/http/HttpEncodingProperties.java
Unescape View File

@ -42,23 +42,24 @@ public class HttpEncodingProperties { @@ -42,23 +42,24 @@ public class HttpEncodingProperties {
private Charset charset = DEFAULT_CHARSET;
/**
* Force the encoding to the configured charset on HTTP requests and responses.
* Whether to force the encoding to the configured charset on HTTP requests and
* responses.
*/
private Boolean force;
/**
* Force the encoding to the configured charset on HTTP requests. Defaults to true
* when "force" has not been specified.
* Whether to force the encoding to the configured charset on HTTP requests. Defaults
* to true when "force" has not been specified.
*/
private Boolean forceRequest;
/**
* Force the encoding to the configured charset on HTTP responses.
* Whether to force the encoding to the configured charset on HTTP responses.
*/
private Boolean forceResponse;
/**
* Locale to Encoding mapping.
* Locale in which to encode mapping.
*/
private Map<Locale, Charset> mapping;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/influx/InfluxDbProperties.java
Unescape View File

@ -29,7 +29,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -29,7 +29,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class InfluxDbProperties {
/**
* Url of the InfluxDB instance to connect to.
* URL of the InfluxDB instance to which to connect.
*/
private String url;

12
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java
Unescape View File

@ -42,14 +42,14 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -42,14 +42,14 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class JacksonProperties {
/**
* Date format string (yyyy-MM-dd HH:mm:ss), or a fully-qualified date format class
* name.
* Date format string or a fully-qualified date format class name. For instance,
* `yyyy-MM-dd HH:mm:ss`.
*/
private String dateFormat;
/**
* Joda date time format string (yyyy-MM-dd HH:mm:ss). If not configured,
* "date-format" will be used as a fallback if it is configured with a format string.
* Joda date time format string. If not configured, "date-format" is used as a
* fallback if it is configured with a format string.
*/
private String jodaDateTimeFormat;
@ -92,8 +92,8 @@ public class JacksonProperties { @@ -92,8 +92,8 @@ public class JacksonProperties {
private JsonInclude.Include defaultPropertyInclusion;
/**
* Time zone used when formatting dates. Configured using any recognized time zone
* identifier, for example "America/Los_Angeles" or "GMT+10".
* Time zone used when formatting dates. For instance, "America/Los_Angeles" or
* "GMT+10".
*/
private TimeZone timeZone = null;

10
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java
Unescape View File

@ -63,7 +63,7 @@ public class DataSourceProperties @@ -63,7 +63,7 @@ public class DataSourceProperties
private String name = "testdb";
/**
* Generate a random datasource name.
* Whether to generate a random datasource name.
*/
private boolean generateUniqueName;
@ -84,7 +84,7 @@ public class DataSourceProperties @@ -84,7 +84,7 @@ public class DataSourceProperties
private String url;
/**
* Login user of the database.
* Login username of the database.
*/
private String username;
@ -105,7 +105,7 @@ public class DataSourceProperties @@ -105,7 +105,7 @@ public class DataSourceProperties
private DataSourceInitializationMode initializationMode = DataSourceInitializationMode.EMBEDDED;
/**
* Platform to use in the DDL or DML scripts (e.g. schema-${platform}.sql or
* Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or
* data-${platform}.sql).
*/
private String platform = "all";
@ -131,7 +131,7 @@ public class DataSourceProperties @@ -131,7 +131,7 @@ public class DataSourceProperties
private List<String> data;
/**
* User of the database to execute DML scripts.
* Username of the database to execute DML scripts.
*/
private String dataUsername;
@ -141,7 +141,7 @@ public class DataSourceProperties @@ -141,7 +141,7 @@ public class DataSourceProperties
private String dataPassword;
/**
* Do not stop if an error occurs while initializing the database.
* Whether to stop if an error occurs while initializing the database.
*/
private boolean continueOnError = false;

6
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jersey/JerseyProperties.java
Unescape View File

@ -38,7 +38,7 @@ public class JerseyProperties { @@ -38,7 +38,7 @@ public class JerseyProperties {
private Type type = Type.SERVLET;
/**
* Init parameters to pass to Jersey via the servlet or filter.
* Init parameters to pass to Jersey through the servlet or filter.
*/
private Map<String, String> init = new HashMap<>();
@ -47,8 +47,8 @@ public class JerseyProperties { @@ -47,8 +47,8 @@ public class JerseyProperties {
private final Servlet servlet = new Servlet();
/**
* Path that serves as the base URI for the application. Overrides the value of
* "@ApplicationPath" if specified.
* Path that serves as the base URI for the application. If specified, overrides the
* value of "@ApplicationPath".
*/
private String applicationPath;

18
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsProperties.java
Unescape View File

@ -31,7 +31,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -31,7 +31,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class JmsProperties {
/**
* Specify if the default destination type is topic.
* Whether the default destination type is topic.
*/
private boolean pubSubDomain = false;
@ -138,7 +138,7 @@ public class JmsProperties { @@ -138,7 +138,7 @@ public class JmsProperties {
public static class Template {
/**
* Default destination to use on send/receive operations that do not have a
* Default destination to use on send and receive operations that do not have a
* destination parameter.
*/
private String defaultDestination;
@ -149,24 +149,26 @@ public class JmsProperties { @@ -149,24 +149,26 @@ public class JmsProperties {
private Duration deliveryDelay;
/**
* Delivery mode. Enable QoS when set.
* Delivery mode. Enables QoS (Quality of Service) when set.
*/
private DeliveryMode deliveryMode;
/**
* Priority of a message when sending. Enable QoS when set.
* Priority of a message when sending. Enables QoS (Quality of Service) when set.
*/
private Integer priority;
/**
* Time-to-live of a message when sending. Enable QoS when set.
* Time-to-live of a message when sending. Enables QoS (Quality of Service) when
* set.
*/
private Duration timeToLive;
/**
* Enable explicit QoS when sending a message. When enabled, the delivery mode,
* priority and time-to-live properties will be used when sending a message. QoS
* is automatically enabled when at least one of those settings is customized.
* Whether to enable explicit QoS (Quality of Service) when sending a message.
* When enabled, the delivery mode, priority and time-to-live properties will be
* used when sending a message. QoS is automatically enabled when at least one of
* those settings is customized.
*/
private Boolean qosEnabled;

26
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQProperties.java
Unescape View File

@ -39,8 +39,8 @@ public class ActiveMQProperties { @@ -39,8 +39,8 @@ public class ActiveMQProperties {
private String brokerUrl;
/**
* Specify if the default broker URL should be in memory. Ignored if an explicit
* broker has been specified.
* Whether the default broker URL should be in memory. Ignored if an explicit broker
* has been specified.
*/
private boolean inMemory = true;
@ -60,14 +60,13 @@ public class ActiveMQProperties { @@ -60,14 +60,13 @@ public class ActiveMQProperties {
private Duration closeTimeout = Duration.ofSeconds(15);
/**
* Do not stop message delivery before re-delivering messages from a rolled back
* transaction. This implies that message order will not be preserved when this is
* enabled.
* Whether to stop message delivery before re-delivering messages from a rolled back
* transaction. This implies that message order is not preserved when this is enabled.
*/
private boolean nonBlockingRedelivery = false;
/**
* Time to wait on Message sends for a response. Set it to 0 to indicate to wait
* Time to wait on message sends for a response. Set it to 0 to indicate to wait
* forever.
*/
private Duration sendTimeout = Duration.ofMillis(0);
@ -147,14 +146,14 @@ public class ActiveMQProperties { @@ -147,14 +146,14 @@ public class ActiveMQProperties {
public static class Pool {
/**
* Whether a PooledConnectionFactory should be created instead of a regular
* Whether a PooledConnectionFactory should be created, instead of a regular
* ConnectionFactory.
*/
private boolean enabled;
/**
* Block when a connection is requested and the pool is full. Set it to false to
* throw a "JMSException" instead.
* Whether to block when a connection is requested and the pool is full. Set it to
* false to throw a "JMSException" instead.
*/
private boolean blockIfFull = true;
@ -164,7 +163,8 @@ public class ActiveMQProperties { @@ -164,7 +163,8 @@ public class ActiveMQProperties {
private Duration blockIfFullTimeout = Duration.ofMillis(-1);
/**
* Create a connection on startup. Can be used to warm-up the pool on startup.
* Whether to create a connection on startup. Can be used to warm up the pool on
* startup.
*/
private boolean createConnectionOnStartup = true;
@ -200,8 +200,8 @@ public class ActiveMQProperties { @@ -200,8 +200,8 @@ public class ActiveMQProperties {
private Duration timeBetweenExpirationCheck = Duration.ofMillis(-1);
/**
* Use only one anonymous "MessageProducer" instance. Set it to false to create
* one "MessageProducer" every time one is required.
* Whether to use only one anonymous "MessageProducer" instance. Set it to false
* to create one "MessageProducer" every time one is required.
*/
private boolean useAnonymousProducers = true;
@ -299,7 +299,7 @@ public class ActiveMQProperties { @@ -299,7 +299,7 @@ public class ActiveMQProperties {
public static class Packages {
/**
* Trust all packages.
* Whether to trust all packages.
*/
private Boolean trustAll;

6
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisProperties.java
Unescape View File

@ -114,17 +114,17 @@ public class ArtemisProperties { @@ -114,17 +114,17 @@ public class ArtemisProperties {
private static final AtomicInteger serverIdCounter = new AtomicInteger();
/**
* Server id. By default, an auto-incremented counter is used.
* Server ID. By default, an auto-incremented counter is used.
*/
private int serverId = serverIdCounter.getAndIncrement();
/**
* Enable embedded mode if the Artemis server APIs are available.
* Whether to enable embedded mode if the Artemis server APIs are available.
*/
private boolean enabled = true;
/**
* Enable persistent store.
* Whether to enable persistent store.
*/
private boolean persistent;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/JooqProperties.java
Unescape View File

@ -33,7 +33,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -33,7 +33,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class JooqProperties {
/**
* SQL dialect to use, auto-detected by default.
* SQL dialect to use. Auto-detected by default.
*/
private SQLDialect sqlDialect;

38
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java
Unescape View File

@ -60,7 +60,7 @@ public class KafkaProperties { @@ -60,7 +60,7 @@ public class KafkaProperties {
Collections.singletonList("localhost:9092"));
/**
* Id to pass to the server when making requests; used for server-side logging.
* ID to pass to the server when making requests. Used for server-side logging.
*/
private String clientId;
@ -223,14 +223,14 @@ public class KafkaProperties { @@ -223,14 +223,14 @@ public class KafkaProperties {
private final Ssl ssl = new Ssl();
/**
* Frequency that the consumer offsets are auto-committed to Kafka if
* 'enable.auto.commit' true.
* Frequency with which the consumer offsets are auto-committed to Kafka if
* 'enable.auto.commit' is set to true.
*/
private Duration autoCommitInterval;
/**
* What to do when there is no initial offset in Kafka or if the current offset
* does not exist any more on the server.
* What to do when there is no initial offset in Kafka or if the current offset no
* longer exists on the server.
*/
private String autoOffsetReset;
@ -241,29 +241,31 @@ public class KafkaProperties { @@ -241,29 +241,31 @@ public class KafkaProperties {
private List<String> bootstrapServers;
/**
* Id to pass to the server when making requests; used for server-side logging.
* ID to pass to the server when making requests. Used for server-side logging.
*/
private String clientId;
/**
* If true the consumer's offset will be periodically committed in the background.
* Whether the consumer's offset is periodically committed in the background.
*/
private Boolean enableAutoCommit;
/**
* Maximum amount of time the server will block before answering the fetch request
* if there isn't sufficient data to immediately satisfy the requirement given by
* Maximum amount of time the server blocks before answering the fetch request if
* there isn't sufficient data to immediately satisfy the requirement given by
* "fetch.min.bytes".
*/
private Duration fetchMaxWait;
/**
* Minimum amount of data the server should return for a fetch request in bytes.
* Minimum amount of data, in bytes, the server should return for a fetch request
* in bytes.
*/
private Integer fetchMinSize;
/**
* Unique string that identifies the consumer group this consumer belongs to.
* Unique string that identifies the consumer group to which this consumer belongs
* to.
*/
private String groupId;
@ -497,7 +499,7 @@ public class KafkaProperties { @@ -497,7 +499,7 @@ public class KafkaProperties {
private Long bufferMemory;
/**
* Id to pass to the server when making requests; used for server-side logging.
* ID to pass to the server when making requests. Used for server-side logging.
*/
private String clientId;
@ -683,7 +685,7 @@ public class KafkaProperties { @@ -683,7 +685,7 @@ public class KafkaProperties {
private final Ssl ssl = new Ssl();
/**
* Id to pass to the server when making requests; used for server-side logging.
* ID to pass to the server when making requests. Used for server-side logging.
*/
private String clientId;
@ -693,7 +695,7 @@ public class KafkaProperties { @@ -693,7 +695,7 @@ public class KafkaProperties {
private final Map<String, String> properties = new HashMap<>();
/**
* Fail fast if the broker is not available on startup.
* Whether to fail fast if the broker is not available on startup.
*/
private boolean failFast;
@ -755,7 +757,7 @@ public class KafkaProperties { @@ -755,7 +757,7 @@ public class KafkaProperties {
public static class Template {
/**
* Default topic to which messages will be sent.
* Default topic to which messages are sent.
*/
private String defaultTopic;
@ -791,7 +793,7 @@ public class KafkaProperties { @@ -791,7 +793,7 @@ public class KafkaProperties {
private Type type = Type.SINGLE;
/**
* Listener AckMode; see the spring-kafka documentation.
* Listener AckMode. See the spring-kafka documentation.
*/
private AckMode ackMode;
@ -879,7 +881,7 @@ public class KafkaProperties { @@ -879,7 +881,7 @@ public class KafkaProperties {
private Resource keystoreLocation;
/**
* Store password for the key store file.
* Password of the key store file.
*/
private String keystorePassword;
@ -938,7 +940,7 @@ public class KafkaProperties { @@ -938,7 +940,7 @@ public class KafkaProperties {
public static class Jaas {
/**
* Enable JAAS configuration.
* Whether to enable JAAS configuration.
*/
private boolean enabled;

4
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapProperties.java
Unescape View File

@ -46,12 +46,12 @@ public class LdapProperties { @@ -46,12 +46,12 @@ public class LdapProperties {
private String base;
/**
* Login user of the LDAP.
* Login username of the server.
*/
private String username;
/**
* Login password of the LDAP.
* Login password of the server.
*/
private String password;

4
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java
Unescape View File

@ -40,7 +40,7 @@ public class EmbeddedLdapProperties { @@ -40,7 +40,7 @@ public class EmbeddedLdapProperties {
private Credential credential = new Credential();
/**
* Base DNs.
* The base DN
*/
private String baseDn;
@ -123,7 +123,7 @@ public class EmbeddedLdapProperties { @@ -123,7 +123,7 @@ public class EmbeddedLdapProperties {
public static class Validation {
/**
* Enable LDAP schema validation.
* Whether to enable LDAP schema validation.
*/
private boolean enabled = true;

10
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.java
Unescape View File

@ -39,7 +39,7 @@ public class LiquibaseProperties { @@ -39,7 +39,7 @@ public class LiquibaseProperties {
private String changeLog = "classpath:/db/changelog/db.changelog-master.yaml";
/**
* Check the change log location exists.
* Whether to check that the change log location exists.
*/
private boolean checkChangeLogLocation = true;
@ -54,12 +54,12 @@ public class LiquibaseProperties { @@ -54,12 +54,12 @@ public class LiquibaseProperties {
private String defaultSchema;
/**
* Drop the database schema first.
* Whether to first drop the database schema.
*/
private boolean dropFirst;
/**
* Enable liquibase support.
* Whether to enable Liquibase support.
*/
private boolean enabled = true;
@ -74,7 +74,7 @@ public class LiquibaseProperties { @@ -74,7 +74,7 @@ public class LiquibaseProperties {
private String password;
/**
* JDBC url of the database to migrate. If not set, the primary configured data source
* JDBC URL of the database to migrate. If not set, the primary configured data source
* is used.
*/
private String url;
@ -90,7 +90,7 @@ public class LiquibaseProperties { @@ -90,7 +90,7 @@ public class LiquibaseProperties {
private Map<String, String> parameters;
/**
* File to which rollback SQL will be written when an update is performed.
* File to which rollback SQL is written when an update is performed.
*/
private File rollbackFile;

6
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java
Unescape View File

@ -37,7 +37,7 @@ public class MailProperties { @@ -37,7 +37,7 @@ public class MailProperties {
private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
/**
* SMTP server host.
* SMTP server host. For instance, `smtp.example.com`.
*/
private String host;
@ -72,12 +72,12 @@ public class MailProperties { @@ -72,12 +72,12 @@ public class MailProperties {
private Map<String, String> properties = new HashMap<>();
/**
* Session JNDI name. When set, takes precedence to others mail settings.
* Session JNDI name. When set, takes precedence over other mail settings.
*/
private String jndiName;
/**
* Test that the mail server is available on startup.
* Whether to test that the mail server is available on startup.
*/
private boolean testConnection;

8
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoProperties.java
Unescape View File

@ -46,12 +46,12 @@ public class MongoProperties { @@ -46,12 +46,12 @@ public class MongoProperties {
public static final String DEFAULT_URI = "mongodb://localhost/test";
/**
* Mongo server host. Cannot be set with uri.
* Mongo server host. Cannot be set with URI.
*/
private String host;
/**
* Mongo server port. Cannot be set with uri.
* Mongo server port. Cannot be set with URI.
*/
private Integer port = null;
@ -76,12 +76,12 @@ public class MongoProperties { @@ -76,12 +76,12 @@ public class MongoProperties {
private String gridFsDatabase;
/**
* Login user of the mongo server. Cannot be set with uri.
* Login user of the mongo server. Cannot be set with URI.
*/
private String username;
/**
* Login password of the mongo server. Cannot be set with uri.
* Login password of the mongo server. Cannot be set with URI.
*/
private char[] password;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoProperties.java
Unescape View File

@ -70,7 +70,7 @@ public class EmbeddedMongoProperties { @@ -70,7 +70,7 @@ public class EmbeddedMongoProperties {
public static class Storage {
/**
* Maximum size of the oplog in megabytes.
* Maximum size of the oplog, in megabytes.
*/
private Integer oplogSize;

15
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaProperties.java
Unescape View File

@ -63,12 +63,12 @@ public class JpaProperties { @@ -63,12 +63,12 @@ public class JpaProperties {
private Database database;
/**
* Initialize the schema on startup.
* Whether to initialize the schema on startup.
*/
private boolean generateDdl = false;
/**
* Enable logging of SQL statements.
* Whether to enable logging of SQL statements.
*/
private boolean showSql = false;
@ -170,15 +170,16 @@ public class JpaProperties { @@ -170,15 +170,16 @@ public class JpaProperties {
/**
* DDL mode. This is actually a shortcut for the "hibernate.hbm2ddl.auto"
* property. Default to "create-drop" when using an embedded database and no
* schema manager was detected, "none" otherwise.
* property. Defaults to "create-drop" when using an embedded database and no
* schema manager was detected. Otherwise, defaults to "none" otherwise.
*/
private String ddlAuto;
/**
* Use Hibernate's newer IdentifierGenerator for AUTO, TABLE and SEQUENCE. This is
* actually a shortcut for the "hibernate.id.new_generator_mappings" property.
* When not specified will default to "true".
* Whether to use Hibernate's newer IdentifierGenerator for AUTO, TABLE and
* SEQUENCE. This is actually a shortcut for the
* "hibernate.id.new_generator_mappings" property. When not specified will default
* to "true".
*/
private Boolean useNewIdGeneratorMappings;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/reactor/core/ReactorCoreProperties.java
Unescape View File

@ -36,7 +36,7 @@ public class ReactorCoreProperties { @@ -36,7 +36,7 @@ public class ReactorCoreProperties {
public static class StacktraceMode {
/**
* Set whether Reactor should collect stacktrace information at runtime.
* Whether Reactor should collect stacktrace information at runtime.
*/
private boolean enabled;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java
Unescape View File

@ -41,7 +41,7 @@ public class JdbcSessionProperties { @@ -41,7 +41,7 @@ public class JdbcSessionProperties {
private String schema = DEFAULT_SCHEMA_LOCATION;
/**
* Name of database table used to store sessions.
* Name of the database table used to store sessions.
*/
private String tableName = DEFAULT_TABLE_NAME;

4
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/SocialProperties.java
Unescape View File

@ -27,12 +27,12 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @@ -27,12 +27,12 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public abstract class SocialProperties {
/**
* Application id.
* Your application's OAuth App ID.
*/
private String appId;
/**
* Application secret.
* Your application's OAuth secret.
*/
private String appSecret;

16
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractTemplateViewResolverProperties.java
Unescape View File

@ -47,32 +47,32 @@ public abstract class AbstractTemplateViewResolverProperties @@ -47,32 +47,32 @@ public abstract class AbstractTemplateViewResolverProperties
private String requestContextAttribute;
/**
* Set whether all request attributes should be added to the model prior to merging
* with the template.
* Whether all request attributes should be added to the model prior to merging with
* the template.
*/
private boolean exposeRequestAttributes = false;
/**
* Set whether all HttpSession attributes should be added to the model prior to
* merging with the template.
* Whether all HttpSession attributes should be added to the model prior to merging
* with the template.
*/
private boolean exposeSessionAttributes = false;
/**
* Set whether HttpServletRequest attributes are allowed to override (hide) controller
* Whether HttpServletRequest attributes are allowed to override (hide) controller
* generated model attributes of the same name.
*/
private boolean allowRequestOverride = false;
/**
* Set whether to expose a RequestContext for use by Spring's macro library, under the
* Whether to expose a RequestContext for use by Spring's macro library, under the
* name "springMacroRequestContext".
*/
private boolean exposeSpringMacroHelpers = true;
/**
* Set whether HttpSession attributes are allowed to override (hide) controller
* generated model attributes of the same name.
* Whether HttpSession attributes are allowed to override (hide) controller generated
* model attributes of the same name.
*/
private boolean allowSessionOverride = false;

6
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java
Unescape View File

@ -40,12 +40,12 @@ public abstract class AbstractViewResolverProperties { @@ -40,12 +40,12 @@ public abstract class AbstractViewResolverProperties {
private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
/**
* Enable MVC view resolution for this technology.
* Whether to enable MVC view resolution for this technology.
*/
private boolean enabled = true;
/**
* Enable template caching.
* Whether to enable template caching.
*/
private boolean cache;
@ -65,7 +65,7 @@ public abstract class AbstractViewResolverProperties { @@ -65,7 +65,7 @@ public abstract class AbstractViewResolverProperties {
private String[] viewNames;
/**
* Check that the templates location exists.
* Whether to check that the templates location exists.
*/
private boolean checkTemplateLocation = true;

11
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafProperties.java
Unescape View File

@ -43,12 +43,12 @@ public class ThymeleafProperties { @@ -43,12 +43,12 @@ public class ThymeleafProperties {
public static final String DEFAULT_SUFFIX = ".html";
/**
* Check that the template exists before rendering it.
* Whether to check that the template exists before rendering it.
*/
private boolean checkTemplate = true;
/**
* Check that the templates location exists.
* Whether to check that the templates location exists.
*/
private boolean checkTemplateLocation = true;
@ -63,8 +63,7 @@ public class ThymeleafProperties { @@ -63,8 +63,7 @@ public class ThymeleafProperties {
private String suffix = DEFAULT_SUFFIX;
/**
* Template mode to be applied to templates. See also
* org.thymeleaf.templatemode.TemplateMode.
* Template mode to be applied to templates. See also Thymleaf's TemplateMode enum.
*/
private String mode = "HTML";
@ -74,7 +73,7 @@ public class ThymeleafProperties { @@ -74,7 +73,7 @@ public class ThymeleafProperties {
private Charset encoding = DEFAULT_ENCODING;
/**
* Enable template caching.
* Whether to enable template caching.
*/
private boolean cache = true;
@ -102,7 +101,7 @@ public class ThymeleafProperties { @@ -102,7 +101,7 @@ public class ThymeleafProperties {
private boolean enableSpringElCompiler;
/**
* Enable Thymeleaf view resolution for Web frameworks.
* Whether to enable Thymeleaf view resolution for Web frameworks.
*/
private boolean enabled = true;

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionProperties.java
Unescape View File

@ -43,7 +43,7 @@ public class TransactionProperties implements @@ -43,7 +43,7 @@ public class TransactionProperties implements
private Duration defaultTimeout;
/**
* Perform the rollback on commit failures.
* Whether to roll back on commit failures.
*/
private Boolean rollbackOnCommitFailure;

24
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ResourceProperties.java
Unescape View File

@ -63,7 +63,7 @@ public class ResourceProperties { @@ -63,7 +63,7 @@ public class ResourceProperties {
private CacheControlProperties cacheControl = new CacheControlProperties();
/**
* Enable default resource handling.
* Whether to enable default resource handling.
*/
private boolean addMappings = true;
@ -120,24 +120,24 @@ public class ResourceProperties { @@ -120,24 +120,24 @@ public class ResourceProperties {
public static class Chain {
/**
* Enable the Spring Resource Handling chain. Disabled by default unless at least
* one strategy has been enabled.
* Whether to enable the Spring Resource Handling chain. By default, disabled
* unless at least one strategy has been enabled.
*/
private Boolean enabled;
/**
* Enable caching in the Resource chain.
* Whether to enable caching in the Resource chain.
*/
private boolean cache = true;
/**
* Enable HTML5 application cache manifest rewriting.
* Whether to enable HTML5 application cache manifest rewriting.
*/
private boolean htmlApplicationCache = false;
/**
* Enable resolution of already gzipped resources. Checks for a resource name
* variant with the "*.gz" extension.
* Whether to enable resolution of already gzipped resources. Checks for a
* resource name variant with the "*.gz" extension.
*/
private boolean gzipped = false;
@ -218,12 +218,12 @@ public class ResourceProperties { @@ -218,12 +218,12 @@ public class ResourceProperties {
public static class Content {
/**
* Enable the content Version Strategy.
* Whether to enable the content Version Strategy.
*/
private boolean enabled;
/**
* Comma-separated list of patterns to apply to the Version Strategy.
* Comma-separated list of patterns to apply to the content Version Strategy.
*/
private String[] paths = new String[] { "/**" };
@ -251,17 +251,17 @@ public class ResourceProperties { @@ -251,17 +251,17 @@ public class ResourceProperties {
public static class Fixed {
/**
* Enable the fixed Version Strategy.
* Whether to enable the fixed Version Strategy.
*/
private boolean enabled;
/**
* Comma-separated list of patterns to apply to the Version Strategy.
* Comma-separated list of patterns to apply to the fixed Version Strategy.
*/
private String[] paths = new String[] { "/**" };
/**
* Version string to use for the Version Strategy.
* Version string to use for the fixed Version Strategy.
*/
private String version;

74
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java
Unescape View File

@ -64,7 +64,7 @@ public class ServerProperties { @@ -64,7 +64,7 @@ public class ServerProperties {
private Integer port;
/**
* Network address to which the server should bind to.
* Network address to which the server should bind.
*/
private InetAddress address;
@ -77,24 +77,24 @@ public class ServerProperties { @@ -77,24 +77,24 @@ public class ServerProperties {
private ErrorProperties error = new ErrorProperties();
/**
* If X-Forwarded-* headers should be applied to the HttpRequest.
* Whether X-Forwarded-* headers should be applied to the HttpRequest.
*/
private Boolean useForwardHeaders;
/**
* Value to use for the Server response header (no header is sent if empty).
* Value to use for the Server response header (if empty, no header is sent).
*/
private String serverHeader;
/**
* Maximum size in bytes of the HTTP message header.
* Maximum size, in bytes, of the HTTP message header.
*/
private int maxHttpHeaderSize = 0; // bytes
/**
* Time that connectors will wait for another HTTP request before closing the
* connection. When not set, the connector's server-specific default will be used. Use
* a value of -1 to indicate no (i.e. infinite) timeout.
* Time that connectors wait for another HTTP request before closing the connection.
* When not set, the connector's container-specific default is used. Use a value of -1
* to indicate no (that is, an infinite) timeout.
*/
private Duration connectionTimeout;
@ -349,7 +349,7 @@ public class ServerProperties { @@ -349,7 +349,7 @@ public class ServerProperties {
private Set<SessionTrackingMode> trackingModes;
/**
* Persist session data between restarts.
* Whether to persist session data between restarts.
*/
private boolean persistent;
@ -547,7 +547,7 @@ public class ServerProperties { @@ -547,7 +547,7 @@ public class ServerProperties {
private String protocolHeader;
/**
* Value of the protocol header that indicates that the incoming request uses SSL.
* Value of the protocol header indicating whether the incoming request uses SSL.
*/
private String protocolHeaderHttpsValue = "https";
@ -557,39 +557,42 @@ public class ServerProperties { @@ -557,39 +557,42 @@ public class ServerProperties {
private String portHeader = "X-Forwarded-Port";
/**
* Name of the http header from which the remote ip is extracted..
* Name of the HTTP header from which the remote IP is extracted. For instance,
* 'X-FORWARDED-FOR'.
*/
private String remoteIpHeader;
/**
* Tomcat base directory. If not specified a temporary directory will be used.
* Tomcat base directory. If not specified, a temporary directory will be used.
*/
private File basedir;
/**
* Delay between the invocation of backgroundProcess methods. If a duration suffix
* is not specified, seconds will be used.
* <<<<<<< HEAD Delay between the invocation of backgroundProcess methods. If a
* duration suffix is not specified, seconds will be used. ======= Delay, in
* seconds, between the invocation of backgroundProcess methods. >>>>>>> Align
* edits with code
*/
@DefaultDurationUnit(ChronoUnit.SECONDS)
private Duration backgroundProcessorDelay = Duration.ofSeconds(30);
/**
* Maximum amount of worker threads.
* Maximum number of worker threads.
*/
private int maxThreads = 0;
/**
* Minimum amount of worker threads.
* Minimum number of worker threads.
*/
private int minSpareThreads = 0;
/**
* Maximum size in bytes of the HTTP post content.
* Maximum size, in bytes, of the HTTP post content.
*/
private int maxHttpPostSize = 0;
/**
* Maximum size in bytes of the HTTP message header.
* Maximum size, in bytes, of the HTTP message header.
*/
private int maxHttpHeaderSize = 0;
@ -605,7 +608,7 @@ public class ServerProperties { @@ -605,7 +608,7 @@ public class ServerProperties {
private Charset uriEncoding;
/**
* Maximum number of connections that the server will accept and process at any
* Maximum number of connections that the server accepts and processes at any
* given time. Once the limit has been reached, the operating system may still
* accept connections based on the "acceptCount" property.
*/
@ -781,8 +784,8 @@ public class ServerProperties { @@ -781,8 +784,8 @@ public class ServerProperties {
private String pattern = "common";
/**
* Directory in which log files are created. Can be relative to the tomcat
* base dir or absolute.
* Directory in which log files are created. Can be absolute or relative to
* the Tomcat base dir.
*/
private String directory = "logs";
@ -797,28 +800,29 @@ public class ServerProperties { @@ -797,28 +800,29 @@ public class ServerProperties {
private String suffix = ".log";
/**
* Enable access log rotation.
* Whether to enable access log rotation.
*/
private boolean rotate = true;
/**
* Defer inclusion of the date stamp in the file name until rotate time.
* Whether to defer inclusion of the date stamp in the file name until rotate
* time.
*/
private boolean renameOnRotate;
/**
* Date format to place in log file name.
* Date format to place in the log file name.
*/
private String fileDateFormat = ".yyyy-MM-dd";
/**
* Set request attributes for IP address, Hostname, protocol and port used for
* the request.
* Set request attributes for the IP address, Hostname, protocol, and port
* used for the request.
*/
private boolean requestAttributesEnabled;
/**
* Buffer output such that it is only flushed periodically.
* Whether to buffer output such that it is flushed only periodically.
*/
private boolean buffered = true;
@ -910,7 +914,9 @@ public class ServerProperties { @@ -910,7 +914,9 @@ public class ServerProperties {
public static class Resource {
/**
* Time-to-live of the static resource cache.
* <<<<<<< HEAD Time-to-live of the static resource cache. =======
* Time-to-live, in milliseconds, of the static resource cache. >>>>>>> Align
* edits with code
*/
private Duration cacheTtl;
@ -937,7 +943,7 @@ public class ServerProperties { @@ -937,7 +943,7 @@ public class ServerProperties {
private final Accesslog accesslog = new Accesslog();
/**
* Maximum size in bytes of the HTTP post or put content.
* Maximum size, in bytes, of the HTTP post or put content.
*/
private int maxHttpPostSize = 0; // bytes
@ -990,7 +996,7 @@ public class ServerProperties { @@ -990,7 +996,7 @@ public class ServerProperties {
private boolean enabled = false;
/**
* Log filename. If not specified, logs will be redirected to "System.err".
* Log filename. If not specified, logs redirect to "System.err".
*/
private String filename;
@ -1149,12 +1155,12 @@ public class ServerProperties { @@ -1149,12 +1155,12 @@ public class ServerProperties {
public static class Undertow {
/**
* Maximum size in bytes of the HTTP post content.
* Maximum size, in bytes, of the HTTP post content.
*/
private long maxHttpPostSize = 0; // bytes
/**
* Size of each buffer in bytes.
* Size of each buffer, in bytes.
*/
private Integer bufferSize;
@ -1169,7 +1175,7 @@ public class ServerProperties { @@ -1169,7 +1175,7 @@ public class ServerProperties {
private Integer workerThreads;
/**
* Allocate buffers outside the Java heap.
* Whether to allocate buffers outside the Java heap.
*/
private Boolean directBuffers;
@ -1238,7 +1244,7 @@ public class ServerProperties { @@ -1238,7 +1244,7 @@ public class ServerProperties {
public static class Accesslog {
/**
* Enable access log.
* Whether to enable the access log.
*/
private Boolean enabled;
@ -1263,7 +1269,7 @@ public class ServerProperties { @@ -1263,7 +1269,7 @@ public class ServerProperties {
private File dir = new File("logs");
/**
* Enable access log rotation.
* Whether to enable access log rotation.
*/
private boolean rotate = true;

10
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/MultipartProperties.java
Unescape View File

@ -47,7 +47,7 @@ import org.springframework.util.StringUtils; @@ -47,7 +47,7 @@ import org.springframework.util.StringUtils;
public class MultipartProperties {
/**
* Enable support of multipart uploads.
* Whether to enable support of multipart uploads.
*/
private boolean enabled = true;
@ -58,19 +58,19 @@ public class MultipartProperties { @@ -58,19 +58,19 @@ public class MultipartProperties {
/**
* Max file size. Values can use the suffixes "MB" or "KB" to indicate megabytes or
* kilobytes respectively.
* kilobytes, respectively.
*/
private String maxFileSize = "1MB";
/**
* Max request size. Values can use the suffixes "MB" or "KB" to indicate megabytes or
* kilobytes respectively.
* kilobytes, respectively.
*/
private String maxRequestSize = "10MB";
/**
* Threshold after which files will be written to disk. Values can use the suffixes
* "MB" or "KB" to indicate megabytes or kilobytes respectively.
* Threshold after which files are written to disk. Values can use the suffixes "MB"
* or "KB" to indicate megabytes or kilobytes, respectively.
*/
private String fileSizeThreshold = "0";

18
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java
Unescape View File

@ -38,7 +38,7 @@ import org.springframework.validation.DefaultMessageCodesResolver; @@ -38,7 +38,7 @@ import org.springframework.validation.DefaultMessageCodesResolver;
public class WebMvcProperties {
/**
* Formatting strategy for message codes (PREFIX_ERROR_CODE, POSTFIX_ERROR_CODE).
* Formatting strategy for message codes. For instance, `PREFIX_ERROR_CODE`.
*/
private DefaultMessageCodesResolver.Format messageCodesResolverFormat;
@ -54,33 +54,35 @@ public class WebMvcProperties { @@ -54,33 +54,35 @@ public class WebMvcProperties {
private LocaleResolver localeResolver = LocaleResolver.ACCEPT_HEADER;
/**
* Date format to use (e.g. dd/MM/yyyy).
* Date format to use. For instance, "dd/MM/yyyy".
*/
private String dateFormat;
/**
* Dispatch TRACE requests to the FrameworkServlet doService method.
* Whether to dispatch TRACE requests to the FrameworkServlet doService method.
*/
private boolean dispatchTraceRequest = false;
/**
* Dispatch OPTIONS requests to the FrameworkServlet doService method.
* Whether to dispatch OPTIONS requests to the FrameworkServlet doService method.
*/
private boolean dispatchOptionsRequest = true;
/**
* If the content of the "default" model should be ignored during redirect scenarios.
* Whether the content of the "default" model should be ignored during redirect
* scenarios.
*/
private boolean ignoreDefaultModelOnRedirect = true;
/**
* If a "NoHandlerFoundException" should be thrown if no Handler was found to process
* a request.
* Whether a "NoHandlerFoundException" should be thrown if no Handler was found to
* process a request.
*/
private boolean throwExceptionIfNoHandlerFound = false;
/**
* Enable warn logging of exceptions resolved by a "HandlerExceptionResolver".
* Whether to enable warn logging of exceptions resolved by a
* "HandlerExceptionResolver".
*/
private boolean logResolvedException = false;

78
spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
Unescape View File

@ -2,7 +2,7 @@ @@ -2,7 +2,7 @@
{
"name": "security.basic.enabled",
"type": "java.lang.Boolean",
"description": "Enable basic authentication.",
"description": "Whether to enable basic authentication.",
"defaultValue": true,
"deprecation": {
"reason": "The security auto-configuration is no longer customizable. Provide your own WebSecurityConfigurer bean instead.",
@ -35,7 +35,7 @@ @@ -35,7 +35,7 @@
{
"name": "server.error.whitelabel.enabled",
"type": "java.lang.Boolean",
"description": "Enable the default error page displayed in browsers in case of a server error.",
"description": "Whether to enable the default error page displayed in browsers in case of a server error.",
"defaultValue": true
},
{
@ -47,13 +47,13 @@ @@ -47,13 +47,13 @@
{
"name": "spring.aop.proxy-target-class",
"type": "java.lang.Boolean",
"description": "Whether subclass-based (CGLIB) proxies are to be created (true) as opposed to standard Java interface-based proxies (false).",
"description": "Whether subclass-based (CGLIB) proxies are to be created (true), as opposed to standard Java interface-based proxies (false).",
"defaultValue": true
},
{
"name": "spring.application.admin.enabled",
"type": "java.lang.Boolean",
"description": "Enable admin features for the application.",
"description": "Whether to enable admin features for the application.",
"defaultValue": false
},
{
@ -76,13 +76,13 @@ @@ -76,13 +76,13 @@
{
"name": "spring.dao.exceptiontranslation.enabled",
"type": "java.lang.Boolean",
"description": "Enable the PersistenceExceptionTranslationPostProcessor.",
"description": "Whether to enable the PersistenceExceptionTranslationPostProcessor.",
"defaultValue": true
},
{
"name": "spring.datasource.jmx-enabled",
"type": "java.lang.Boolean",
"description": "Enable JMX support (if provided by the underlying pool).",
"description": "Whether to enable JMX support (if provided by the underlying pool).",
"defaultValue": false
},
{
@ -96,13 +96,13 @@ @@ -96,13 +96,13 @@
{
"name": "spring.data.cassandra.reactive-repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Cassandra reactive repositories.",
"description": "Whether to enable Cassandra reactive repositories.",
"defaultValue": true
},
{
"name": "spring.data.cassandra.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Cassandra repositories.",
"description": "Whether to enable Cassandra repositories.",
"defaultValue": true
},
{
@ -112,43 +112,43 @@ @@ -112,43 +112,43 @@
{
"name": "spring.data.couchbase.reactive-repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Couchbase reactive repositories.",
"description": "Whether to enable Couchbase reactive repositories.",
"defaultValue": true
},
{
"name": "spring.data.couchbase.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Couchbase repositories.",
"description": "Whether to enable Couchbase repositories.",
"defaultValue": true
},
{
"name": "spring.data.elasticsearch.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Elasticsearch repositories.",
"description": "Whether to enable Elasticsearch repositories.",
"defaultValue": true
},
{
"name": "spring.data.jpa.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable JPA repositories.",
"description": "Whether to enable JPA repositories.",
"defaultValue": true
},
{
"name": "spring.data.ldap.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable LDAP repositories.",
"description": "Whether to enable LDAP repositories.",
"defaultValue": true
},
{
"name": "spring.data.mongodb.reactive-repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Mongo reactive repositories.",
"description": "Whether to enable Mongo reactive repositories.",
"defaultValue": true
},
{
"name": "spring.data.mongodb.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Mongo repositories.",
"description": "Whether to enable Mongo repositories.",
"defaultValue": true
},
{
@ -158,13 +158,13 @@ @@ -158,13 +158,13 @@
{
"name": "spring.data.neo4j.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Neo4j repositories.",
"description": "Whether to enable Neo4j repositories.",
"defaultValue": true
},
{
"name": "spring.data.redis.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Redis repositories.",
"description": "Whether to enable Redis repositories.",
"defaultValue": true
},
{
@ -174,7 +174,7 @@ @@ -174,7 +174,7 @@
{
"name": "spring.data.solr.repositories.enabled",
"type": "java.lang.Boolean",
"description": "Enable Solr repositories.",
"description": "Whether to enable Solr repositories.",
"defaultValue": true
},
{
@ -210,13 +210,13 @@ @@ -210,13 +210,13 @@
{
"name": "spring.http.encoding.enabled",
"type": "java.lang.Boolean",
"description": "Enable http encoding support.",
"description": "Whether to enable http encoding support.",
"defaultValue": true
},
{
"name": "spring.http.converters.preferred-json-mapper",
"type": "java.lang.String",
"description": "Preferred JSON mapper to use for HTTP message conversion, auto-detected according to the environment by default."
"description": "Preferred JSON mapper to use for HTTP message conversion. By default, auto-detected according to the environment."
},
{
"name": "spring.jersey.type",
@ -246,7 +246,7 @@ @@ -246,7 +246,7 @@
{
"name": "spring.jta.enabled",
"type": "java.lang.Boolean",
"description": "Enable JTA support.",
"description": "Whether to enable JTA support.",
"defaultValue": true
},
{
@ -256,7 +256,7 @@ @@ -256,7 +256,7 @@
},
{
"name": "spring.jta.bitronix.properties.asynchronous2-pc",
"description": "Enable asynchronously execution of two phase commit.",
"description": "Whether to enable asynchronously execution of two phase commit.",
"defaultValue": false
},
{
@ -289,7 +289,7 @@ @@ -289,7 +289,7 @@
},
{
"name": "spring.jta.bitronix.properties.disable-jmx",
"description": "Enable JMX support.",
"description": "Whether to enable JMX support.",
"defaultValue": false
},
{
@ -298,7 +298,7 @@ @@ -298,7 +298,7 @@
},
{
"name": "spring.jta.bitronix.properties.filter-log-status",
"description": "Enable filtering of logs so that only mandatory logs are written.",
"description": "Whether to enable filtering of logs so that only mandatory logs are written.",
"defaultValue": false
},
{
@ -373,13 +373,13 @@ @@ -373,13 +373,13 @@
{
"name": "spring.mobile.devicedelegatingviewresolver.enabled",
"type": "java.lang.Boolean",
"description": "Enable device view resolver.",
"description": "Whether to enable device view resolver.",
"defaultValue": false
},
{
"name": "spring.mobile.sitepreference.enabled",
"type": "java.lang.Boolean",
"description": "Enable SitePreferenceHandler.",
"description": "Whether to enable SitePreferenceHandler.",
"defaultValue": true
},
{
@ -393,13 +393,13 @@ @@ -393,13 +393,13 @@
{
"name": "spring.mvc.favicon.enabled",
"type": "java.lang.Boolean",
"description": "Enable resolution of favicon.ico.",
"description": "Whether to enable resolution of favicon.ico.",
"defaultValue": true
},
{
"name": "spring.mvc.formcontent.putfilter.enabled",
"type": "java.lang.Boolean",
"description": "Enable Spring's HttpPutFormContentFilter.",
"description": "Whether to enable Spring's HttpPutFormContentFilter.",
"defaultValue": true
},
{
@ -417,7 +417,7 @@ @@ -417,7 +417,7 @@
{
"name": "spring.rabbitmq.dynamic",
"type": "java.lang.Boolean",
"description": "Create an AmqpAdmin bean.",
"description": "Whether to create an AmqpAdmin bean.",
"defaultValue": true
},
{
@ -447,7 +447,7 @@ @@ -447,7 +447,7 @@
{
"name": "spring.social.auto-connection-views",
"type": "java.lang.Boolean",
"description": "Enable the connection status view for supported providers.",
"description": "Whether to enable the connection status view for supported providers.",
"defaultValue": false
},
{
@ -495,7 +495,7 @@ @@ -495,7 +495,7 @@
{
"name": "flyway.enabled",
"type": "java.lang.Boolean",
"description": "Enable flyway.",
"description": "Whether to enable flyway.",
"defaultValue": true,
"deprecation": {
"replacement": "spring.flyway.enabled",
@ -731,7 +731,7 @@ @@ -731,7 +731,7 @@
{
"name": "liquibase.enabled",
"type": "java.lang.Boolean",
"description": "Enable liquibase support.",
"description": "Whether to enable liquibase support.",
"defaultValue": true,
"deprecation": {
"replacement": "spring.liquibase.enabled",
@ -826,7 +826,7 @@ @@ -826,7 +826,7 @@
{
"name": "security.enable-csrf",
"type": "java.lang.Boolean",
"description": "Enable Cross Site Request Forgery support.",
"description": "Whether to enable Cross Site Request Forgery support.",
"defaultValue": false,
"deprecation": {
"reason": "The security auto-configuration is no longer customizable. Provide your own WebSecurityConfigurer bean instead.",
@ -836,7 +836,7 @@ @@ -836,7 +836,7 @@
{
"name": "security.headers.cache",
"type": "java.lang.Boolean",
"description": "Enable cache control HTTP headers.",
"description": "Whether to enable cache control HTTP headers.",
"defaultValue": true,
"deprecation": {
"reason": "The security auto-configuration is no longer customizable. Provide your own WebSecurityConfigurer bean instead.",
@ -864,7 +864,7 @@ @@ -864,7 +864,7 @@
{
"name": "security.headers.content-type",
"type": "java.lang.Boolean",
"description": "Enable \"X-Content-Type-Options\" header.",
"description": "Whether to enable \"X-Content-Type-Options\" header.",
"defaultValue": true,
"deprecation": {
"reason": "The security auto-configuration is no longer customizable. Provide your own WebSecurityConfigurer bean instead.",
@ -874,7 +874,7 @@ @@ -874,7 +874,7 @@
{
"name": "security.headers.frame",
"type": "java.lang.Boolean",
"description": "Enable \"X-Frame-Options\" header.",
"description": "Whether to enable \"X-Frame-Options\" header.",
"defaultValue": true,
"deprecation": {
"reason": "The security auto-configuration is no longer customizable. Provide your own WebSecurityConfigurer bean instead.",
@ -893,7 +893,7 @@ @@ -893,7 +893,7 @@
{
"name": "security.headers.xss",
"type": "java.lang.Boolean",
"description": "Enable cross site scripting (XSS) protection.",
"description": "Whether to enable cross site scripting (XSS) protection.",
"defaultValue": true,
"deprecation": {
"reason": "The security auto-configuration is no longer customizable. Provide your own WebSecurityConfigurer bean instead.",
@ -912,7 +912,7 @@ @@ -912,7 +912,7 @@
{
"name": "security.require-ssl",
"type": "java.lang.Boolean",
"description": "Enable secure channel for all requests.",
"description": "Whether to enable secure channel for all requests.",
"defaultValue": false,
"deprecation": {
"reason": "The security auto-configuration is no longer customizable. Provide your own WebSecurityConfigurer bean instead.",
@ -1083,7 +1083,7 @@ @@ -1083,7 +1083,7 @@
{
"name": "spring.http.multipart.enabled",
"type": "java.lang.Boolean",
"description": "Enable support of multipart uploads.",
"description": "Whether to enable support of multipart uploads.",
"defaultValue": true,
"deprecation": {
"replacement": "spring.servlet.multipart.enabled",

8
spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsProperties.java
Unescape View File

@ -64,7 +64,7 @@ public class DevToolsProperties { @@ -64,7 +64,7 @@ public class DevToolsProperties {
+ "**/*Test.class,**/*Tests.class,git.properties,META-INF/build-info.properties";
/**
* Enable automatic restart.
* Whether to enable automatic restart.
*/
private boolean enabled = true;
@ -90,8 +90,8 @@ public class DevToolsProperties { @@ -90,8 +90,8 @@ public class DevToolsProperties {
private Duration quietPeriod = Duration.ofMillis(400);
/**
* Name of a specific file that when changed will trigger the restart check. If
* not specified any classpath file change will trigger the restart.
* Name of a specific file that, when changed, triggers the restart check. If not
* specified, any classpath file change will trigger the restart.
*/
private String triggerFile;
@ -176,7 +176,7 @@ public class DevToolsProperties { @@ -176,7 +176,7 @@ public class DevToolsProperties {
public static class Livereload {
/**
* Enable a livereload.com compatible server.
* Whether to enable a livereload.com-compatible server.
*/
private boolean enabled = true;

2
spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsProperties.java
Unescape View File

@ -85,7 +85,7 @@ public class RemoteDevToolsProperties { @@ -85,7 +85,7 @@ public class RemoteDevToolsProperties {
public static class Restart {
/**
* Enable remote restart.
* Whether to enable remote restart.
*/
private boolean enabled = true;

743
spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
View File

File diff suppressed because it is too large Load Diff

2
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java
Unescape View File

@ -422,7 +422,7 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor @@ -422,7 +422,7 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
.add(ItemMetadata.newGroup(endpointKey(endpointId), type, type, null));
this.metadataCollector.add(ItemMetadata.newProperty(endpointKey(endpointId),
"enabled", Boolean.class.getName(), type, null,
String.format("Enable the %s endpoint.", endpointId),
String.format("Whether to enable the %s endpoint.", endpointId),
(enabledByDefault == null ? true : enabledByDefault), null));
this.metadataCollector.add(ItemMetadata.newProperty(endpointKey(endpointId),
"cache.time-to-live", Duration.class.getName(), type, null,

14
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java
Unescape View File

@ -56,29 +56,29 @@ public class AtomikosProperties { @@ -56,29 +56,29 @@ public class AtomikosProperties {
private int maxActives = 50;
/**
* Enable disk logging.
* Whether to enable disk logging.
*/
private boolean enableLogging = true;
/**
* Transaction manager's unique name. Defaults to the machine's IP address. If you
* The transaction manager's unique name. Defaults to the machine's IP address. If you
* plan to run more than one transaction manager against one database you must set
* this property to a unique value.
*/
private String transactionManagerUniqueName;
/**
* Specify if sub-transactions should be joined when possible.
* Whether sub-transactions should be joined when possible.
*/
private boolean serialJtaTransactions = true;
/**
* Specify if sub-transactions are allowed.
* Specify whether sub-transactions are allowed.
*/
private boolean allowSubTransactions = true;
/**
* Specify if a VM shutdown should trigger forced shutdown of the transaction core.
* Whether a VM shutdown should trigger forced shutdown of the transaction core.
*/
private boolean forceShutdownOnVmExit;
@ -100,8 +100,8 @@ public class AtomikosProperties { @@ -100,8 +100,8 @@ public class AtomikosProperties {
private long checkpointInterval = 500;
/**
* Use different (and concurrent) threads for two-phase commit on the participating
* resources.
* Whether to use different (and concurrent) threads for two-phase commit on the
* participating resources.
*/
private boolean threadedTwoPhaseCommit;

10
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/narayana/NarayanaProperties.java
Unescape View File

@ -52,7 +52,7 @@ public class NarayanaProperties { @@ -52,7 +52,7 @@ public class NarayanaProperties {
private String transactionManagerId = "1";
/**
* Enable one phase commit optimization.
* Whether to enable one phase commit optimization.
*/
private boolean onePhaseCommit = true;
@ -77,22 +77,22 @@ public class NarayanaProperties { @@ -77,22 +77,22 @@ public class NarayanaProperties {
private Duration recoveryBackoffPeriod = Duration.ofSeconds(10);
/**
* Database username to be used by recovery manager.
* Database username to be used by the recovery manager.
*/
private String recoveryDbUser = null;
/**
* Database password to be used by recovery manager.
* Database password to be used by the recovery manager.
*/
private String recoveryDbPass = null;
/**
* JMS username to be used by recovery manager.
* JMS username to be used by the recovery manager.
*/
private String recoveryJmsUser = null;
/**
* JMS password to be used by recovery manager.
* JMS password to be used by the recovery manager.
*/
private String recoveryJmsPass = null;

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Compression.java
Unescape View File

@ -26,7 +26,7 @@ package org.springframework.boot.web.server; @@ -26,7 +26,7 @@ package org.springframework.boot.web.server;
public class Compression {
/**
* If response compression is enabled.
* Whether response compression is enabled.
*/
private boolean enabled = false;

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Ssl.java
Unescape View File

@ -26,7 +26,7 @@ package org.springframework.boot.web.server; @@ -26,7 +26,7 @@ package org.springframework.boot.web.server;
public class Ssl {
/**
* Enable SSL support.
* Whether to enable SSL support.
*/
private boolean enabled = true;

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/Jsp.java
Unescape View File

@ -41,7 +41,7 @@ public class Jsp { @@ -41,7 +41,7 @@ public class Jsp {
private Map<String, String> initParameters = new HashMap<>();
/**
* Whether or not the JSP servlet should be registered with the web server.
* Whether the JSP servlet is registered.
*/
private boolean registered = true;

40
spring-boot-project/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json
Unescape View File

@ -19,7 +19,7 @@ @@ -19,7 +19,7 @@
{
"name": "banner.image.location",
"type": "org.springframework.core.io.Resource",
"description": "Banner image file location (jpg/png can also be used).",
"description": "Banner image file location (jpg or png can also be used).",
"defaultValue": "banner.gif"
},
{
@ -40,7 +40,7 @@ @@ -40,7 +40,7 @@
{
"name": "banner.image.invert",
"type": "java.lang.Boolean",
"description": "Invert images for dark console themes.",
"description": "Whether images should be inverted for dark terminal themes.",
"defaultValue": false
},
{
@ -53,7 +53,7 @@ @@ -53,7 +53,7 @@
{
"name": "logging.config",
"type": "java.lang.String",
"description": "Location of the logging configuration file.",
"description": "Location of the logging configuration file. For instance, 'classpath:logback.xml' for Logback.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
@ -66,7 +66,7 @@ @@ -66,7 +66,7 @@
{
"name": "logging.file",
"type": "java.lang.String",
"description": "Name of the log file. Names can be an exact location or relative to the current directory.",
"description": "Log file name. For instance, 'myapp.log'. Names can be an exact location or relative to the current directory.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
@ -86,39 +86,41 @@ @@ -86,39 +86,41 @@
{
"name": "logging.level",
"type": "java.util.Map<java.lang.String,java.lang.String>",
"description": "Log levels severity mapping. Use 'root' for the root logger.",
"description": "Log levels severity mapping. For instance, 'logging.level.org.springframework=DEBUG'",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
"name": "logging.pattern.console",
"type": "java.lang.String",
"description": "Appender pattern for output to the console. Only supported with the default logback setup.",
"description": "Appender pattern for output to the console. Supported only with the default Logback setup.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
"defaultValue": "%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"
},
{
"name": "logging.pattern.file",
"type": "java.lang.String",
"description": "Appender pattern for output to the file. Only supported with the default logback setup.",
"description": "Appender pattern for output to a file. Supported only with the default Logback setup.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
"defaultValue": "%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"
},
{
"name": "logging.pattern.level",
"type": "java.lang.String",
"description": "Appender pattern for log level (default %5p). Only supported with the default logback setup.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
"description": "Appender pattern for log level. Supported only with the default Logback setup.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
"defaultValue": "%5p"
},
{
"name": "logging.pattern.dateformat",
"type": "java.lang.String",
"description": "Appender pattern for log dateformat (default yyyy-MM-dd HH:mm:ss.SSS). Only supported with the default logback setup.",
"sourceType": "org.springframework.boot.logging.LoggingApplicationListener"
"description": "Appender pattern for log dateformat. Only supported with the default logback setup.",
"sourceType": "org.springframework.boot.logging.LoggingApplicationListener",
"defaultValue": "yyyy-MM-dd HH:mm:ss.SSS"
},
{
"name": "logging.path",
"type": "java.lang.String",
"description": "Directory where log files are written.",
"description": "Location of the log file. For instance, '/var/log'",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
@ -149,7 +151,7 @@ @@ -149,7 +151,7 @@
"name": "spring.beaninfo.ignore",
"type": "java.lang.Boolean",
"sourceType": "org.springframework.boot.context.config.ConfigFileApplicationListener",
"description": "Skip search of BeanInfo classes.",
"description": "Whether to skip search of BeanInfo classes.",
"defaultValue": true
},
{
@ -194,15 +196,15 @@ @@ -194,15 +196,15 @@
},
{
"name": "spring.main.sources",
"type": "java.util.Set<java.lang.Object>",
"type": "java.util.Set<java.lang.String>",
"sourceType": "org.springframework.boot.SpringApplication",
"description": "Sources (class name, package name or XML resource location) to include in the ApplicationContext."
"description": "Sources (class names, package names, or XML resource locations) to include in the ApplicationContext."
},
{
"name": "spring.main.web-application-type",
"type": "org.springframework.boot.WebApplicationType",
"sourceType": "org.springframework.boot.SpringApplication",
"description": "Flag to explicitly request a specific type of web application. Auto-detected based on the classpath if not set."
"description": "Flag to explicitly request a specific type of web application. If not set, auto-detected based on the classpath."
},
{
"name": "spring.main.web-environment",
@ -217,7 +219,7 @@ @@ -217,7 +219,7 @@
{
"name": "spring.output.ansi.enabled",
"type": "org.springframework.boot.ansi.AnsiOutput$Enabled",
"description": "Configure the ANSI output.",
"description": "Configures the ANSI output.",
"defaultValue": "detect"
},
{
@ -229,7 +231,7 @@ @@ -229,7 +231,7 @@
{
"name": "spring.pid.fail-on-write-error",
"type": "java.lang.Boolean",
"description": "Fail if ApplicationPidFileWriter is used but it cannot write the PID file.",
"description": "Fails if ApplicationPidFileWriter is used but it cannot write the PID file.",
"sourceType": "org.springframework.boot.system.ApplicationPidFileWriter"
},
{
@ -242,7 +244,7 @@ @@ -242,7 +244,7 @@
"name": "spring.profiles.include",
"type": "java.util.List<java.lang.String>",
"sourceType": "org.springframework.boot.context.config.ConfigFileApplicationListener",
"description": "Unconditionally activate the specified comma separated profiles."
"description": "Unconditionally activate the specified comma-separated list of profiles (or list of profiles if using YAML)."
},
{
"name": "trace",

Write Preview
Loading…
Cancel
Save