diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/CorsEndpointProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/CorsEndpointProperties.java index 88b8aaf9c51..61c6242bf12 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/CorsEndpointProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/CorsEndpointProperties.java @@ -56,7 +56,7 @@ public class CorsEndpointProperties { private List 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; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorProperties.java index 4204199aadf..989d61f241a 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorProperties.java @@ -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 httpMapping = new HashMap<>(); diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaProperties.java index 38f6a0358e2..7768a07cccb 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaProperties.java @@ -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"; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java index c59500f4997..074f1b83b61 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java @@ -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 { 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 { 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; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/StepRegistryProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/StepRegistryProperties.java index 4bcdfb89fb2..8488b1e7697 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/StepRegistryProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/StepRegistryProperties.java @@ -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 { 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; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java index 5e79eee3f65..6fc6a7a2f1c 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java @@ -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 = ""; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index f6ca7ce47ad..94777956b40 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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.", diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java index 6a38bd3fd6d..d3e5458a8b6 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java @@ -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 { public static class Ssl { /** - * Enable SSL support. + * Whether to enable SSL support. */ private boolean enabled; @@ -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 { 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 { 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 { 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 { 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 { 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 { 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 { public static class ListenerRetry extends Retry { /** - * Whether or not retries are stateless or stateful. + * Whether retries are stateless or stateful. */ private boolean stateless = true; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java index 8f073593a33..adc8824cf8f 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java @@ -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 = ""; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java index b5d7d723e97..99d94f9b8be 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java @@ -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 { 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 { /** * 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CassandraProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CassandraProperties.java index 141047f02b1..5e37bdd967a 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CassandraProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CassandraProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.java index c47c9a4ed7f..7f308c53375 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseProperties.java index c0ee3baddba..31599aa382a 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseProperties.java @@ -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 { public static class Timeouts { /** - * Bucket connections timeout. + * Bucket connections timeouts. */ private Duration connect = Duration.ofMillis(5000); diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jProperties.java index ef4524eaff4..d1f8f8fecd9 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java index feaf3fa43ba..f8fbfbdbf50 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java @@ -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 { private int port = 6379; /** - * Enable SSL. + * Whether to enable SSL support. */ private boolean ssl; @@ -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 { 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 { public static class Sentinel { /** - * Name of Redis server. + * Name of the Redis server. */ private String master; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestProperties.java index 06288ede16d..89bdb4b0f0c 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/jest/JestProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/jest/JestProperties.java index 00ec3bc9d02..1ff9937d735 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/jest/JestProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/jest/JestProperties.java @@ -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 { private String password; /** - * Enable connection requests from multiple execution threads. + * Whether to enable connection requests from multiple execution threads. */ private boolean multiThreaded = true; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java index 0e610c691ed..2784d669462 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java @@ -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 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerProperties.java index e99c376ec9a..335177e362f 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerProperties.java @@ -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 settings = new HashMap<>(); @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/h2/H2ConsoleProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/h2/H2ConsoleProperties.java index 10f851bd94d..c99a769681f 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/h2/H2ConsoleProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/h2/H2ConsoleProperties.java @@ -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 { 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hateoas/HateoasProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hateoas/HateoasProperties.java index e740d4b35a3..1885b3dbd4a 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hateoas/HateoasProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hateoas/HateoasProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/http/HttpEncodingProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/http/HttpEncodingProperties.java index f27af4670de..f20ecc3fb03 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/http/HttpEncodingProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/http/HttpEncodingProperties.java @@ -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 mapping; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/influx/InfluxDbProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/influx/InfluxDbProperties.java index 6987cb2aeaa..e82607b1de2 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/influx/InfluxDbProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/influx/InfluxDbProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java index 894cf077e63..e4f8f0e53d9 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java @@ -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 { 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java index 800b4349ef9..98ec7b74acd 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java @@ -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 private String url; /** - * Login user of the database. + * Login username of the database. */ private String username; @@ -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 private List 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 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jersey/JerseyProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jersey/JerseyProperties.java index 4e0462499cb..db1d2fe21e2 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jersey/JerseyProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jersey/JerseyProperties.java @@ -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 init = new HashMap<>(); @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsProperties.java index 2d7f36511e3..be584dc5750 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsProperties.java @@ -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 { 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 { 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQProperties.java index e8d3f8d5580..a0896b89841 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQProperties.java @@ -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 { 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 { 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 { 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 { 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 { public static class Packages { /** - * Trust all packages. + * Whether to trust all packages. */ private Boolean trustAll; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisProperties.java index 3d16f3a7dac..e0f43aba268 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/JooqProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/JooqProperties.java index 107cbf205e6..8e4a892439c 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/JooqProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/JooqProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java index 3a325d97e30..a64a9670f5e 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java @@ -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 { 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 { private List 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 { 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 { 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 { private final Map 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 { 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 { 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 { 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 { public static class Jaas { /** - * Enable JAAS configuration. + * Whether to enable JAAS configuration. */ private boolean enabled; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapProperties.java index d35611e173c..fcc9aba0718 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java index bd4de81fa34..930518abb11 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java @@ -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 { public static class Validation { /** - * Enable LDAP schema validation. + * Whether to enable LDAP schema validation. */ private boolean enabled = true; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.java index fe2b60ede06..64e7d3f27bc 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.java @@ -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 { 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 { 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 { private Map 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java index 8a191201bed..64c8d8c7740 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java @@ -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 { private Map 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoProperties.java index 11e21955af9..584601f41b7 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoProperties.java @@ -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 { 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoProperties.java index c20e42bfef5..9814ba06f34 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaProperties.java index 96eaef0c358..cfba51ff58c 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaProperties.java @@ -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 { /** * 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/reactor/core/ReactorCoreProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/reactor/core/ReactorCoreProperties.java index e0f8c082ce0..ce3a0a55643 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/reactor/core/ReactorCoreProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/reactor/core/ReactorCoreProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java index 11fc18d11d9..06897b14c68 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/SocialProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/SocialProperties.java index 7668c3bdcfc..4fdeb6c008c 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/SocialProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/SocialProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractTemplateViewResolverProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractTemplateViewResolverProperties.java index ed59cdcb68d..e2f700ccb73 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractTemplateViewResolverProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractTemplateViewResolverProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java index 97df9890a6c..6cb46236dec 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java @@ -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 { private String[] viewNames; /** - * Check that the templates location exists. + * Whether to check that the templates location exists. */ private boolean checkTemplateLocation = true; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafProperties.java index 1a65f773471..f781e85595f 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafProperties.java @@ -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 { 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 { private Charset encoding = DEFAULT_ENCODING; /** - * Enable template caching. + * Whether to enable template caching. */ private boolean cache = true; @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionProperties.java index 8d6de0e1a87..8b5ea8f69ef 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionProperties.java @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ResourceProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ResourceProperties.java index ba5d830a217..9166fe10442 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ResourceProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ResourceProperties.java @@ -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 { 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 { 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 { 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java index 3320db39a3a..a96fdc922e8 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java @@ -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 { 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 { private Set trackingModes; /** - * Persist session data between restarts. + * Whether to persist session data between restarts. */ private boolean persistent; @@ -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 { 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 { 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 { 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 { 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 { 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 { 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 { 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 { 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 { 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 { public static class Accesslog { /** - * Enable access log. + * Whether to enable the access log. */ private Boolean enabled; @@ -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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/MultipartProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/MultipartProperties.java index 79c2e54fc6b..e7b1649249e 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/MultipartProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/MultipartProperties.java @@ -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 { /** * 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"; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java index e8ef71e36d5..473d2c22c69 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java @@ -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 { 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 4f16892dd4f..c22d2b8fc01 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "name": "spring.jta.enabled", "type": "java.lang.Boolean", - "description": "Enable JTA support.", + "description": "Whether to enable JTA support.", "defaultValue": true }, { @@ -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 @@ }, { "name": "spring.jta.bitronix.properties.disable-jmx", - "description": "Enable JMX support.", + "description": "Whether to enable JMX support.", "defaultValue": false }, { @@ -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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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 @@ { "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", diff --git a/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsProperties.java b/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsProperties.java index 08c1b619524..70243cf73c1 100644 --- a/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsProperties.java +++ b/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsProperties.java @@ -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 { 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 { public static class Livereload { /** - * Enable a livereload.com compatible server. + * Whether to enable a livereload.com-compatible server. */ private boolean enabled = true; diff --git a/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsProperties.java b/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsProperties.java index 39f4505cd59..d8836354e57 100644 --- a/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsProperties.java +++ b/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsProperties.java @@ -85,7 +85,7 @@ public class RemoteDevToolsProperties { public static class Restart { /** - * Enable remote restart. + * Whether to enable remote restart. */ private boolean enabled = true; diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index 5a06cff8f9c..cd35f5bde20 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -2,16 +2,16 @@ [appendix] [[common-application-properties]] == Common application properties -Various properties can be specified inside your `application.properties`/`application.yml` -file or as command line switches. This section provides a list of common Spring Boot -properties and references to the underlying classes that consume them. +Various properties can be specified inside your `application.properties` file, inside +your `application.yml` file, or as command line switches. This appendix provides a list +of common Spring Boot properties and references to the underlying classes that consume +them. -NOTE: Property contributions can come from additional jar files on your classpath so -you should not consider this an exhaustive list. It is also perfectly legit to define -your own properties. +NOTE: Property contributions can come from additional jar files on your classpath, so you +should not consider this an exhaustive list. Also, you can define your own properties. -WARNING: This sample file is meant as a guide only. Do **not** copy/paste the entire -content into your application; rather pick only the properties that you need. +WARNING: This sample file is meant as a guide only. Do **not** copy and paste the entire +content into your application. Rather, pick only the properties that you need. [source,properties,indent=0,subs="verbatim,attributes,macros"] @@ -31,57 +31,57 @@ content into your application; rather pick only the properties that you need. # BANNER banner.charset=UTF-8 # Banner file encoding. banner.location=classpath:banner.txt # Banner file location. - banner.image.location=classpath:banner.gif # Banner image file location (jpg/png can also be used). + banner.image.location=classpath:banner.gif # Banner image file location (jpg or png can also be used). banner.image.width= # Width of the banner image in chars (default 76) banner.image.height= # Height of the banner image in chars (default based on image height) banner.image.margin= # Left hand image margin in chars (default 2) - banner.image.invert= # If images should be inverted for dark terminal themes (default false) + banner.image.invert= # Whether images should be inverted for dark terminal themes (default false) # LOGGING - logging.config= # Location of the logging configuration file. For instance `classpath:logback.xml` for Logback + logging.config= # Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions. - logging.file= # Log file name. For instance `myapp.log` + logging.file= # Log file name. For instance, `myapp.log` logging.file.max-history= # Maximum of archive log files to keep. Only supported with the default logback setup. logging.file.max-size= # Maximum log file size. Only supported with the default logback setup. - logging.level.*= # Log levels severity mapping. For instance `logging.level.org.springframework=DEBUG` - logging.path= # Location of the log file. For instance `/var/log` - logging.pattern.console= # Appender pattern for output to the console. Only supported with the default logback setup. - logging.pattern.file= # Appender pattern for output to the file. Only supported with the default logback setup. - logging.pattern.level= # Appender pattern for log level (default %5p). Only supported with the default logback setup. + logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG` + logging.path= # Location of the log file. For instance, `/var/log` + logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup. + logging.pattern.file= # Appender pattern for output to a file. Supported only with the default Logback setup. + logging.pattern.level= # Appender pattern for log level (default: %5p). Supported only with the default Logback setup. logging.pattern.dateformat= # Appender pattern for log dateformat (default yyyy-MM-dd HH:mm:ss.SSS). Only supported with the default logback setup. logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized. # AOP spring.aop.auto=true # Add @EnableAspectJAutoProxy. - spring.aop.proxy-target-class=true # Whether subclass-based (CGLIB) proxies are to be created (true) as opposed to standard Java interface-based proxies (false). + spring.aop.proxy-target-class=true # Whether subclass-based (CGLIB) proxies are to be created (true), as opposed to standard Java interface-based proxies (false). # IDENTITY ({sc-spring-boot}/context/ContextIdApplicationContextInitializer.{sc-ext}[ContextIdApplicationContextInitializer]) spring.application.index= # Application index. spring.application.name= # Application name. # ADMIN ({sc-spring-boot-autoconfigure}/admin/SpringApplicationAdminJmxAutoConfiguration.{sc-ext}[SpringApplicationAdminJmxAutoConfiguration]) - spring.application.admin.enabled=false # Enable admin features for the application. + spring.application.admin.enabled=false # Whether to enable admin features for the application. spring.application.admin.jmx-name=org.springframework.boot:type=Admin,name=SpringApplication # JMX name of the application admin MBean. # AUTO-CONFIGURATION spring.autoconfigure.exclude= # Auto-configuration classes to exclude. # SPRING CORE - spring.beaninfo.ignore=true # Skip search of BeanInfo classes. + spring.beaninfo.ignore=true # Whether to skip search of BeanInfo classes. # SPRING CACHE ({sc-spring-boot-autoconfigure}/cache/CacheProperties.{sc-ext}[CacheProperties]) spring.cache.cache-names= # Comma-separated list of cache names to create if supported by the underlying cache manager. - spring.cache.caffeine.spec= # The spec to use to create caches. Check CaffeineSpec for more details on the spec format. - spring.cache.couchbase.expiration=0ms # Entry expiration. By default the entries never expire. + spring.cache.caffeine.spec= # The spec to use to create caches. See CaffeineSpec for more details on the spec format. + spring.cache.couchbase.expiration=0ms # Entry expiration in milliseconds. By default, the entries never expire. spring.cache.ehcache.config= # The location of the configuration file to use to initialize EhCache. spring.cache.infinispan.config= # The location of the configuration file to use to initialize Infinispan. spring.cache.jcache.config= # The location of the configuration file to use to initialize the cache manager. - spring.cache.jcache.provider= # 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 implementation is available on the classpath. + spring.cache.jcache.provider= # Fully qualified name of the CachingProvider implementation to use to retrieve the JSR-107 compliant cache manager. Needed only if more than one JSR-107 implementation is available on the classpath. spring.cache.redis.cache-null-values=true # Allow caching null values. spring.cache.redis.key-prefix= # Key prefix. spring.cache.redis.time-to-live=0ms # Entry expiration. By default the entries never expire. spring.cache.redis.use-key-prefix=true # Whether to use the key prefix when writing to Redis. - spring.cache.type= # Cache type, auto-detected according to the environment by default. + spring.cache.type= # Cache type. By default, auto-detected according to the environment. # SPRING CONFIG - using environment property only ({sc-spring-boot}/context/config/ConfigFileApplicationListener.{sc-ext}[ConfigFileApplicationListener]) spring.config.location= # Config file locations. @@ -101,41 +101,41 @@ content into your application; rather pick only the properties that you need. # Email ({sc-spring-boot-autoconfigure}/mail/MailProperties.{sc-ext}[MailProperties]) spring.mail.default-encoding=UTF-8 # Default MimeMessage encoding. - spring.mail.host= # SMTP server host. For instance `smtp.example.com` - spring.mail.jndi-name= # Session JNDI name. When set, takes precedence to others mail settings. + spring.mail.host= # SMTP server host. For instance, `smtp.example.com` + spring.mail.jndi-name= # Session JNDI name. When set, takes precedence over other mail settings. spring.mail.password= # Login password of the SMTP server. spring.mail.port= # SMTP server port. spring.mail.properties.*= # Additional JavaMail session properties. spring.mail.protocol=smtp # Protocol used by the SMTP server. - spring.mail.test-connection=false # Test that the mail server is available on startup. + spring.mail.test-connection=false # Whether to test that the mail server is available on startup. spring.mail.username= # Login user of the SMTP server. # APPLICATION SETTINGS ({sc-spring-boot}/SpringApplication.{sc-ext}[SpringApplication]) spring.main.banner-mode=console # Mode used to display the banner when the application runs. - spring.main.sources= # Sources (class name, package name or XML resource location) to include in the ApplicationContext. - spring.main.web-application-type= # Flag to explicitly request a specific type of web application. Auto-detected based on the classpath if not set. + spring.main.sources= # Sources (class names, package names, or XML resource locations) to include in the ApplicationContext. + spring.main.web-application-type= # Flag to explicitly request a specific type of web application. If not set, auto-detected based on the classpath. # FILE ENCODING ({sc-spring-boot}/context/FileEncodingApplicationListener.{sc-ext}[FileEncodingApplicationListener]) spring.mandatory-file-encoding= # Expected character encoding the application must use. - # INTERNATIONALIZATION ({sc-spring-boot-autoconfigure}/context/MessageSourceAutoConfiguration.{sc-ext}[MessageSourceAutoConfiguration]) - spring.messages.always-use-message-format=false # Set whether to always apply the MessageFormat rules, parsing even messages without arguments. + # INTERNATIONALIZATION ({sc-spring-boot-autoconfigure}/context/MessageSourceProperties.{sc-ext}[MessageSourceProperties]) + spring.messages.always-use-message-format=false # Whether to always apply the MessageFormat rules, parsing even messages without arguments. spring.messages.basename=messages # Comma-separated list of basenames, each following the ResourceBundle convention. spring.messages.cache-duration=-1 # Loaded resource bundle files cache duration. When not set, bundles are cached forever. spring.messages.encoding=UTF-8 # Message bundles encoding. - spring.messages.fallback-to-system-locale=true # Set whether to fall back to the system Locale if no files for a specific Locale have been found. - spring.messages.use-code-as-default-message=false # Set whether to use the message code as default message instead of throwing a "NoSuchMessageException". Recommended during development only. + spring.messages.fallback-to-system-locale=true # Whether to fall back to the system Locale if no files for a specific Locale have been found. + spring.messages.use-code-as-default-message=false # Whether to use the message code as the default message instead of throwing a "NoSuchMessageException". Recommended during development only. # OUTPUT - spring.output.ansi.enabled=detect # Configure the ANSI output. + spring.output.ansi.enabled=detect # Configures the ANSI output. # PID FILE ({sc-spring-boot}/system/ApplicationPidFileWriter.{sc-ext}[ApplicationPidFileWriter]) - spring.pid.fail-on-write-error= # Fail if ApplicationPidFileWriter is used but it cannot write the PID file. + spring.pid.fail-on-write-error= # Fails if ApplicationPidFileWriter is used but it cannot write the PID file. spring.pid.file= # Location of the PID file to write (if ApplicationPidFileWriter is used). # PROFILES spring.profiles.active= # Comma-separated list (or list if using YAML) of <>. - spring.profiles.include= # Unconditionally activate the specified comma separated profiles (or list of profiles if using YAML). + spring.profiles.include= # Unconditionally activate the specified comma-separated list of profiles (or list of profiles if using YAML). # QUARTZ SCHEDULER ({sc-spring-boot-autoconfigure}/quartz/QuartzProperties.{sc-ext}[QuartzProperties]) spring.quartz.job-store-type=memory # Quartz job store type. @@ -143,8 +143,8 @@ content into your application; rather pick only the properties that you need. spring.quartz.jdbc.initialize-schema=embedded # Database schema initialization mode. spring.quartz.jdbc.schema=classpath:org/quartz/impl/jdbcjobstore/tables_@@platform@@.sql # Path to the SQL file to use to initialize the database schema. - # Reactor - spring.reactor.stacktrace-mode.enabled=false # Set whether Reactor should collect stacktrace information at runtime. + # REACTOR ({sc-spring-boot-autoconfigure}/reactor/core/ReactorCoreProperties.{sc-ext}[ReactorCoreProperties]) + spring.reactor.stacktrace-mode.enabled=false # Whether Reactor should collect stacktrace information at runtime. # SENDGRID ({sc-spring-boot-autoconfigure}/sendgrid/SendGridAutoConfiguration.{sc-ext}[SendGridAutoConfiguration]) spring.sendgrid.api-key= # SendGrid API key. @@ -157,14 +157,14 @@ content into your application; rather pick only the properties that you need. # ---------------------------------------- # EMBEDDED SERVER CONFIGURATION ({sc-spring-boot-autoconfigure}/web/ServerProperties.{sc-ext}[ServerProperties]) - server.address= # Network address to which the server should bind to. - server.compression.enabled=false # If response compression is enabled. + server.address= # Network address to which the server should bind. + server.compression.enabled=false # Whether response compression is enabled. server.compression.excluded-user-agents= # List of user-agents to exclude from compression. server.compression.mime-types=text/html,text/xml,text/plain,text/css,text/javascript,application/javascript # Comma-separated list of MIME types that should be compressed. server.compression.min-response-size=2048 # Minimum response size that is required for compression to be performed. - server.connection-timeout= # Time that connectors will wait for another HTTP request before closing the connection. When not set, the connector's container-specific default will be used. Use a value of -1ms to indicate no (i.e. infinite) timeout. + server.connection-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. server.display-name=application # Display name of the application. - server.max-http-header-size=0 # Maximum size in bytes of the HTTP message header. + server.max-http-header-size=0 # Maximum size, in bytes, of the HTTP message header. server.error.include-exception=false # Include the "exception" attribute. server.error.include-stacktrace=never # When to include a "stacktrace" attribute. server.error.path=/error # Path of the error controller. @@ -176,23 +176,23 @@ content into your application; rather pick only the properties that you need. server.jetty.accesslog.enabled=false # Enable access log. server.jetty.accesslog.extended-format=false # Enable extended NCSA format. server.jetty.accesslog.file-date-format= # Date format to place in log file name. - server.jetty.accesslog.filename= # Log filename. If not specified, logs will be redirected to "System.err". + server.jetty.accesslog.filename= # Log filename. If not specified, logs redirect to "System.err". server.jetty.accesslog.locale= # Locale of the request log. server.jetty.accesslog.log-cookies=false # Enable logging of the request cookies. server.jetty.accesslog.log-latency=false # Enable logging of request processing time. server.jetty.accesslog.log-server=false # Enable logging of the request hostname. server.jetty.accesslog.retention-period=31 # Number of days before rotated log files are deleted. server.jetty.accesslog.time-zone=GMT # Timezone of the request log. - server.jetty.max-http-post-size=0 # Maximum size in bytes of the HTTP post or put content. + server.jetty.max-http-post-size=0 # Maximum size, in bytes, of the HTTP post or put content. server.jetty.selectors= # Number of selector threads to use. server.port=8080 # Server HTTP port. - server.server-header= # Value to use for the Server response header (no header is sent if empty) - server.use-forward-headers= # If X-Forwarded-* headers should be applied to the HttpRequest. + server.server-header= # Value to use for the Server response header (if empty, no header is sent) + server.use-forward-headers= # Whether X-Forwarded-* headers should be applied to the HttpRequest. server.servlet.context-parameters.*= # Servlet context init parameters server.servlet.context-path= # Context path of the application. server.servlet.jsp.class-name=org.apache.jasper.servlet.JspServlet # The class name of the JSP servlet. - server.servlet.jsp.init-parameters.*= # Init parameters used to configure the JSP servlet - server.servlet.jsp.registered=true # Whether or not the JSP servlet is registered + server.servlet.jsp.init-parameters.*= # Init parameters used to configure the JSP servlet. + server.servlet.jsp.registered=true # Whether the JSP servlet is registered. server.servlet.path=/ # Path of the main dispatcher servlet. server.session.cookie.comment= # Comment for the session cookie. server.session.cookie.domain= # Domain for the session cookie. @@ -201,7 +201,7 @@ content into your application; rather pick only the properties that you need. server.session.cookie.name= # Session cookie name. server.session.cookie.path= # Path of the session cookie. server.session.cookie.secure= # "Secure" flag for the session cookie. - server.session.persistent=false # Persist session data between restarts. + server.session.persistent=false # Whether to persist session data between restarts. server.session.store-dir= # Directory used to store session data. server.session.timeout= # Session timeout. If a duration suffix is not specified, seconds will be used. server.session.tracking-modes= # Session tracking modes (one or more of the following: "cookie", "url", "ssl"). @@ -221,19 +221,19 @@ content into your application; rather pick only the properties that you need. server.ssl.trust-store-provider= # Provider for the trust store. server.ssl.trust-store-type= # Type of the trust store. server.tomcat.accept-count= # Maximum queue length for incoming connection requests when all possible request processing threads are in use. - server.tomcat.accesslog.buffered=true # Buffer output such that it is only flushed periodically. - server.tomcat.accesslog.directory=logs # Directory in which log files are created. Can be relative to the tomcat base dir or absolute. + server.tomcat.accesslog.buffered=true # Whether to buffer output such that it is flushed only periodically. + server.tomcat.accesslog.directory=logs # Directory in which log files are created. Can be absolute or relative to the Tomcat base dir. server.tomcat.accesslog.enabled=false # Enable access log. - server.tomcat.accesslog.file-date-format=.yyyy-MM-dd # Date format to place in log file name. + server.tomcat.accesslog.file-date-format=.yyyy-MM-dd # Date format to place in the log file name. server.tomcat.accesslog.pattern=common # Format pattern for access logs. server.tomcat.accesslog.prefix=access_log # Log file name prefix. - server.tomcat.accesslog.rename-on-rotate=false # Defer inclusion of the date stamp in the file name until rotate time. - server.tomcat.accesslog.request-attributes-enabled=false # Set request attributes for IP address, Hostname, protocol and port used for the request. - server.tomcat.accesslog.rotate=true # Enable access log rotation. + server.tomcat.accesslog.rename-on-rotate=false # Whether to defer inclusion of the date stamp in the file name until rotate time. + server.tomcat.accesslog.request-attributes-enabled=false # Set request attributes for the IP address, Hostname, protocol, and port used for the request. + server.tomcat.accesslog.rotate=true # Whether to enable access log rotation. server.tomcat.accesslog.suffix=.log # Log file name suffix. server.tomcat.additional-tld-skip-patterns= # Comma-separated list of additional patterns that match jars to ignore for TLD scanning. server.tomcat.background-processor-delay=30s # Delay between the invocation of backgroundProcess methods. If a duration suffix is not specified, seconds will be used. - server.tomcat.basedir= # Tomcat base directory. If not specified a temporary directory will be used. + server.tomcat.basedir= # Tomcat base directory. If not specified, a temporary directory is used. server.tomcat.internal-proxies=10\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}|\\ 192\\.168\\.\\d{1,3}\\.\\d{1,3}|\\ 169\\.254\\.\\d{1,3}\\.\\d{1,3}|\\ @@ -241,62 +241,62 @@ content into your application; rather pick only the properties that you need. 172\\.1[6-9]{1}\\.\\d{1,3}\\.\\d{1,3}|\\ 172\\.2[0-9]{1}\\.\\d{1,3}\\.\\d{1,3}|\\ 172\\.3[0-1]{1}\\.\\d{1,3}\\.\\d{1,3} # regular expression matching trusted IP addresses. - server.tomcat.max-connections= # Maximum number of connections that the server will accept and process at any given time. - server.tomcat.max-http-header-size=0 # Maximum size in bytes of the HTTP message header. - server.tomcat.max-http-post-size=0 # Maximum size in bytes of the HTTP post content. - server.tomcat.max-threads=0 # Maximum amount of worker threads. - server.tomcat.min-spare-threads=0 # Minimum amount of worker threads. + server.tomcat.max-connections= # Maximum number of connections that the server accepts and processes at any given time. + server.tomcat.max-http-header-size=0 # Maximum size, in bytes, of the HTTP message header. + server.tomcat.max-http-post-size=0 # Maximum size, in bytes, of the HTTP post content. + server.tomcat.max-threads=0 # Maximum number of worker threads. + server.tomcat.min-spare-threads=0 # Minimum number of worker threads. server.tomcat.port-header=X-Forwarded-Port # Name of the HTTP header used to override the original port value. server.tomcat.protocol-header= # Header that holds the incoming protocol, usually named "X-Forwarded-Proto". - server.tomcat.protocol-header-https-value=https # Value of the protocol header that indicates that the incoming request uses SSL. + server.tomcat.protocol-header-https-value=https # Value of the protocol header indicating whether the incoming request uses SSL. server.tomcat.redirect-context-root= # Whether requests to the context root should be redirected by appending a / to the path. - server.tomcat.remote-ip-header= # Name of the http header from which the remote ip is extracted. For instance `X-FORWARDED-FOR` + server.tomcat.remote-ip-header= # Name of the HTTP header from which the remote IP is extracted. For instance, `X-FORWARDED-FOR`. server.tomcat.resource.cache-ttl= # Time-to-live of the static resource cache. server.tomcat.uri-encoding=UTF-8 # Character encoding to use to decode the URI. server.undertow.accesslog.dir= # Undertow access log directory. - server.undertow.accesslog.enabled=false # Enable access log. + server.undertow.accesslog.enabled=false # Whether to enable the access log. server.undertow.accesslog.pattern=common # Format pattern for access logs. server.undertow.accesslog.prefix=access_log. # Log file name prefix. - server.undertow.accesslog.rotate=true # Enable access log rotation. + server.undertow.accesslog.rotate=true # Whether to enable access log rotation. server.undertow.accesslog.suffix=log # Log file name suffix. - server.undertow.buffer-size= # Size of each buffer in bytes. - server.undertow.direct-buffers= # Allocate buffers outside the Java heap. + server.undertow.buffer-size= # Size of each buffer, in bytes. + server.undertow.direct-buffers= # Whether to allocate buffers outside the Java heap. server.undertow.io-threads= # Number of I/O threads to create for the worker. server.undertow.eager-filter-init=true # Whether servlet filters should be initialized on startup. - server.undertow.max-http-post-size=0 # Maximum size in bytes of the HTTP post content. + server.undertow.max-http-post-size=0 # Maximum size, in bytes, of the HTTP post content. server.undertow.worker-threads= # Number of worker threads. - # FREEMARKER ({sc-spring-boot-autoconfigure}/freemarker/FreeMarkerAutoConfiguration.{sc-ext}[FreeMarkerAutoConfiguration]) - spring.freemarker.allow-request-override=false # Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.freemarker.allow-session-override=false # Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.freemarker.cache=false # Enable template caching. + # FREEMARKER ({sc-spring-boot-autoconfigure}/freemarker/FreeMarkerProperties.{sc-ext}[FreeMarkerProperties]) + spring.freemarker.allow-request-override=false # Whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. + spring.freemarker.allow-session-override=false # Whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. + spring.freemarker.cache=false # Whether to enable template caching. spring.freemarker.charset=UTF-8 # Template encoding. - spring.freemarker.check-template-location=true # Check that the templates location exists. + spring.freemarker.check-template-location=true # Whether to check that the templates location exists. spring.freemarker.content-type=text/html # Content-Type value. - spring.freemarker.enabled=true # Enable MVC view resolution for this technology. - spring.freemarker.expose-request-attributes=false # Set whether all request attributes should be added to the model prior to merging with the template. - spring.freemarker.expose-session-attributes=false # Set whether all HttpSession attributes should be added to the model prior to merging with the template. - spring.freemarker.expose-spring-macro-helpers=true # Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". - spring.freemarker.prefer-file-system-access=true # Prefer file system access for template loading. File system access enables hot detection of template changes. + spring.freemarker.enabled=true # Whether to enable MVC view resolution for this technology. + spring.freemarker.expose-request-attributes=false # Whether all request attributes should be added to the model prior to merging with the template. + spring.freemarker.expose-session-attributes=false # Whether all HttpSession attributes should be added to the model prior to merging with the template. + spring.freemarker.expose-spring-macro-helpers=true # Whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". + spring.freemarker.prefer-file-system-access=true # Whether to prefer file system access for template loading. File system access enables hot detection of template changes. spring.freemarker.prefix= # Prefix that gets prepended to view names when building a URL. spring.freemarker.request-context-attribute= # Name of the RequestContext attribute for all views. - spring.freemarker.settings.*= # Well-known FreeMarker keys which will be passed to FreeMarker's Configuration. + spring.freemarker.settings.*= # Well-known FreeMarker keys which are passed to FreeMarker's Configuration. spring.freemarker.suffix=.ftl # Suffix that gets appended to view names when building a URL. spring.freemarker.template-loader-path=classpath:/templates/ # Comma-separated list of template paths. spring.freemarker.view-names= # White list of view names that can be resolved. - # GROOVY TEMPLATES ({sc-spring-boot-autoconfigure}/groovy/template/GroovyTemplateAutoConfiguration.{sc-ext}[GroovyTemplateAutoConfiguration]) - spring.groovy.template.allow-request-override=false # Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.groovy.template.allow-session-override=false # Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.groovy.template.cache= # Enable template caching. + # GROOVY TEMPLATES ({sc-spring-boot-autoconfigure}/groovy/template/GroovyTemplateProperties.{sc-ext}[GroovyTemplateProperties]) + spring.groovy.template.allow-request-override=false # Whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. + spring.groovy.template.allow-session-override=false # Whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. + spring.groovy.template.cache= # Whether to enable template caching. spring.groovy.template.charset=UTF-8 # Template encoding. spring.groovy.template.check-template-location=true # Check that the templates location exists. - spring.groovy.template.configuration.*= # See GroovyMarkupConfigurer + spring.groovy.template.configuration.*= # See https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/view/groovy/GroovyMarkupConfigurer.html[GroovyMarkupConfigurer] spring.groovy.template.content-type=test/html # Content-Type value. - spring.groovy.template.enabled=true # Enable MVC view resolution for this technology. - spring.groovy.template.expose-request-attributes=false # Set whether all request attributes should be added to the model prior to merging with the template. - spring.groovy.template.expose-session-attributes=false # Set whether all HttpSession attributes should be added to the model prior to merging with the template. - spring.groovy.template.expose-spring-macro-helpers=true # Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". + spring.groovy.template.enabled=true # Whether to enable MVC view resolution for this technology. + spring.groovy.template.expose-request-attributes=false # Whether all request attributes should be added to the model prior to merging with the template. + spring.groovy.template.expose-session-attributes=false # Whether all HttpSession attributes should be added to the model prior to merging with the template. + spring.groovy.template.expose-spring-macro-helpers=true # Whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". spring.groovy.template.prefix= # Prefix that gets prepended to view names when building a URL. spring.groovy.template.request-context-attribute= # Name of the RequestContext attribute for all views. spring.groovy.template.resource-loader-path=classpath:/templates/ # Template path. @@ -304,51 +304,51 @@ content into your application; rather pick only the properties that you need. spring.groovy.template.view-names= # White list of view names that can be resolved. # SPRING HATEOAS ({sc-spring-boot-autoconfigure}/hateoas/HateoasProperties.{sc-ext}[HateoasProperties]) - spring.hateoas.use-hal-as-default-json-media-type=true # Specify if application/hal+json responses should be sent to requests that accept application/json. + spring.hateoas.use-hal-as-default-json-media-type=true # Whether application/hal+json responses should be sent to requests that accept application/json. # HTTP message conversion - spring.http.converters.preferred-json-mapper= # Preferred JSON mapper to use for HTTP message conversion, auto-detected according to the environment by default. + spring.http.converters.preferred-json-mapper= # Preferred JSON mapper to use for HTTP message conversion. By default, auto-detected according to the environment. # HTTP encoding ({sc-spring-boot-autoconfigure}/http/HttpEncodingProperties.{sc-ext}[HttpEncodingProperties]) spring.http.encoding.charset=UTF-8 # Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly. - spring.http.encoding.enabled=true # Enable http encoding support. - spring.http.encoding.force= # Force the encoding to the configured charset on HTTP requests and responses. - spring.http.encoding.force-request= # Force the encoding to the configured charset on HTTP requests. Defaults to true when "force" has not been specified. - spring.http.encoding.force-response= # Force the encoding to the configured charset on HTTP responses. - spring.http.encoding.mapping= # Locale to Encoding mapping. + spring.http.encoding.enabled=true # Whether to enable http encoding support. + spring.http.encoding.force= # Whether to force the encoding to the configured charset on HTTP requests and responses. + spring.http.encoding.force-request= # Whether to force the encoding to the configured charset on HTTP requests. Defaults to true when "force" has not been specified. + spring.http.encoding.force-response= # Whether to force the encoding to the configured charset on HTTP responses. + spring.http.encoding.mapping= # Locale in which to encode mapping. # MULTIPART ({sc-spring-boot-autoconfigure}/web/servlet/MultipartProperties.{sc-ext}[MultipartProperties]) - spring.servlet.multipart.enabled=true # Enable support of multipart uploads. - spring.servlet.multipart.file-size-threshold=0 # Threshold after which files will be written to disk. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes respectively. + spring.servlet.multipart.enabled=true # Whether to enable support of multipart uploads. + spring.servlet.multipart.file-size-threshold=0 # Threshold after which files are written to disk. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes, respectively. spring.servlet.multipart.location= # Intermediate location of uploaded files. - spring.servlet.multipart.max-file-size=1MB # Max file size. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes respectively. - spring.servlet.multipart.max-request-size=10MB # Max request size. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes respectively. + spring.servlet.multipart.max-file-size=1MB # Max file size. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes, respectively. + spring.servlet.multipart.max-request-size=10MB # Max request size. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes, respectively. spring.servlet.multipart.resolve-lazily=false # Whether to resolve the multipart request lazily at the time of file or parameter access. # JACKSON ({sc-spring-boot-autoconfigure}/jackson/JacksonProperties.{sc-ext}[JacksonProperties]) - spring.jackson.date-format= # Date format string or a fully-qualified date format class name. For instance `yyyy-MM-dd HH:mm:ss`. - spring.jackson.default-property-inclusion= # Controls the inclusion of properties during serialization. + spring.jackson.date-format= # Date format string or a fully-qualified date format class name. For instance, `yyyy-MM-dd HH:mm:ss`. + spring.jackson.default-property-inclusion= # Controls the inclusion of properties during serialization. Configured with one of the values in Jackson's JsonInclude.Include enumeration. spring.jackson.deserialization.*= # Jackson on/off features that affect the way Java objects are deserialized. spring.jackson.generator.*= # Jackson on/off features for generators. - spring.jackson.joda-date-time-format= # Joda date time format string. If not configured, "date-format" will be used as a fallback if it is configured with a format string. + spring.jackson.joda-date-time-format= # Joda date time format string. If not configured, "date-format" is used as a fallback if it is configured with a format string. spring.jackson.locale= # Locale used for formatting. spring.jackson.mapper.*= # Jackson general purpose on/off features. spring.jackson.parser.*= # Jackson on/off features for parsers. spring.jackson.property-naming-strategy= # One of the constants on Jackson's PropertyNamingStrategy. Can also be a fully-qualified class name of a PropertyNamingStrategy subclass. spring.jackson.serialization.*= # Jackson on/off features that affect the way Java objects are serialized. - spring.jackson.time-zone= # Time zone used when formatting dates. For instance `America/Los_Angeles` + spring.jackson.time-zone= # Time zone used when formatting dates. For instance, "America/Los_Angeles" or "GMT+10". # JERSEY ({sc-spring-boot-autoconfigure}/jersey/JerseyProperties.{sc-ext}[JerseyProperties]) - spring.jersey.application-path= # Path that serves as the base URI for the application. Overrides the value of "@ApplicationPath" if specified. + spring.jersey.application-path= # Path that serves as the base URI for the application. If specified, overrides the value of "@ApplicationPath". spring.jersey.filter.order=0 # Jersey filter chain order. - spring.jersey.init.*= # Init parameters to pass to Jersey via the servlet or filter. + spring.jersey.init.*= # Init parameters to pass to Jersey through the servlet or filter. spring.jersey.servlet.load-on-startup=-1 # Load on startup priority of the Jersey servlet. spring.jersey.type=servlet # Jersey integration type. # SPRING LDAP ({sc-spring-boot-autoconfigure}/ldap/LdapProperties.{sc-ext}[LdapProperties]) spring.ldap.urls= # LDAP URLs of the server. spring.ldap.base= # Base suffix from which all operations should originate. - spring.ldap.username= # Login user of the server. + spring.ldap.username= # Login username of the server. spring.ldap.password= # Login password of the server. spring.ldap.base-environment.*= # LDAP specification settings. @@ -358,20 +358,20 @@ content into your application; rather pick only the properties that you need. spring.ldap.embedded.credential.password= # Embedded LDAP password. spring.ldap.embedded.ldif=classpath:schema.ldif # Schema (LDIF) script resource reference. spring.ldap.embedded.port= # Embedded LDAP port. - spring.ldap.embedded.validation.enabled=true # Enable LDAP schema validation. + spring.ldap.embedded.validation.enabled=true # Whether to enable LDAP schema validation. spring.ldap.embedded.validation.schema= # Path to the custom schema. # MUSTACHE TEMPLATES ({sc-spring-boot-autoconfigure}/mustache/MustacheAutoConfiguration.{sc-ext}[MustacheAutoConfiguration]) - spring.mustache.allow-request-override= # Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.mustache.allow-session-override= # Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.mustache.cache= # Enable template caching. + spring.mustache.allow-request-override= # Whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. + spring.mustache.allow-session-override= # Whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. + spring.mustache.cache= # Whether to enable template caching. spring.mustache.charset= # Template encoding. - spring.mustache.check-template-location= # Check that the templates location exists. + spring.mustache.check-template-location= # Whether to check that the templates location exists. spring.mustache.content-type= # Content-Type value. - spring.mustache.enabled= # Enable MVC view resolution for this technology. - spring.mustache.expose-request-attributes= # Set whether all request attributes should be added to the model prior to merging with the template. - spring.mustache.expose-session-attributes= # Set whether all HttpSession attributes should be added to the model prior to merging with the template. - spring.mustache.expose-spring-macro-helpers= # Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". + spring.mustache.enabled= # Whether to enable MVC view resolution for this technology. + spring.mustache.expose-request-attributes= # Whether all request attributes should be added to the model prior to merging with the template. + spring.mustache.expose-session-attributes= # Whether all HttpSession attributes should be added to the model prior to merging with the template. + spring.mustache.expose-spring-macro-helpers= # Whether to expose a RequestContext for use by Spring's macro library under the name "springMacroRequestContext". spring.mustache.prefix=classpath:/templates/ # Prefix to apply to template names. spring.mustache.request-context-attribute= # Name of the RequestContext attribute for all views. spring.mustache.suffix=.mustache # Suffix to apply to template names. @@ -379,25 +379,25 @@ content into your application; rather pick only the properties that you need. # SPRING MVC ({sc-spring-boot-autoconfigure}/web/servlet/WebMvcProperties.{sc-ext}[WebMvcProperties]) spring.mvc.async.request-timeout= # Amount of time before asynchronous request handling times out. - spring.mvc.date-format= # Date format to use. For instance `dd/MM/yyyy`. - spring.mvc.dispatch-trace-request=false # Dispatch TRACE requests to the FrameworkServlet doService method. - spring.mvc.dispatch-options-request=true # Dispatch OPTIONS requests to the FrameworkServlet doService method. - spring.mvc.favicon.enabled=true # Enable resolution of favicon.ico. - spring.mvc.formcontent.putfilter.enabled=true # Enable Spring's HttpPutFormContentFilter. - spring.mvc.ignore-default-model-on-redirect=true # If the content of the "default" model should be ignored during redirect scenarios. + spring.mvc.date-format= # Date format to use. For instance, `dd/MM/yyyy`. + spring.mvc.dispatch-trace-request=false # Whether to dispatch TRACE requests to the FrameworkServlet doService method. + spring.mvc.dispatch-options-request=true # Whether to dispatch OPTIONS requests to the FrameworkServlet doService method. + spring.mvc.favicon.enabled=true # Whether to enable resolution of favicon.ico. + spring.mvc.formcontent.putfilter.enabled=true # Whether to enable Spring's HttpPutFormContentFilter. + spring.mvc.ignore-default-model-on-redirect=true # Whether the content of the "default" model should be ignored during redirect scenarios. spring.mvc.locale= # Locale to use. By default, this locale is overridden by the "Accept-Language" header. spring.mvc.locale-resolver=accept-header # Define how the locale should be resolved. - spring.mvc.log-resolved-exception=false # Enable warn logging of exceptions resolved by a "HandlerExceptionResolver". + spring.mvc.log-resolved-exception=false # Whether to enable warn logging of exceptions resolved by a "HandlerExceptionResolver". spring.mvc.media-types.*= # Maps file extensions to media types for content negotiation. - spring.mvc.message-codes-resolver-format= # Formatting strategy for message codes. For instance `PREFIX_ERROR_CODE`. + spring.mvc.message-codes-resolver-format= # Formatting strategy for message codes. For instance, `PREFIX_ERROR_CODE`. spring.mvc.servlet.load-on-startup=-1 # Load on startup priority of the Spring Web Services servlet. spring.mvc.static-path-pattern=/** # Path pattern used for static resources. - spring.mvc.throw-exception-if-no-handler-found=false # If a "NoHandlerFoundException" should be thrown if no Handler was found to process a request. + spring.mvc.throw-exception-if-no-handler-found=false # Whether a "NoHandlerFoundException" should be thrown if no Handler was found to process a request. spring.mvc.view.prefix= # Spring MVC view prefix. spring.mvc.view.suffix= # Spring MVC view suffix. # SPRING RESOURCES HANDLING ({sc-spring-boot-autoconfigure}/web/ResourceProperties.{sc-ext}[ResourceProperties]) - spring.resources.add-mappings=true # Enable default resource handling. + spring.resources.add-mappings=true # Whether to enable default resource handling. spring.resources.cache-control.max-age= # Maximum time the response should be cached, in seconds if no duration suffix is not specified. spring.resources.cache-control.no-cache= # Indicate that the cached response can be reused only if re-validated with the server. spring.resources.cache-control.no-store= # Indicate to not cache the response in any case. @@ -410,15 +410,16 @@ content into your application; rather pick only the properties that you need. spring.resources.cache-control.stale-if-error= # Maximum time the response may be used when errors are encountered, in seconds if no duration suffix is not specified. spring.resources.cache-control.s-max-age= # Maximum time the response should be cached by shared caches, in seconds if no duration suffix is not specified. spring.resources.cache-period= # Cache period for the resources served by the resource handler. If a duration suffix is not specified, seconds will be used. - spring.resources.chain.cache=true # Enable caching in the Resource chain. - spring.resources.chain.enabled= # Enable the Spring Resource Handling chain. Disabled by default unless at least one strategy has been enabled. - spring.resources.chain.gzipped=false # Enable resolution of already gzipped resources. - spring.resources.chain.html-application-cache=false # Enable HTML5 application cache manifest rewriting. + spring.resources.chain.cache=true # Whether to enable caching in the Resource chain. + spring.resources.chain.enabled= # Whether to enable the Spring Resource Handling chain. By default, disabled unless at least one strategy has been enabled. + spring.resources.chain.gzipped=false # Whether to enable resolution of already gzipped resources. + spring.resources.chain.html-application-cache=false # Whether to enable HTML5 application cache manifest rewriting. spring.resources.chain.strategy.content.enabled=false # Enable the content Version Strategy. - spring.resources.chain.strategy.content.paths=/** # Comma-separated list of patterns to apply to the Version Strategy. - spring.resources.chain.strategy.fixed.enabled=false # Enable the fixed Version Strategy. - spring.resources.chain.strategy.fixed.paths=/** # Comma-separated list of patterns to apply to the Version Strategy. - spring.resources.chain.strategy.fixed.version= # Version string to use for the Version Strategy. + spring.resources.chain.strategy.content.paths=/** # Comma-separated list of patterns to apply to the content Version Strategy. + spring.resources.chain.strategy.content.enabled=false # Whether to enable the content Version Strategy. + spring.resources.chain.strategy.fixed.enabled=false # Whether to enable the fixed Version Strategy. + spring.resources.chain.strategy.fixed.paths=/** # Comma-separated list of patterns to apply to the fixed Version Strategy. + spring.resources.chain.strategy.fixed.version= # Version string to use for the fixed Version Strategy. spring.resources.static-locations=classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/ # Locations of static resources. # SPRING SESSION ({sc-spring-boot-autoconfigure}/session/SessionProperties.{sc-ext}[SessionProperties]) @@ -434,7 +435,7 @@ content into your application; rather pick only the properties that you need. spring.session.jdbc.cleanup-cron=0 * * * * * # Cron expression for expired session cleanup job. spring.session.jdbc.initialize-schema=embedded # Database schema initialization mode. spring.session.jdbc.schema=classpath:org/springframework/session/jdbc/schema-@@platform@@.sql # Path to the SQL file to use to initialize the database schema. - spring.session.jdbc.table-name=SPRING_SESSION # Name of database table used to store sessions. + spring.session.jdbc.table-name=SPRING_SESSION # Name of the database table used to store sessions. # SPRING SESSION MONGODB ({sc-spring-boot-autoconfigure}/session/MongoSessionProperties.{sc-ext}[MongoSessionProperties]) spring.session.mongodb.collection-name=sessions # Collection name used to store sessions. @@ -445,29 +446,29 @@ content into your application; rather pick only the properties that you need. spring.session.redis.namespace=spring:session # Namespace for keys used to store sessions. # SPRING SOCIAL ({sc-spring-boot-autoconfigure}/social/SocialWebAutoConfiguration.{sc-ext}[SocialWebAutoConfiguration]) - spring.social.auto-connection-views=false # Enable the connection status view for supported providers. + spring.social.auto-connection-views=false # Whether to enable the connection status view for supported providers. # SPRING SOCIAL FACEBOOK ({sc-spring-boot-autoconfigure}/social/FacebookAutoConfiguration.{sc-ext}[FacebookAutoConfiguration]) - spring.social.facebook.app-id= # your application's Facebook App ID - spring.social.facebook.app-secret= # your application's Facebook App Secret + spring.social.facebook.app-id= # Your application's Facebook App ID. + spring.social.facebook.app-secret= # Your application's Facebook App Secret. # SPRING SOCIAL LINKEDIN ({sc-spring-boot-autoconfigure}/social/LinkedInAutoConfiguration.{sc-ext}[LinkedInAutoConfiguration]) - spring.social.linkedin.app-id= # your application's LinkedIn App ID - spring.social.linkedin.app-secret= # your application's LinkedIn App Secret + spring.social.linkedin.app-id= # Your application's LinkedIn App ID. + spring.social.linkedin.app-secret= # Your application's LinkedIn App Secret. # SPRING SOCIAL TWITTER ({sc-spring-boot-autoconfigure}/social/TwitterAutoConfiguration.{sc-ext}[TwitterAutoConfiguration]) - spring.social.twitter.app-id= # your application's Twitter App ID - spring.social.twitter.app-secret= # your application's Twitter App Secret + spring.social.twitter.app-id= # Your application's Twitter App ID. + spring.social.twitter.app-secret= # Your application's Twitter App Secret. # THYMELEAF ({sc-spring-boot-autoconfigure}/thymeleaf/ThymeleafAutoConfiguration.{sc-ext}[ThymeleafAutoConfiguration]) - spring.thymeleaf.cache=true # Enable template caching. - spring.thymeleaf.check-template=true # Check that the template exists before rendering it. - spring.thymeleaf.check-template-location=true # Check that the templates location exists. - spring.thymeleaf.enabled=true # Enable Thymeleaf view resolution for Web frameworks. + spring.thymeleaf.cache=true # Whether to enable template caching. + spring.thymeleaf.check-template=true # Whether to check that the template exists before rendering it. + spring.thymeleaf.check-template-location=true # Whether to check that the templates location exists. + spring.thymeleaf.enabled=true # Whether to enable Thymeleaf view resolution for Web frameworks. spring.thymeleaf.enable-spring-el-compiler=false # Enable the SpringEL compiler in SpringEL expressions. spring.thymeleaf.encoding=UTF-8 # Template files encoding. spring.thymeleaf.excluded-view-names= # Comma-separated list of view names that should be excluded from resolution. - spring.thymeleaf.mode=HTML5 # Template mode to be applied to templates. See also StandardTemplateModeHandlers. + spring.thymeleaf.mode=HTML5 # Template mode to be applied to templates. See also Thymleaf's TemplateMode enum. spring.thymeleaf.prefix=classpath:/templates/ # Prefix that gets prepended to view names when building a URL. spring.thymeleaf.reactive.max-chunk-size= # Maximum size of data buffers used for writing to the response, in bytes. spring.thymeleaf.reactive.media-types= # Media types supported by the view technology. @@ -506,11 +507,11 @@ content into your application; rather pick only the properties that you need. spring.flyway.allow-mixed-migrations= # spring.flyway.baseline-description= # spring.flyway.baseline-on-migrate= # - spring.flyway.baseline-version=1 # version to start migration - spring.flyway.check-location=true # Check that migration scripts location exists. + spring.flyway.baseline-version=1 # Version to start migration + spring.flyway.check-location=true # Whether to check that migration scripts location exists. spring.flyway.clean-disabled= # spring.flyway.clean-on-validation-error= # - spring.flyway.enabled=true # Enable flyway. + spring.flyway.enabled=true # Whether to enable flyway. spring.flyway.encoding= # spring.flyway.group= # spring.flyway.ignore-failed-future-migration= # @@ -518,10 +519,10 @@ content into your application; rather pick only the properties that you need. spring.flyway.ignore-missing-migrations= # spring.flyway.init-sqls= # SQL statements to execute to initialize a connection immediately after obtaining it. spring.flyway.installed-by= # - spring.flyway.locations=classpath:db/migration # locations of migrations scripts + spring.flyway.locations=classpath:db/migration # The locations of migrations scripts. spring.flyway.mixed= # spring.flyway.out-of-order= # - spring.flyway.password= # JDBC password if you want Flyway to create its own DataSource + spring.flyway.password= # JDBC password to use if you want Flyway to create its own DataSource. spring.flyway.placeholder-prefix= # spring.flyway.placeholder-replacement= # spring.flyway.placeholder-suffix= # @@ -541,16 +542,16 @@ content into your application; rather pick only the properties that you need. # LIQUIBASE ({sc-spring-boot-autoconfigure}/liquibase/LiquibaseProperties.{sc-ext}[LiquibaseProperties]) spring.liquibase.change-log=classpath:/db/changelog/db.changelog-master.yaml # Change log configuration path. - spring.liquibase.check-change-log-location=true # Check the change log location exists. + spring.liquibase.check-change-log-location=true # Whether to check that the change log location exists. spring.liquibase.contexts= # Comma-separated list of runtime contexts to use. spring.liquibase.default-schema= # Default database schema. - spring.liquibase.drop-first=false # Drop the database schema first. - spring.liquibase.enabled=true # Enable liquibase support. + spring.liquibase.drop-first=false # Whether to first drop the database schema. + spring.liquibase.enabled=true # Whether to enable Liquibase support. spring.liquibase.labels= # Comma-separated list of runtime labels to use. spring.liquibase.parameters.*= # Change log parameters. spring.liquibase.password= # Login password of the database to migrate. - spring.liquibase.rollback-file= # File to which rollback SQL will be written when an update is performed. - spring.liquibase.url= # JDBC url of the database to migrate. If not set, the primary configured data source is used. + spring.liquibase.rollback-file= # File to which rollback SQL is written when an update is performed. + spring.liquibase.url= # JDBC URL of the database to migrate. If not set, the primary configured data source is used. spring.liquibase.user= # Login user of the database to migrate. # COUCHBASE ({sc-spring-boot-autoconfigure}/couchbase/CouchbaseProperties.{sc-ext}[CouchbaseProperties]) @@ -560,17 +561,17 @@ content into your application; rather pick only the properties that you need. spring.couchbase.env.endpoints.key-value=1 # Number of sockets per node against the Key/value service. spring.couchbase.env.endpoints.query=1 # Number of sockets per node against the Query (N1QL) service. spring.couchbase.env.endpoints.view=1 # Number of sockets per node against the view service. - spring.couchbase.env.ssl.enabled= # Enable SSL support. Enabled automatically if a "keyStore" is provided unless specified otherwise. + spring.couchbase.env.ssl.enabled= # Whether to enable SSL support. Enabled automatically if a "keyStore" is provided, unless specified otherwise. spring.couchbase.env.ssl.key-store= # Path to the JVM key store that holds the certificates. spring.couchbase.env.ssl.key-store-password= # Password used to access the key store. - spring.couchbase.env.timeouts.connect=5000ms # Bucket connections timeout . + spring.couchbase.env.timeouts.connect=5000ms # Bucket connections timeouts. spring.couchbase.env.timeouts.key-value=2500ms # Blocking operations performed on a specific key timeout. spring.couchbase.env.timeouts.query=7500ms # N1QL query operations timeout. spring.couchbase.env.timeouts.socket-connect=1000ms # Socket connect connections timeout. spring.couchbase.env.timeouts.view=7500ms # Regular and geospatial view operations timeout. # DAO ({sc-spring-boot-autoconfigure}/dao/PersistenceExceptionTranslationAutoConfiguration.{sc-ext}[PersistenceExceptionTranslationAutoConfiguration]) - spring.dao.exceptiontranslation.enabled=true # Enable the PersistenceExceptionTranslationPostProcessor. + spring.dao.exceptiontranslation.enabled=true # Whether to enable the PersistenceExceptionTranslationPostProcessor. # CASSANDRA ({sc-spring-boot-autoconfigure}/cassandra/CassandraProperties.{sc-ext}[CassandraProperties]) spring.data.cassandra.cluster-name= # Name of the Cassandra cluster. @@ -585,9 +586,9 @@ content into your application; rather pick only the properties that you need. spring.data.cassandra.password= # Login password of the server. spring.data.cassandra.pool.heartbeat-interval=30 # Heartbeat interval after which a message is sent on an idle connection to make sure it's still alive. If a duration suffix is not specified, seconds will be used. spring.data.cassandra.pool.idle-timeout=120 # Idle timeout before an idle connection is removed. If a duration suffix is not specified, seconds will be used. - spring.data.cassandra.pool.max-queue-size=256 # Maximum number of requests that get enqueued if no connection is available. + spring.data.cassandra.pool.max-queue-size=256 # Maximum number of requests that get queued if no connection is available. spring.data.cassandra.pool.pool-timeout=5000ms # Pool timeout when trying to acquire a connection from a host's pool. - spring.data.cassandra.reactive-repositories.enabled=true # Enable Cassandra reactive repositories. + spring.data.cassandra.reactive-repositories.enabled=true # Whether to enable Cassandra reactive repositories. spring.data.cassandra.read-timeout= # Socket option: read time out. spring.data.cassandra.reconnection-policy= # Reconnection policy class. spring.data.cassandra.repositories.enabled= # Enable Cassandra repositories. @@ -607,7 +608,7 @@ content into your application; rather pick only the properties that you need. spring.data.elasticsearch.cluster-name=elasticsearch # Elasticsearch cluster name. spring.data.elasticsearch.cluster-nodes= # Comma-separated list of cluster node addresses. spring.data.elasticsearch.properties.*= # Additional properties used to configure the client. - spring.data.elasticsearch.repositories.enabled=true # Enable Elasticsearch repositories. + spring.data.elasticsearch.repositories.enabled=true # Whether to enable Elasticsearch repositories. # DATA LDAP spring.data.ldap.repositories.enabled=true # Enable LDAP repositories. @@ -617,23 +618,23 @@ content into your application; rather pick only the properties that you need. spring.data.mongodb.database=test # Database name. spring.data.mongodb.field-naming-strategy= # Fully qualified name of the FieldNamingStrategy to use. spring.data.mongodb.grid-fs-database= # GridFS database name. - spring.data.mongodb.host=localhost # Mongo server host. Cannot be set with uri. - spring.data.mongodb.password= # Login password of the mongo server. Cannot be set with uri. - spring.data.mongodb.port=27017 # Mongo server port. Cannot be set with uri. - spring.data.mongodb.reactive-repositories.enabled=true # Enable Mongo reactive repositories. - spring.data.mongodb.repositories.enabled=true # Enable Mongo repositories. + spring.data.mongodb.host=localhost # Mongo server host. Cannot be set with URI. + spring.data.mongodb.password= # Login password of the mongo server. Cannot be set with URI. + spring.data.mongodb.port=27017 # Mongo server port. Cannot be set with URI. + spring.data.mongodb.reactive-repositories.enabled=true # Whether to enable Mongo reactive repositories. + spring.data.mongodb.repositories.enabled=true # Whether to enable Mongo repositories. spring.data.mongodb.uri=mongodb://localhost/test # Mongo database URI. Cannot be set with host, port and credentials. - spring.data.mongodb.username= # Login user of the mongo server. Cannot be set with uri. + spring.data.mongodb.username= # Login user of the mongo server. Cannot be set with URI. # DATA REDIS - spring.data.redis.repositories.enabled=true # Enable Redis repositories. + spring.data.redis.repositories.enabled=true # Whether to enable Redis repositories. # NEO4J ({sc-spring-boot-autoconfigure}/data/neo4j/Neo4jProperties.{sc-ext}[Neo4jProperties]) spring.data.neo4j.auto-index=none # Auto index mode. - spring.data.neo4j.embedded.enabled=true # Enable embedded mode if the embedded driver is available. + spring.data.neo4j.embedded.enabled=true # Whether to enable embedded mode if the embedded driver is available. spring.data.neo4j.open-in-view=true # Register OpenSessionInViewInterceptor. Binds a Neo4j Session to the thread for the entire processing of the request. spring.data.neo4j.password= # Login password of the server. - spring.data.neo4j.repositories.enabled=true # Enable Neo4j repositories. + spring.data.neo4j.repositories.enabled=true # Whether to enable Neo4j repositories. spring.data.neo4j.uri= # URI used by the driver. Auto-detected by default. spring.data.neo4j.username= # Login user of the server. @@ -641,17 +642,17 @@ content into your application; rather pick only the properties that you need. spring.data.rest.base-path= # Base path to be used by Spring Data REST to expose repository resources. spring.data.rest.default-page-size= # Default size of pages. spring.data.rest.detection-strategy=default # Strategy to use to determine which repositories get exposed. - spring.data.rest.enable-enum-translation= # Enable enum value translation via the Spring Data REST default resource bundle. + spring.data.rest.enable-enum-translation= # Whether to enable enum value translation through the Spring Data REST default resource bundle. spring.data.rest.limit-param-name= # Name of the URL query string parameter that indicates how many results to return at once. spring.data.rest.max-page-size= # Maximum size of pages. spring.data.rest.page-param-name= # Name of the URL query string parameter that indicates what page to return. - spring.data.rest.return-body-on-create= # Return a response body after creating an entity. - spring.data.rest.return-body-on-update= # Return a response body after updating an entity. + spring.data.rest.return-body-on-create= # Whether to return a response body after creating an entity. + spring.data.rest.return-body-on-update= # Whether to return a response body after updating an entity. spring.data.rest.sort-param-name= # Name of the URL query string parameter that indicates what direction to sort results. # SOLR ({sc-spring-boot-autoconfigure}/solr/SolrProperties.{sc-ext}[SolrProperties]) spring.data.solr.host=http://127.0.0.1:8983/solr # Solr host. Ignored if "zk-host" is set. - spring.data.solr.repositories.enabled=true # Enable Solr repositories. + spring.data.solr.repositories.enabled=true # Whether to enable Solr repositories. spring.data.solr.zk-host= # ZooKeeper host address in the form HOST:PORT. # DATA WEB ({sc-spring-boot-autoconfigure}/data/web/SpringDataWebProperties.{sc-ext}[SpringDataWebProperties]) @@ -661,55 +662,55 @@ content into your application; rather pick only the properties that you need. spring.data.web.sort.sort-parameter=sort # Sort parameter name. # DATASOURCE ({sc-spring-boot-autoconfigure}/jdbc/DataSourceAutoConfiguration.{sc-ext}[DataSourceAutoConfiguration] & {sc-spring-boot-autoconfigure}/jdbc/DataSourceProperties.{sc-ext}[DataSourceProperties]) - spring.datasource.continue-on-error=false # Do not stop if an error occurs while initializing the database. + spring.datasource.continue-on-error=false # Whether to stop if an error occurs while initializing the database. spring.datasource.data= # Data (DML) script resource references. - spring.datasource.data-username= # User of the database to execute DML scripts (if different). + spring.datasource.data-username= # Username of the database to execute DML scripts (if different). spring.datasource.data-password= # Password of the database to execute DML scripts (if different). spring.datasource.dbcp2.*= # Commons DBCP2 specific settings spring.datasource.driver-class-name= # Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. - spring.datasource.generate-unique-name=false # Generate a random datasource name. + spring.datasource.generate-unique-name=false # Whether to generate a random datasource name. spring.datasource.hikari.*= # Hikari specific settings - spring.datasource.initialization-mode=embedded # Initialize the datasource using available DDL and DML scripts. - spring.datasource.jmx-enabled=false # Enable JMX support (if provided by the underlying pool). + spring.datasource.initialization-mode=embedded # Initialize the datasource with available DDL and DML scripts. + spring.datasource.jmx-enabled=false # Whether to enable JMX support (if provided by the underlying pool). spring.datasource.jndi-name= # JNDI location of the datasource. Class, url, username & password are ignored when set. spring.datasource.name=testdb # Name of the datasource. spring.datasource.password= # Login password of the database. - spring.datasource.platform=all # Platform to use in the DDL or DML scripts (e.g. schema-${platform}.sql or data-${platform}.sql). + spring.datasource.platform=all # Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or data-${platform}.sql). spring.datasource.schema= # Schema (DDL) script resource references. - spring.datasource.schema-username= # User of the database to execute DDL scripts (if different). + spring.datasource.schema-username= # Username of the database to execute DDL scripts (if different). spring.datasource.schema-password= # Password of the database to execute DDL scripts (if different). spring.datasource.separator=; # Statement separator in SQL initialization scripts. spring.datasource.sql-script-encoding= # SQL scripts encoding. spring.datasource.tomcat.*= # Tomcat datasource specific settings spring.datasource.type= # Fully qualified name of the connection pool implementation to use. By default, it is auto-detected from the classpath. - spring.datasource.url= # JDBC url of the database. - spring.datasource.username= # Login user of the database. + spring.datasource.url= # JDBC URL of the database. + spring.datasource.username= # Login username of the database. spring.datasource.xa.data-source-class-name= # XA datasource fully qualified name. spring.datasource.xa.properties= # Properties to pass to the XA data source. # JEST (Elasticsearch HTTP client) ({sc-spring-boot-autoconfigure}/elasticsearch/jest/JestProperties.{sc-ext}[JestProperties]) spring.elasticsearch.jest.connection-timeout=3s # Connection timeout. - spring.elasticsearch.jest.multi-threaded=true # Enable connection requests from multiple execution threads. + spring.elasticsearch.jest.multi-threaded=true # Whether to enable connection requests from multiple execution threads. spring.elasticsearch.jest.password= # Login password. spring.elasticsearch.jest.proxy.host= # Proxy host the HTTP client should use. spring.elasticsearch.jest.proxy.port= # Proxy port the HTTP client should use. spring.elasticsearch.jest.read-timeout=3s # Read timeout. spring.elasticsearch.jest.uris=http://localhost:9200 # Comma-separated list of the Elasticsearch instances to use. - spring.elasticsearch.jest.username= # Login user. + spring.elasticsearch.jest.username= # Login username. # H2 Web Console ({sc-spring-boot-autoconfigure}/h2/H2ConsoleProperties.{sc-ext}[H2ConsoleProperties]) - spring.h2.console.enabled=false # Enable the console. - spring.h2.console.path=/h2-console # Path at which the console will be available. - spring.h2.console.settings.trace=false # Enable trace output. - spring.h2.console.settings.web-allow-others=false # Enable remote access. + spring.h2.console.enabled=false # Whether to enable the console. + spring.h2.console.path=/h2-console # Path at which the console is available. + spring.h2.console.settings.trace=false # Whether to enable trace output. + spring.h2.console.settings.web-allow-others=false # Whether to enable remote access. # InfluxDB ({sc-spring-boot-autoconfigure}/influx/InfluxDbProperties.{sc-ext}[InfluxDbProperties]) spring.influx.password= # Login password. - spring.influx.url= # Url of the InfluxDB instance to connect to. + spring.influx.url= # URL of the InfluxDB instance to which to connect. spring.influx.user= # Login user. # JOOQ ({sc-spring-boot-autoconfigure}/jooq/JooqAutoConfiguration.{sc-ext}[JooqAutoConfiguration]) - spring.jooq.sql-dialect= # Sql dialect to use, auto-detected by default. + spring.jooq.sql-dialect= # SQL dialect to use. Auto-detected by default. # JDBC ({sc-spring-boot-autoconfigure}/jdbc/JdbcProperties.{sc-ext}[JdbcProperties]) spring.jdbc.template.fetch-size=-1 # Number of rows that should be fetched from the database when more rows are needed. @@ -717,28 +718,28 @@ content into your application; rather pick only the properties that you need. spring.jdbc.template.query-timeout= # Query timeout. If a duration suffix is not specified, seconds will be used. # JPA ({sc-spring-boot-autoconfigure}/orm/jpa/JpaBaseConfiguration.{sc-ext}[JpaBaseConfiguration], {sc-spring-boot-autoconfigure}/orm/jpa/HibernateJpaAutoConfiguration.{sc-ext}[HibernateJpaAutoConfiguration]) - spring.data.jpa.repositories.enabled=true # Enable JPA repositories. + spring.data.jpa.repositories.enabled=true # Whether to enable JPA repositories. spring.jpa.database= # Target database to operate on, auto-detected by default. Can be alternatively set using the "databasePlatform" property. spring.jpa.database-platform= # Name of the target database to operate on, auto-detected by default. Can be alternatively set using the "Database" enum. - spring.jpa.generate-ddl=false # Initialize the schema on startup. - spring.jpa.hibernate.ddl-auto= # 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. + spring.jpa.generate-ddl=false # Whether to initialize the schema on startup. + spring.jpa.hibernate.ddl-auto= # DDL mode. This is actually a shortcut for the "hibernate.hbm2ddl.auto" property. Defaults to "create-drop" when using an embedded database and no schema manager was detected. Otherwise, defaults to "none". spring.jpa.hibernate.naming.implicit-strategy= # Hibernate 5 implicit naming strategy fully qualified name. spring.jpa.hibernate.naming.physical-strategy= # Hibernate 5 physical naming strategy fully qualified name. - spring.jpa.hibernate.use-new-id-generator-mappings= # Use Hibernate's newer IdentifierGenerator for AUTO, TABLE and SEQUENCE. + spring.jpa.hibernate.use-new-id-generator-mappings= # Whether to use Hibernate's newer IdentifierGenerator for AUTO, TABLE and SEQUENCE. spring.jpa.mapping-resources= # Mapping resources (equivalent to "mapping-file" entries in persistence.xml). spring.jpa.open-in-view=true # Register OpenEntityManagerInViewInterceptor. Binds a JPA EntityManager to the thread for the entire processing of the request. spring.jpa.properties.*= # Additional native properties to set on the JPA provider. - spring.jpa.show-sql=false # Enable logging of SQL statements. + spring.jpa.show-sql=false # Whether to enable logging of SQL statements. # JTA ({sc-spring-boot-autoconfigure}/transaction/jta/JtaAutoConfiguration.{sc-ext}[JtaAutoConfiguration]) - spring.jta.enabled=true # Enable JTA support. + spring.jta.enabled=true # Whether to enable JTA support. spring.jta.log-dir= # Transaction logs directory. spring.jta.transaction-manager-id= # Transaction manager unique identifier. # ATOMIKOS ({sc-spring-boot}/jta/atomikos/AtomikosProperties.{sc-ext}[AtomikosProperties]) spring.jta.atomikos.connectionfactory.borrow-connection-timeout=30 # Timeout, in seconds, for borrowing connections from the pool. - spring.jta.atomikos.connectionfactory.ignore-session-transacted-flag=true # Whether or not to ignore the transacted flag when creating session. - spring.jta.atomikos.connectionfactory.local-transaction-mode=false # Whether or not local transactions are desired. + spring.jta.atomikos.connectionfactory.ignore-session-transacted-flag=true # Whether to ignore the transacted flag when creating session. + spring.jta.atomikos.connectionfactory.local-transaction-mode=false # Whether local transactions are desired. spring.jta.atomikos.connectionfactory.maintenance-interval=60 # The time, in seconds, between runs of the pool's maintenance thread. spring.jta.atomikos.connectionfactory.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool. spring.jta.atomikos.connectionfactory.max-lifetime=0 # The time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. @@ -757,11 +758,11 @@ content into your application; rather pick only the properties that you need. spring.jta.atomikos.datasource.reap-timeout=0 # The reap timeout, in seconds, for borrowed connections. 0 denotes no limit. spring.jta.atomikos.datasource.test-query= # SQL query or statement used to validate a connection before returning it. spring.jta.atomikos.datasource.unique-resource-name=dataSource # The unique name used to identify the resource during recovery. - spring.jta.atomikos.properties.allow-sub-transactions=true # Specify if sub-transactions are allowed. - spring.jta.atomikos.properties.checkpoint-interval=500 # Interval between checkpoints. - spring.jta.atomikos.properties.default-jta-timeout=10000 # Default timeout for JTA transactions. - spring.jta.atomikos.properties.enable-logging=true # Enable disk logging. - spring.jta.atomikos.properties.force-shutdown-on-vm-exit=false # Specify if a VM shutdown should trigger forced shutdown of the transaction core. + spring.jta.atomikos.properties.allow-sub-transactions=true # Specify whether sub-transactions are allowed. + spring.jta.atomikos.properties.checkpoint-interval=500 # Interval between checkpoints, in milliseconds. + spring.jta.atomikos.properties.default-jta-timeout=10000 # Default timeout for JTA transactions, in milliseconds. + spring.jta.atomikos.properties.enable-logging=true # Whether to enable disk logging. + spring.jta.atomikos.properties.force-shutdown-on-vm-exit=false # Whether a VM shutdown should trigger forced shutdown of the transaction core. spring.jta.atomikos.properties.log-base-dir= # Directory in which the log files should be stored. spring.jta.atomikos.properties.log-base-name=tmlog # Transactions log file base name. spring.jta.atomikos.properties.max-actives=50 # Maximum number of active transactions. @@ -770,41 +771,41 @@ content into your application; rather pick only the properties that you need. spring.jta.atomikos.properties.recovery.forget-orphaned-log-entries-delay=86400000 # Delay after which recovery can cleanup pending ('orphaned') log entries. spring.jta.atomikos.properties.recovery.max-retries=5 # Number of retry attempts to commit the transaction before throwing an exception. spring.jta.atomikos.properties.recovery.retry-interval=10000ms # Delay between retry attempts. - spring.jta.atomikos.properties.serial-jta-transactions=true # Specify if sub-transactions should be joined when possible. + spring.jta.atomikos.properties.serial-jta-transactions=true # Whether sub-transactions should be joined when possible. spring.jta.atomikos.properties.service= # Transaction manager implementation that should be started. - spring.jta.atomikos.properties.threaded-two-phase-commit=false # Use different (and concurrent) threads for two-phase commit on the participating resources. - spring.jta.atomikos.properties.transaction-manager-unique-name= # Transaction manager's unique name. + spring.jta.atomikos.properties.threaded-two-phase-commit=false # Whether to use different (and concurrent) threads for two-phase commit on the participating resources. + spring.jta.atomikos.properties.transaction-manager-unique-name= # The transaction manager's unique name. # BITRONIX spring.jta.bitronix.connectionfactory.acquire-increment=1 # Number of connections to create when growing the pool. spring.jta.bitronix.connectionfactory.acquisition-interval=1 # Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired. spring.jta.bitronix.connectionfactory.acquisition-timeout=30 # Timeout, in seconds, for acquiring connections from the pool. - spring.jta.bitronix.connectionfactory.allow-local-transactions=true # Whether or not the transaction manager should allow mixing XA and non-XA transactions. - spring.jta.bitronix.connectionfactory.apply-transaction-timeout=false # Whether or not the transaction timeout should be set on the XAResource when it is enlisted. - spring.jta.bitronix.connectionfactory.automatic-enlisting-enabled=true # Whether or not resources should be enlisted and delisted automatically. - spring.jta.bitronix.connectionfactory.cache-producers-consumers=true # Whether or not produces and consumers should be cached. - spring.jta.bitronix.connectionfactory.defer-connection-release=true # Whether or not the provider can run many transactions on the same connection and supports transaction interleaving. - spring.jta.bitronix.connectionfactory.ignore-recovery-failures=false # Whether or not recovery failures should be ignored. + spring.jta.bitronix.connectionfactory.allow-local-transactions=true # Whether the transaction manager should allow mixing XA and non-XA transactions. + spring.jta.bitronix.connectionfactory.apply-transaction-timeout=false # Whether the transaction timeout should be set on the XAResource when it is enlisted. + spring.jta.bitronix.connectionfactory.automatic-enlisting-enabled=true # Whether resources should be enlisted and delisted automatically. + spring.jta.bitronix.connectionfactory.cache-producers-consumers=true # Whether producers and consumers should be cached. + spring.jta.bitronix.connectionfactory.defer-connection-release=true # Whether the provider can run many transactions on the same connection and supports transaction interleaving. + spring.jta.bitronix.connectionfactory.ignore-recovery-failures=false # Whether recovery failures should be ignored. spring.jta.bitronix.connectionfactory.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool. spring.jta.bitronix.connectionfactory.max-pool-size=10 # The maximum size of the pool. 0 denotes no limit. spring.jta.bitronix.connectionfactory.min-pool-size=0 # The minimum size of the pool. spring.jta.bitronix.connectionfactory.password= # The password to use to connect to the JMS provider. - spring.jta.bitronix.connectionfactory.share-transaction-connections=false # Whether or not connections in the ACCESSIBLE state can be shared within the context of a transaction. - spring.jta.bitronix.connectionfactory.test-connections=true # Whether or not connections should be tested when acquired from the pool. + spring.jta.bitronix.connectionfactory.share-transaction-connections=false # Whether connections in the ACCESSIBLE state can be shared within the context of a transaction. + spring.jta.bitronix.connectionfactory.test-connections=true # Whether connections should be tested when acquired from the pool. spring.jta.bitronix.connectionfactory.two-pc-ordering-position=1 # The position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE). spring.jta.bitronix.connectionfactory.unique-name=jmsConnectionFactory # The unique name used to identify the resource during recovery. - spring.jta.bitronix.connectionfactory.use-tm-join=true Whether or not TMJOIN should be used when starting XAResources. + spring.jta.bitronix.connectionfactory.use-tm-join=true Whether TMJOIN should be used when starting XAResources. spring.jta.bitronix.connectionfactory.user= # The user to use to connect to the JMS provider. spring.jta.bitronix.datasource.acquire-increment=1 # Number of connections to create when growing the pool. spring.jta.bitronix.datasource.acquisition-interval=1 # Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired. spring.jta.bitronix.datasource.acquisition-timeout=30 # Timeout, in seconds, for acquiring connections from the pool. - spring.jta.bitronix.datasource.allow-local-transactions=true # Whether or not the transaction manager should allow mixing XA and non-XA transactions. - spring.jta.bitronix.datasource.apply-transaction-timeout=false # Whether or not the transaction timeout should be set on the XAResource when it is enlisted. - spring.jta.bitronix.datasource.automatic-enlisting-enabled=true # Whether or not resources should be enlisted and delisted automatically. + spring.jta.bitronix.datasource.allow-local-transactions=true # Whether the transaction manager should allow mixing XA and non-XA transactions. + spring.jta.bitronix.datasource.apply-transaction-timeout=false # Whether the transaction timeout should be set on the XAResource when it is enlisted. + spring.jta.bitronix.datasource.automatic-enlisting-enabled=true # Whether resources should be enlisted and delisted automatically. spring.jta.bitronix.datasource.cursor-holdability= # The default cursor holdability for connections. - spring.jta.bitronix.datasource.defer-connection-release=true # Whether or not the database can run many transactions on the same connection and supports transaction interleaving. - spring.jta.bitronix.datasource.enable-jdbc4-connection-test= # Whether or not Connection.isValid() is called when acquiring a connection from the pool. - spring.jta.bitronix.datasource.ignore-recovery-failures=false # Whether or not recovery failures should be ignored. + spring.jta.bitronix.datasource.defer-connection-release=true # Whether the database can run many transactions on the same connection and supports transaction interleaving. + spring.jta.bitronix.datasource.enable-jdbc4-connection-test= # Whether Connection.isValid() is called when acquiring a connection from the pool. + spring.jta.bitronix.datasource.ignore-recovery-failures=false # Whether recovery failures should be ignored. spring.jta.bitronix.datasource.isolation-level= # The default isolation level for connections. spring.jta.bitronix.datasource.local-auto-commit= # The default auto-commit mode for local transactions. spring.jta.bitronix.datasource.login-timeout= # Timeout, in seconds, for establishing a database connection. @@ -812,45 +813,45 @@ content into your application; rather pick only the properties that you need. spring.jta.bitronix.datasource.max-pool-size=10 # The maximum size of the pool. 0 denotes no limit. spring.jta.bitronix.datasource.min-pool-size=0 # The minimum size of the pool. spring.jta.bitronix.datasource.prepared-statement-cache-size=0 # The target size of the prepared statement cache. 0 disables the cache. - spring.jta.bitronix.datasource.share-transaction-connections=false # Whether or not connections in the ACCESSIBLE state can be shared within the context of a transaction. + spring.jta.bitronix.datasource.share-transaction-connections=false # Whether connections in the ACCESSIBLE state can be shared within the context of a transaction. spring.jta.bitronix.datasource.test-query= # SQL query or statement used to validate a connection before returning it. - spring.jta.bitronix.datasource.two-pc-ordering-position=1 # The position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE). + spring.jta.bitronix.datasource.two-pc-ordering-position=1 # The position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, and always last is Integer.MAX_VALUE). spring.jta.bitronix.datasource.unique-name=dataSource # The unique name used to identify the resource during recovery. - spring.jta.bitronix.datasource.use-tm-join=true Whether or not TMJOIN should be used when starting XAResources. - spring.jta.bitronix.properties.allow-multiple-lrc=false # Allow multiple LRC resources to be enlisted into the same transaction. + spring.jta.bitronix.datasource.use-tm-join=true Whether TMJOIN should be used when starting XAResources. + spring.jta.bitronix.properties.allow-multiple-lrc=false # Whether to allow multiple LRC resources to be enlisted into the same transaction. spring.jta.bitronix.properties.asynchronous2-pc=false # Enable asynchronously execution of two phase commit. spring.jta.bitronix.properties.background-recovery-interval-seconds=60 # Interval in seconds at which to run the recovery process in the background. - spring.jta.bitronix.properties.current-node-only-recovery=true # Recover only the current node. - spring.jta.bitronix.properties.debug-zero-resource-transaction=false # Log the creation and commit call stacks of transactions executed without a single enlisted resource. - spring.jta.bitronix.properties.default-transaction-timeout=60 # Default transaction timeout in seconds. - spring.jta.bitronix.properties.disable-jmx=false # Enable JMX support. + spring.jta.bitronix.properties.current-node-only-recovery=true # Whether to recover only the current node. + spring.jta.bitronix.properties.debug-zero-resource-transaction=false # Whether to log the creation and commit call stacks of transactions executed without a single enlisted resource. + spring.jta.bitronix.properties.default-transaction-timeout=60 # Default transaction timeout, in seconds. + spring.jta.bitronix.properties.disable-jmx=false # Whether to enable JMX support. spring.jta.bitronix.properties.exception-analyzer= # Set the fully qualified name of the exception analyzer implementation to use. - spring.jta.bitronix.properties.filter-log-status=false # Enable filtering of logs so that only mandatory logs are written. - spring.jta.bitronix.properties.force-batching-enabled=true # Set if disk forces are batched. - spring.jta.bitronix.properties.forced-write-enabled=true # Set if logs are forced to disk. - spring.jta.bitronix.properties.graceful-shutdown-interval=60 # Maximum amount of seconds the TM will wait for transactions to get done before aborting them at shutdown time. + spring.jta.bitronix.properties.filter-log-status=false # Whether to enable filtering of logs so that only mandatory logs are written. + spring.jta.bitronix.properties.force-batching-enabled=true # Whether disk forces are batched. + spring.jta.bitronix.properties.forced-write-enabled=true # Whether logs are forced to disk. + spring.jta.bitronix.properties.graceful-shutdown-interval=60 # Maximum amount of seconds the TM waits for transactions to get done before aborting them at shutdown time. spring.jta.bitronix.properties.jndi-transaction-synchronization-registry-name= # JNDI name of the TransactionSynchronizationRegistry. spring.jta.bitronix.properties.jndi-user-transaction-name= # JNDI name of the UserTransaction. - spring.jta.bitronix.properties.journal=disk # Name of the journal. Can be 'disk', 'null' or a class name. + spring.jta.bitronix.properties.journal=disk # Name of the journal. Can be 'disk', 'null', or a class name. spring.jta.bitronix.properties.log-part1-filename=btm1.tlog # Name of the first fragment of the journal. spring.jta.bitronix.properties.log-part2-filename=btm2.tlog # Name of the second fragment of the journal. spring.jta.bitronix.properties.max-log-size-in-mb=2 # Maximum size in megabytes of the journal fragments. spring.jta.bitronix.properties.resource-configuration-filename= # ResourceLoader configuration file name. - spring.jta.bitronix.properties.server-id= # ASCII ID that must uniquely identify this TM instance. Default to the machine's IP address. + spring.jta.bitronix.properties.server-id= # ASCII ID that must uniquely identify this TM instance. Defaults to the machine's IP address. spring.jta.bitronix.properties.skip-corrupted-logs=false # Skip corrupted transactions log entries. - spring.jta.bitronix.properties.warn-about-zero-resource-transaction=true # Log a warning for transactions executed without a single enlisted resource. + spring.jta.bitronix.properties.warn-about-zero-resource-transaction=true # Whether to log a warning for transactions executed without a single enlisted resource. # NARAYANA ({sc-spring-boot}/jta/narayana/NarayanaProperties.{sc-ext}[NarayanaProperties]) spring.jta.narayana.default-timeout=60s # Transaction timeout. If a duration suffix is not specified, seconds will be used. spring.jta.narayana.expiry-scanners=com.arjuna.ats.internal.arjuna.recovery.ExpiredTransactionStatusManagerScanner # Comma-separated list of expiry scanners. spring.jta.narayana.log-dir= # Transaction object store directory. - spring.jta.narayana.one-phase-commit=true # Enable one phase commit optimisation. + spring.jta.narayana.one-phase-commit=true # Whether to enable one phase commit optimization. spring.jta.narayana.periodic-recovery-period=120s # Interval in which periodic recovery scans are performed. If a duration suffix is not specified, seconds will be used. spring.jta.narayana.recovery-backoff-period=10s # Back off period between first and second phases of the recovery scan. If a duration suffix is not specified, seconds will be used. - spring.jta.narayana.recovery-db-pass= # Database password to be used by recovery manager. - spring.jta.narayana.recovery-db-user= # Database username to be used by recovery manager. - spring.jta.narayana.recovery-jms-pass= # JMS password to be used by recovery manager. - spring.jta.narayana.recovery-jms-user= # JMS username to be used by recovery manager. + spring.jta.narayana.recovery-db-pass= # Database password to be used by the recovery manager. + spring.jta.narayana.recovery-db-user= # Database username to be used by the recovery manager. + spring.jta.narayana.recovery-jms-pass= # JMS password to be used by the recovery manager. + spring.jta.narayana.recovery-jms-user= # JMS username to be used by the recovery manager. spring.jta.narayana.recovery-modules= # Comma-separated list of recovery modules. spring.jta.narayana.transaction-manager-id=1 # Unique transaction manager id. spring.jta.narayana.xa-resource-orphan-filters= # Comma-separated list of orphan filters. @@ -858,7 +859,7 @@ content into your application; rather pick only the properties that you need. # EMBEDDED MONGODB ({sc-spring-boot-autoconfigure}/mongo/embedded/EmbeddedMongoProperties.{sc-ext}[EmbeddedMongoProperties]) spring.mongodb.embedded.features=SYNC_DELAY # Comma-separated list of features to enable. spring.mongodb.embedded.storage.database-dir= # Directory used for data storage. - spring.mongodb.embedded.storage.oplog-size= # Maximum size of the oplog in megabytes. + spring.mongodb.embedded.storage.oplog-size= # Maximum size of the oplog, in megabytes. spring.mongodb.embedded.storage.repl-set-name= # Name of the replica set. spring.mongodb.embedded.version=2.6.10 # Version of Mongo to use. @@ -866,27 +867,27 @@ content into your application; rather pick only the properties that you need. spring.redis.cluster.max-redirects= # Maximum number of redirects to follow when executing commands across the cluster. spring.redis.cluster.nodes= # Comma-separated list of "host:port" pairs to bootstrap from. spring.redis.database=0 # Database index used by the connection factory. - spring.redis.url= # Connection URL, will override host, port and password (user will be ignored), e.g. redis://user:password@example.com:6379 + spring.redis.url= # Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:password@example.com:6379 spring.redis.host=localhost # Redis server host. spring.redis.jedis.pool.max-active=8 # Max number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. spring.redis.jedis.pool.max-idle=8 # Max number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. spring.redis.jedis.pool.max-wait=-1ms # Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely. spring.redis.jedis.pool.min-idle=0 # Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. - spring.redis.lettuce.pool.max-active=8 # Max number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. - spring.redis.lettuce.pool.max-idle=8 # Max number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. + spring.redis.lettuce.pool.max-active=8 # Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. + spring.redis.lettuce.pool.max-idle=8 # Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. spring.redis.lettuce.pool.max-wait=-1ms # Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely. spring.redis.lettuce.pool.min-idle=0 # Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. spring.redis.lettuce.shutdown-timeout=100ms # Shutdown timeout. spring.redis.password= # Login password of the redis server. spring.redis.port=6379 # Redis server port. - spring.redis.sentinel.master= # Name of Redis server. + spring.redis.sentinel.master= # Name of the Redis server. spring.redis.sentinel.nodes= # Comma-separated list of "host:port" pairs. - spring.redis.ssl=false # Enable SSL support. + spring.redis.ssl=false # Whether to enable SSL support. spring.redis.timeout=0 # Connection timeout. # TRANSACTION ({sc-spring-boot-autoconfigure}/transaction/TransactionProperties.{sc-ext}[TransactionProperties]) spring.transaction.default-timeout= # Default transaction timeout. If a duration suffix is not specified, seconds will be used. - spring.transaction.rollback-on-commit-failure= # Perform the rollback on commit failures. + spring.transaction.rollback-on-commit-failure= # Whether to roll back on commit failures. @@ -897,32 +898,32 @@ content into your application; rather pick only the properties that you need. # ACTIVEMQ ({sc-spring-boot-autoconfigure}/jms/activemq/ActiveMQProperties.{sc-ext}[ActiveMQProperties]) spring.activemq.broker-url= # URL of the ActiveMQ broker. Auto-generated by default. spring.activemq.close-timeout=15s # Time to wait before considering a close complete. - spring.activemq.in-memory=true # Specify if the default broker URL should be in memory. Ignored if an explicit broker has been specified. - spring.activemq.non-blocking-redelivery=false # 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. + spring.activemq.in-memory=true # Whether the default broker URL should be in memory. Ignored if an explicit broker has been specified. + spring.activemq.non-blocking-redelivery=false # 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. spring.activemq.password= # Login password of the broker. - spring.activemq.send-timeout=0 # Time to wait on Message sends for a response. Set it to 0 to indicate to wait forever. + spring.activemq.send-timeout=0 # Time to wait on message sends for a response. Set it to 0 to wait forever. spring.activemq.user= # Login user of the broker. - spring.activemq.packages.trust-all= # Trust all packages. + spring.activemq.packages.trust-all= # Whether to trust all packages. spring.activemq.packages.trusted= # Comma-separated list of specific packages to trust (when not trusting all packages). - spring.activemq.pool.block-if-full=true # Block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead. + spring.activemq.pool.block-if-full=true # Whether to block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead. spring.activemq.pool.block-if-full-timeout=-1ms # Blocking period before throwing an exception if the pool is still full. - spring.activemq.pool.create-connection-on-startup=true # Create a connection on startup. Can be used to warm-up the pool on startup. - spring.activemq.pool.enabled=false # Whether a PooledConnectionFactory should be created instead of a regular ConnectionFactory. + spring.activemq.pool.create-connection-on-startup=true # Whether to create a connection on startup. Can be used to warm up the pool on startup. + spring.activemq.pool.enabled=false # Whether a PooledConnectionFactory should be created, instead of a regular ConnectionFactory. spring.activemq.pool.expiry-timeout=0ms # Connection expiration timeout. spring.activemq.pool.idle-timeout=30s # Connection idle timeout. spring.activemq.pool.max-connections=1 # Maximum number of pooled connections. spring.activemq.pool.maximum-active-session-per-connection=500 # Maximum number of active sessions per connection. spring.activemq.pool.reconnect-on-exception=true # Reset the connection when a "JMSException" occurs. spring.activemq.pool.time-between-expiration-check=-1ms # Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs. - spring.activemq.pool.use-anonymous-producers=true # Use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required. + spring.activemq.pool.use-anonymous-producers=true # Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required. # ARTEMIS ({sc-spring-boot-autoconfigure}/jms/artemis/ArtemisProperties.{sc-ext}[ArtemisProperties]) spring.artemis.embedded.cluster-password= # Cluster password. Randomly generated on startup by default. spring.artemis.embedded.data-directory= # Journal file directory. Not necessary if persistence is turned off. - spring.artemis.embedded.enabled=true # Enable embedded mode if the Artemis server APIs are available. - spring.artemis.embedded.persistent=false # Enable persistent store. + spring.artemis.embedded.enabled=true # Whether to enable embedded mode if the Artemis server APIs are available. + spring.artemis.embedded.persistent=false # Whether to enable persistent store. spring.artemis.embedded.queues= # Comma-separated list of queues to create on startup. - spring.artemis.embedded.server-id= # Server id. By default, an auto-incremented counter is used. + spring.artemis.embedded.server-id= # Server ID. By default, an auto-incremented counter is used. spring.artemis.embedded.topics= # Comma-separated list of topics to create on startup. spring.artemis.host=localhost # Artemis broker host. spring.artemis.mode= # Artemis deployment mode, auto-detected by default. @@ -933,7 +934,7 @@ content into your application; rather pick only the properties that you need. # SPRING BATCH ({sc-spring-boot-autoconfigure}/batch/BatchProperties.{sc-ext}[BatchProperties]) spring.batch.initialize-schema=embedded # Database schema initialization mode. spring.batch.job.enabled=true # Execute all Spring Batch jobs in the context on startup. - spring.batch.job.names= # Comma-separated list of job names to execute on startup (For instance `job1,job2`). By default, all Jobs found in the context are executed. + spring.batch.job.names= # Comma-separated list of job names to execute on startup (for instance, `job1,job2`). By default, all Jobs found in the context are executed. spring.batch.schema=classpath:org/springframework/batch/core/schema-@@platform@@.sql # Path to the SQL file to use to initialize the database schema. spring.batch.table-prefix= # Table prefix for all the batch meta-data tables. @@ -947,34 +948,34 @@ content into your application; rather pick only the properties that you need. spring.jms.listener.auto-startup=true # Start the container automatically on startup. spring.jms.listener.concurrency= # Minimum number of concurrent consumers. spring.jms.listener.max-concurrency= # Maximum number of concurrent consumers. - spring.jms.pub-sub-domain=false # Specify if the default destination type is topic. - spring.jms.template.default-destination= # Default destination to use on send/receive operations that do not have a destination parameter. + spring.jms.pub-sub-domain=false # Whether the default destination type is topic. + spring.jms.template.default-destination= # Default destination to use on send and receive operations that do not have a destination parameter. spring.jms.template.delivery-delay= # Delivery delay to use for send calls. - spring.jms.template.delivery-mode= # Delivery mode. Enable QoS when set. - spring.jms.template.priority= # Priority of a message when sending. Enable QoS when set. - spring.jms.template.qos-enabled= # Enable explicit QoS when sending a message. + spring.jms.template.delivery-mode= # Delivery mode. Enables QoS (Quality of Service) when set. + spring.jms.template.priority= # Priority of a message when sending. Enables QoS (Quality of Service) when set. + spring.jms.template.qos-enabled= # Whether to enable explicit QoS (Quality of Service) when sending a message. spring.jms.template.receive-timeout= # Timeout to use for receive calls. - spring.jms.template.time-to-live= # Time-to-live of a message when sending. Enable QoS when set. + spring.jms.template.time-to-live= # Time-to-live of a message when sending. Enable QoS (Quality of Service) when set. # APACHE KAFKA ({sc-spring-boot-autoconfigure}/kafka/KafkaProperties.{sc-ext}[KafkaProperties]) - spring.kafka.admin.client-id= # Id to pass to the server when making requests; used for server-side logging. - spring.kafka.admin.fail-fast=false # Fail fast if the broker is not available on startup. + spring.kafka.admin.client-id= # ID to pass to the server when making requests. Used for server-side logging. + spring.kafka.admin.fail-fast=false # Whether to fail fast if the broker is not available on startup. spring.kafka.admin.properties.*= # Additional admin-specific properties used to configure the client. spring.kafka.admin.ssl.key-password= # Password of the private key in the key store file. spring.kafka.admin.ssl.keystore-location= # Location of the key store file. - spring.kafka.admin.ssl.keystore-password= # Store password for the key store file. + spring.kafka.admin.ssl.keystore-password= # Password of the key store file. spring.kafka.admin.ssl.truststore-location= # Location of the trust store file. spring.kafka.admin.ssl.truststore-password= # Store password for the trust store file. spring.kafka.bootstrap-servers= # Comma-delimited list of host:port pairs to use for establishing the initial connection to the Kafka cluster. - spring.kafka.client-id= # Id to pass to the server when making requests; used for server-side logging. - spring.kafka.consumer.auto-commit-interval= # Frequency that the consumer offsets are auto-committed to Kafka if 'enable.auto.commit' true. - spring.kafka.consumer.auto-offset-reset= # What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. + spring.kafka.client-id= # ID to pass to the server when making requests. Used for server-side logging. + spring.kafka.consumer.auto-commit-interval= # Frequency with which the consumer offsets are auto-committed to Kafka if 'enable.auto.commit' is set to true. + spring.kafka.consumer.auto-offset-reset= # What to do when there is no initial offset in Kafka or if the current offset no longer exists on the server. spring.kafka.consumer.bootstrap-servers= # Comma-delimited list of host:port pairs to use for establishing the initial connection to the Kafka cluster. - spring.kafka.consumer.client-id= # Id to pass to the server when making requests; used for server-side logging. - spring.kafka.consumer.enable-auto-commit= # If true the consumer's offset will be periodically committed in the background. - spring.kafka.consumer.fetch-max-wait= # 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 "fetch.min.bytes". - spring.kafka.consumer.fetch-min-size= # Minimum amount of data the server should return for a fetch request in bytes. - spring.kafka.consumer.group-id= # Unique string that identifies the consumer group this consumer belongs to. + spring.kafka.consumer.client-id= # ID to pass to the server when making requests. Used for server-side logging. + spring.kafka.consumer.enable-auto-commit= # Whether the consumer's offset is periodically committed in the background. + spring.kafka.consumer.fetch-max-wait= # 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". + spring.kafka.consumer.fetch-min-size= # Minimum amount of data, in bytes, the server should return for a fetch request. + spring.kafka.consumer.group-id= # Unique string that identifies the consumer group to which this consumer belongs. spring.kafka.consumer.heartbeat-interval= # Expected time between heartbeats to the consumer coordinator. spring.kafka.consumer.key-deserializer= # Deserializer class for keys. spring.kafka.consumer.max-poll-records= # Maximum number of records returned in a single call to poll(). @@ -986,11 +987,11 @@ content into your application; rather pick only the properties that you need. spring.kafka.consumer.ssl.truststore-password= # Store password for the trust store file. spring.kafka.consumer.value-deserializer= # Deserializer class for values. spring.kafka.jaas.control-flag=required # Control flag for login configuration. - spring.kafka.jaas.enabled= # Enable JAAS configuration. + spring.kafka.jaas.enabled= # Whether to enable JAAS configuration. spring.kafka.jaas.login-module=com.sun.security.auth.module.Krb5LoginModule # Login module. spring.kafka.jaas.options= # Additional JAAS options. spring.kafka.listener.ack-count= # Number of records between offset commits when ackMode is "COUNT" or "COUNT_TIME". - spring.kafka.listener.ack-mode= # Listener AckMode; see the spring-kafka documentation. + spring.kafka.listener.ack-mode= # Listener AckMode. See the spring-kafka documentation. spring.kafka.listener.ack-time= # Time between offset commits when ackMode is "TIME" or "COUNT_TIME". spring.kafka.listener.concurrency= # Number of threads to run in the listener containers. spring.kafka.listener.poll-timeout= # Timeout to use when polling the consumer. @@ -999,7 +1000,7 @@ content into your application; rather pick only the properties that you need. spring.kafka.producer.batch-size= # Number of records to batch before sending. spring.kafka.producer.bootstrap-servers= # Comma-delimited list of host:port pairs to use for establishing the initial connection to the Kafka cluster. spring.kafka.producer.buffer-memory= # Total bytes of memory the producer can use to buffer records waiting to be sent to the server. - spring.kafka.producer.client-id= # Id to pass to the server when making requests; used for server-side logging. + spring.kafka.producer.client-id= # ID to pass to the server when making requests. Used for server-side logging. spring.kafka.producer.compression-type= # Compression type for all data generated by the producer. spring.kafka.producer.key-serializer= # Serializer class for keys. spring.kafka.producer.properties.*= # Additional producer-specific properties used to configure the client. @@ -1017,7 +1018,7 @@ content into your application; rather pick only the properties that you need. spring.kafka.ssl.keystore-password= # Store password for the key store file. spring.kafka.ssl.truststore-location= # Location of the trust store file. spring.kafka.ssl.truststore-password= # Store password for the trust store file. - spring.kafka.template.default-topic= # Default topic to which messages will be sent. + spring.kafka.template.default-topic= # Default topic to which messages are sent. # RABBIT ({sc-spring-boot-autoconfigure}/amqp/RabbitProperties.{sc-ext}[RabbitProperties]) spring.rabbitmq.addresses= # Comma-separated list of addresses to which the client should connect. @@ -1025,57 +1026,57 @@ content into your application; rather pick only the properties that you need. spring.rabbitmq.cache.channel.size= # Number of channels to retain in the cache. spring.rabbitmq.cache.connection.mode=channel # Connection factory cache mode. spring.rabbitmq.cache.connection.size= # Number of connections to cache. - spring.rabbitmq.connection-timeout= # Connection timeout; zero for infinite. - spring.rabbitmq.dynamic=true # Create an AmqpAdmin bean. + spring.rabbitmq.connection-timeout= # Connection timeout. Set it to zero to wait forever. + spring.rabbitmq.dynamic=true # Whether to create an AmqpAdmin bean. spring.rabbitmq.host=localhost # RabbitMQ host. spring.rabbitmq.listener.direct.acknowledge-mode= # Acknowledge mode of container. - spring.rabbitmq.listener.direct.auto-startup=true # Start the container automatically on startup. + spring.rabbitmq.listener.direct.auto-startup=true # Whether to start the container automatically on startup. spring.rabbitmq.listener.direct.consumers-per-queue= # Number of consumers per queue. - spring.rabbitmq.listener.direct.default-requeue-rejected= # Whether rejected deliveries are requeued by default; default true. + spring.rabbitmq.listener.direct.default-requeue-rejected= # Whether rejected deliveries are re-queued by default. Defaults to true. spring.rabbitmq.listener.direct.idle-event-interval= # How often idle container events should be published. spring.rabbitmq.listener.direct.prefetch= # Number of messages to be handled in a single request. It should be greater than or equal to the transaction size (if used). - spring.rabbitmq.listener.direct.retry.enabled=false # Whether or not publishing retries are enabled. - spring.rabbitmq.listener.direct.retry.initial-interval=1000 # Interval between the first and second attempt to publish or deliver a message. + spring.rabbitmq.listener.direct.retry.enabled=false # Whether publishing retries are enabled. + spring.rabbitmq.listener.direct.retry.initial-interval=1000ms # Interval between the first and second attempt to publish or deliver a message. spring.rabbitmq.listener.direct.retry.max-attempts=3 # Maximum number of attempts to publish or deliver a message. - spring.rabbitmq.listener.direct.retry.max-interval=10000 # Maximum interval between attempts. - spring.rabbitmq.listener.direct.retry.multiplier=1 # A multiplier to apply to the previous retry interval. - spring.rabbitmq.listener.direct.retry.stateless=true # Whether or not retries are stateless or stateful. + spring.rabbitmq.listener.direct.retry.max-interval=10000ms # Maximum interval between attempts. + spring.rabbitmq.listener.direct.retry.multiplier=1 # Multiplier to apply to the previous retry interval. + spring.rabbitmq.listener.direct.retry.stateless=true # Whether retries are stateless or stateful. spring.rabbitmq.listener.simple.acknowledge-mode= # Acknowledge mode of container. - spring.rabbitmq.listener.simple.auto-startup=true # Start the container automatically on startup. + spring.rabbitmq.listener.simple.auto-startup=true # Whether to start the container automatically on startup. spring.rabbitmq.listener.simple.concurrency= # Minimum number of listener invoker threads. - spring.rabbitmq.listener.simple.default-requeue-rejected= # Whether or not to requeue delivery failures. + spring.rabbitmq.listener.simple.default-requeue-rejected= # Whether to re-queue delivery failures. spring.rabbitmq.listener.simple.idle-event-interval= # How often idle container events should be published. spring.rabbitmq.listener.simple.max-concurrency= # Maximum number of listener invoker. spring.rabbitmq.listener.simple.prefetch= # Number of messages to be handled in a single request. It should be greater than or equal to the transaction size (if used). - spring.rabbitmq.listener.simple.retry.enabled=false # Whether or not publishing retries are enabled. - spring.rabbitmq.listener.simple.retry.initial-interval=1000 # Interval between the first and second attempt to deliver a message. + spring.rabbitmq.listener.simple.retry.enabled=false # Whether publishing retries are enabled. + spring.rabbitmq.listener.simple.retry.initial-interval=1000 # Interval, in milliseconds, between the first and second attempt to deliver a message. spring.rabbitmq.listener.simple.retry.max-attempts=3 # Maximum number of attempts to deliver a message. - spring.rabbitmq.listener.simple.retry.max-interval=10000 # Maximum interval between attempts. - spring.rabbitmq.listener.simple.retry.multiplier=1.0 # A multiplier to apply to the previous delivery retry interval. + spring.rabbitmq.listener.simple.retry.max-interval=10000 # Maximum interval, in milliseconds, between attempts. + spring.rabbitmq.listener.simple.retry.multiplier=1.0 # Multiplier to apply to the previous delivery retry interval. spring.rabbitmq.listener.simple.retry.stateless=true # Whether or not retry is stateless or stateful. - spring.rabbitmq.listener.simple.transaction-size= # 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. + spring.rabbitmq.listener.simple.transaction-size= # 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. spring.rabbitmq.listener.type=simple # Listener container type. spring.rabbitmq.password= # Login to authenticate against the broker. spring.rabbitmq.port=5672 # RabbitMQ port. - spring.rabbitmq.publisher-confirms=false # Enable publisher confirms. - spring.rabbitmq.publisher-returns=false # Enable publisher returns. + spring.rabbitmq.publisher-confirms=false # Whether to enable publisher confirms. + spring.rabbitmq.publisher-returns=false # Whether to enable publisher returns. spring.rabbitmq.requested-heartbeat= # Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used. - spring.rabbitmq.ssl.enabled=false # Enable SSL support. + spring.rabbitmq.ssl.enabled=false # Whether to enable SSL support. spring.rabbitmq.ssl.key-store= # Path to the key store that holds the SSL certificate. spring.rabbitmq.ssl.key-store-password= # Password used to access the key store. spring.rabbitmq.ssl.key-store-type=PKCS12 # Key store type. spring.rabbitmq.ssl.trust-store= # Trust store that holds SSL certificates. spring.rabbitmq.ssl.trust-store-password= # Password used to access the trust store. spring.rabbitmq.ssl.trust-store-type=JKS # Trust store type. - spring.rabbitmq.ssl.algorithm= # SSL algorithm to use. By default configure by the rabbit client library. - spring.rabbitmq.template.mandatory=false # Enable mandatory messages. + spring.rabbitmq.ssl.algorithm= # SSL algorithm to use. By default, configured by the Rabbit client library. + spring.rabbitmq.template.mandatory=false # Whether to enable mandatory messages. spring.rabbitmq.template.receive-timeout=0 # Timeout for `receive()` methods. spring.rabbitmq.template.reply-timeout=5000 # Timeout for `sendAndReceive()` methods. - spring.rabbitmq.template.retry.enabled=false # Set to true to enable retries in the `RabbitTemplate`. - spring.rabbitmq.template.retry.initial-interval=1000 # Interval between the first and second attempt to publish a message. + spring.rabbitmq.template.retry.enabled=false # Whether to enable retries in the `RabbitTemplate`. + spring.rabbitmq.template.retry.initial-interval=1000 # Interval, in milliseconds, between the first and second attempt to publish a message. spring.rabbitmq.template.retry.max-attempts=3 # Maximum number of attempts to publish a message. spring.rabbitmq.template.retry.max-interval=10000 # Maximum number of attempts to publish a message. - spring.rabbitmq.template.retry.multiplier=1.0 # A multiplier to apply to the previous publishing retry interval. + spring.rabbitmq.template.retry.multiplier=1.0 # Multiplier to apply to the previous publishing retry interval. spring.rabbitmq.username= # Login user to authenticate to the broker. spring.rabbitmq.virtual-host= # Virtual host to use when connecting to the broker. @@ -1086,12 +1087,12 @@ content into your application; rather pick only the properties that you need. # MANAGEMENT HTTP SERVER ({sc-spring-boot-actuator-autoconfigure}/web/server/ManagementServerProperties.{sc-ext}[ManagementServerProperties]) management.server.add-application-context-header=false # Add the "X-Application-Context" HTTP header in each response. Requires a custom management.server.port. - management.server.address= # Network address that the management endpoints should bind to. Requires a custom management.server.port. - management.server.context-path= # Management endpoint context-path. For instance `/actuator`. Requires a custom management.server.port + management.server.address= # Network address that to which the management endpoints should bind. Requires a custom management.server.port. + management.server.context-path= # Management endpoint context-path. For instance, `/actuator`. Requires a custom management.server.port management.server.port= # Management endpoint HTTP port. Uses the same port as the application by default. Configure a different port to use management-specific SSL. management.server.ssl.ciphers= # Supported SSL ciphers. Requires a custom management.port. management.server.ssl.client-auth= # Whether client authentication is wanted ("want") or needed ("need"). Requires a trust store. Requires a custom management.server.port. - management.server.ssl.enabled= # Enable SSL support. Requires a custom management.server.port. + management.server.ssl.enabled= # Whether to enable SSL support. Requires a custom management.server.port. management.server.ssl.enabled-protocols= # Enabled SSL protocols. Requires a custom management.server.port. management.server.ssl.key-alias= # Alias that identifies the key in the key store. Requires a custom management.server.port. management.server.ssl.key-password= # Password used to access the key in the key store. Requires a custom management.server.port. @@ -1106,8 +1107,8 @@ content into your application; rather pick only the properties that you need. management.server.ssl.trust-store-type= # Type of the trust store. Requires a custom management.server.port. # CLOUDFOUNDRY - management.cloudfoundry.enabled=true # Enable extended Cloud Foundry actuator endpoints. - management.cloudfoundry.skip-ssl-validation=false # Skip SSL verification for Cloud Foundry actuator endpoint security calls. + management.cloudfoundry.enabled=true # Whether to enable extended Cloud Foundry actuator endpoints. + management.cloudfoundry.skip-ssl-validation=false # Whether to skip SSL verification for Cloud Foundry actuator endpoint security calls. # ENDPOINTS GENERAL CONFIGURATION management.endpoints.enabled-by-default= # Enable or disable all endpoints by default. @@ -1118,7 +1119,7 @@ content into your application; rather pick only the properties that you need. management.endpoints.jmx.exclude= # Endpoint IDs that should be excluded. management.endpoints.jmx.domain=org.springframework.boot # Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set. management.endpoints.jmx.static-names=false # Additional static properties to append to all ObjectNames of MBeans representing Endpoints. - management.endpoints.jmx.unique-names=false # Ensure that ObjectNames are modified in case of conflict. + management.endpoints.jmx.unique-names=false # Whether to ensure that ObjectNames are modified in case of conflict. # ENDPOINTS WEB CONFIGURATION ({sc-spring-boot-actuator-autoconfigure}/endpoint/web/WebEndpointProperties.{sc-ext}[WebEndpointProperties]) management.endpoints.web.enabled=true # Whether web endpoints are enabled @@ -1128,7 +1129,7 @@ content into your application; rather pick only the properties that you need. management.endpoints.web.path-mapping= # Mapping between endpoint IDs and the path that should expose them. # ENDPOINTS CORS CONFIGURATION ({sc-spring-boot-actuator-autoconfigure}/endpoint/web/servlet/CorsEndpointProperties.{sc-ext}[CorsEndpointProperties]) - management.endpoints.web.cors.allow-credentials= # Set whether credentials are supported. When not set, credentials are not supported. + management.endpoints.web.cors.allow-credentials= # Whether credentials are supported. When not set, credentials are not supported. management.endpoints.web.cors.allowed-headers= # Comma-separated list of headers to allow in a request. '*' allows all headers. management.endpoints.web.cors.allowed-methods= # Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET. management.endpoints.web.cors.allowed-origins= # Comma-separated list of origins to allow. '*' allows all origins. When not set, CORS support is disabled. @@ -1137,137 +1138,137 @@ content into your application; rather pick only the properties that you need. # AUDIT EVENTS ENDPOINT ({sc-spring-boot-actuator}/audit/AuditEventsEndpoint.{sc-ext}[AuditEventsEndpoint]) management.endpoint.auditevents.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.auditevents.enabled= # Enable the auditevents endpoint. + management.endpoint.auditevents.enabled= # Whether to enable the auditevents endpoint. # BEANS ENDPOINT ({sc-spring-boot-actuator}/beans/BeansEndpoint.{sc-ext}[BeansEndpoint]) management.endpoint.beans.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.beans.enabled= # Enable the beans endpoint. + management.endpoint.beans.enabled= # Whether to enable the beans endpoint. # CONDITIONS REPORT ENDPOINT ({sc-spring-boot-actuator-autoconfigure}/condition/ConditionsReportEndpoint.{sc-ext}[ConditionsReportEndpoint]) management.endpoint.conditions.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.conditions.enabled= # Enable the conditions endpoint. + management.endpoint.conditions.enabled= # Whether to enable the conditions endpoint. # CONFIGURATION PROPERTIES REPORT ENDPOINT ({sc-spring-boot-actuator}/context/properties/ConfigurationPropertiesReportEndpoint.{sc-ext}[ConfigurationPropertiesReportEndpoint]) management.endpoint.configprops.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.configprops.enabled= # Enable the configprops endpoint. + management.endpoint.configprops.enabled= # Whether to enable the configprops endpoint. management.endpoint.configprops.keys-to-sanitize=password,secret,key,token,.*credentials.*,vcap_services # Keys that should be sanitized. Keys can be simple strings that the property ends with or regular expressions. # ENVIRONMENT ENDPOINT ({sc-spring-boot-actuator}/env/EnvironmentEndpoint.{sc-ext}[EnvironmentEndpoint]) management.endpoint.env.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.env.enabled= # Enable the env endpoint. + management.endpoint.env.enabled= # Whether to enable the env endpoint. management.endpoint.env.keys-to-sanitize=password,secret,key,token,.*credentials.*,vcap_services # Keys that should be sanitized. Keys can be simple strings that the property ends with or regular expressions. # FLYWAY ENDPOINT ({sc-spring-boot-actuator}/flyway/FlywayEndpoint.{sc-ext}[FlywayEndpoint]) management.endpoint.flyway.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.flyway.enabled= # Enable the flyway endpoint. + management.endpoint.flyway.enabled= # Whether to enable the flyway endpoint. # HEALTH ENDPOINT ({sc-spring-boot-actuator}/health/HealthEndpoint.{sc-ext}[HealthEndpoint]) management.endpoint.health.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.health.enabled= # Enable the health endpoint. + management.endpoint.health.enabled= # Whether to enable the health endpoint. # HEAP DUMP ENDPOINT ({sc-spring-boot-actuator}/management/HeapDumpWebEndpoint.{sc-ext}[HeapDumpWebEndpoint]) management.endpoint.heapdump.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.heapdump.enabled= # Enable the heapdump endpoint. + management.endpoint.heapdump.enabled= # Whether to enable the heapdump endpoint. # INFO ENDPOINT ({sc-spring-boot-actuator}/info/InfoEndpoint.{sc-ext}[InfoEndpoint]) management.endpoint.info.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.info.enabled=true # Enable the info endpoint. + management.endpoint.info.enabled=true # Whether to enable the info endpoint. # LIQUIBASE ENDPOINT ({sc-spring-boot-actuator}/liquibase/LiquibaseEndpoint.{sc-ext}[LiquibaseEndpoint]) management.endpoint.liquibase.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.liquibase.enabled= # Enable the liquibase endpoint. + management.endpoint.liquibase.enabled= # Whether to enable the liquibase endpoint. # LOG FILE ENDPOINT ({sc-spring-boot-actuator}/logging/LogFileWebEndpoint.{sc-ext}[LogFileWebEndpoint]) management.endpoint.logfile.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.logfile.enabled= # Enable the logfile endpoint. + management.endpoint.logfile.enabled= # Whether to enable the logfile endpoint. management.endpoint.logfile.external-file= # External Logfile to be accessed. Can be used if the logfile is written by output redirect and not by the logging system itself. # LOGGERS ENDPOINT ({sc-spring-boot-actuator}/logging/LoggersEndpoint.{sc-ext}[LoggersEndpoint]) management.endpoint.loggers.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.loggers.enabled= # Enable the loggers endpoint. + management.endpoint.loggers.enabled= # Whether to enable the loggers endpoint. # REQUEST MAPPING ENDPOINT ({sc-spring-boot-actuator-autoconfigure}/web/servlet/RequestMappingEndpoint.{sc-ext}[RequestMappingEndpoint]) management.endpoint.mappings.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.mappings.enabled= # Enable the mappings endpoint. + management.endpoint.mappings.enabled= # Whether to enable the mappings endpoint. # METRICS ENDPOINT ({sc-spring-boot-actuator}/metrics/MetricsEndpoint.{sc-ext}[MetricsEndpoint]) management.endpoint.metrics.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.metrics.enabled= # Enable the metrics endpoint. + management.endpoint.metrics.enabled= # Whether to enable the metrics endpoint. # PROMETHEUS ENDPOINT ({sc-spring-boot-actuator}/metrics/export/prometheus/PrometheusScrapeEndpoint.{sc-ext}[PrometheusScrapeEndpoint]) management.endpoint.prometheus.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.prometheus.enabled= # Enable the metrics endpoint. + management.endpoint.prometheus.enabled= # Whether to enable the metrics endpoint. # SCHEDULED TASKS ENDPOINT ({sc-spring-boot-actuator}/scheduling/ScheduledTasksEndpoint.{sc-ext}[ScheduledTasksEndpoint]) management.endpoint.scheduledtasks.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.scheduledtasks.enabled= # Enable the scheduled tasks endpoint. + management.endpoint.scheduledtasks.enabled= # Whether to enable the scheduled tasks endpoint. # SESSIONS ENDPOINT ({sc-spring-boot-actuator}/session/SessionsEndpoint.{sc-ext}[SessionsEndpoint]) management.endpoint.sessions.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.sessions.enabled= # Enable the sessions endpoint. + management.endpoint.sessions.enabled= # Whether to enable the sessions endpoint. # SHUTDOWN ENDPOINT ({sc-spring-boot-actuator}/context/ShutdownEndpoint.{sc-ext}[ShutdownEndpoint]) management.endpoint.shutdown.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.shutdown.enabled=false # Enable the shutdown endpoint. + management.endpoint.shutdown.enabled=false # Whether to enable the shutdown endpoint. # STATUS ENDPOINT ({sc-spring-boot-actuator}/health/StatusEndpoint.{sc-ext}[StatusEndpoint]) management.endpoint.status.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.status.enabled=true # Enable the status endpoint. + management.endpoint.status.enabled=true # Whether to enable the status endpoint. # THREAD DUMP ENDPOINT ({sc-spring-boot-actuator}/management/ThreadDumpEndpoint.{sc-ext}[ThreadDumpEndpoint]) management.endpoint.threaddump.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.threaddump.enabled= # Enable the threaddump endpoint. + management.endpoint.threaddump.enabled= # Whether to enable the threaddump endpoint. # TRACE ENDPOINT ({sc-spring-boot-actuator}/trace/TraceEndpoint.{sc-ext}[TraceEndpoint]) management.endpoint.trace.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.trace.enabled= # Enable the trace endpoint. + management.endpoint.trace.enabled= # Whether to enable the trace endpoint. # HEALTH INDICATORS - management.health.db.enabled=true # Enable database health check. - management.health.cassandra.enabled=true # Enable cassandra health check. - management.health.couchbase.enabled=true # Enable couchbase health check. - management.health.defaults.enabled=true # Enable default health indicators. - management.health.diskspace.enabled=true # Enable disk space health check. + management.health.db.enabled=true # Whether to enable database health check. + management.health.cassandra.enabled=true # Whether to enable Cassandra health check. + management.health.couchbase.enabled=true # Whether to enable Couchbase health check. + management.health.defaults.enabled=true # Whether to enable default health indicators. + management.health.diskspace.enabled=true # Whether to enable disk space health check. management.health.diskspace.path= # Path used to compute the available disk space. - management.health.diskspace.threshold=0 # Minimum disk space that should be available, in bytes. - management.health.elasticsearch.enabled=true # Enable elasticsearch health check. + management.health.diskspace.threshold=0 # Minimum disk space, in bytes, that should be available. + management.health.elasticsearch.enabled=true # Whether to enable Elasticsearch health check. management.health.elasticsearch.indices= # Comma-separated index names. management.health.elasticsearch.response-timeout=100ms # The time to wait for a response from the cluster. - management.health.jms.enabled=true # Enable JMS health check. - management.health.ldap.enabled=true # Enable LDAP health check. - management.health.mail.enabled=true # Enable Mail health check. - management.health.mongo.enabled=true # Enable MongoDB health check. - management.health.neo4j.enabled=true # Enable Neo4j health check. - management.health.rabbit.enabled=true # Enable RabbitMQ health check. - management.health.redis.enabled=true # Enable Redis health check. - management.health.solr.enabled=true # Enable Solr health check. - management.health.status.http-mapping= # Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (i.e. UP maps to 200). + management.health.jms.enabled=true # Whether to enable JMS health check. + management.health.ldap.enabled=true # Whether to enable LDAP health check. + management.health.mail.enabled=true # Whether to enable Mail health check. + management.health.mongo.enabled=true # Whether to enable MongoDB health check. + management.health.neo4j.enabled=true # Whether to enable Neo4j health check. + management.health.rabbit.enabled=true # Whether to enable RabbitMQ health check. + management.health.redis.enabled=true # Whether to enable Redis health check. + management.health.solr.enabled=true # Whether to enable Solr health check. + management.health.status.http-mapping= # Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200). management.health.status.order=DOWN, OUT_OF_SERVICE, UP, UNKNOWN # Comma-separated list of health statuses in order of severity. # INFO CONTRIBUTORS ({sc-spring-boot-actuator-autoconfigure}/info/InfoContributorProperties.{sc-ext}[InfoContributorProperties]) - management.info.build.enabled=true # Enable build info. - management.info.defaults.enabled=true # Enable default info contributors. - management.info.env.enabled=true # Enable environment info. - management.info.git.enabled=true # Enable git info. + management.info.build.enabled=true # Whether to enable build info. + management.info.defaults.enabled=true # Whether to enable default info contributors. + management.info.env.enabled=true # Whether to enable environment info. + management.info.git.enabled=true # Whether to enable git info. management.info.git.mode=simple # Mode to use to expose git information. # JOLOKIA ({sc-spring-boot-actuator-autoconfigure}/jolokia/JolokiaProperties.{sc-ext}[JolokiaProperties]) management.jolokia.config.*= # Jolokia settings. See the Jolokia manual for details. - management.jolokia.enabled=false # Enable Jolokia. - management.jolokia.path=/jolokia # Path at which Jolokia will be available. + management.jolokia.enabled=false # Whether to enable Jolokia. + management.jolokia.path=/jolokia # Path at which Jolokia is available. # TRACING ({sc-spring-boot-actuator-autoconfigure}/trace/TraceEndpointProperties.{sc-ext}[TraceEndpointProperties]) - management.trace.filter.enabled=true # Enable the trace servlet filter. + management.trace.filter.enabled=true # Whether to enable the trace servlet filter. management.trace.include=request-headers,response-headers,cookies,errors # Items to be included in the trace. # METRICS - spring.metrics.use-global-registry=true # Whether or not auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics. + spring.metrics.use-global-registry=true # Whether auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics. spring.metrics.export.atlas.batch-size= # Number of measurements per request to use for the backend. If more measurements are found, then multiple requests will be made. spring.metrics.export.atlas.config-refresh-frequency= # Frequency for refreshing config settings from the LWC service. spring.metrics.export.atlas.config-time-to-live= # Time to live for subscriptions from the LWC service. spring.metrics.export.atlas.config-uri= # URI for the Atlas LWC endpoint to retrieve current subscriptions. spring.metrics.export.atlas.connect-timeout= # Connection timeout for requests to the backend. - spring.metrics.export.atlas.enabled= # Enable publishing to the backend. + spring.metrics.export.atlas.enabled= # Whether exporting of metrics to Atlas is enabled. spring.metrics.export.atlas.eval-uri= # URI for the Atlas LWC endpoint to evaluate the data for a subscription. spring.metrics.export.atlas.lwc-enabled= # Enable streaming to Atlas LWC. spring.metrics.export.atlas.meter-time-to-live= # Time to live for meters that do not have any activity. After this period the meter will be considered expired and will not get reported. @@ -1285,7 +1286,7 @@ content into your application; rather pick only the properties that you need. spring.metrics.export.datadog.uri= # URI to ship metrics to. If you need to publish metrics to an internal proxy en-route to Datadog, you can define the location of the proxy with this. spring.metrics.export.ganglia.addressing-mode= # UDP addressing mode, either unicast or multicast. spring.metrics.export.ganglia.duration-units= # Base time unit used to report durations. - spring.metrics.export.ganglia.enabled= # Enable publishing to Ganglia. + spring.metrics.export.ganglia.enabled= # Whether exporting of metrics to Ganglia is enabled. spring.metrics.export.ganglia.host= # Host of the Ganglia server to receive exported metrics. spring.metrics.export.ganglia.port= # Port of the Ganglia server to receive exported metrics. spring.metrics.export.ganglia.protocol-version= # Ganglia protocol version. Must be either 3.1 or 3.0. @@ -1293,7 +1294,7 @@ content into your application; rather pick only the properties that you need. spring.metrics.export.ganglia.step= # Step size (i.e. reporting frequency) to use. spring.metrics.export.ganglia.time-to-live= # Time to live for metrics on Ganglia. spring.metrics.export.graphite.duration-units= # Base time unit used to report durations. - spring.metrics.export.graphite.enabled= # Enable publishing to Graphite. + spring.metrics.export.graphite.enabled= # Whether exporting of metrics to Graphite is enabled. spring.metrics.export.graphite.host= # Host of the Graphite server to receive exported metrics. spring.metrics.export.graphite.port= # Port of the Graphite server to receive exported metrics. spring.metrics.export.graphite.protocol= # Protocol to use while shipping data to Graphite. @@ -1304,7 +1305,7 @@ content into your application; rather pick only the properties that you need. spring.metrics.export.influx.connect-timeout= # Connection timeout for requests to the backend. spring.metrics.export.influx.consistency= # Write consistency for each point. spring.metrics.export.influx.db= # Tag that will be mapped to "host" when shipping metrics to Influx. Can be omitted of host should be omitted on publishing. - spring.metrics.export.influx.enabled= # Enable publishing to the backend. + spring.metrics.export.influx.enabled= # Whether exporting of metrics to InfluxDB is enabled. spring.metrics.export.influx.num-threads= # Number of threads to use with the metrics publishing scheduler. spring.metrics.export.influx.password= # Login password of the Influx server. spring.metrics.export.influx.read-timeout= # Read timeout for requests to the backend. @@ -1313,9 +1314,9 @@ content into your application; rather pick only the properties that you need. spring.metrics.export.influx.uri= # URI of the Influx server. spring.metrics.export.influx.user-name= # Login user of the Influx server. spring.metrics.export.prometheus.descriptions= # Enable publishing descriptions as part of the scrape payload to Prometheus. Turn this off to minimize the amount of data sent on each scrape. - spring.metrics.export.prometheus.enabled= # Enable publishing to Prometheus. + spring.metrics.export.prometheus.enabled= # Whether exporting of metrics to Prometheus is enabled. spring.metrics.export.prometheus.step= # Step size (i.e. reporting frequency) to use. - spring.metrics.export.simple.enabled=false # Enable publishing to the backend. + spring.metrics.export.simple.enabled=false # Whether exporting of metrics to a simple in-memory store is enabled. spring.metrics.export.simple.step=10 # Step size (i.e. reporting frequency) to use. spring.metrics.export.statsd.enabled= # Export metrics to StatsD. spring.metrics.export.statsd.flavor= # StatsD line protocol to use. @@ -1326,10 +1327,10 @@ content into your application; rather pick only the properties that you need. spring.metrics.export.statsd.queue-size= # Maximum size of the queue of items waiting to be sent to the StatsD server. spring.metrics.jdbc.datasource-metric-name=data.source # Name of the metric for data source usage. spring.metrics.jdbc.instrument-datasource=true # Instrument all available data sources. - spring.metrics.web.client.record-request-percentiles=false # Whether or not instrumented requests record percentiles histogram buckets by default. + spring.metrics.web.client.record-request-percentiles=false # Whether instrumented requests record percentiles histogram buckets by default. spring.metrics.web.client.requests-metric-name=http.client.requests # Name of the metric for sent requests. - spring.metrics.web.server.auto-time-requests=true # Whether or not requests handled by Spring MVC or WebFlux should be automatically timed. - spring.metrics.web.server.record-request-percentiles=false # Whether or not instrumented requests record percentiles histogram buckets by default. + spring.metrics.web.server.auto-time-requests=true # Whether requests handled by Spring MVC or WebFlux should be automatically timed. + spring.metrics.web.server.record-request-percentiles=false # Whether instrumented requests record percentiles histogram buckets by default. spring.metrics.web.server.requests-metric-name=http.server.requests # Name of the metric for received requests. @@ -1339,7 +1340,7 @@ content into your application; rather pick only the properties that you need. # ---------------------------------------- # DEVTOOLS ({sc-spring-boot-devtools}/autoconfigure/DevToolsProperties.{sc-ext}[DevToolsProperties]) - spring.devtools.livereload.enabled=true # Enable a livereload.com compatible server. + spring.devtools.livereload.enabled=true # Whether to enable a livereload.com-compatible server. spring.devtools.livereload.port=35729 # Server port. spring.devtools.restart.additional-exclude= # Additional patterns that should be excluded from triggering a full restart. spring.devtools.restart.additional-paths= # Additional paths to watch for changes. @@ -1347,13 +1348,13 @@ content into your application; rather pick only the properties that you need. spring.devtools.restart.exclude=META-INF/maven/**,META-INF/resources/**,resources/**,static/**,public/**,templates/**,**/*Test.class,**/*Tests.class,git.properties # Patterns that should be excluded from triggering a full restart. spring.devtools.restart.poll-interval=1s # Amount of time to wait between polling for classpath changes. spring.devtools.restart.quiet-period=400ms # Amount of quiet time required without any classpath changes before a restart is triggered. - spring.devtools.restart.trigger-file= # Name of a specific file that when changed will trigger the restart check. If not specified any classpath file change will trigger the restart. + spring.devtools.restart.trigger-file= # Name of a specific file that, when changed, triggers the restart check. If not specified, any classpath file change triggers the restart. # REMOTE DEVTOOLS ({sc-spring-boot-devtools}/autoconfigure/RemoteDevToolsProperties.{sc-ext}[RemoteDevToolsProperties]) spring.devtools.remote.context-path=/.~~spring-boot!~ # Context path used to handle the remote connection. spring.devtools.remote.proxy.host= # The host of the proxy to use to connect to the remote application. spring.devtools.remote.proxy.port= # The port of the proxy to use to connect to the remote application. - spring.devtools.remote.restart.enabled=true # Enable remote restart. + spring.devtools.remote.restart.enabled=true # Whether to enable remote restart. spring.devtools.remote.secret= # A shared secret required to establish a connection (required to enable remote support). spring.devtools.remote.secret-header-name=X-AUTH-TOKEN # HTTP header used to transfer the shared secret. diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java index e0e7b20f3bd..a622ce6d5d9 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java @@ -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, diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java index 75842d0f478..6a03d099d31 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java @@ -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 { 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; diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/narayana/NarayanaProperties.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/narayana/NarayanaProperties.java index ddd6c3f89d1..dcb2037422d 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/narayana/NarayanaProperties.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/narayana/NarayanaProperties.java @@ -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 { 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; diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Compression.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Compression.java index 8d64ccdc4c9..0857fabdf19 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Compression.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Compression.java @@ -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; diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Ssl.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Ssl.java index 1e5ef703915..0217fa97152 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Ssl.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/Ssl.java @@ -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; diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/Jsp.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/Jsp.java index ff435bd7588..1416c1a1a40 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/Jsp.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/Jsp.java @@ -41,7 +41,7 @@ public class Jsp { private Map 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; diff --git a/spring-boot-project/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-boot-project/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 9a58a74caef..41f26acf50a 100644 --- a/spring-boot-project/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-boot-project/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -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 @@ { "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 @@ { "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 @@ { "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 @@ { "name": "logging.level", "type": "java.util.Map", - "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 @@ "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 @@ }, { "name": "spring.main.sources", - "type": "java.util.Set", + "type": "java.util.Set", "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 @@ { "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 @@ { "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 @@ "name": "spring.profiles.include", "type": "java.util.List", "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",