diff --git a/ci/pipeline.yml b/ci/pipeline.yml index 7eaaf7205a..ecd5a6dcbb 100644 --- a/ci/pipeline.yml +++ b/ci/pipeline.yml @@ -192,6 +192,7 @@ jobs: disable_checksum_uploads: true exclude: - "**/spring-boot-test-support/**" + - "**/spring-boot-configuration-docs/**" - "**/*.effective-pom" artifact_set: - include: diff --git a/spring-boot-project/spring-boot-docs/pom.xml b/spring-boot-project/spring-boot-docs/pom.xml index ff5baf0cfa..95979201d6 100644 --- a/spring-boot-project/spring-boot-docs/pom.xml +++ b/spring-boot-project/spring-boot-docs/pom.xml @@ -55,6 +55,11 @@ org.springframework.boot spring-boot-loader-tools + + org.springframework.boot + spring-boot-configuration-docs + ${revision} + org.springframework.boot spring-boot-test @@ -1244,6 +1249,7 @@ + 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 a87cb83cc0..18259b55b2 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 @@ -14,1582 +14,63 @@ the properties conversion section>>. 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 and paste the entire -content into your application. Rather, pick only the properties that you need. +=== Core properties -[source,properties,indent=0,subs="verbatim,attributes,macros"] ----- - # =================================================================== - # COMMON SPRING BOOT PROPERTIES - # - # This sample file is provided as a guideline. Do NOT copy it in its - # entirety to your own application. ^^^ - # =================================================================== +include::../../../target/generated-resources/config-docs/core.adoc[] +=== Cache properties - # ---------------------------------------- - # CORE PROPERTIES - # ---------------------------------------- - debug=false # Enable debug logs. - trace=false # Enable trace logs. +include::../../../target/generated-resources/config-docs/cache.adoc[] - # LOGGING - 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.clean-history-on-start=false # Whether to clean the archive log files on startup. Only supported with the default logback setup. - logging.file.max-history=0 # Maximum of archive log files to keep. Only supported with the default logback setup. - logging.file.max-size=10MB # Maximum log file size. Only supported with the default logback setup. - logging.file.name= # Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory. - logging.file.path= # Location of the log file. For instance, `/var/log`. - logging.file.total-size-cap=0 # Total size of log backups to be kept. Only supported with the default logback setup. - logging.group.*= # Log groups to quickly change multiple loggers at the same time. For instance, `logging.level.db=org.hibernate,org.springframework.jdbc`. - logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`. - logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup. - logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS # Appender pattern for log date format. 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=%5p # Appender pattern for log level. Supported only with the default Logback setup. - logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized. +=== Mail properties - # 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). +include::../../../target/generated-resources/config-docs/mail.adoc[] - # IDENTITY ({sc-spring-boot}/context/ContextIdApplicationContextInitializer.{sc-ext}[ContextIdApplicationContextInitializer]) - spring.application.name= # Application name. +=== JSON properties - # ADMIN ({sc-spring-boot-autoconfigure}/admin/SpringApplicationAdminJmxAutoConfiguration.{sc-ext}[SpringApplicationAdminJmxAutoConfiguration]) - 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. +include::../../../target/generated-resources/config-docs/json.adoc[] - # AUTO-CONFIGURATION - spring.autoconfigure.exclude= # Auto-configuration classes to exclude. +=== Data properties - # BANNER - spring.banner.charset=UTF-8 # Banner file encoding. - spring.banner.location=classpath:banner.txt # Banner text resource location. - spring.banner.image.location=classpath:banner.gif # Banner image file location (jpg or png can also be used). - spring.banner.image.width=76 # Width of the banner image in chars. - spring.banner.image.height= # Height of the banner image in chars (default based on image height). - spring.banner.image.margin=2 # Left hand image margin in chars. - spring.banner.image.invert=false # Whether images should be inverted for dark terminal themes. +include::../../../target/generated-resources/config-docs/data.adoc[] - # SPRING CORE - spring.beaninfo.ignore=true # Whether to skip search of BeanInfo classes. +=== Transaction properties - # 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. See CaffeineSpec for more details on the spec format. - spring.cache.couchbase.expiration= # Entry expiration. By default the entries never expire. Note that this value is ultimately converted to seconds. - 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. 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= # 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. By default, auto-detected according to the environment. +include::../../../target/generated-resources/config-docs/transaction.adoc[] - # SPRING CONFIG - using environment property only ({sc-spring-boot}/context/config/ConfigFileApplicationListener.{sc-ext}[ConfigFileApplicationListener]) - spring.config.additional-location= # Config file locations used in addition to the defaults. - spring.config.location= # Config file locations that replace the defaults. - spring.config.name=application # Config file name. +=== Data migration properties - # HAZELCAST ({sc-spring-boot-autoconfigure}/hazelcast/HazelcastProperties.{sc-ext}[HazelcastProperties]) - spring.hazelcast.config= # The location of the configuration file to use to initialize Hazelcast. +include::../../../target/generated-resources/config-docs/data-migration.adoc[] - # PROJECT INFORMATION ({sc-spring-boot-autoconfigure}/info/ProjectInfoProperties.{sc-ext}[ProjectInfoProperties]) - spring.info.build.encoding=UTF-8 # File encoding. - spring.info.build.location=classpath:META-INF/build-info.properties # Location of the generated build-info.properties file. - spring.info.git.encoding=UTF-8 # File encoding. - spring.info.git.location=classpath:git.properties # Location of the generated git.properties file. +=== Integration properties - # JMX - spring.jmx.default-domain= # JMX domain name. - spring.jmx.enabled=true # Expose management beans to the JMX domain. - spring.jmx.server=mbeanServer # MBeanServer bean name. - spring.jmx.unique-names=false # Whether unique runtime object names should be ensured. +include::../../../target/generated-resources/config-docs/integration.adoc[] - # 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 over other Session 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 # Whether to test that the mail server is available on startup. - spring.mail.username= # Login user of the SMTP server. +=== Web properties - # APPLICATION SETTINGS ({sc-spring-boot}/SpringApplication.{sc-ext}[SpringApplication]) - spring.main.allow-bean-definition-overriding=false # Whether bean definition overriding, by registering a definition with the same name as an existing definition, is allowed. - spring.main.banner-mode=console # Mode used to display the banner when the application runs. - spring.main.lazy-initialization=false # Whether initialization should be performed lazily. - 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. +include::../../../target/generated-resources/config-docs/web.adoc[] - # FILE ENCODING ({sc-spring-boot}/context/FileEncodingApplicationListener.{sc-ext}[FileEncodingApplicationListener]) - spring.mandatory-file-encoding= # Expected character encoding the application must use. +=== Templating properties - # 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 (essentially a fully-qualified classpath location), each following the ResourceBundle convention with relaxed support for slash based locations. - spring.messages.cache-duration= # Loaded resource bundle files cache duration. When not set, bundles are cached forever. If a duration suffix is not specified, seconds will be used. - spring.messages.encoding=UTF-8 # Message bundles encoding. - 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. +include::../../../target/generated-resources/config-docs/templating.adoc[] - # OUTPUT - spring.output.ansi.enabled=detect # Configures the ANSI output. +=== Server properties - # PID FILE ({sc-spring-boot}/context/ApplicationPidFileWriter.{sc-ext}[ApplicationPidFileWriter]) - 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). +include::../../../target/generated-resources/config-docs/server.adoc[] - # PROFILES - spring.profiles.active= # Comma-separated list of active profiles. Can be overridden by a command line switch. - spring.profiles.include= # Unconditionally activate the specified comma-separated list of profiles (or list of profiles if using YAML). +=== Security properties - # QUARTZ SCHEDULER ({sc-spring-boot-autoconfigure}/quartz/QuartzProperties.{sc-ext}[QuartzProperties]) - spring.quartz.auto-startup=true # Whether to automatically start the scheduler after initialization. - spring.quartz.jdbc.comment-prefix=-- # Prefix for single-line comments in SQL initialization scripts. - 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. - spring.quartz.job-store-type=memory # Quartz job store type. - spring.quartz.overwrite-existing-jobs=false # Whether configured jobs should overwrite existing job definitions. - spring.quartz.properties.*= # Additional Quartz Scheduler properties. - spring.quartz.scheduler-name=quartzScheduler # Name of the scheduler. - spring.quartz.startup-delay=0s # Delay after which the scheduler is started once initialization completes. - spring.quartz.wait-for-jobs-to-complete-on-shutdown=false # Whether to wait for running jobs to complete on shutdown. +include::../../../target/generated-resources/config-docs/security.adoc[] - # 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. +=== Actuator properties - # SENDGRID ({sc-spring-boot-autoconfigure}/sendgrid/SendGridAutoConfiguration.{sc-ext}[SendGridAutoConfiguration]) - spring.sendgrid.api-key= # SendGrid API key. - spring.sendgrid.proxy.host= # SendGrid proxy host. - spring.sendgrid.proxy.port= # SendGrid proxy port. +include::../../../target/generated-resources/config-docs/actuator.adoc[] - # TASK EXECUTION ({sc-spring-boot-autoconfigure}/task/TaskExecutionProperties.{sc-ext}[TaskExecutionProperties]) - spring.task.execution.pool.allow-core-thread-timeout=true # Whether core threads are allowed to time out. This enables dynamic growing and shrinking of the pool. - spring.task.execution.pool.core-size=8 # Core number of threads. - spring.task.execution.pool.keep-alive=60s # Time limit for which threads may remain idle before being terminated. - spring.task.execution.pool.max-size= # Maximum allowed number of threads. If tasks are filling up the queue, the pool can expand up to that size to accommodate the load. Ignored if the queue is unbounded. - spring.task.execution.pool.queue-capacity= # Queue capacity. An unbounded capacity does not increase the pool and therefore ignores the "max-size" property. - spring.task.execution.thread-name-prefix=task- # Prefix to use for the names of newly created threads. +=== Devtools properties - # TASK SCHEDULING ({sc-spring-boot-autoconfigure}/task/TaskSchedulingProperties.{sc-ext}[TaskSchedulingProperties]) - spring.task.scheduling.pool.size=1 # Maximum allowed number of threads. - spring.task.scheduling.thread-name-prefix=scheduling- # Prefix to use for the names of newly created threads. +include::../../../target/generated-resources/config-docs/devtools.adoc[] - # ---------------------------------------- - # WEB PROPERTIES - # ---------------------------------------- +=== Testing properties - # EMBEDDED SERVER CONFIGURATION ({sc-spring-boot-autoconfigure}/web/ServerProperties.{sc-ext}[ServerProperties]) - server.address= # Network address to which the server should bind. - server.compression.enabled=false # Whether response compression is enabled. - server.compression.excluded-user-agents= # Comma-separated list of user agents for which responses should not be compressed. - server.compression.mime-types=text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml # Comma-separated list of MIME types that should be compressed. - server.compression.min-response-size=2KB # Minimum "Content-Length" value that is required for compression to be performed. - 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.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. - server.error.whitelabel.enabled=true # Whether to enable the default error page displayed in browsers in case of a server error. - server.http2.enabled=false # Whether to enable HTTP/2 support, if the current environment supports it. - server.jetty.acceptors=-1 # Number of acceptor threads to use. When the value is -1, the default, the number of acceptors is derived from the operating environment. - server.jetty.accesslog.append=false # Append to log. - server.jetty.accesslog.date-format=dd/MMM/yyyy:HH:mm:ss Z # Timestamp format of the request log. - server.jetty.accesslog.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 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=200000B # Maximum size of the HTTP post or put content. - server.jetty.selectors=-1 # Number of selector threads to use. When the value is -1, the default, the number of selectors is derived from the operating environment. - server.max-http-header-size=8KB # Maximum size of the HTTP message header. - server.port=8080 # Server HTTP port. - 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.application-display-name=application # Display name of the application. - server.servlet.jsp.class-name=org.apache.jasper.servlet.JspServlet # Class name of the servlet to use for JSPs. - 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.session.cookie.comment= # Comment for the session cookie. - server.servlet.session.cookie.domain= # Domain for the session cookie. - server.servlet.session.cookie.http-only= # Whether to use "HttpOnly" cookies for session cookies. - server.servlet.session.cookie.max-age= # Maximum age of the session cookie. If a duration suffix is not specified, seconds will be used. - server.servlet.session.cookie.name= # Session cookie name. - server.servlet.session.cookie.path= # Path of the session cookie. - server.servlet.session.cookie.secure= # Whether to always mark the session cookie as secure. - server.servlet.session.persistent=false # Whether to persist session data between restarts. - server.servlet.session.store-dir= # Directory used to store session data. - server.servlet.session.timeout=30m # Session timeout. If a duration suffix is not specified, seconds will be used. - server.servlet.session.tracking-modes= # Session tracking modes. - server.ssl.ciphers= # Supported SSL ciphers. - server.ssl.client-auth= # Client authentication mode. - server.ssl.enabled=true # Whether to enable SSL support. - server.ssl.enabled-protocols= # Enabled SSL protocols. - server.ssl.key-alias= # Alias that identifies the key in the key store. - server.ssl.key-password= # Password used to access the key in the key store. - server.ssl.key-store= # Path to the key store that holds the SSL certificate (typically a jks file). - server.ssl.key-store-password= # Password used to access the key store. - server.ssl.key-store-provider= # Provider for the key store. - server.ssl.key-store-type= # Type of the key store. - server.ssl.protocol=TLS # SSL protocol to use. - server.ssl.trust-store= # Trust store that holds SSL certificates. - server.ssl.trust-store-password= # Password used to access the trust store. - server.ssl.trust-store-provider= # Provider for the trust store. - server.ssl.trust-store-type= # Type of the trust store. - server.tomcat.accept-count=100 # Maximum queue length for incoming connection requests when all possible request processing threads are in use. - 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 the log file name. - server.tomcat.accesslog.max-days=-1# Number of days to retain the access log files before they are removed. - 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 # 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=10s # 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 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}|\\ - 127\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}|\\ - 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}\\ - 0:0:0:0:0:0:0:1\\ - ::1 # Regular expression that matches proxies that are to be trusted. - server.tomcat.max-connections=10000 # Maximum number of connections that the server accepts and processes at any given time. - server.tomcat.max-http-post-size=2MB # Maximum size of the HTTP post content. - server.tomcat.max-swallow-size=2MB # Maximum amount of request body to swallow. - server.tomcat.max-threads=200 # Maximum amount of worker threads. - server.tomcat.min-spare-threads=10 # Minimum amount of worker threads. - server.tomcat.port-header=X-Forwarded-Port # Name of the HTTP header used to override the original port value. - server.tomcat.processor-cache=200 # Maximum number of idle processors that will be retained in the cache and reused with a subsequent request. - 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 indicating whether the incoming request uses SSL. - server.tomcat.redirect-context-root=true # 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.resource.allow-caching=true # Whether static resource caching is permitted for this web application. - 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.tomcat.use-relative-redirects= # Whether HTTP 1.1 and later location headers generated by a call to sendRedirect will use relative or absolute redirects. - server.undertow.accesslog.dir= # Undertow access log directory. - 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 # Whether to enable access log rotation. - server.undertow.accesslog.suffix=log # Log file name suffix. - server.undertow.buffer-size= # Size of each buffer. - server.undertow.direct-buffers= # Whether to allocate buffers outside the Java heap. The default is derived from the maximum amount of memory that is available to the JVM. - server.undertow.eager-filter-init=true # Whether servlet filters should be initialized on startup. - server.undertow.io-threads= # Number of I/O threads to create for the worker. The default is derived from the number of available processors. - server.undertow.max-http-post-size=-1B # Maximum size of the HTTP post content. When the value is -1, the default, the size is unlimited. - server.undertow.worker-threads= # Number of worker threads. The default is 8 times the number of I/O threads. - - # 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 # Whether to check that the templates location exists. - spring.freemarker.content-type=text/html # Content-Type value. - 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 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/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=false # Whether to enable template caching. - spring.groovy.template.charset=UTF-8 # Template encoding. - spring.groovy.template.check-template-location=true # Whether to check that the templates location exists. - 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=text/html # Content-Type value. - 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. - spring.groovy.template.suffix=.tpl # Suffix that gets appended to view names when building a URL. - 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 # Whether application/hal+json responses should be sent to requests that accept application/json. - - # HTTP ({sc-spring-boot-autoconfigure}/http/HttpProperties.{sc-ext}[HttpProperties]) - spring.http.converters.preferred-json-mapper= # Preferred JSON mapper to use for HTTP message conversion. By default, auto-detected according to the environment. - 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 # 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. - spring.http.log-request-details=false # Whether logging of (potentially sensitive) request details at DEBUG and TRACE level is allowed. - - # MULTIPART ({sc-spring-boot-autoconfigure}/web/servlet/MultipartProperties.{sc-ext}[MultipartProperties]) - spring.servlet.multipart.enabled=true # Whether to enable support of multipart uploads. - spring.servlet.multipart.file-size-threshold=0B # Threshold after which files are written to disk. - spring.servlet.multipart.location= # Intermediate location of uploaded files. - spring.servlet.multipart.max-file-size=1MB # Max file size. - spring.servlet.multipart.max-request-size=10MB # Max request size. - 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. 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" 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" or "GMT+10". - spring.jackson.visibility.*= # Jackson visibility thresholds that can be used to limit which methods (and fields) are auto-detected. - - # GSON ({sc-spring-boot-autoconfigure}/gson/GsonProperties.{sc-ext}[GsonProperties]) - spring.gson.date-format= # Format to use when serializing Date objects. - spring.gson.disable-html-escaping= # Whether to disable the escaping of HTML characters such as '<', '>', etc. - spring.gson.disable-inner-class-serialization= # Whether to exclude inner classes during serialization. - spring.gson.enable-complex-map-key-serialization= # Whether to enable serialization of complex map keys (i.e. non-primitives). - spring.gson.exclude-fields-without-expose-annotation= # Whether to exclude all fields from consideration for serialization or deserialization that do not have the "Expose" annotation. - spring.gson.field-naming-policy= # Naming policy that should be applied to an object's field during serialization and deserialization. - spring.gson.generate-non-executable-json= # Whether to generate non executable JSON by prefixing the output with some special text. - spring.gson.lenient= # Whether to be lenient about parsing JSON that doesn't conform to RFC 4627. - spring.gson.long-serialization-policy= # Serialization policy for Long and long types. - spring.gson.pretty-printing= # Whether to output serialized JSON that fits in a page for pretty printing. - spring.gson.serialize-nulls= # Whether to serialize null fields. - - # JERSEY ({sc-spring-boot-autoconfigure}/jersey/JerseyProperties.{sc-ext}[JerseyProperties]) - 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 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.anonymous-read-only=false # Whether read-only operations should use an anonymous environment. - spring.ldap.base= # Base suffix from which all operations should originate. - spring.ldap.base-environment.*= # LDAP specification settings. - spring.ldap.password= # Login password of the server. - spring.ldap.urls= # LDAP URLs of the server. - spring.ldap.username= # Login username of the server. - - # EMBEDDED LDAP ({sc-spring-boot-autoconfigure}/ldap/embedded/EmbeddedLdapProperties.{sc-ext}[EmbeddedLdapProperties]) - spring.ldap.embedded.base-dn= # List of base DNs. - spring.ldap.embedded.credential.username= # Embedded LDAP username. - spring.ldap.embedded.credential.password= # Embedded LDAP password. - spring.ldap.embedded.ldif=classpath:schema.ldif # Schema (LDIF) script resource reference. - spring.ldap.embedded.port=0 # Embedded LDAP port. - 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=false # Whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.mustache.allow-session-override=false # Whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. - spring.mustache.cache=false # Whether to enable template caching. - spring.mustache.charset=UTF-8 # Template encoding. - spring.mustache.check-template-location=true # Whether to check that the templates location exists. - spring.mustache.content-type=text/html # Content-Type value. - spring.mustache.enabled=true # Whether to enable MVC view resolution for this technology. - spring.mustache.expose-request-attributes=false # Whether all request attributes should be added to the model prior to merging with the template. - spring.mustache.expose-session-attributes=false # Whether all HttpSession attributes should be added to the model prior to merging with the template. - spring.mustache.expose-spring-macro-helpers=true # 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. - spring.mustache.view-names= # White list of view names that can be resolved. - - # 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.contentnegotiation.favor-parameter=false # Whether a request parameter ("format" by default) should be used to determine the requested media type. - spring.mvc.contentnegotiation.favor-path-extension=false # Whether the path extension in the URL path should be used to determine the requested media type. - spring.mvc.contentnegotiation.media-types.*= # Map file extensions to media types for content negotiation. For instance, yml to text/yaml. - spring.mvc.contentnegotiation.parameter-name= # Query parameter name to use when "favor-parameter" is enabled. - 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.filter.enabled=true # Whether to enable Spring's FormContentFilter. - spring.mvc.hiddenmethod.filter.enabled=true # Whether to enable Spring's HiddenHttpMethodFilter. - 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 # Whether to enable warn logging of exceptions resolved by a "HandlerExceptionResolver", except for "DefaultHandlerExceptionResolver". - spring.mvc.message-codes-resolver-format= # Formatting strategy for message codes. For instance, `PREFIX_ERROR_CODE`. - spring.mvc.pathmatch.use-registered-suffix-pattern=false # Whether suffix pattern matching should work only against extensions registered with "spring.mvc.contentnegotiation.media-types.*". - spring.mvc.pathmatch.use-suffix-pattern=false # Whether to use suffix pattern match (".*") when matching patterns to requests. - spring.mvc.servlet.load-on-startup=-1 # Load on startup priority of the dispatcher servlet. - spring.mvc.servlet.path=/ # Path of the dispatcher servlet. - spring.mvc.static-path-pattern=/** # Path pattern used for static resources. - 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 # Whether to enable default resource handling. - spring.resources.cache.cachecontrol.cache-private= # Indicate that the response message is intended for a single user and must not be stored by a shared cache. - spring.resources.cache.cachecontrol.cache-public= # Indicate that any cache may store the response. - spring.resources.cache.cachecontrol.max-age= # Maximum time the response should be cached, in seconds if no duration suffix is not specified. - spring.resources.cache.cachecontrol.must-revalidate= # Indicate that once it has become stale, a cache must not use the response without re-validating it with the server. - spring.resources.cache.cachecontrol.no-cache= # Indicate that the cached response can be reused only if re-validated with the server. - spring.resources.cache.cachecontrol.no-store= # Indicate to not cache the response in any case. - spring.resources.cache.cachecontrol.no-transform= # Indicate intermediaries (caches and others) that they should not transform the response content. - spring.resources.cache.cachecontrol.proxy-revalidate= # Same meaning as the "must-revalidate" directive, except that it does not apply to private caches. - spring.resources.cache.cachecontrol.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.cachecontrol.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.cachecontrol.stale-while-revalidate= # Maximum time the response can be served after it becomes stale, 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 # Whether to enable caching in the Resource chain. - spring.resources.chain.compressed=false # Whether to enable resolution of already compressed resources (gzip, brotli). - 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.html-application-cache=false # Whether to enable HTML5 application cache manifest rewriting. - spring.resources.chain.strategy.content.enabled=false # Whether to enable the content Version Strategy. - spring.resources.chain.strategy.content.paths=/** # Comma-separated list of patterns to apply to 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]) - spring.session.store-type= # Session store type. - spring.session.timeout= # Session timeout. If a duration suffix is not specified, seconds will be used. - spring.session.servlet.filter-order=-2147483598 # Session repository filter order. - spring.session.servlet.filter-dispatcher-types=async,error,request # Session repository filter dispatcher types. - - # SPRING SESSION HAZELCAST ({sc-spring-boot-autoconfigure}/session/HazelcastSessionProperties.{sc-ext}[HazelcastSessionProperties]) - spring.session.hazelcast.flush-mode=on-save # Sessions flush mode. - spring.session.hazelcast.map-name=spring:session:sessions # Name of the map used to store sessions. - - # SPRING SESSION JDBC ({sc-spring-boot-autoconfigure}/session/JdbcSessionProperties.{sc-ext}[JdbcSessionProperties]) - 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 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. - - # SPRING SESSION REDIS ({sc-spring-boot-autoconfigure}/session/RedisSessionProperties.{sc-ext}[RedisSessionProperties]) - spring.session.redis.cleanup-cron=0 * * * * * # Cron expression for expired session cleanup job. - spring.session.redis.flush-mode=on-save # Sessions flush mode. - spring.session.redis.namespace=spring:session # Namespace for keys used to store sessions. - - # THYMELEAF ({sc-spring-boot-autoconfigure}/thymeleaf/ThymeleafAutoConfiguration.{sc-ext}[ThymeleafAutoConfiguration]) - 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 (patterns allowed) that should be excluded from resolution. - spring.thymeleaf.mode=HTML # Template mode to be applied to templates. See also Thymeleaf's TemplateMode enum. - spring.thymeleaf.prefix=classpath:/templates/ # Prefix that gets prepended to view names when building a URL. - spring.thymeleaf.reactive.chunked-mode-view-names= # Comma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set. - spring.thymeleaf.reactive.full-mode-view-names= # Comma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set. - spring.thymeleaf.reactive.max-chunk-size=0B # Maximum size of data buffers used for writing to the response. - spring.thymeleaf.reactive.media-types= # Media types supported by the view technology. - spring.thymeleaf.render-hidden-markers-before-checkboxes=false # Whether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself. - spring.thymeleaf.servlet.content-type=text/html # Content-Type value written to HTTP responses. - spring.thymeleaf.servlet.produce-partial-output-while-processing=true # Whether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished. - spring.thymeleaf.suffix=.html # Suffix that gets appended to view names when building a URL. - spring.thymeleaf.template-resolver-order= # Order of the template resolver in the chain. - spring.thymeleaf.view-names= # Comma-separated list of view names (patterns allowed) that can be resolved. - - # SPRING WEBFLUX ({sc-spring-boot-autoconfigure}/web/reactive/WebFluxProperties.{sc-ext}[WebFluxProperties]) - spring.webflux.date-format= # Date format to use. For instance, `dd/MM/yyyy`. - spring.webflux.hiddenmethod.filter.enabled=true # Whether to enable Spring's HiddenHttpMethodFilter. - spring.webflux.static-path-pattern=/** # Path pattern used for static resources. - - # SPRING WEB SERVICES ({sc-spring-boot-autoconfigure}/webservices/WebServicesProperties.{sc-ext}[WebServicesProperties]) - spring.webservices.path=/services # Path that serves as the base URI for the services. - spring.webservices.servlet.init= # Servlet init parameters to pass to Spring Web Services. - spring.webservices.servlet.load-on-startup=-1 # Load on startup priority of the Spring Web Services servlet. - spring.webservices.wsdl-locations= # Comma-separated list of locations of WSDLs and accompanying XSDs to be exposed as beans. - - - # ---------------------------------------- - # SECURITY PROPERTIES - # ---------------------------------------- - # SECURITY ({sc-spring-boot-autoconfigure}/security/SecurityProperties.{sc-ext}[SecurityProperties]) - spring.security.filter.order=-100 # Security filter chain order. - spring.security.filter.dispatcher-types=async,error,request # Security filter chain dispatcher types. - spring.security.user.name=user # Default user name. - spring.security.user.password= # Password for the default user name. - spring.security.user.roles= # Granted roles for the default user name. - - # SECURITY OAUTH2 CLIENT ({sc-spring-boot-autoconfigure}/security/oauth2/client/OAuth2ClientProperties.{sc-ext}[OAuth2ClientProperties]) - spring.security.oauth2.client.provider.*= # OAuth provider details. - spring.security.oauth2.client.registration.*= # OAuth client registrations. - - # SECURITY OAUTH2 RESOURCE SERVER ({sc-spring-boot-autoconfigure}/security/oauth2/resource/OAuth2ResourceServerProperties.{sc-ext}[OAuth2ResourceServerProperties]) - spring.security.oauth2.resourceserver.jwt.jwk-set-uri= # JSON Web Key URI to use to verify the JWT token. - spring.security.oauth2.resourceserver.jwt.jws-algorithm=RS256 # JSON Web Algorithm used for verifying the digital signatures. - spring.security.oauth2.resourceserver.jwt.issuer-uri= # URI that an OpenID Connect Provider asserts as its Issuer Identifier. - - # ---------------------------------------- - # DATA PROPERTIES - # ---------------------------------------- - - # FLYWAY ({sc-spring-boot-autoconfigure}/flyway/FlywayProperties.{sc-ext}[FlywayProperties]) - spring.flyway.baseline-description=<< Flyway Baseline >> # Description to tag an existing schema with when applying a baseline. - spring.flyway.baseline-on-migrate=false # Whether to automatically call baseline when migrating a non-empty schema. - spring.flyway.baseline-version=1 # Version to tag an existing schema with when executing baseline. - spring.flyway.check-location=true # Whether to check that migration scripts location exists. - spring.flyway.clean-disabled=false # Whether to disable cleaning of the database. - spring.flyway.clean-on-validation-error=false # Whether to automatically call clean when a validation error occurs. - spring.flyway.connect-retries=0 # Maximum number of retries when attempting to connect to the database. - spring.flyway.enabled=true # Whether to enable flyway. - spring.flyway.encoding=UTF-8 # Encoding of SQL migrations. - spring.flyway.group=false # Whether to group all pending migrations together in the same transaction when applying them. - spring.flyway.ignore-future-migrations=true # Whether to ignore future migrations when reading the schema history table. - spring.flyway.ignore-ignored-migrations=false # Whether to ignore ignored migrations when reading the schema history table. - spring.flyway.ignore-missing-migrations=false # Whether to ignore missing migrations when reading the schema history table. - spring.flyway.ignore-pending-migrations=false # Whether to ignore pending migrations when reading the schema history table. - spring.flyway.init-sqls= # SQL statements to execute to initialize a connection immediately after obtaining it. - spring.flyway.installed-by= # Username recorded in the schema history table as having applied the migration. - spring.flyway.locations=classpath:db/migration # Locations of migrations scripts. Can contain the special "{vendor}" placeholder to use vendor-specific locations. - spring.flyway.mixed=false # Whether to allow mixing transactional and non-transactional statements within the same migration. - spring.flyway.out-of-order=false # Whether to allow migrations to be run out of order. - spring.flyway.password= # Login password of the database to migrate. - spring.flyway.placeholder-prefix=${ # Prefix of placeholders in migration scripts. - spring.flyway.placeholder-replacement=true # Perform placeholder replacement in migration scripts. - spring.flyway.placeholder-suffix=} # Suffix of placeholders in migration scripts. - spring.flyway.placeholders= # Placeholders and their replacements to apply to sql migration scripts. - spring.flyway.repeatable-sql-migration-prefix=R # File name prefix for repeatable SQL migrations. - spring.flyway.schemas= # Scheme names managed by Flyway (case-sensitive). - spring.flyway.skip-default-callbacks=false # Whether to skip default callbacks. If true, only custom callbacks are used. - spring.flyway.skip-default-resolvers=false # Whether to skip default resolvers. If true, only custom resolvers are used. - spring.flyway.sql-migration-prefix=V # File name prefix for SQL migrations. - spring.flyway.sql-migration-separator=__ # File name separator for SQL migrations. - spring.flyway.sql-migration-suffixes=.sql # File name suffix for SQL migrations. - spring.flyway.table=flyway_schema_history # Name of the schema schema history table that will be used by Flyway. - spring.flyway.target= # Target version up to which migrations should be considered. - spring.flyway.url= # JDBC url of the database to migrate. If not set, the primary configured data source is used. - spring.flyway.user= # Login user of the database to migrate. - spring.flyway.validate-on-migrate=true # Whether to automatically call validate when performing a migration. - - # 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 # Whether to check that the change log location exists. - spring.liquibase.contexts= # Comma-separated list of runtime contexts to use. - spring.liquibase.database-change-log-lock-table=DATABASECHANGELOGLOCK # Name of table to use for tracking concurrent Liquibase usage. - spring.liquibase.database-change-log-table=DATABASECHANGELOG # Name of table to use for tracking change history. - spring.liquibase.default-schema= # Default database schema. - 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.liquibase-schema= # Schema to use for Liquibase objects. - spring.liquibase.liquibase-tablespace= # Tablespace to use for Liquibase objects. - 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 is written when an update is performed. - spring.liquibase.test-rollback-on-update=false # Whether rollback should be tested before 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]) - spring.couchbase.bootstrap-hosts= # Couchbase nodes (host or IP address) to bootstrap from. - spring.couchbase.bucket.name=default # Name of the bucket to connect to. - spring.couchbase.bucket.password= # Password of the bucket. - spring.couchbase.env.endpoints.key-value=1 # Number of sockets per node against the key/value service. - spring.couchbase.env.endpoints.queryservice.min-endpoints=1 # Minimum number of sockets per node. - spring.couchbase.env.endpoints.queryservice.max-endpoints=1 # Maximum number of sockets per node. - spring.couchbase.env.endpoints.viewservice.min-endpoints=1 # Minimum number of sockets per node. - spring.couchbase.env.endpoints.viewservice.max-endpoints=1 # Maximum number of sockets per node. - 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 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 # 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. - spring.data.cassandra.compression=none # Compression supported by the Cassandra binary protocol. - spring.data.cassandra.connect-timeout= # Socket option: connection time out. - spring.data.cassandra.consistency-level= # Queries consistency level. - spring.data.cassandra.contact-points=localhost # Cluster node addresses. - spring.data.cassandra.fetch-size= # Queries default fetch size. - spring.data.cassandra.jmx-enabled=false # Whether to enable JMX reporting. - spring.data.cassandra.keyspace-name= # Keyspace name to use. - spring.data.cassandra.port= # Port of the Cassandra server. - spring.data.cassandra.password= # Login password of the server. - spring.data.cassandra.pool.heartbeat-interval=30s # 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=120s # 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 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.read-timeout= # Socket option: read time out. - spring.data.cassandra.repositories.type=auto # Type of Cassandra repositories to enable. - spring.data.cassandra.serial-consistency-level= # Queries serial consistency level. - spring.data.cassandra.schema-action=none # Schema action to take at startup. - spring.data.cassandra.ssl=false # Enable SSL support. - spring.data.cassandra.username= # Login user of the server. - - # DATA COUCHBASE ({sc-spring-boot-autoconfigure}/data/couchbase/CouchbaseDataProperties.{sc-ext}[CouchbaseDataProperties]) - spring.data.couchbase.auto-index=false # Automatically create views and indexes. - spring.data.couchbase.consistency=read-your-own-writes # Consistency to apply by default on generated queries. - spring.data.couchbase.repositories.type=auto # Type of Couchbase repositories to enable. - - # ELASTICSEARCH ({sc-spring-boot-autoconfigure}/data/elasticsearch/ElasticsearchProperties.{sc-ext}[ElasticsearchProperties]) - 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 # Whether to enable Elasticsearch repositories. - - # DATA JDBC - spring.data.jdbc.repositories.enabled=true # Whether to enable JDBC repositories. - - # DATA LDAP - spring.data.ldap.repositories.enabled=true # Whether to enable LDAP repositories. - - # MONGODB ({sc-spring-boot-autoconfigure}/mongo/MongoProperties.{sc-ext}[MongoProperties]) - spring.data.mongodb.authentication-database= # Authentication database name. - spring.data.mongodb.database= # 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= # 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= # Mongo server port. Cannot be set with URI. - spring.data.mongodb.repositories.type=auto # Type of Mongo repositories to enable. - 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. - - # DATA REDIS - 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 # 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 # Whether to enable Neo4j repositories. - spring.data.neo4j.uri= # URI used by the driver. Auto-detected by default. - spring.data.neo4j.use-native-types=false # Whether to use Neo4j native types wherever possible. - spring.data.neo4j.username= # Login user of the server. - - # DATA REST ({sc-spring-boot-autoconfigure}/data/rest/RepositoryRestProperties.{sc-ext}[RepositoryRestProperties]) - spring.data.rest.base-path= # Base path to be used by Spring Data REST to expose repository resources. - spring.data.rest.default-media-type= # Content type to use as a default when none is specified. - 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= # 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= # 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 # 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]) - spring.data.web.pageable.default-page-size=20 # Default page size. - spring.data.web.pageable.max-page-size=2000 # Maximum page size to be accepted. - spring.data.web.pageable.one-indexed-parameters=false # Whether to expose and assume 1-based page number indexes. - spring.data.web.pageable.page-parameter=page # Page index parameter name. - spring.data.web.pageable.prefix= # General prefix to be prepended to the page number and page size parameters. - spring.data.web.pageable.qualifier-delimiter=_ # Delimiter to be used between the qualifier and the actual page number and size properties. - spring.data.web.pageable.size-parameter=size # Page size parameter name. - 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 # Whether to stop if an error occurs while initializing the database. - spring.datasource.data= # Data (DML) script resource references. - 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 # Whether to generate a random datasource name. - spring.datasource.hikari.*= # Hikari specific settings - 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= # Name of the datasource. Default to "testdb" when using an embedded database. - spring.datasource.password= # Login password of the database. - 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= # 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 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 # 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 username. - - # Elasticsearch REST clients ({sc-spring-boot-autoconfigure}/elasticsearch/rest/RestClientProperties.{sc-ext}[RestClientProperties]) - spring.elasticsearch.rest.password= # Credentials password. - spring.elasticsearch.rest.uris=http://localhost:9200 # Comma-separated list of the Elasticsearch instances to use. - spring.elasticsearch.rest.username= # Credentials username. - - # H2 Web Console ({sc-spring-boot-autoconfigure}/h2/H2ConsoleProperties.{sc-ext}[H2ConsoleProperties]) - 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 which to connect. - spring.influx.user= # Login user. - - # JOOQ ({sc-spring-boot-autoconfigure}/jooq/JooqProperties.{sc-ext}[JooqProperties]) - 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. - spring.jdbc.template.max-rows=-1 # Maximum number of rows. - spring.jdbc.template.query-timeout= # Query timeout. Default is to use the JDBC driver's default configuration. 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.bootstrap-mode=default # Bootstrap mode for 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 # 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= # Fully qualified name of the implicit naming strategy. - spring.jpa.hibernate.naming.physical-strategy= # Fully qualified name of the physical naming strategy. - 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 # Whether to enable logging of SQL statements. - - # JTA ({sc-spring-boot-autoconfigure}/transaction/jta/JtaAutoConfiguration.{sc-ext}[JtaAutoConfiguration]) - 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 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. - spring.jta.atomikos.connectionfactory.max-pool-size=1 # The maximum size of the pool. - spring.jta.atomikos.connectionfactory.min-pool-size=1 # The minimum size of the pool. - spring.jta.atomikos.connectionfactory.reap-timeout=0 # The reap timeout, in seconds, for borrowed connections. 0 denotes no limit. - spring.jta.atomikos.connectionfactory.unique-resource-name=jmsConnectionFactory # The unique name used to identify the resource during recovery. - spring.jta.atomikos.connectionfactory.xa-connection-factory-class-name= # Vendor-specific implementation of XAConnectionFactory. - spring.jta.atomikos.connectionfactory.xa-properties= # Vendor-specific XA properties. - spring.jta.atomikos.datasource.borrow-connection-timeout=30 # Timeout, in seconds, for borrowing connections from the pool. - spring.jta.atomikos.datasource.concurrent-connection-validation= # Whether to use concurrent connection validation. - spring.jta.atomikos.datasource.default-isolation-level= # Default isolation level of connections provided by the pool. - spring.jta.atomikos.datasource.login-timeout= # Timeout, in seconds, for establishing a database connection. - spring.jta.atomikos.datasource.maintenance-interval=60 # The time, in seconds, between runs of the pool's maintenance thread. - spring.jta.atomikos.datasource.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool. - spring.jta.atomikos.datasource.max-lifetime=0 # The time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. - spring.jta.atomikos.datasource.max-pool-size=1 # The maximum size of the pool. - spring.jta.atomikos.datasource.min-pool-size=1 # The minimum size of the pool. - 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.datasource.xa-data-source-class-name= # Vendor-specific implementation of XAConnectionFactory. - spring.jta.atomikos.datasource.xa-properties= # Vendor-specific XA properties. - spring.jta.atomikos.properties.allow-sub-transactions=true # Specify whether sub-transactions are allowed. - spring.jta.atomikos.properties.checkpoint-interval=500 # Interval between checkpoints, expressed as the number of log writes between two checkpoints. - spring.jta.atomikos.properties.default-jta-timeout=10000ms # Default timeout for JTA transactions. - spring.jta.atomikos.properties.default-max-wait-time-on-shutdown=9223372036854775807 # How long should normal shutdown (no-force) wait for transactions to complete. - 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. - spring.jta.atomikos.properties.max-timeout=300000ms # Maximum timeout that can be allowed for transactions. - spring.jta.atomikos.properties.recovery.delay=10000ms # Delay between two recovery scans. - spring.jta.atomikos.properties.recovery.forget-orphaned-log-entries-delay=86400000ms # 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 # 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 # 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 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.class-name= # Underlying implementation class name of the XA resource. - 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.disabled= # Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool. - spring.jta.bitronix.connectionfactory.driver-properties= # Properties that should be set on the underlying implementation. - spring.jta.bitronix.connectionfactory.failed= # Mark this resource producer as failed. - 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 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 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 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.class-name= # Underlying implementation class name of the XA resource. - spring.jta.bitronix.datasource.cursor-holdability= # The default cursor holdability for connections. - 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.disabled= # Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool. - spring.jta.bitronix.datasource.driver-properties= # Properties that should be set on the underlying implementation. - spring.jta.bitronix.datasource.enable-jdbc4-connection-test= # Whether Connection.isValid() is called when acquiring a connection from the pool. - spring.jta.bitronix.datasource.failed= # Mark this resource producer as failed. - 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. - spring.jta.bitronix.datasource.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool. - 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 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, 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 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 # Whether to 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 # 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 # 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.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. 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 # Whether to log a warning for transactions executed without a single enlisted resource. - - # 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. - spring.mongodb.embedded.storage.repl-set-name= # Name of the replica set. - spring.mongodb.embedded.version=3.5.5 # Version of Mongo to use. - - # REDIS ({sc-spring-boot-autoconfigure}/data/redis/RedisProperties.{sc-ext}[RedisProperties]) - 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. 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 # Maximum 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 # Maximum 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 # 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 the Redis server. - spring.redis.sentinel.nodes= # Comma-separated list of "host:port" pairs. - spring.redis.ssl=false # Whether to enable SSL support. - spring.redis.timeout= # 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= # Whether to roll back on commit failures. - - - - # ---------------------------------------- - # INTEGRATION PROPERTIES - # ---------------------------------------- - - # 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 # 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=0ms # 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= # 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 # 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.enabled=false # Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. - spring.activemq.pool.idle-timeout=30s # Connection idle timeout. - spring.activemq.pool.max-connections=1 # Maximum number of pooled connections. - spring.activemq.pool.max-sessions-per-connection=500 # Maximum number of pooled sessions per connection in the pool. - 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 # 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 # 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.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. - spring.artemis.password= # Login password of the broker. - spring.artemis.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.artemis.pool.block-if-full-timeout=-1ms # Blocking period before throwing an exception if the pool is still full. - spring.artemis.pool.enabled=false # Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. - spring.artemis.pool.idle-timeout=30s # Connection idle timeout. - spring.artemis.pool.max-connections=1 # Maximum number of pooled connections. - spring.artemis.pool.max-sessions-per-connection=500 # Maximum number of pooled sessions per connection in the pool. - spring.artemis.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.artemis.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. - spring.artemis.port=61616 # Artemis broker port. - spring.artemis.user= # Login user of the broker. - - # 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.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. - - # SPRING INTEGRATION ({sc-spring-boot-autoconfigure}/integration/IntegrationProperties.{sc-ext}[IntegrationProperties]) - spring.integration.jdbc.initialize-schema=embedded # Database schema initialization mode. - spring.integration.jdbc.schema=classpath:org/springframework/integration/jdbc/schema-@@platform@@.sql # Path to the SQL file to use to initialize the database schema. - - # JMS ({sc-spring-boot-autoconfigure}/jms/JmsProperties.{sc-ext}[JmsProperties]) - spring.jms.cache.consumers=false # Whether to cache message consumers. - spring.jms.cache.enabled=true # Whether to cache sessions. - spring.jms.cache.producers=true # Whether to cache message producers. - spring.jms.cache.session-cache-size=1 # Size of the session cache (per JMS Session type). - spring.jms.jndi-name= # Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations. - spring.jms.listener.acknowledge-mode= # Acknowledge mode of the container. By default, the listener is transacted with automatic acknowledgment. - 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 # 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. 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. Enables 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 # 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.key-store-location= # Location of the key store file. - spring.kafka.admin.ssl.key-store-password= # Store password for the key store file. - spring.kafka.admin.ssl.key-store-type= # Type of the key store. - spring.kafka.admin.ssl.protocol= # SSL protocol to use. - spring.kafka.admin.ssl.trust-store-location= # Location of the trust store file. - spring.kafka.admin.ssl.trust-store-password= # Store password for the trust store file. - spring.kafka.admin.ssl.trust-store-type= # Type of the trust store. - spring.kafka.bootstrap-servers= # Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Applies to all components unless overridden. - 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 connections to the Kafka cluster. Overrides the global property, for consumers. - 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-size". - spring.kafka.consumer.fetch-min-size= # Minimum amount of data 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(). - spring.kafka.consumer.properties.*= # Additional consumer-specific properties used to configure the client. - spring.kafka.consumer.ssl.key-password= # Password of the private key in the key store file. - spring.kafka.consumer.ssl.key-store-location= # Location of the key store file. - spring.kafka.consumer.ssl.key-store-password= # Store password for the key store file. - spring.kafka.consumer.ssl.key-store-type= # Type of the key store. - spring.kafka.consumer.ssl.protocol= # SSL protocol to use. - spring.kafka.consumer.ssl.trust-store-location= # Location of the trust store file. - spring.kafka.consumer.ssl.trust-store-password= # Store password for the trust store file. - spring.kafka.consumer.ssl.trust-store-type= # Type of the trust store. - spring.kafka.consumer.value-deserializer= # Deserializer class for values. - spring.kafka.jaas.control-flag=required # Control flag for login configuration. - spring.kafka.jaas.enabled=false # 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-time= # Time between offset commits when ackMode is "TIME" or "COUNT_TIME". - spring.kafka.listener.client-id= # Prefix for the listener's consumer client.id property. - spring.kafka.listener.concurrency= # Number of threads to run in the listener containers. - spring.kafka.listener.idle-event-interval= # Time between publishing idle consumer events (no data received). - spring.kafka.listener.log-container-config= # Whether to log the container configuration during initialization (INFO level). - spring.kafka.listener.monitor-interval= # Time between checks for non-responsive consumers. If a duration suffix is not specified, seconds will be used. - spring.kafka.listener.no-poll-threshold= # Multiplier applied to "pollTimeout" to determine if a consumer is non-responsive. - spring.kafka.listener.poll-timeout= # Timeout to use when polling the consumer. - spring.kafka.listener.type=single # Listener type. - spring.kafka.producer.acks= # Number of acknowledgments the producer requires the leader to have received before considering a request complete. - spring.kafka.producer.batch-size= # Default batch size. - spring.kafka.producer.bootstrap-servers= # Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for producers. - spring.kafka.producer.buffer-memory= # Total memory size 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.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. - spring.kafka.producer.retries= # When greater than zero, enables retrying of failed sends. - spring.kafka.producer.ssl.key-password= # Password of the private key in the key store file. - spring.kafka.producer.ssl.key-store-location= # Location of the key store file. - spring.kafka.producer.ssl.key-store-password= # Store password for the key store file. - spring.kafka.producer.ssl.key-store-type= # Type of the key store. - spring.kafka.producer.ssl.protocol= # SSL protocol to use. - spring.kafka.producer.ssl.trust-store-location= # Location of the trust store file. - spring.kafka.producer.ssl.trust-store-password= # Store password for the trust store file. - spring.kafka.producer.ssl.trust-store-type= # Type of the trust store. - spring.kafka.producer.transaction-id-prefix= # When non empty, enables transaction support for producer. - spring.kafka.producer.value-serializer= # Serializer class for values. - spring.kafka.properties.*= # Additional properties, common to producers and consumers, used to configure the client. - spring.kafka.ssl.key-password= # Password of the private key in the key store file. - spring.kafka.ssl.key-store-location= # Location of the key store file. - spring.kafka.ssl.key-store-password= # Store password for the key store file. - spring.kafka.ssl.key-store-type= # Type of the key store. - spring.kafka.ssl.protocol= # SSL protocol to use. - spring.kafka.ssl.trust-store-location= # Location of the trust store file. - spring.kafka.ssl.trust-store-password= # Store password for the trust store file. - spring.kafka.ssl.trust-store-type= # Type of the trust store. - spring.kafka.streams.application-id= # Kafka streams application.id property; default spring.application.name. - spring.kafka.streams.auto-startup=true # Whether or not to auto-start the streams factory bean. - spring.kafka.streams.bootstrap-servers= # Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for streams. - spring.kafka.streams.cache-max-size-buffering= # Maximum memory size to be used for buffering across all threads. - spring.kafka.streams.client-id= # ID to pass to the server when making requests. Used for server-side logging. - spring.kafka.streams.properties.*= # Additional Kafka properties used to configure the streams. - spring.kafka.streams.replication-factor= # The replication factor for change log topics and repartition topics created by the stream processing application. - spring.kafka.streams.ssl.key-password= # Password of the private key in the key store file. - spring.kafka.streams.ssl.key-store-location= # Location of the key store file. - spring.kafka.streams.ssl.key-store-password= # Store password for the key store file. - spring.kafka.streams.ssl.key-store-type= # Type of the key store. - spring.kafka.streams.ssl.protocol= # SSL protocol to use. - spring.kafka.streams.ssl.trust-store-location= # Location of the trust store file. - spring.kafka.streams.ssl.trust-store-password= # Store password for the trust store file. - spring.kafka.streams.ssl.trust-store-type= # Type of the trust store. - spring.kafka.streams.state-dir= # Directory location for the state store. - 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. - spring.rabbitmq.cache.channel.checkout-timeout= # Duration to wait to obtain a channel if the cache size has been reached. - 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. 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 # 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 re-queued by default. - spring.rabbitmq.listener.direct.idle-event-interval= # How often idle container events should be published. - spring.rabbitmq.listener.direct.missing-queues-fatal=false # Whether to fail if the queues declared by the container are not available on the broker. - spring.rabbitmq.listener.direct.prefetch= # Maximum number of unacknowledged messages that can be outstanding at each consumer. - spring.rabbitmq.listener.direct.retry.enabled=false # Whether publishing retries are enabled. - spring.rabbitmq.listener.direct.retry.initial-interval=1000ms # Duration between the first and second attempt to deliver a message. - spring.rabbitmq.listener.direct.retry.max-attempts=3 # Maximum number of attempts to deliver a message. - spring.rabbitmq.listener.direct.retry.max-interval=10000ms # Maximum duration 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 # 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 rejected deliveries are re-queued by default. - 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 threads. - spring.rabbitmq.listener.simple.missing-queues-fatal=true # Whether to fail if the queues declared by the container are not available on the broker and/or whether to stop the container if one or more queues are deleted at runtime. - spring.rabbitmq.listener.simple.prefetch= # Maximum number of unacknowledged messages that can be outstanding at each consumer. - spring.rabbitmq.listener.simple.retry.enabled=false # Whether publishing retries are enabled. - spring.rabbitmq.listener.simple.retry.initial-interval=1000ms # Duration 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=10000ms # Maximum duration between attempts. - spring.rabbitmq.listener.simple.retry.multiplier=1 # Multiplier to apply to the previous retry interval. - spring.rabbitmq.listener.simple.retry.stateless=true # Whether retries are stateless or stateful. - spring.rabbitmq.listener.simple.transaction-size= # Number of messages to be processed between acks when the acknowledge mode is AUTO. If larger than prefetch, prefetch will be increased to this value. - spring.rabbitmq.listener.type=simple # Listener container type. - spring.rabbitmq.password=guest # Login to authenticate against the broker. - spring.rabbitmq.port=5672 # RabbitMQ port. - 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.algorithm= # SSL algorithm to use. By default, configured by the Rabbit client library. - 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.validate-server-certificate=true # Whether to enable server side certificate validation. - spring.rabbitmq.ssl.verify-hostname=true # Whether to enable hostname verification. - spring.rabbitmq.template.default-receive-queue= # Name of the default queue to receive messages from when none is specified explicitly. - spring.rabbitmq.template.exchange= # Name of the default exchange to use for send operations. - spring.rabbitmq.template.mandatory= # Whether to enable mandatory messages. - spring.rabbitmq.template.receive-timeout= # Timeout for `receive()` operations. - spring.rabbitmq.template.reply-timeout= # Timeout for `sendAndReceive()` operations. - spring.rabbitmq.template.retry.enabled=false # Whether publishing retries are enabled. - spring.rabbitmq.template.retry.initial-interval=1000ms # Duration between the first and second attempt to deliver a message. - spring.rabbitmq.template.retry.max-attempts=3 # Maximum number of attempts to deliver a message. - spring.rabbitmq.template.retry.max-interval=10000ms # Maximum duration between attempts. - spring.rabbitmq.template.retry.multiplier=1 # Multiplier to apply to the previous retry interval. - spring.rabbitmq.template.routing-key= # Value of a default routing key to use for send operations. - spring.rabbitmq.username=guest # Login user to authenticate to the broker. - spring.rabbitmq.virtual-host= # Virtual host to use when connecting to the broker. - - - # ---------------------------------------- - # ACTUATOR PROPERTIES - # ---------------------------------------- - - # 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. - management.server.address= # Network address to which the management endpoints should bind. 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.servlet.context-path= # Management endpoint context-path (for instance, `/management`). Requires a custom management.server.port. - management.server.ssl.ciphers= # Supported SSL ciphers. - management.server.ssl.client-auth= # Client authentication mode. - management.server.ssl.enabled=true # Whether to enable SSL support. - management.server.ssl.enabled-protocols= # Enabled SSL protocols. - management.server.ssl.key-alias= # Alias that identifies the key in the key store. - management.server.ssl.key-password= # Password used to access the key in the key store. - management.server.ssl.key-store= # Path to the key store that holds the SSL certificate (typically a jks file). - management.server.ssl.key-store-password= # Password used to access the key store. - management.server.ssl.key-store-provider= # Provider for the key store. - management.server.ssl.key-store-type= # Type of the key store. - management.server.ssl.protocol=TLS # SSL protocol to use. - management.server.ssl.trust-store= # Trust store that holds SSL certificates. - management.server.ssl.trust-store-password= # Password used to access the trust store. - management.server.ssl.trust-store-provider= # Provider for the trust store. - management.server.ssl.trust-store-type= # Type of the trust store. - - # CLOUDFOUNDRY - 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= # Whether to enable or disable all endpoints by default. - - # ENDPOINTS JMX CONFIGURATION ({sc-spring-boot-actuator-autoconfigure}/endpoint/jmx/JmxEndpointProperties.{sc-ext}[JmxEndpointProperties]) - management.endpoints.jmx.domain=org.springframework.boot # Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set. - management.endpoints.jmx.exposure.include=* # Endpoint IDs that should be included or '*' for all. - management.endpoints.jmx.exposure.exclude= # Endpoint IDs that should be excluded or '*' for all. - management.endpoints.jmx.static-names= # Additional static properties to append to all ObjectNames of MBeans representing Endpoints. - - # ENDPOINTS WEB CONFIGURATION ({sc-spring-boot-actuator-autoconfigure}/endpoint/web/WebEndpointProperties.{sc-ext}[WebEndpointProperties]) - management.endpoints.web.exposure.include=health,info # Endpoint IDs that should be included or '*' for all. - management.endpoints.web.exposure.exclude= # Endpoint IDs that should be excluded or '*' for all. - management.endpoints.web.base-path=/actuator # Base path for Web endpoints. Relative to server.servlet.context-path or management.server.servlet.context-path if management.server.port is configured. - 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/CorsEndpointProperties.{sc-ext}[CorsEndpointProperties]) - 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. - management.endpoints.web.cors.exposed-headers= # Comma-separated list of headers to include in a response. - management.endpoints.web.cors.max-age=1800s # How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used. - - # 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=true # 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=true # Whether to enable the beans endpoint. - - # CACHES ENDPOINT ({sc-spring-boot-actuator}/cache/CachesEndpoint.{sc-ext}[CachesEndpoint]) - management.endpoint.caches.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.caches.enabled=true # Whether to enable the caches 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=true # Whether to enable the conditions endpoint. - - # CONFIGURATION PROPERTIES REPORT ENDPOINT ({sc-spring-boot-actuator}/context/properties/ConfigurationPropertiesReportEndpoint.{sc-ext}[ConfigurationPropertiesReportEndpoint], {sc-spring-boot-actuator-autoconfigure}/context/properties/ConfigurationPropertiesReportEndpointProperties.{sc-ext}[ConfigurationPropertiesReportEndpointProperties]) - management.endpoint.configprops.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.configprops.enabled=true # Whether to enable the configprops endpoint. - management.endpoint.configprops.keys-to-sanitize=password,secret,key,token,.*credentials.*,vcap_services,sun.java.command # 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], {sc-spring-boot-actuator-autoconfigure}/env/EnvironmentEndpointProperties.{sc-ext}[EnvironmentEndpointProperties]) - management.endpoint.env.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.env.enabled=true # Whether to enable the env endpoint. - management.endpoint.env.keys-to-sanitize=password,secret,key,token,.*credentials.*,vcap_services,sun.java.command # 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=true # Whether to enable the flyway endpoint. - - # HEALTH ENDPOINT ({sc-spring-boot-actuator}/health/HealthEndpoint.{sc-ext}[HealthEndpoint], {sc-spring-boot-actuator-autoconfigure}/health/HealthEndpointProperties.{sc-ext}[HealthEndpointProperties]) - management.endpoint.health.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.health.enabled=true # Whether to enable the health endpoint. - management.endpoint.health.roles= # Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized. - management.endpoint.health.show-details=never # When to show full health details. - - # 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=true # Whether to enable the heapdump endpoint. - - # HTTP TRACE ENDPOINT ({sc-spring-boot-actuator}/trace/http/HttpTraceEndpoint.{sc-ext}[HttpTraceEndpoint]) - management.endpoint.httptrace.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.httptrace.enabled=true # Whether to enable the httptrace endpoint. - - # INFO ENDPOINT ({sc-spring-boot-actuator}/info/InfoEndpoint.{sc-ext}[InfoEndpoint]) - info= # Arbitrary properties to add to the info endpoint. - management.endpoint.info.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.info.enabled=true # Whether to enable the info endpoint. - - # INTEGRATION GRAPH ENDPOINT ({sc-spring-boot-actuator}/integration/IntegrationGraphEndpoint.{sc-ext}[IntegrationGraphEndpoint]) - management.endpoint.integrationgraph.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.integrationgraph.enabled=true # Whether to enable the integrationgraph endpoint. - - # JOLOKIA ENDPOINT ({sc-spring-boot-actuator-autoconfigure}/jolokia/JolokiaProperties.{sc-ext}[JolokiaProperties]) - management.endpoint.jolokia.config.*= # Jolokia settings. Refer to the documentation of Jolokia for more details. - management.endpoint.jolokia.enabled=true # Whether to enable the jolokia 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=true # Whether to enable the liquibase endpoint. - - # LOG FILE ENDPOINT ({sc-spring-boot-actuator}/logging/LogFileWebEndpoint.{sc-ext}[LogFileWebEndpoint], {sc-spring-boot-actuator-autoconfigure}/logging/LogFileWebEndpointProperties.{sc-ext}[LogFileWebEndpointProperties]) - management.endpoint.logfile.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.logfile.enabled=true # 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=true # Whether to enable the loggers endpoint. - - # REQUEST MAPPING ENDPOINT ({sc-spring-boot-actuator}/web/mappings/MappingsEndpoint.{sc-ext}[MappingsEndpoint]) - management.endpoint.mappings.cache.time-to-live=0ms # Maximum time that a response can be cached. - management.endpoint.mappings.enabled=true # 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=true # 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=true # Whether to enable the prometheus 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=true # Whether to enable the scheduledtasks endpoint. - - # SESSIONS ENDPOINT ({sc-spring-boot-actuator}/session/SessionsEndpoint.{sc-ext}[SessionsEndpoint]) - management.endpoint.sessions.enabled=true # Whether to enable the sessions endpoint. - - # SHUTDOWN ENDPOINT ({sc-spring-boot-actuator}/context/ShutdownEndpoint.{sc-ext}[ShutdownEndpoint]) - management.endpoint.shutdown.enabled=false # Whether to enable the shutdown 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=true # Whether to enable the threaddump endpoint. - - # HEALTH INDICATORS - 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=10MB # Minimum disk space 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 # Time to wait for a response from the cluster. - management.health.influxdb.enabled=true # Whether to enable InfluxDB health check. - 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. - - # HTTP TRACING ({sc-spring-boot-actuator-autoconfigure}/trace/http/HttpTraceProperties.{sc-ext}[HttpTraceProperties]) - management.trace.http.enabled=true # Whether to enable HTTP request-response tracing. - management.trace.http.include=request-headers,response-headers,cookies,errors # Items to be included in the trace. - - # INFO CONTRIBUTORS ({sc-spring-boot-actuator-autoconfigure}/info/InfoContributorProperties.{sc-ext}[InfoContributorProperties]) - 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. - - # METRICS - management.metrics.distribution.maximum-expected-value.*= # Maximum value that meter IDs starting-with the specified name are expected to observe. - management.metrics.distribution.minimum-expected-value.*= # Minimum value that meter IDs starting-with the specified name are expected to observe. - management.metrics.distribution.percentiles.*= # Specific computed non-aggregable percentiles to ship to the backend for meter IDs starting-with the specified name. - management.metrics.distribution.percentiles-histogram.*= # Whether meter IDs starting with the specified name should publish percentile histograms. - management.metrics.distribution.sla.*= # Specific SLA boundaries for meter IDs starting-with the specified name. The longest match wins. - management.metrics.enable.*= # Whether meter IDs starting-with the specified name should be enabled. The longest match wins, the key `all` can also be used to configure all meters. - management.metrics.export.appoptics.api-token= # AppOptics API token. - management.metrics.export.appoptics.batch-size=500 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.appoptics.connect-timeout=5s # Connection timeout for requests to this backend. - management.metrics.export.appoptics.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.appoptics.host-tag=instance # Tag that will be mapped to "@host" when shipping metrics to AppOptics. - management.metrics.export.appoptics.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.appoptics.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.appoptics.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.appoptics.uri=https://api.appoptics.com/v1/measurements # URI to ship metrics to. - management.metrics.export.atlas.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.atlas.config-refresh-frequency=10s # Frequency for refreshing config settings from the LWC service. - management.metrics.export.atlas.config-time-to-live=150s # Time to live for subscriptions from the LWC service. - management.metrics.export.atlas.config-uri=http://localhost:7101/lwc/api/v1/expressions/local-dev # URI for the Atlas LWC endpoint to retrieve current subscriptions. - management.metrics.export.atlas.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.atlas.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.atlas.eval-uri=http://localhost:7101/lwc/api/v1/evaluate # URI for the Atlas LWC endpoint to evaluate the data for a subscription. - management.metrics.export.atlas.lwc-enabled=false # Whether to enable streaming to Atlas LWC. - management.metrics.export.atlas.meter-time-to-live=15m # 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. - management.metrics.export.atlas.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.atlas.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.atlas.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.atlas.uri=http://localhost:7101/api/v1/publish # URI of the Atlas server. - management.metrics.export.datadog.api-key= # Datadog API key. - management.metrics.export.datadog.application-key= # Datadog application key. Not strictly required, but improves the Datadog experience by sending meter descriptions, types, and base units to Datadog. - management.metrics.export.datadog.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.datadog.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.datadog.descriptions=true # Whether to publish descriptions metadata to Datadog. Turn this off to minimize the amount of metadata sent. - management.metrics.export.datadog.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.datadog.host-tag=instance # Tag that will be mapped to "host" when shipping metrics to Datadog. - management.metrics.export.datadog.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.datadog.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.datadog.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.datadog.uri=https://app.datadoghq.com # 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. - management.metrics.export.dynatrace.api-token= # Dynatrace authentication token. - management.metrics.export.dynatrace.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.dynatrace.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.dynatrace.device-id= # ID of the custom device that is exporting metrics to Dynatrace. - management.metrics.export.dynatrace.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.dynatrace.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.dynatrace.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.dynatrace.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.dynatrace.technology-type=java # Technology type for exported metrics. Used to group metrics under a logical technology name in the Dynatrace UI. - management.metrics.export.dynatrace.uri= # URI to ship metrics to. Should be used for SaaS, self managed instances or to en-route through an internal proxy. - management.metrics.export.elastic.auto-create-index=true # Whether to create the index automatically if it does not exist. - management.metrics.export.elastic.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.elastic.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.elastic.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.elastic.host=http://localhost:9200 # Host to export metrics to. - management.metrics.export.elastic.index=metrics # Index to export metrics to. - management.metrics.export.elastic.index-date-format=yyyy-MM # Index date format used for rolling indices. Appended to the index name, preceded by a '-'. - management.metrics.export.elastic.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.elastic.password= # Login password of the Elastic server. - management.metrics.export.elastic.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.elastic.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.elastic.timestamp-field-name=@timestamp # Name of the timestamp field. - management.metrics.export.elastic.user-name= # Login user of the Elastic server. - management.metrics.export.ganglia.addressing-mode=multicast # UDP addressing mode, either unicast or multicast. - management.metrics.export.ganglia.duration-units=milliseconds # Base time unit used to report durations. - management.metrics.export.ganglia.enabled=true # Whether exporting of metrics to Ganglia is enabled. - management.metrics.export.ganglia.host=localhost # Host of the Ganglia server to receive exported metrics. - management.metrics.export.ganglia.port=8649 # Port of the Ganglia server to receive exported metrics. - management.metrics.export.ganglia.protocol-version=3.1 # Ganglia protocol version. Must be either 3.1 or 3.0. - management.metrics.export.ganglia.rate-units=seconds # Base time unit used to report rates. - management.metrics.export.ganglia.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.ganglia.time-to-live=1 # Time to live for metrics on Ganglia. Set the multi-cast Time-To-Live to be one greater than the number of hops (routers) between the hosts. - management.metrics.export.graphite.duration-units=milliseconds # Base time unit used to report durations. - management.metrics.export.graphite.enabled=true # Whether exporting of metrics to Graphite is enabled. - management.metrics.export.graphite.host=localhost # Host of the Graphite server to receive exported metrics. - management.metrics.export.graphite.port=2004 # Port of the Graphite server to receive exported metrics. - management.metrics.export.graphite.protocol=pickled # Protocol to use while shipping data to Graphite. - management.metrics.export.graphite.rate-units=seconds # Base time unit used to report rates. - management.metrics.export.graphite.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.graphite.tags-as-prefix= # For the default naming convention, turn the specified tag keys into part of the metric prefix. - management.metrics.export.humio.api-token= # Humio API token. - management.metrics.export.humio.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.humio.connect-timeout=5s # Connection timeout for requests to this backend. - management.metrics.export.humio.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.humio.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.humio.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.humio.repository=sandbox # Name of the repository to publish metrics to. - management.metrics.export.humio.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.humio.tags.*= # Humio tags describing the data source in which metrics will be stored. Humio tags are a distinct concept from Micrometer's tags. Micrometer's tags are used to divide metrics along dimensional boundaries. - management.metrics.export.humio.uri=https://cloud.humio.com # URI to ship metrics to. If you need to publish metrics to an internal proxy en-route to Humio, you can define the location of the proxy with this. - management.metrics.export.influx.auto-create-db=true # Whether to create the Influx database if it does not exist before attempting to publish metrics to it. - management.metrics.export.influx.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.influx.compressed=true # Whether to enable GZIP compression of metrics batches published to Influx. - management.metrics.export.influx.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.influx.consistency=one # Write consistency for each point. - management.metrics.export.influx.db=mydb # Tag that will be mapped to "host" when shipping metrics to Influx. - management.metrics.export.influx.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.influx.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.influx.password= # Login password of the Influx server. - management.metrics.export.influx.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.influx.retention-duration= # Time period for which Influx should retain data in the current database. - management.metrics.export.influx.retention-shard-duration= # Time range covered by a shard group. - management.metrics.export.influx.retention-policy= # Retention policy to use (Influx writes to the DEFAULT retention policy if one is not specified). - management.metrics.export.influx.retention-replication-factor= # How many copies of the data are stored in the cluster. - management.metrics.export.influx.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.influx.uri=http://localhost:8086 # URI of the Influx server. - management.metrics.export.influx.user-name= # Login user of the Influx server. - management.metrics.export.jmx.domain=metrics # Metrics JMX domain name. - management.metrics.export.jmx.enabled=true # Whether exporting of metrics to JMX is enabled. - management.metrics.export.jmx.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.kairos.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.kairos.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.kairos.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.kairos.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.kairos.password= # Login password of the KairosDB server. - management.metrics.export.kairos.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.kairos.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.kairos.uri= http://localhost:8080/api/v1/datapoints # URI of the KairosDB server. - management.metrics.export.kairos.user-name= # Login user of the KairosDB server. - management.metrics.export.newrelic.account-id= # New Relic account ID. - management.metrics.export.newrelic.api-key= # New Relic API key. - management.metrics.export.newrelic.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.newrelic.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.newrelic.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.newrelic.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.newrelic.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.newrelic.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.newrelic.uri=https://insights-collector.newrelic.com # URI to ship metrics to. - management.metrics.export.prometheus.descriptions=true # Whether to enable publishing descriptions as part of the scrape payload to Prometheus. Turn this off to minimize the amount of data sent on each scrape. - management.metrics.export.prometheus.enabled=true # Whether exporting of metrics to Prometheus is enabled. - management.metrics.export.prometheus.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.prometheus.pushgateway.base-url=localhost:9091 # Base URL for the Pushgateway. - management.metrics.export.prometheus.pushgateway.enabled=false # Enable publishing via a Prometheus Pushgateway. - management.metrics.export.prometheus.pushgateway.grouping-key= # Grouping key for the pushed metrics. - management.metrics.export.prometheus.pushgateway.job= # Job identifier for this application instance. - management.metrics.export.prometheus.pushgateway.push-rate=1m # Frequency with which to push metrics. - management.metrics.export.prometheus.pushgateway.shutdown-operation= # Operation that should be performed on shutdown. - management.metrics.export.signalfx.access-token= # SignalFX access token. - management.metrics.export.signalfx.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.signalfx.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.signalfx.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.signalfx.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.signalfx.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.signalfx.source= # Uniquely identifies the app instance that is publishing metrics to SignalFx. Defaults to the local host name. - management.metrics.export.signalfx.step=10s # Step size (i.e. reporting frequency) to use. - management.metrics.export.signalfx.uri=https://ingest.signalfx.com # URI to ship metrics to. - management.metrics.export.simple.enabled=true # Whether, in the absence of any other exporter, exporting of metrics to an in-memory backend is enabled. - management.metrics.export.simple.mode=cumulative # Counting mode. - management.metrics.export.simple.step=1m # Step size (i.e. reporting frequency) to use. - management.metrics.export.statsd.enabled=true # Whether exporting of metrics to StatsD is enabled. - management.metrics.export.statsd.flavor=datadog # StatsD line protocol to use. - management.metrics.export.statsd.host=localhost # Host of the StatsD server to receive exported metrics. - management.metrics.export.statsd.max-packet-length=1400 # Total length of a single payload should be kept within your network's MTU. - management.metrics.export.statsd.polling-frequency=10s # How often gauges will be polled. When a gauge is polled, its value is recalculated and if the value has changed (or publishUnchangedMeters is true), it is sent to the StatsD server. - management.metrics.export.statsd.port=8125 # Port of the StatsD server to receive exported metrics. - management.metrics.export.statsd.publish-unchanged-meters=true # Whether to send unchanged meters to the StatsD server. - management.metrics.export.wavefront.api-token= # API token used when publishing metrics directly to the Wavefront API host. - management.metrics.export.wavefront.batch-size=10000 # Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. - management.metrics.export.wavefront.connect-timeout=1s # Connection timeout for requests to this backend. - management.metrics.export.wavefront.enabled=true # Whether exporting of metrics to this backend is enabled. - management.metrics.export.wavefront.global-prefix= # Global prefix to separate metrics originating from this app's white box instrumentation from those originating from other Wavefront integrations when viewed in the Wavefront UI. - management.metrics.export.wavefront.num-threads=2 # Number of threads to use with the metrics publishing scheduler. - management.metrics.export.wavefront.read-timeout=10s # Read timeout for requests to this backend. - management.metrics.export.wavefront.source= # Unique identifier for the app instance that is the source of metrics being published to Wavefront. Defaults to the local host name. - management.metrics.export.wavefront.step=10s # Step size (i.e. reporting frequency) to use. - management.metrics.export.wavefront.uri=https://longboard.wavefront.com # URI to ship metrics to. - management.metrics.use-global-registry=true # Whether auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics. - management.metrics.tags.*= # Common tags that are applied to every meter. - management.metrics.web.client.max-uri-tags=100 # Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter. - management.metrics.web.client.requests-metric-name=http.client.requests # Name of the metric for sent requests. - management.metrics.web.server.auto-time-requests=true # Whether requests handled by Spring MVC, WebFlux or Jersey should be automatically timed. - management.metrics.web.server.max-uri-tags=100 # Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter. - management.metrics.web.server.requests-metric-name=http.server.requests # Name of the metric for received requests. - - - # ---------------------------------------- - # DEVTOOLS PROPERTIES - # ---------------------------------------- - - # DEVTOOLS ({sc-spring-boot-devtools}/autoconfigure/DevToolsProperties.{sc-ext}[DevToolsProperties]) - spring.devtools.add-properties=true # Whether to enable development property defaults. - 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. - spring.devtools.restart.enabled=true # Whether to enable automatic restart. - spring.devtools.restart.exclude=META-INF/maven/**,META-INF/resources/**,resources/**,static/**,public/**,templates/**,**/*Test.class,**/*Tests.class,git.properties,META-INF/build-info.properties # Patterns that should be excluded from triggering a full restart. - spring.devtools.restart.log-condition-evaluation-delta=true # Whether to log the condition evaluation delta upon 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, 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 # 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. - - - # ---------------------------------------- - # TESTING PROPERTIES - # ---------------------------------------- - - spring.test.database.replace=any # Type of existing DataSource to replace. - spring.test.mockmvc.print=default # MVC Print option. - ----- +include::../../../target/generated-resources/config-docs/testing.adoc[] diff --git a/spring-boot-project/spring-boot-docs/src/main/groovy/generateConfigurationPropertyTables.groovy b/spring-boot-project/spring-boot-docs/src/main/groovy/generateConfigurationPropertyTables.groovy new file mode 100644 index 0000000000..183f68114c --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/main/groovy/generateConfigurationPropertyTables.groovy @@ -0,0 +1,79 @@ +import org.springframework.boot.configurationdocs.ConfigurationMetadataDocumentWriter +import org.springframework.boot.configurationdocs.DocumentOptions +import org.springframework.core.io.UrlResource + +import java.nio.file.Path +import java.nio.file.Paths + +def getConfigMetadataInputStreams() { + def mainMetadata = getClass().getClassLoader().getResources("META-INF/spring-configuration-metadata.json") + def additionalMetadata = getClass().getClassLoader().getResources("META-INF/additional-spring-configuration-metadata.json") + def streams = [] + streams += mainMetadata.collect { new UrlResource(it).getInputStream() } + streams += additionalMetadata.collect { new UrlResource(it).getInputStream() } + return streams +} + +def generateConfigMetadataDocumentation() { + + def streams = getConfigMetadataInputStreams() + try { + Path outputPath = Paths.get(project.build.directory, 'generated-resources', 'config-docs') + def builder = DocumentOptions.builder(); + + builder + .addSection("core") + .withKeyPrefixes("debug", "trace", "logging", "spring.aop", "spring.application", + "spring.autoconfigure", "spring.banner", "spring.beaninfo", "spring.config", + "spring.info", "spring.jmx", "spring.main", "spring.messages", "spring.pid", + "spring.profiles", "spring.quartz", "spring.reactor", "spring.task", + "spring.mandatory-file-encoding", "info", "spring.output.ansi.enabled") + .addSection("mail") + .withKeyPrefixes("spring.mail", "spring.sendgrid") + .addSection("cache") + .withKeyPrefixes("spring.cache") + .addSection("server") + .withKeyPrefixes("server") + .addSection("web") + .withKeyPrefixes("spring.hateoas", + "spring.http", "spring.servlet", "spring.jersey", + "spring.mvc", "spring.resources", "spring.webflux") + .addSection("json") + .withKeyPrefixes("spring.jackson", "spring.gson") + .addSection("templating") + .withKeyPrefixes("spring.freemarker", "spring.groovy", "spring.mustache", "spring.thymeleaf") + .addOverride("spring.groovy.template.configuration", "See GroovyMarkupConfigurer") + .addSection("security") + .withKeyPrefixes("spring.security", "spring.ldap", "spring.session") + .addSection("data-migration") + .withKeyPrefixes("spring.flyway", "spring.liquibase") + .addSection("data") + .withKeyPrefixes("spring.couchbase", "spring.elasticsearch", "spring.h2", + "spring.influx", "spring.mongodb", "spring.redis", + "spring.dao", "spring.data", "spring.datasource", "spring.jooq", + "spring.jdbc", "spring.jpa") + .addOverride("spring.datasource.dbcp2", "Commons DBCP2 specific settings") + .addOverride("spring.datasource.tomcat", "Tomcat datasource specific settings") + .addOverride("spring.datasource.hikari", "Hikari specific settings") + .addSection("transaction") + .withKeyPrefixes("spring.jta", "spring.transaction") + .addSection("integration") + .withKeyPrefixes("spring.activemq", "spring.artemis", "spring.batch", + "spring.integration", "spring.jms", "spring.kafka", "spring.rabbitmq", "spring.hazelcast", + "spring.webservices") + .addSection("actuator") + .withKeyPrefixes("management") + .addSection("devtools") + .withKeyPrefixes("spring.devtools") + .addSection("testing") + .withKeyPrefixes("spring.test"); + + ConfigurationMetadataDocumentWriter writer = new ConfigurationMetadataDocumentWriter(); + writer.writeDocument(outputPath, builder.build(), streams.toArray(new InputStream[0])); + } + finally { + streams.each { it.close() } + } +} + +generateConfigMetadataDocumentation() \ No newline at end of file diff --git a/spring-boot-project/spring-boot-tools/pom.xml b/spring-boot-project/spring-boot-tools/pom.xml index 9e2c8bc4a8..c5a2e58ec6 100644 --- a/spring-boot-project/spring-boot-tools/pom.xml +++ b/spring-boot-project/spring-boot-tools/pom.xml @@ -17,6 +17,7 @@ spring-boot-antlib spring-boot-autoconfigure-processor + spring-boot-configuration-docs spring-boot-configuration-metadata spring-boot-configuration-processor spring-boot-gradle-plugin diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/pom.xml b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/pom.xml new file mode 100644 index 0000000000..70d541a5a1 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/pom.xml @@ -0,0 +1,26 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-tools + ${revision} + + spring-boot-configuration-docs + Spring Boot Configuration Docs + Spring Boot Configuration Docs + + ${basedir}/../../.. + + + + org.springframework.boot + spring-boot-configuration-metadata + + + org.springframework.boot + spring-boot-test-support + test + + + diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/AbstractConfigurationEntry.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/AbstractConfigurationEntry.java new file mode 100644 index 0000000000..14fb76f702 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/AbstractConfigurationEntry.java @@ -0,0 +1,61 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import java.util.Objects; + +/** + * Abstract class for entries in {@link ConfigurationTable}. + * + * @author Brian Clozel + */ +abstract class AbstractConfigurationEntry + implements Comparable { + + protected static final String NEWLINE = System.lineSeparator(); + + protected String key; + + public String getKey() { + return this.key; + } + + public abstract void writeAsciidoc(StringBuilder builder); + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AbstractConfigurationEntry that = (AbstractConfigurationEntry) o; + return this.key.equals(that.key); + } + + @Override + public int hashCode() { + return Objects.hash(this.key); + } + + @Override + public int compareTo(AbstractConfigurationEntry other) { + return this.key.compareTo(other.getKey()); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/CompoundKeyEntry.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/CompoundKeyEntry.java new file mode 100644 index 0000000000..c27702ff62 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/CompoundKeyEntry.java @@ -0,0 +1,55 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import java.util.Set; +import java.util.TreeSet; +import java.util.stream.Stream; + +import org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty; + +/** + * Table entry regrouping a list of configuration properties sharing the same description. + * + * @author Brian Clozel + */ +class CompoundKeyEntry extends AbstractConfigurationEntry { + + private Set configurationKeys; + + private String description; + + CompoundKeyEntry(String key, String description) { + this.key = key; + this.description = description; + this.configurationKeys = new TreeSet<>(); + } + + void addConfigurationKeys(ConfigurationMetadataProperty... properties) { + Stream.of(properties) + .forEach((property) -> this.configurationKeys.add(property.getId())); + } + + @Override + public void writeAsciidoc(StringBuilder builder) { + builder.append("|`+++"); + this.configurationKeys.forEach((key) -> builder.append(key).append(NEWLINE)); + builder.append("+++`").append(NEWLINE).append("|").append(NEWLINE).append("|+++") + .append(this.description).append("+++").append(NEWLINE); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationMetadataDocumentWriter.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationMetadataDocumentWriter.java new file mode 100644 index 0000000000..26b537d586 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationMetadataDocumentWriter.java @@ -0,0 +1,143 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty; +import org.springframework.boot.configurationmetadata.ConfigurationMetadataRepository; +import org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder; + +/** + * Write Asciidoc documents with configuration properties listings. + * + * @author Brian Clozel + */ +public class ConfigurationMetadataDocumentWriter { + + public void writeDocument(Path outputDirPath, DocumentOptions options, + InputStream... metadataInput) throws IOException { + if (outputDirPath == null) { + throw new IllegalArgumentException("output path should not be null"); + } + if (Files.exists(outputDirPath) && !Files.isDirectory(outputDirPath)) { + throw new IllegalArgumentException( + "output path already exists and is not a directory"); + } + else if (!Files.exists(outputDirPath)) { + Files.createDirectory(outputDirPath); + } + if (metadataInput == null || metadataInput.length < 1) { + throw new IllegalArgumentException("missing input metadata"); + } + + ConfigurationMetadataRepository configRepository = ConfigurationMetadataRepositoryJsonBuilder + .create(metadataInput).build(); + Map allProperties = configRepository + .getAllProperties(); + + List tables = createConfigTables(allProperties, options); + + for (ConfigurationTable table : tables) { + Path outputFilePath = outputDirPath.resolve(table.getId() + ".adoc"); + Files.deleteIfExists(outputFilePath); + Files.createFile(outputFilePath); + try (OutputStream outputStream = Files.newOutputStream(outputFilePath)) { + outputStream + .write(table.toAsciidocTable().getBytes(StandardCharsets.UTF_8)); + } + } + } + + private List createConfigTables( + Map allProperties, + DocumentOptions options) { + + final List tables = new ArrayList<>(); + final List unmappedKeys = allProperties.values().stream() + .filter((prop) -> !prop.isDeprecated()).map((prop) -> prop.getId()) + .collect(Collectors.toList()); + + final Map overrides = getOverrides(allProperties, + unmappedKeys, options); + + options.getMetadataSections().forEach((id, keyPrefixes) -> { + ConfigurationTable table = new ConfigurationTable(id); + tables.add(table); + for (String keyPrefix : keyPrefixes) { + List matchingOverrides = overrides.keySet().stream() + .filter((overrideKey) -> overrideKey.startsWith(keyPrefix)) + .collect(Collectors.toList()); + matchingOverrides.forEach((match) -> { + table.addEntry(overrides.remove(match)); + }); + } + List matchingKeys = unmappedKeys.stream() + .filter((key) -> keyPrefixes.stream().anyMatch(key::startsWith)) + .collect(Collectors.toList()); + for (String matchingKey : matchingKeys) { + ConfigurationMetadataProperty property = allProperties.get(matchingKey); + table.addEntry(new SingleKeyEntry(property)); + + } + unmappedKeys.removeAll(matchingKeys); + }); + + if (!unmappedKeys.isEmpty()) { + throw new IllegalStateException( + "The following keys were not written to the documentation: " + + String.join(", ", unmappedKeys)); + } + if (!overrides.isEmpty()) { + throw new IllegalStateException( + "The following keys were not written to the documentation: " + + String.join(", ", overrides.keySet())); + } + + return tables; + } + + private Map getOverrides( + Map allProperties, + List unmappedKeys, DocumentOptions options) { + final Map overrides = new HashMap<>(); + + options.getOverrides().forEach((keyPrefix, description) -> { + final CompoundKeyEntry entry = new CompoundKeyEntry(keyPrefix, description); + List matchingKeys = unmappedKeys.stream() + .filter((key) -> key.startsWith(keyPrefix)) + .collect(Collectors.toList()); + for (String matchingKey : matchingKeys) { + entry.addConfigurationKeys(allProperties.get(matchingKey)); + } + overrides.put(keyPrefix, entry); + unmappedKeys.removeAll(matchingKeys); + }); + return overrides; + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationTable.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationTable.java new file mode 100644 index 0000000000..828ad7bfc9 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationTable.java @@ -0,0 +1,61 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import java.util.Arrays; +import java.util.Set; +import java.util.TreeSet; + +/** + * Asciidoctor table listing configuration properties sharing to a common theme. + * + * @author Brian Clozel + */ +class ConfigurationTable { + + private static final String NEWLINE = System.lineSeparator(); + + private final String id; + + private final Set entries; + + ConfigurationTable(String id) { + this.id = id; + this.entries = new TreeSet<>(); + } + + public String getId() { + return this.id; + } + + void addEntry(AbstractConfigurationEntry... entries) { + this.entries.addAll(Arrays.asList(entries)); + } + + String toAsciidocTable() { + final StringBuilder builder = new StringBuilder(); + builder.append("[cols=\"1,1,2\", options=\"header\"]").append(NEWLINE); + builder.append("|===").append(NEWLINE).append("|Key|Default Value|Description") + .append(NEWLINE).append(NEWLINE); + this.entries.forEach((entry) -> { + entry.writeAsciidoc(builder); + builder.append(NEWLINE); + }); + return builder.append("|===").append(NEWLINE).toString(); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/DocumentOptions.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/DocumentOptions.java new file mode 100644 index 0000000000..5d2561196c --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/DocumentOptions.java @@ -0,0 +1,98 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * Options for generating documentation for configuration properties. + * + * @author Brian Clozel + */ +public final class DocumentOptions { + + private final Map> metadataSections; + + private final Map overrides; + + private DocumentOptions(Map> metadataSections, + Map overrides) { + this.metadataSections = metadataSections; + this.overrides = overrides; + } + + Map> getMetadataSections() { + return this.metadataSections; + } + + Map getOverrides() { + return this.overrides; + } + + static Builder builder() { + return new Builder(); + } + + /** + * Builder for DocumentOptions. + */ + public static class Builder { + + Map> metadataSections = new HashMap<>(); + + Map overrides = new HashMap<>(); + + SectionSpec addSection(String name) { + return new SectionSpec(this, name); + } + + Builder addOverride(String keyPrefix, String description) { + this.overrides.put(keyPrefix, description); + return this; + } + + DocumentOptions build() { + return new DocumentOptions(this.metadataSections, this.overrides); + } + + } + + /** + * Configuration for a documentation section listing properties for a specific theme. + */ + public static class SectionSpec { + + private final String name; + + private final Builder builder; + + SectionSpec(Builder builder, String name) { + this.builder = builder; + this.name = name; + } + + Builder withKeyPrefixes(String... keyPrefixes) { + this.builder.metadataSections.put(this.name, Arrays.asList(keyPrefixes)); + return this.builder; + } + + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleKeyEntry.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleKeyEntry.java new file mode 100644 index 0000000000..8a6a28db1d --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleKeyEntry.java @@ -0,0 +1,83 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import java.util.Arrays; +import java.util.stream.Collectors; + +import org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty; + +/** + * Table entry containing a single configuration property. + * + * @author Brian Clozel + */ +class SingleKeyEntry extends AbstractConfigurationEntry { + + private String defaultValue; + + private String description; + + SingleKeyEntry(ConfigurationMetadataProperty property) { + + this.key = property.getId(); + if (property.getType() != null + && property.getType().startsWith("java.util.Map")) { + this.key += ".*"; + } + + this.description = property.getDescription(); + + if (property.getDefaultValue() != null) { + if (property.getDefaultValue().getClass().isArray()) { + this.defaultValue = Arrays.stream((Object[]) property.getDefaultValue()) + .map(Object::toString).collect(Collectors.joining("," + NEWLINE)); + } + else { + this.defaultValue = property.getDefaultValue().toString(); + } + } + } + + @Override + public void writeAsciidoc(StringBuilder builder) { + builder.append("|`+").append(this.key).append("+`").append(NEWLINE); + String defaultValue = processDefaultValue(); + if (defaultValue.length() > 0) { + builder.append("|`+").append(defaultValue).append("+`").append(NEWLINE); + } + else { + builder.append("|").append(NEWLINE); + } + if (this.description != null) { + builder.append("|+++").append(this.description).append("+++"); + } + else { + builder.append("|"); + } + builder.append(NEWLINE); + } + + private String processDefaultValue() { + if (this.defaultValue != null && this.defaultValue.length() > 0) { + return this.defaultValue.replace("\\", "\\\\").replace("|", + "{vbar}" + NEWLINE); + } + return ""; + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/CompoundKeyEntryTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/CompoundKeyEntryTests.java new file mode 100644 index 0000000000..9cd6172677 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/CompoundKeyEntryTests.java @@ -0,0 +1,57 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import org.junit.Test; + +import org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * @author Brian Clozel + */ +public class CompoundKeyEntryTests { + + private static String NEWLINE = System.lineSeparator(); + + @Test + public void simpleProperty() { + ConfigurationMetadataProperty firstProp = new ConfigurationMetadataProperty(); + firstProp.setId("spring.test.first"); + firstProp.setType("java.lang.String"); + + ConfigurationMetadataProperty secondProp = new ConfigurationMetadataProperty(); + secondProp.setId("spring.test.second"); + secondProp.setType("java.lang.String"); + + ConfigurationMetadataProperty thirdProp = new ConfigurationMetadataProperty(); + thirdProp.setId("spring.test.third"); + thirdProp.setType("java.lang.String"); + + CompoundKeyEntry entry = new CompoundKeyEntry("spring.test", + "This is a description."); + entry.addConfigurationKeys(firstProp, secondProp, thirdProp); + StringBuilder builder = new StringBuilder(); + entry.writeAsciidoc(builder); + + assertThat(builder.toString()).isEqualTo("|`+++spring.test.first" + NEWLINE + + "spring.test.second" + NEWLINE + "spring.test.third" + NEWLINE + "+++`" + + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/ConfigurationTableTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/ConfigurationTableTests.java new file mode 100644 index 0000000000..6b09185dcc --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/ConfigurationTableTests.java @@ -0,0 +1,61 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import org.junit.Test; + +import org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * @author Brian Clozel + */ +public class ConfigurationTableTests { + + private static String NEWLINE = System.lineSeparator(); + + @Test + public void simpleTable() { + ConfigurationTable table = new ConfigurationTable("test"); + + ConfigurationMetadataProperty first = new ConfigurationMetadataProperty(); + first.setId("spring.test.prop"); + first.setDefaultValue("something"); + first.setDescription("This is a description."); + first.setType("java.lang.String"); + + ConfigurationMetadataProperty second = new ConfigurationMetadataProperty(); + second.setId("spring.test.other"); + second.setDefaultValue("other value"); + second.setDescription("This is another description."); + second.setType("java.lang.String"); + + table.addEntry(new SingleKeyEntry(first)); + table.addEntry(new SingleKeyEntry(second)); + + assertThat(table.toAsciidocTable()) + .isEqualTo("[cols=\"1,1,2\", options=\"header\"]" + NEWLINE + "|===" + + NEWLINE + "|Key|Default Value|Description" + NEWLINE + NEWLINE + + "|`+spring.test.other+`" + NEWLINE + "|`+other value+`" + + NEWLINE + "|+++This is another description.+++" + NEWLINE + + NEWLINE + "|`+spring.test.prop+`" + NEWLINE + "|`+something+`" + + NEWLINE + "|+++This is a description.+++" + NEWLINE + NEWLINE + + "|===" + NEWLINE); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleKeyEntryTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleKeyEntryTests.java new file mode 100644 index 0000000000..2acafd3c96 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleKeyEntryTests.java @@ -0,0 +1,130 @@ +/* + * Copyright 2012-2019 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.configurationdocs; + +import org.junit.Test; + +import org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * @author Brian Clozel + */ +public class SingleKeyEntryTests { + + private static String NEWLINE = System.lineSeparator(); + + @Test + public void simpleProperty() { + ConfigurationMetadataProperty property = new ConfigurationMetadataProperty(); + property.setId("spring.test.prop"); + property.setDefaultValue("something"); + property.setDescription("This is a description."); + property.setType("java.lang.String"); + + SingleKeyEntry entry = new SingleKeyEntry(property); + StringBuilder builder = new StringBuilder(); + entry.writeAsciidoc(builder); + + assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + + "|`+something+`" + NEWLINE + "|+++This is a description.+++" + NEWLINE); + } + + @Test + public void noDefaultValue() { + ConfigurationMetadataProperty property = new ConfigurationMetadataProperty(); + property.setId("spring.test.prop"); + property.setDescription("This is a description."); + property.setType("java.lang.String"); + + SingleKeyEntry entry = new SingleKeyEntry(property); + StringBuilder builder = new StringBuilder(); + entry.writeAsciidoc(builder); + + assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|" + + NEWLINE + "|+++This is a description.+++" + NEWLINE); + } + + @Test + public void defaultValueWithPipes() { + ConfigurationMetadataProperty property = new ConfigurationMetadataProperty(); + property.setId("spring.test.prop"); + property.setDefaultValue("first|second"); + property.setDescription("This is a description."); + property.setType("java.lang.String"); + + SingleKeyEntry entry = new SingleKeyEntry(property); + StringBuilder builder = new StringBuilder(); + entry.writeAsciidoc(builder); + + assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + + "|`+first{vbar}" + NEWLINE + "second+`" + NEWLINE + + "|+++This is a description.+++" + NEWLINE); + } + + @Test + public void defaultValueWithBackslash() { + ConfigurationMetadataProperty property = new ConfigurationMetadataProperty(); + property.setId("spring.test.prop"); + property.setDefaultValue("first\\second"); + property.setDescription("This is a description."); + property.setType("java.lang.String"); + + SingleKeyEntry entry = new SingleKeyEntry(property); + StringBuilder builder = new StringBuilder(); + entry.writeAsciidoc(builder); + + assertThat(builder.toString()) + .isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\\\second+`" + + NEWLINE + "|+++This is a description.+++" + NEWLINE); + } + + @Test + public void mapProperty() { + ConfigurationMetadataProperty property = new ConfigurationMetadataProperty(); + property.setId("spring.test.prop"); + property.setDescription("This is a description."); + property.setType("java.util.Map"); + + SingleKeyEntry entry = new SingleKeyEntry(property); + StringBuilder builder = new StringBuilder(); + entry.writeAsciidoc(builder); + + assertThat(builder.toString()).isEqualTo("|`+spring.test.prop.*+`" + NEWLINE + "|" + + NEWLINE + "|+++This is a description.+++" + NEWLINE); + } + + @Test + public void listProperty() { + String[] defaultValue = new String[] { "first", "second", "third" }; + ConfigurationMetadataProperty property = new ConfigurationMetadataProperty(); + property.setId("spring.test.prop"); + property.setDescription("This is a description."); + property.setType("java.util.List"); + property.setDefaultValue(defaultValue); + + SingleKeyEntry entry = new SingleKeyEntry(property); + StringBuilder builder = new StringBuilder(); + entry.writeAsciidoc(builder); + + assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + + "|`+first," + NEWLINE + "second," + NEWLINE + "third+`" + NEWLINE + + "|+++This is a description.+++" + NEWLINE); + } + +}