Commit 09ff815f authored by Stephane Nicoll's avatar Stephane Nicoll

Harmonize metadata

Closes gh-12177
parent f9da1139
......@@ -41,7 +41,7 @@ public class JmxEndpointProperties {
private String domain = "org.springframework.boot";
/**
* Ensure that ObjectNames are modified in case of conflict.
* Whether to ensure that ObjectNames are modified in case of conflict.
*/
private boolean uniqueNames = false;
......
......@@ -33,8 +33,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class JolokiaProperties {
/**
* Jolokia settings. These are traditionally set using servlet parameters. Refer to
* the documentation of Jolokia for more details.
* Jolokia settings. Refer to the documentation of Jolokia for more details.
*/
private final Map<String, String> config = new HashMap<>();
......
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -41,7 +41,7 @@ public class DiskSpaceHealthIndicatorProperties {
private File path = new File(".");
/**
* Minimum disk space that should be available, in bytes.
* Minimum disk space, in bytes, that should be available.
*/
private long threshold = DEFAULT_THRESHOLD;
......
......@@ -39,13 +39,14 @@ import org.springframework.util.StringUtils;
public class ManagementServerProperties implements SecurityPrerequisite {
/**
* Management endpoint HTTP port. Use the same port as the application by default.
* Management endpoint HTTP port (uses the same port as the application by default).
* Configure a different port to use management-specific SSL.
*/
private Integer port;
/**
* Network address that to which the management endpoints should bind to. Requires a
* custom management.server.port.
* Network address to which the management endpoints should bind. Requires a custom
* management.server.port.
*/
private InetAddress address;
......@@ -55,7 +56,8 @@ public class ManagementServerProperties implements SecurityPrerequisite {
private Ssl ssl;
/**
* Add the "X-Application-Context" HTTP header in each response.
* Add the "X-Application-Context" HTTP header in each response. Requires a custom
* management.server.port.
*/
private boolean addApplicationContextHeader = false;
......@@ -112,7 +114,7 @@ public class ManagementServerProperties implements SecurityPrerequisite {
public static class Servlet {
/**
* Management endpoint context-path. For instance, '/management'. Requires a
* Management endpoint context-path (for instance, `/management`). Requires a
* custom management.server.port.
*/
private String contextPath = "";
......
......@@ -62,13 +62,13 @@
{
"name": "management.health.cassandra.enabled",
"type": "java.lang.Boolean",
"description": "Whether to enable cassandra health check.",
"description": "Whether to enable Cassandra health check.",
"defaultValue": true
},
{
"name": "management.health.couchbase.enabled",
"type": "java.lang.Boolean",
"description": "Whether to enable couchbase health check.",
"description": "Whether to enable Couchbase health check.",
"defaultValue": true
},
{
......@@ -92,7 +92,7 @@
{
"name": "management.health.elasticsearch.enabled",
"type": "java.lang.Boolean",
"description": "Whether to enable elasticsearch health check.",
"description": "Whether to enable Elasticsearch health check.",
"defaultValue": true
},
{
......@@ -143,6 +143,15 @@
"description": "Whether to enable Solr health check.",
"defaultValue": true
},
{
"name": "management.health.status.order",
"defaultValue": [
"DOWN",
"OUT_OF_SERVICE",
"UP",
"UNKNOWN"
]
},
{
"name": "management.health.mail.enabled",
"type": "java.lang.Boolean",
......@@ -283,6 +292,15 @@
"description": "Whether to enable HTTP request-response tracing.",
"defaultValue": true
},
{
"name": "management.trace.http.include",
"defaultValue": [
"request-headers",
"response-headers",
"cookies",
"errors"
]
},
{
"name": "endpoints.actuator.enabled",
"type": "java.lang.Boolean",
......
......@@ -556,7 +556,7 @@ public class RabbitProperties {
private Integer prefetch;
/**
* Whether rejected deliveries are re-queued by default. Defaults to true.
* Whether rejected deliveries are re-queued by default.
*/
private Boolean defaultRequeueRejected;
......@@ -694,12 +694,12 @@ public class RabbitProperties {
private Boolean mandatory;
/**
* Timeout for receive() operations.
* Timeout for `receive()` operations.
*/
private Long receiveTimeout;
/**
* Timeout for sendAndReceive() operations.
* Timeout for `sendAndReceive()` operations.
*/
private Long replyTimeout;
......@@ -762,17 +762,17 @@ public class RabbitProperties {
public static class Retry {
/**
* Whether to enable retries in the RabbitTemplate.
* Whether publishing retries are enabled.
*/
private boolean enabled;
/**
* Maximum number of attempts to publish or deliver a message.
* Maximum number of attempts to deliver a message.
*/
private int maxAttempts = 3;
/**
* Interval between the first and second attempt to publish or deliver a message.
* Interval, in milliseconds, between the first and second attempt to deliver a message.
*/
private long initialInterval = 1000L;
......@@ -782,7 +782,7 @@ public class RabbitProperties {
private double multiplier = 1.0;
/**
* Maximum interval between attempts.
* Maximum interval, in milliseconds, between attempts.
*/
private long maxInterval = 10000L;
......
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -43,8 +43,8 @@ public class MessageSourceProperties {
private Charset encoding = StandardCharsets.UTF_8;
/**
* Loaded resource bundle files cache expiration, in seconds. When not set, bundles
* are cached forever.
* Loaded resource bundle files cache duration. When not set, bundles are cached
* forever.
*/
private Duration cacheDuration;
......
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -84,8 +84,8 @@ public class RepositoryRestProperties {
private Boolean returnBodyOnUpdate;
/**
* Whether to enable enum value translation through Spring Data REST default resource
* bundle. Will use the fully qualified enum name as key.
* Whether to enable enum value translation through the Spring Data REST default
* resource bundle.
*/
private Boolean enableEnumTranslation;
......
......@@ -60,7 +60,7 @@ public class FlywayProperties {
private String user;
/**
* Login password of the database to migrate.
* JDBC password to use if you want Flyway to create its own DataSource.
*/
private String password;
......
......@@ -54,9 +54,8 @@ public class JacksonProperties {
private String jodaDateTimeFormat;
/**
* One of the constants on Jackson's PropertyNamingStrategy
* (CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES). Can also be a fully-qualified class
* name of a PropertyNamingStrategy subclass.
* One of the constants on Jackson's PropertyNamingStrategy. Can also be a
* fully-qualified class name of a PropertyNamingStrategy subclass.
*/
private String propertyNamingStrategy;
......
......@@ -73,7 +73,7 @@ public class DataSourceProperties implements BeanClassLoaderAware, InitializingB
private String driverClassName;
/**
* JDBC url of the database.
* JDBC URL of the database.
*/
private String url;
......@@ -94,7 +94,7 @@ public class DataSourceProperties implements BeanClassLoaderAware, InitializingB
private String jndiName;
/**
* Initialize the datasource using available DDL and DML scripts.
* Initialize the datasource with available DDL and DML scripts.
*/
private DataSourceInitializationMode initializationMode = DataSourceInitializationMode.EMBEDDED;
......@@ -110,7 +110,7 @@ public class DataSourceProperties implements BeanClassLoaderAware, InitializingB
private List<String> schema;
/**
* User of the database to execute DDL scripts (if different).
* Username of the database to execute DDL scripts (if different).
*/
private String schemaUsername;
......@@ -125,12 +125,12 @@ public class DataSourceProperties implements BeanClassLoaderAware, InitializingB
private List<String> data;
/**
* Username of the database to execute DML scripts.
* Username of the database to execute DML scripts (if different).
*/
private String dataUsername;
/**
* Password of the database to execute DML scripts.
* Password of the database to execute DML scripts (if different).
*/
private String dataPassword;
......
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -66,8 +66,7 @@ public class ActiveMQProperties {
private boolean nonBlockingRedelivery = false;
/**
* Time to wait on message sends for a response. Set it to 0 to indicate to wait
* forever.
* Time to wait on message sends for a response. Set it to 0 to wait forever.
*/
private Duration sendTimeout = Duration.ofMillis(0);
......@@ -158,7 +157,7 @@ public class ActiveMQProperties {
private boolean blockIfFull = true;
/**
* Blocking period, before throwing an exception if the pool is still full.
* Blocking period before throwing an exception if the pool is still full.
*/
private Duration blockIfFullTimeout = Duration.ofMillis(-1);
......
......@@ -260,14 +260,13 @@ public class KafkaProperties {
private Duration fetchMaxWait;
/**
* Minimum amount of data, in bytes, the server should return for a fetch request
* in bytes.
* Minimum amount of data, in bytes, the server should return for a fetch request.
*/
private Integer fetchMinSize;
/**
* Unique string that identifies the consumer group to which this consumer belongs
* to.
* Unique string that identifies the consumer group to which this consumer
* belongs.
*/
private String groupId;
......@@ -951,7 +950,7 @@ public class KafkaProperties {
private Resource keystoreLocation;
/**
* Password of the key store file.
* Store password for the key store file.
*/
private String keystorePassword;
......
......@@ -36,7 +36,7 @@ public class LdapProperties {
private static final int DEFAULT_PORT = 389;
/**
* LDAP URLs.
* LDAP URLs of the server.
*/
private String[] urls;
......
......@@ -176,7 +176,7 @@ public class JpaProperties {
/**
* 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" otherwise.
* schema manager was detected. Otherwise, defaults to "none".
*/
private String ddlAuto;
......
......@@ -333,7 +333,7 @@ public class ServerProperties {
private final Accesslog accesslog = new Accesslog();
/**
* Regular expression that matches proxies that are to be trusted.
* Regular expression matching trusted IP addresses.
*/
private String internalProxies = "10\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}|" // 10/8
+ "192\\.168\\.\\d{1,3}\\.\\d{1,3}|" // 192.168/16
......@@ -360,12 +360,12 @@ public class ServerProperties {
/**
* Name of the HTTP header from which the remote IP is extracted. For instance,
* 'X-FORWARDED-FOR'.
* `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 is used.
*/
private File basedir;
......
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -28,7 +28,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class WebFluxProperties {
/**
* Date format to use. For instance, "dd/MM/yyyy".
* Date format to use. For instance, `dd/MM/yyyy`.
*/
private String dateFormat;
......
......@@ -55,7 +55,7 @@ public class WebMvcProperties {
private LocaleResolver localeResolver = LocaleResolver.ACCEPT_HEADER;
/**
* Date format to use. For instance, "dd/MM/yyyy".
* Date format to use. For instance, `dd/MM/yyyy`.
*/
private String dateFormat;
......@@ -286,8 +286,8 @@ public class WebMvcProperties {
private boolean favorParameter = false;
/**
* Maps file extensions to media types for content negotiation, e.g. yml to
* text/yaml.
* Map file extensions to media types for content negotiation. For instance, yml
* to text/yaml.
*/
private Map<String, MediaType> mediaTypes = new LinkedHashMap<>();
......@@ -340,7 +340,7 @@ public class WebMvcProperties {
/**
* Whether suffix pattern matching should work only against extensions registered
* with "spring.mvc.content-negotiation.media-types.*". This is generally
* with "spring.mvc.contentnegotiation.media-types.*". This is generally
* recommended to reduce ambiguity and to avoid issues such as when a "." appears
* in the path for other reasons.
*/
......
......@@ -39,6 +39,10 @@
"description": "Whether to enable the default error page displayed in browsers in case of a server error.",
"defaultValue": true
},
{
"name": "server.port",
"defaultValue": 8080
},
{
"name": "spring.aop.auto",
"type": "java.lang.Boolean",
......@@ -174,6 +178,10 @@
"level": "error"
}
},
{
"name": "spring.data.mongodb.uri",
"defaultValue": "mongodb://localhost/test"
},
{
"name": "spring.data.neo4j.auto-index",
"defaultValue": "none"
......@@ -282,7 +290,7 @@
},
{
"name": "spring.jta.bitronix.properties.allow-multiple-lrc",
"description": "Allow multiple LRC resources to be enlisted into the same transaction.",
"description": "Whether to allow multiple LRC resources to be enlisted into the same transaction.",
"defaultValue": false
},
{
......@@ -305,17 +313,17 @@
},
{
"name": "spring.jta.bitronix.properties.current-node-only-recovery",
"description": "Recover only the current node. Should be enabled if you run multiple instances of the transaction manager on the same JMS and JDBC resources.",
"description": "Whether to recover only the current node. Should be enabled if you run multiple instances of the transaction manager on the same JMS and JDBC resources.",
"defaultValue": true
},
{
"name": "spring.jta.bitronix.properties.debug-zero-resource-transaction",
"description": "Log the creation and commit call stacks of transactions executed without a single enlisted resource.",
"description": "Whether to log the creation and commit call stacks of transactions executed without a single enlisted resource.",
"defaultValue": false
},
{
"name": "spring.jta.bitronix.properties.default-transaction-timeout",
"description": "Default transaction timeout in seconds.",
"description": "Default transaction timeout, in seconds.",
"defaultValue": 60
},
{
......@@ -334,17 +342,17 @@
},
{
"name": "spring.jta.bitronix.properties.force-batching-enabled",
"description": " Set if disk forces are batched.",
"description": "Whether disk forces are batched.",
"defaultValue": true
},
{
"name": "spring.jta.bitronix.properties.forced-write-enabled",
"description": "Set if logs are forced to disk.",
"description": "Whether logs are forced to disk.",
"defaultValue": true
},
{
"name": "spring.jta.bitronix.properties.graceful-shutdown-interval",
"description": "Maximum amount of seconds the TM will wait for transactions to get done before aborting them at shutdown time.",
"description": "Maximum amount of seconds the TM waits for transactions to get done before aborting them at shutdown time.",
"defaultValue": 60
},
{
......@@ -357,7 +365,7 @@
},
{
"name": "spring.jta.bitronix.properties.journal",
"description": "Name of the journal. Can be 'disk', 'null' or a class name.",
"description": "Name of the journal. Can be 'disk', 'null', or a class name.",
"defaultValue": "disk"
},
{
......@@ -381,7 +389,7 @@
},
{
"name": "spring.jta.bitronix.properties.server-id",
"description": "ASCII ID that must uniquely identify this TM instance. Default to the machine's IP address."
"description": "ASCII ID that must uniquely identify this TM instance. Defaults to the machine's IP address."
},
{
"name": "spring.jta.bitronix.properties.skip-corrupted-logs",
......@@ -390,7 +398,7 @@
},
{
"name": "spring.jta.bitronix.properties.warn-about-zero-resource-transaction",
"description": "Log a warning for transactions executed without a single enlisted resource.",
"description": "Whether to log a warning for transactions executed without a single enlisted resource.",
"defaultValue": true
},
{
......@@ -401,6 +409,12 @@
"name": "spring.kafka.listener.type",
"defaultValue": "single"
},
{
"name": "spring.mongodb.embedded.features",
"defaultValue": [
"sync_delay"
]
},
{
"name": "spring.mustache.prefix",
"defaultValue": "classpath:/templates/"
......@@ -464,6 +478,10 @@
"request"
]
},
{
"name": "spring.security.filter.order",
"defaultValue": -100
},
{
"name": "spring.session.jdbc.initialize-schema",
"defaultValue": "embedded"
......
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -44,6 +44,11 @@ public class SecurityPropertiesTests {
this.binder = new Binder(this.source);
}
@Test
public void validateDefaultFilterOrderMatchesMetadata() {
assertThat(this.security.getFilter().getOrder()).isEqualTo(-100);
}
@Test
public void filterOrderShouldBind() {
this.source.put("spring.security.filter.order", "55");
......
......@@ -91,7 +91,7 @@ public class DevToolsProperties {
/**
* Name of a specific file that, when changed, triggers the restart check. If not
* specified, any classpath file change will trigger the restart.
* specified, any classpath file change triggers the restart.
*/
private String triggerFile;
......
......@@ -22,22 +22,24 @@
"name": "spring.banner.image.location",
"type": "org.springframework.core.io.Resource",
"description": "Banner image file location (jpg or png can also be used).",
"defaultValue": "banner.gif"
"defaultValue": "classpath:banner.gif"
},
{
"name": "spring.banner.image.width",
"type": "java.lang.Integer",
"description": "Banner image width (in chars)."
"description": "Width of the banner image in chars.",
"defaultValue": 76
},
{
"name": "spring.banner.image.height",
"type": "java.lang.Integer",
"description": "Banner image height (in chars)."
"description": "Height of the banner image in chars (default based on image height)."
},
{
"name": "spring.banner.image.margin",
"type": "java.lang.Integer",
"description": "Left hand image margin (in chars)."
"description": "Left hand image margin in chars.",
"defaultValue": 2
},
{
"name": "spring.banner.image.invert",
......@@ -55,7 +57,7 @@
{
"name": "logging.config",
"type": "java.lang.String",
"description": "Location of the logging configuration file. For instance, 'classpath:logback.xml' for Logback.",
"description": "Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
......@@ -68,7 +70,7 @@
{
"name": "logging.file",
"type": "java.lang.String",
"description": "Log file name. For instance, 'myapp.log'. 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"
},
{
......@@ -81,20 +83,20 @@
{
"name": "logging.file.max-history",
"type": "java.lang.Integer",
"description": "Maximum number of archive log files to keep. Only supported with the default logback setup.",
"description": "Maximum of archive log files to keep. Only supported with the default logback setup.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
"defaultValue": 0
},
{
"name": "logging.level",
"type": "java.util.Map<java.lang.String,java.lang.String>",
"description": "Log levels severity mapping. For instance, 'logging.level.org.springframework=DEBUG'",
"description": "Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
"name": "logging.path",
"type": "java.lang.String",
"description": "Location of the log file. For instance, '/var/log'.",
"description": "Location of the log file. For instance, `/var/log`.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
......@@ -129,13 +131,8 @@
"name": "logging.register-shutdown-hook",
"type": "java.lang.Boolean",
"description": "Register a shutdown hook for the logging system when it is initialized.",
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
},
{
"name": "spring.mandatory-file-encoding",
"sourceType": "org.springframework.boot.context.FileEncodingApplicationListener",
"type": "java.nio.charset.Charset",
"description": "Expected character encoding the application must use."
"sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
"defaultValue": false
},
{
"name": "spring.application.name",
......@@ -169,6 +166,12 @@
"sourceType": "org.springframework.boot.context.config.ConfigFileApplicationListener",
"description": "Config file locations that replace the defaults."
},
{
"name": "spring.jta.narayana.expiry-scanners",
"defaultValue": [
"com.arjuna.ats.internal.arjuna.recovery.ExpiredTransactionStatusManagerScanner"
]
},
{
"name": "spring.main.banner-mode",
"type": "org.springframework.boot.Banner$Mode",
......@@ -203,11 +206,16 @@
"type": "java.lang.Boolean",
"sourceType": "org.springframework.boot.SpringApplication",
"description": "Run the application in a web environment (auto-detected by default).",
"deprecated": true,
"deprecation": {
"replacement": "spring.main.web-application-type"
}
},
{
"name": "spring.mandatory-file-encoding",
"sourceType": "org.springframework.boot.context.FileEncodingApplicationListener",
"type": "java.nio.charset.Charset",
"description": "Expected character encoding the application must use."
},
{
"name": "spring.output.ansi.enabled",
"type": "org.springframework.boot.ansi.AnsiOutput$Enabled",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment