Harmonize metadata

Closes gh-12177
This commit is contained in:
Stephane Nicoll
2018-02-22 15:26:34 +01:00
parent f9da113943
commit 09ff815f00
23 changed files with 250 additions and 203 deletions

View File

@@ -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;

View File

@@ -1,5 +1,5 @@
/*
* 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;

View File

@@ -1,5 +1,5 @@
/*
* 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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -1,5 +1,5 @@
/*
* 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);

View File

@@ -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;

View File

@@ -36,7 +36,7 @@ public class LdapProperties {
private static final int DEFAULT_PORT = 389;
/**
* LDAP URLs.
* LDAP URLs of the server.
*/
private String[] urls;

View File

@@ -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;

View File

@@ -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;

View File

@@ -1,5 +1,5 @@
/*
* 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;

View File

@@ -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.
*/

View File

@@ -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"

View File

@@ -1,5 +1,5 @@
/*
* 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");