Common Application properties
Various properties can be specified inside your application.properties
file, inside your application.yml
file, or as command line switches. This appendix provides a list of common Spring Boot properties and references to the underlying classes that consume them.
1. Core properties
Key | Default Value | Description |
---|---|---|
|
| Enable debug logs. |
| Arbitrary properties to add to the info endpoint. | |
| Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback. | |
|
| Conversion word used when logging exceptions. |
|
| Whether to clean the archive log files on startup. Only supported with the default logback setup. |
|
| Maximum number of days archive log files are kept. Only supported with the default logback setup. |
|
| Maximum log file size. Only supported with the default logback setup. |
| Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory. | |
| Location of the log file. For instance, `/var/log`. | |
|
| Total size of log backups to be kept. Only supported with the default logback setup. |
| Log groups to quickly change multiple loggers at the same time. For instance, `logging.group.db=org.hibernate,org.springframework.jdbc`. | |
| Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`. | |
|
| Appender pattern for output to the console. Supported only with the default Logback setup. |
|
| Appender pattern for log date format. Supported only with the default Logback setup. |
|
| Appender pattern for output to a file. Supported only with the default Logback setup. |
|
| Appender pattern for log level. Supported only with the default Logback setup. |
|
| Pattern for rolled-over log file names. Supported only with the default Logback setup. |
|
| Register a shutdown hook for the logging system when it is initialized. |
|
| Add @EnableAspectJAutoProxy. |
|
| Whether subclass-based (CGLIB) proxies are to be created (true), as opposed to standard Java interface-based proxies (false). |
|
| Whether to enable admin features for the application. |
|
| JMX name of the application admin MBean. |
| Application name. | |
| Auto-configuration classes to exclude. | |
|
| Banner file encoding. |
|
| The bit depth to use for ANSI colors. Supported values are 4 (16 color) or 8 (256 color). |
| Height of the banner image in chars (default based on image height). | |
|
| Whether images should be inverted for dark terminal themes. |
|
| Banner image file location (jpg or png can also be used). |
|
| Left hand image margin in chars. |
|
| The pixel mode to use when rendering the image. |
|
| Width of the banner image in chars. |
|
| Banner text resource location. |
|
| Whether to skip search of BeanInfo classes. |
| Limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated. By default this is not set, in which case individual codec defaults apply. Most codecs are limited to 256K by default. | |
| Config file locations used in addition to the defaults. | |
| Config file locations that replace the defaults. | |
|
| Config file name. |
|
| File encoding. |
|
| Location of the generated build-info.properties file. |
|
| File encoding. |
|
| |
| JMX domain name. | |
|
| Expose management beans to the JMX domain. |
|
| MBeanServer bean name. |
|
| Whether unique runtime object names should be ensured. |
|
| Whether bean definition overriding, by registering a definition with the same name as an existing definition, is allowed. |
|
| Mode used to display the banner when the application runs. |
|
| Whether initialization should be performed lazily. |
|
| Whether to log information about the application when it starts. |
|
| Whether the application should have a shutdown hook registered. |
| Sources (class names, package names, or XML resource locations) to include in the ApplicationContext. | |
| Flag to explicitly request a specific type of web application. If not set, auto-detected based on the classpath. | |
| Expected character encoding the application must use. | |
|
| Whether to always apply the MessageFormat rules, parsing even messages without arguments. |
|
| Comma-separated list of basenames (essentially a fully-qualified classpath location), each following the ResourceBundle convention with relaxed support for slash based locations. If it doesn't contain a package qualifier (such as "org.mypackage"), it will be resolved from the classpath root. |
| Loaded resource bundle files cache duration. When not set, bundles are cached forever. If a duration suffix is not specified, seconds will be used. | |
|
| Message bundles encoding. |
|
| Whether to fall back to the system Locale if no files for a specific Locale have been found. if this is turned off, the only fallback will be the default file (e.g. "messages.properties" for basename "messages"). |
|
| Whether to use the message code as the default message instead of throwing a "NoSuchMessageException". Recommended during development only. |
|
| Configures the ANSI output. |
| Fails if ApplicationPidFileWriter is used but it cannot write the PID file. | |
| Location of the PID file to write (if ApplicationPidFileWriter is used). | |
| Comma-separated list of profile expressions that at least one should match for the document to be included. | |
| Comma-separated list of active profiles. Can be overridden by a command line switch. | |
| Unconditionally activate the specified comma-separated list of profiles (or list of profiles if using YAML). | |
|
| Whether to automatically start the scheduler after initialization. |
|
| Prefixes for single-line comments in SQL initialization scripts. |
|
| Database schema initialization mode. |
|
| Path to the SQL file to use to initialize the database schema. |
|
| Quartz job store type. |
|
| Whether configured jobs should overwrite existing job definitions. |
| Additional Quartz Scheduler properties. | |
|
| Name of the scheduler. |
|
| Delay after which the scheduler is started once initialization completes. Setting this property makes sense if no jobs should be run before the entire application has started up. |
|
| Whether to wait for running jobs to complete on shutdown. |
|
| Whether the Reactor Debug Agent should be enabled when reactor-tools is present. |
|
| Whether core threads are allowed to time out. This enables dynamic growing and shrinking of the pool. |
|
| Core number of threads. |
|
| Time limit for which threads may remain idle before being terminated. |
| 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. | |
| Queue capacity. An unbounded capacity does not increase the pool and therefore ignores the "max-size" property. | |
|
| Whether the executor should wait for scheduled tasks to complete on shutdown. |
| Maximum time the executor should wait for remaining tasks to complete. | |
|
| Prefix to use for the names of newly created threads. |
|
| Maximum allowed number of threads. |
|
| Whether the executor should wait for scheduled tasks to complete on shutdown. |
| Maximum time the executor should wait for remaining tasks to complete. | |
|
| Prefix to use for the names of newly created threads. |
|
| Enable trace logs. |
2. Cache properties
Key | Default Value | Description |
---|---|---|
| Comma-separated list of cache names to create if supported by the underlying cache manager. Usually, this disables the ability to create additional caches on-the-fly. | |
| The spec to use to create caches. See CaffeineSpec for more details on the spec format. | |
| Entry expiration. By default the entries never expire. Note that this value is ultimately converted to seconds. | |
| The location of the configuration file to use to initialize EhCache. | |
| The location of the configuration file to use to initialize Infinispan. | |
| The location of the configuration file to use to initialize the cache manager. The configuration file is dependent of the underlying cache implementation. | |
| 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. | |
|
| Allow caching null values. |
| Key prefix. | |
| Entry expiration. By default the entries never expire. | |
|
| Whether to use the key prefix when writing to Redis. |
| Cache type. By default, auto-detected according to the environment. |
3. Mail properties
Key | Default Value | Description |
---|---|---|
|
| Default MimeMessage encoding. |
| SMTP server host. For instance, `smtp.example.com`. | |
| Session JNDI name. When set, takes precedence over other Session settings. | |
| Login password of the SMTP server. | |
| SMTP server port. | |
| Additional JavaMail Session properties. | |
|
| Protocol used by the SMTP server. |
|
| Whether to test that the mail server is available on startup. |
| Login user of the SMTP server. | |
| SendGrid API key. | |
| SendGrid proxy host. | |
| SendGrid proxy port. |
4. JSON properties
Key | Default Value | Description |
---|---|---|
| Format to use when serializing Date objects. | |
| Whether to disable the escaping of HTML characters such as '<', '>', etc. | |
| Whether to exclude inner classes during serialization. | |
| Whether to enable serialization of complex map keys (i.e. non-primitives). | |
| Whether to exclude all fields from consideration for serialization or deserialization that do not have the "Expose" annotation. | |
| Naming policy that should be applied to an object's field during serialization and deserialization. | |
| Whether to generate non executable JSON by prefixing the output with some special text. | |
| Whether to be lenient about parsing JSON that doesn't conform to RFC 4627. | |
| Serialization policy for Long and long types. | |
| Whether to output serialized JSON that fits in a page for pretty printing. | |
| Whether to serialize null fields. | |
| Date format string or a fully-qualified date format class name. For instance, `yyyy-MM-dd HH:mm:ss`. | |
| Controls the inclusion of properties during serialization. Configured with one of the values in Jackson's JsonInclude.Include enumeration. | |
| Jackson on/off features that affect the way Java objects are deserialized. | |
| Jackson on/off features for generators. | |
| Locale used for formatting. | |
| Jackson general purpose on/off features. | |
| Jackson on/off features for parsers. | |
| One of the constants on Jackson's PropertyNamingStrategy. Can also be a fully-qualified class name of a PropertyNamingStrategy subclass. | |
| Jackson on/off features that affect the way Java objects are serialized. | |
| Time zone used when formatting dates. For instance, "America/Los_Angeles" or "GMT+10". | |
| Jackson visibility thresholds that can be used to limit which methods (and fields) are auto-detected. |
5. Data properties
Key | Default Value | Description |
---|---|---|
| Couchbase nodes (host or IP address) to bootstrap from. | |
|
| Name of the bucket to connect to. |
| Password of the bucket. | |
|
| Number of sockets per node against the key/value service. |
|
| Maximum number of sockets per node. |
|
| Minimum number of sockets per node. |
|
| Maximum number of sockets per node. |
|
| Minimum number of sockets per node. |
| Whether to enable SSL support. Enabled automatically if a "keyStore" is provided unless specified otherwise. | |
| Path to the JVM key store that holds the certificates. | |
| Password used to access the key store. | |
|
| Bucket connections timeouts. |
|
| Blocking operations performed on a specific key timeout. |
|
| N1QL query operations timeout. |
|
| Socket connect connections timeout. |
|
| Regular and geospatial view operations timeout. |
| Cluster password when using role based access. | |
| Cluster username when using role based access. | |
|
| Whether to enable the PersistenceExceptionTranslationPostProcessor. |
| Name of the Cassandra cluster. | |
|
| Compression supported by the Cassandra binary protocol. |
| Socket option: connection time out. | |
| Queries consistency level. | |
|
| Cluster node addresses. |
| Queries default fetch size. | |
|
| Whether to enable JMX reporting. Default to false as Cassandra JMX reporting is not compatible with Dropwizard Metrics. |
| Keyspace name to use. | |
| Login password of the server. | |
|
| 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. |
|
| Idle timeout before an idle connection is removed. If a duration suffix is not specified, seconds will be used. |
|
| Maximum number of requests that get queued if no connection is available. |
|
| Pool timeout when trying to acquire a connection from a host's pool. |
| Port of the Cassandra server. | |
| Socket option: read time out. | |
|
| Type of Cassandra repositories to enable. |
|
| Schema action to take at startup. |
| Queries serial consistency level. | |
|
| Enable SSL support. |
| Login user of the server. | |
|
| Automatically create views and indexes. Use the meta-data provided by "@ViewIndexed", "@N1qlPrimaryIndexed" and "@N1qlSecondaryIndexed". |
|
| Consistency to apply by default on generated queries. |
|
| Type of Couchbase repositories to enable. |
| Connection timeout. | |
| Comma-separated list of the Elasticsearch endpoints to connect to. | |
| Credentials password. | |
| Read and Write Socket timeout. | |
|
| Whether the client should use SSL to connect to the endpoints. |
| Credentials username. | |
|
| Whether to enable Elasticsearch repositories. |
|
| Whether to enable JDBC repositories. |
|
| Bootstrap mode for JPA repositories. |
|
| Whether to enable JPA repositories. |
|
| Whether to enable LDAP repositories. |
| Authentication database name. | |
| Whether to enable auto-index creation. | |
| Database name. | |
| Fully qualified name of the FieldNamingStrategy to use. | |
| GridFS database name. | |
| Mongo server host. Cannot be set with URI. | |
| Login password of the mongo server. Cannot be set with URI. | |
| Mongo server port. Cannot be set with URI. | |
|
| Type of Mongo repositories to enable. |
|
| Mongo database URI. Cannot be set with host, port and credentials. |
| Login user of the mongo server. Cannot be set with URI. | |
|
| Auto index mode. |
|
| Whether to enable embedded mode if the embedded driver is available. |
|
| Register OpenSessionInViewInterceptor. Binds a Neo4j Session to the thread for the entire processing of the request.", |
| Login password of the server. | |
|
| Whether to enable Neo4j repositories. |
| URI used by the driver. Auto-detected by default. | |
|
| Whether to use Neo4j native types wherever possible. |
| Login user of the server. | |
|
| Whether to enable Redis repositories. |
| Base path to be used by Spring Data REST to expose repository resources. | |
| Content type to use as a default when none is specified. | |
| Default size of pages. | |
|
| |
| Whether to enable enum value translation through the Spring Data REST default resource bundle. | |
| Name of the URL query string parameter that indicates how many results to return at once. | |
| Maximum size of pages. | |
| Name of the URL query string parameter that indicates what page to return. | |
| Whether to return a response body after creating an entity. | |
| Whether to return a response body after updating an entity. | |
| Name of the URL query string parameter that indicates what direction to sort results. | |
|
| Solr host. Ignored if "zk-host" is set. |
|
| Whether to enable Solr repositories. |
| ZooKeeper host address in the form HOST:PORT. | |
|
| Default page size. |
|
| Maximum page size to be accepted. |
|
| Whether to expose and assume 1-based page number indexes. Defaults to "false", meaning a page number of 0 in the request equals the first page. |
|
| Page index parameter name. |
| General prefix to be prepended to the page number and page size parameters. | |
|
| Delimiter to be used between the qualifier and the actual page number and size properties. |
|
| Page size parameter name. |
|
| Sort parameter name. |
|
| Whether to stop if an error occurs while initializing the database. |
| Data (DML) script resource references. | |
| Password of the database to execute DML scripts (if different). | |
| Username of the database to execute DML scripts (if different). | |
| Commons DBCP2 specific settings | |
| Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. | |
|
| Whether to generate a random datasource name. |
| Hikari specific settings | |
|
| |
| JNDI location of the datasource. Class, url, username & password are ignored when set. | |
| Name of the datasource. Default to "testdb" when using an embedded database. | |
| Login password of the database. | |
|
| Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or data-${platform}.sql). |
| Schema (DDL) script resource references. | |
| Password of the database to execute DDL scripts (if different). | |
| Username of the database to execute DDL scripts (if different). | |
|
| Statement separator in SQL initialization scripts. |
| SQL scripts encoding. | |
| Tomcat datasource specific settings | |
| Fully qualified name of the connection pool implementation to use. By default, it is auto-detected from the classpath. | |
| JDBC URL of the database. | |
| Login username of the database. | |
| XA datasource fully qualified name. | |
| Properties to pass to the XA data source. | |
|
| Connection timeout. |
|
| Whether to enable connection requests from multiple execution threads. |
| Login password. | |
| Proxy host the HTTP client should use. | |
| Proxy port the HTTP client should use. | |
|
| Read timeout. |
| Login username. | |
|
| Connection timeout. |
| Credentials password. | |
|
| Read timeout. |
|
| |
| Credentials username. | |
|
| Whether to enable the console. |
|
| Path at which the console is available. |
|
| Whether to enable trace output. |
|
| Whether to enable remote access. |
| Login password. | |
| URL of the InfluxDB instance to which to connect. | |
| Login user. | |
|
| Number of rows that should be fetched from the database when more rows are needed. Use -1 to use the JDBC driver's default configuration. |
|
| Maximum number of rows. Use -1 to use the JDBC driver's default configuration. |
| Query timeout. Default is to use the JDBC driver's default configuration. If a duration suffix is not specified, seconds will be used. | |
| SQL dialect to use. Auto-detected by default. | |
| Target database to operate on, auto-detected by default. Can be alternatively set using the "databasePlatform" property. | |
| Name of the target database to operate on, auto-detected by default. Can be alternatively set using the "Database" enum. | |
|
| Whether to initialize the schema on startup. |
| 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". | |
| Fully qualified name of the implicit naming strategy. | |
| Fully qualified name of the physical naming strategy. | |
| Whether to use Hibernate's newer IdentifierGenerator for AUTO, TABLE and SEQUENCE. This is actually a shortcut for the "hibernate.id.new_generator_mappings" property. When not specified will default to "true". | |
| Mapping resources (equivalent to "mapping-file" entries in persistence.xml). | |
|
| Register OpenEntityManagerInViewInterceptor. Binds a JPA EntityManager to the thread for the entire processing of the request. |
| Additional native properties to set on the JPA provider. | |
|
| Whether to enable logging of SQL statements. |
|
| |
| Directory used for data storage. | |
| Maximum size of the oplog. | |
| Name of the replica set. | |
|
| Version of Mongo to use. |
| Client name to be set on connections with CLIENT SETNAME. | |
| Maximum number of redirects to follow when executing commands across the cluster. | |
| Comma-separated list of "host:port" pairs to bootstrap from. This represents an "initial" list of cluster nodes and is required to have at least one entry. | |
|
| Database index used by the connection factory. |
|
| Redis server host. |
|
| Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
|
| Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
|
| 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. |
|
| Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive. |
| Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed. | |
|
| Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
|
| Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
|
| 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. |
|
| Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive. |
| Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed. | |
|
| Shutdown timeout. |
| Login password of the redis server. | |
|
| Redis server port. |
| Name of the Redis server. | |
| Comma-separated list of "host:port" pairs. | |
|
| Whether to enable SSL support. |
| Connection timeout. | |
| Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:password@example.com:6379 |
6. Transaction properties
Key | Default Value | Description |
---|---|---|
|
| Timeout, in seconds, for borrowing connections from the pool. |
|
| Whether to ignore the transacted flag when creating session. |
|
| Whether local transactions are desired. |
|
| Time, in seconds, between runs of the pool's maintenance thread. |
|
| Time, in seconds, after which connections are cleaned up from the pool. |
|
| Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. |
|
| Maximum size of the pool. |
|
| Minimum size of the pool. |
|
| Reap timeout, in seconds, for borrowed connections. 0 denotes no limit. |
|
| Unique name used to identify the resource during recovery. |
| Vendor-specific implementation of XAConnectionFactory. | |
| Vendor-specific XA properties. | |
|
| Timeout, in seconds, for borrowing connections from the pool. |
|
| Whether to use concurrent connection validation. |
| Default isolation level of connections provided by the pool. | |
|
| Timeout, in seconds, for establishing a database connection. |
|
| Time, in seconds, between runs of the pool's maintenance thread. |
|
| Time, in seconds, after which connections are cleaned up from the pool. |
|
| Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. |
|
| Maximum size of the pool. |
|
| Minimum size of the pool. |
|
| Reap timeout, in seconds, for borrowed connections. 0 denotes no limit. |
| SQL query or statement used to validate a connection before returning it. | |
|
| Unique name used to identify the resource during recovery. |
| Vendor-specific implementation of XAConnectionFactory. | |
| Vendor-specific XA properties. | |
|
| Specify whether sub-transactions are allowed. |
|
| Interval between checkpoints, expressed as the number of log writes between two checkpoints. A checkpoint reduces the log file size at the expense of adding some overhead in the runtime. |
|
| Default timeout for JTA transactions. |
| How long should normal shutdown (no-force) wait for transactions to complete. | |
|
| Whether to enable disk logging. |
|
| Whether a VM shutdown should trigger forced shutdown of the transaction core. |
| Directory in which the log files should be stored. Defaults to the current working directory. | |
|
| Transactions log file base name. |
|
| Maximum number of active transactions. |
|
| Maximum timeout that can be allowed for transactions. |
|
| Delay between two recovery scans. |
|
| Delay after which recovery can cleanup pending ('orphaned') log entries. |
|
| Number of retry attempts to commit the transaction before throwing an exception. |
|
| Delay between retry attempts. |
|
| Whether sub-transactions should be joined when possible. |
| Transaction manager implementation that should be started. | |
|
| Whether to use different (and concurrent) threads for two-phase commit on the participating resources. |
| The transaction manager's unique name. Defaults to the machine's IP address. If you plan to run more than one transaction manager against one database you must set this property to a unique value. | |
|
| Number of connections to create when growing the pool. |
|
| Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired. |
|
| Timeout, in seconds, for acquiring connections from the pool. |
|
| Whether the transaction manager should allow mixing XA and non-XA transactions. |
|
| Whether the transaction timeout should be set on the XAResource when it is enlisted. |
|
| Whether resources should be enlisted and delisted automatically. |
|
| Whether producers and consumers should be cached. |
| Underlying implementation class name of the XA resource. | |
|
| Whether the provider can run many transactions on the same connection and supports transaction interleaving. |
|
| Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool. |
| Properties that should be set on the underlying implementation. | |
| ||
|
| Whether recovery failures should be ignored. |
|
| Time, in seconds, after which connections are cleaned up from the pool. |
|
| Maximum size of the pool. 0 denotes no limit. |
|
| Minimum size of the pool. |
| Password to use to connect to the JMS provider. | |
|
| Whether connections in the ACCESSIBLE state can be shared within the context of a transaction. |
|
| Whether connections should be tested when acquired from the pool. |
|
| Position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE). |
|
| Unique name used to identify the resource during recovery. |
|
| Whether TMJOIN should be used when starting XAResources. |
| User to use to connect to the JMS provider. | |
|
| Number of connections to create when growing the pool. |
|
| Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired. |
|
| Timeout, in seconds, for acquiring connections from the pool. |
|
| Whether the transaction manager should allow mixing XA and non-XA transactions. |
|
| Whether the transaction timeout should be set on the XAResource when it is enlisted. |
|
| Whether resources should be enlisted and delisted automatically. |
| Underlying implementation class name of the XA resource. | |
| Default cursor holdability for connections. | |
|
| Whether the database can run many transactions on the same connection and supports transaction interleaving. |
|
| Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool. |
| Properties that should be set on the underlying implementation. | |
|
| Whether Connection.isValid() is called when acquiring a connection from the pool. |
| ||
|
| Whether recovery failures should be ignored. |
| Default isolation level for connections. | |
| Default auto-commit mode for local transactions. | |
| Timeout, in seconds, for establishing a database connection. | |
|
| Time, in seconds, after which connections are cleaned up from the pool. |
|
| Maximum size of the pool. 0 denotes no limit. |
|
| Minimum size of the pool. |
|
| Target size of the prepared statement cache. 0 disables the cache. |
|
| Whether connections in the ACCESSIBLE state can be shared within the context of a transaction. |
| SQL query or statement used to validate a connection before returning it. | |
|
| Position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, and always last is Integer.MAX_VALUE). |
|
| Unique name used to identify the resource during recovery. |
|
| Whether TMJOIN should be used when starting XAResources. |
|
| Whether to allow multiple LRC resources to be enlisted into the same transaction. |
|
| Whether to enable asynchronously execution of two phase commit. |
|
| Interval in seconds at which to run the recovery process in the background. |
|
| Whether to recover only the current node. Should be enabled if you run multiple instances of the transaction manager on the same JMS and JDBC resources. |
|
| Whether to log the creation and commit call stacks of transactions executed without a single enlisted resource. |
|
| Default transaction timeout, in seconds. |
|
| Whether to enable JMX support. |
| Set the fully qualified name of the exception analyzer implementation to use. | |
|
| Whether to enable filtering of logs so that only mandatory logs are written. |
|
| Whether disk forces are batched. |
|
| Whether logs are forced to disk. |
|
| Maximum amount of seconds the TM waits for transactions to get done before aborting them at shutdown time. |
| JNDI name of the TransactionSynchronizationRegistry. | |
| JNDI name of the UserTransaction. | |
|
| Name of the journal. Can be 'disk', 'null', or a class name. |
|
| Name of the first fragment of the journal. |
|
| Name of the second fragment of the journal. |
|
| Maximum size in megabytes of the journal fragments. |
| ResourceLoader configuration file name. | |
| ASCII ID that must uniquely identify this TM instance. Defaults to the machine's IP address. | |
|
| Skip corrupted transactions log entries. Use only at last resort when all you have to recover is a pair of corrupted files. |
|
| Whether to log a warning for transactions executed without a single enlisted resource. |
|
| Whether to enable JTA support. |
| Transaction logs directory. | |
| Transaction manager unique identifier. | |
| Default transaction timeout. If a duration suffix is not specified, seconds will be used. | |
| Whether to roll back on commit failures. |
7. Data migration properties
Key | Default Value | Description |
---|---|---|
|
| Description to tag an existing schema with when applying a baseline. |
|
| Whether to automatically call baseline when migrating a non-empty schema. |
|
| Version to tag an existing schema with when executing baseline. |
| Whether to batch SQL statements when executing them. Requires Flyway Pro or Flyway Enterprise. | |
|
| Whether to check that migration scripts location exists. |
|
| Whether to disable cleaning of the database. |
|
| Whether to automatically call clean when a validation error occurs. |
|
| Maximum number of retries when attempting to connect to the database. |
|
| Whether to enable flyway. |
|
| Encoding of SQL migrations. |
| Rules for the built-in error handling to override specific SQL states and error codes. Requires Flyway Pro or Flyway Enterprise. | |
|
| Whether to group all pending migrations together in the same transaction when applying them. |
|
| Whether to ignore future migrations when reading the schema history table. |
|
| Whether to ignore ignored migrations when reading the schema history table. |
|
| Whether to ignore missing migrations when reading the schema history table. |
|
| Whether to ignore pending migrations when reading the schema history table. |
| SQL statements to execute to initialize a connection immediately after obtaining it. | |
| Username recorded in the schema history table as having applied the migration. | |
| Licence key for Flyway Pro or Flyway Enterprise. | |
|
| Locations of migrations scripts. Can contain the special "{vendor}" placeholder to use vendor-specific locations. |
|
| Whether to allow mixing transactional and non-transactional statements within the same migration. |
| Whether to enable support for Oracle SQL*Plus commands. Requires Flyway Pro or Flyway Enterprise. | |
| Whether to issue a warning rather than an error when a not-yet-supported Oracle SQL*Plus statement is encountered. Requires Flyway Pro or Flyway Enterprise. | |
|
| Whether to allow migrations to be run out of order. |
| Login password of the database to migrate. | |
|
| Prefix of placeholders in migration scripts. |
|
| Perform placeholder replacement in migration scripts. |
|
| Suffix of placeholders in migration scripts. |
| Placeholders and their replacements to apply to sql migration scripts. | |
|
| File name prefix for repeatable SQL migrations. |
| Scheme names managed by Flyway (case-sensitive). | |
|
| Whether to skip default callbacks. If true, only custom callbacks are used. |
|
| Whether to skip default resolvers. If true, only custom resolvers are used. |
|
| File name prefix for SQL migrations. |
|
| File name separator for SQL migrations. |
|
| File name suffix for SQL migrations. |
| Whether to stream SQL migrations when executing them. Requires Flyway Pro or Flyway Enterprise. | |
|
| Name of the schema history table that will be used by Flyway. |
| Tablespace in which the schema history table is created. Ignored when using a database that does not support tablespaces. Defaults to the default tablespace of the connection used by Flyway. | |
| Target version up to which migrations should be considered. | |
| JDBC url of the database to migrate. If not set, the primary configured data source is used. | |
| Login user of the database to migrate. | |
|
| Whether to automatically call validate when performing a migration. |
|
| Change log configuration path. |
| Comma-separated list of runtime contexts to use. | |
|
| Name of table to use for tracking concurrent Liquibase usage. |
|
| Name of table to use for tracking change history. |
| Default database schema. | |
|
| Whether to first drop the database schema. |
|
| Whether to enable Liquibase support. |
| Comma-separated list of runtime labels to use. | |
| Schema to use for Liquibase objects. | |
| Tablespace to use for Liquibase objects. | |
| Change log parameters. | |
| Login password of the database to migrate. | |
| File to which rollback SQL is written when an update is performed. | |
|
| Whether rollback should be tested before update is performed. |
| JDBC URL of the database to migrate. If not set, the primary configured data source is used. | |
| Login user of the database to migrate. |
8. Integration properties
Key | Default Value | Description |
---|---|---|
| URL of the ActiveMQ broker. Auto-generated by default. | |
|
| Time to wait before considering a close complete. |
|
| Whether the default broker URL should be in memory. Ignored if an explicit broker has been specified. |
|
| 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. |
| Whether to trust all packages. | |
| Comma-separated list of specific packages to trust (when not trusting all packages). | |
| Login password of the broker. | |
|
| Whether to block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead. |
|
| Blocking period before throwing an exception if the pool is still full. |
|
| Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. |
|
| Connection idle timeout. |
|
| Maximum number of pooled connections. |
|
| Maximum number of pooled sessions per connection in the pool. |
|
| Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs. |
|
| Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required. |
|
| Time to wait on message sends for a response. Set it to 0 to wait forever. |
| Login user of the broker. | |
| Cluster password. Randomly generated on startup by default. | |
| Journal file directory. Not necessary if persistence is turned off. | |
|
| Whether to enable embedded mode if the Artemis server APIs are available. |
|
| Whether to enable persistent store. |
| Comma-separated list of queues to create on startup. | |
|
| Server ID. By default, an auto-incremented counter is used. |
| Comma-separated list of topics to create on startup. | |
|
| Artemis broker host. |
| Artemis deployment mode, auto-detected by default. | |
| Login password of the broker. | |
|
| Whether to block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead. |
|
| Blocking period before throwing an exception if the pool is still full. |
|
| Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. |
|
| Connection idle timeout. |
|
| Maximum number of pooled connections. |
|
| Maximum number of pooled sessions per connection in the pool. |
|
| Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs. |
|
| Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required. |
|
| Artemis broker port. |
| Login user of the broker. | |
|
| Database schema initialization mode. |
|
| Execute all Spring Batch jobs in the context on startup. |
| Comma-separated list of job names to execute on startup (for instance, `job1,job2`). By default, all Jobs found in the context are executed. | |
|
| Path to the SQL file to use to initialize the database schema. |
| Table prefix for all the batch meta-data tables. | |
| The location of the configuration file to use to initialize Hazelcast. | |
|
| |
|
| Path to the SQL file to use to initialize the database schema. |
|
| Whether to cache message consumers. |
|
| Whether to cache sessions. |
|
| Whether to cache message producers. |
|
| Size of the session cache (per JMS Session type). |
| Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations. | |
| Acknowledge mode of the container. By default, the listener is transacted with automatic acknowledgment. | |
|
| Start the container automatically on startup. |
| Minimum number of concurrent consumers. | |
| Maximum number of concurrent consumers. | |
|
| Timeout to use for receive calls. Use -1 for a no-wait receive or 0 for no timeout at all. The latter is only feasible if not running within a transaction manager and is generally discouraged since it prevents clean shutdown. |
|
| Whether the default destination type is topic. |
| Default destination to use on send and receive operations that do not have a destination parameter. | |
| Delivery delay to use for send calls. | |
| Delivery mode. Enables QoS (Quality of Service) when set. | |
| Priority of a message when sending. Enables QoS (Quality of Service) when set. | |
| Whether to enable explicit QoS (Quality of Service) when sending a message. When enabled, the delivery mode, priority and time-to-live properties will be used when sending a message. QoS is automatically enabled when at least one of those settings is customized. | |
| Timeout to use for receive calls. | |
| Time-to-live of a message when sending. Enables QoS (Quality of Service) when set. | |
| ID to pass to the server when making requests. Used for server-side logging. | |
|
| Whether to fail fast if the broker is not available on startup. |
| Additional admin-specific properties used to configure the client. | |
| Password of the private key in the key store file. | |
| Location of the key store file. | |
| Store password for the key store file. | |
| Type of the key store. | |
| SSL protocol to use. | |
| Location of the trust store file. | |
| Store password for the trust store file. | |
| Type of the trust store. | |
| Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Applies to all components unless overridden. | |
| ID to pass to the server when making requests. Used for server-side logging. | |
| Frequency with which the consumer offsets are auto-committed to Kafka if 'enable.auto.commit' is set to true. | |
| What to do when there is no initial offset in Kafka or if the current offset no longer exists on the server. | |
| Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for consumers. | |
| ID to pass to the server when making requests. Used for server-side logging. | |
| Whether the consumer's offset is periodically committed in the background. | |
| 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". | |
| Minimum amount of data the server should return for a fetch request. | |
| Unique string that identifies the consumer group to which this consumer belongs. | |
| Expected time between heartbeats to the consumer coordinator. | |
| Isolation level for reading messages that have been written transactionally. | |
| Deserializer class for keys. | |
| Maximum number of records returned in a single call to poll(). | |
| Additional consumer-specific properties used to configure the client. | |
| Password of the private key in the key store file. | |
| Location of the key store file. | |
| Store password for the key store file. | |
| Type of the key store. | |
| SSL protocol to use. | |
| Location of the trust store file. | |
| Store password for the trust store file. | |
| Type of the trust store. | |
| Deserializer class for values. | |
|
| Control flag for login configuration. |
|
| Whether to enable JAAS configuration. |
|
| Login module. |
| Additional JAAS options. | |
| Number of records between offset commits when ackMode is "COUNT" or "COUNT_TIME". | |
| Listener AckMode. See the spring-kafka documentation. | |
| Time between offset commits when ackMode is "TIME" or "COUNT_TIME". | |
| Prefix for the listener's consumer client.id property. | |
| Number of threads to run in the listener containers. | |
| Time between publishing idle consumer events (no data received). | |
| Whether to log the container configuration during initialization (INFO level). | |
|
| Whether the container should fail to start if at least one of the configured topics are not present on the broker. |
| Time between checks for non-responsive consumers. If a duration suffix is not specified, seconds will be used. | |
| Multiplier applied to "pollTimeout" to determine if a consumer is non-responsive. | |
| Timeout to use when polling the consumer. | |
|
| Listener type. |
| Number of acknowledgments the producer requires the leader to have received before considering a request complete. | |
| Default batch size. A small batch size will make batching less common and may reduce throughput (a batch size of zero disables batching entirely). | |
| Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for producers. | |
| Total memory size the producer can use to buffer records waiting to be sent to the server. | |
| ID to pass to the server when making requests. Used for server-side logging. | |
| Compression type for all data generated by the producer. | |
| Serializer class for keys. | |
| Additional producer-specific properties used to configure the client. | |
| When greater than zero, enables retrying of failed sends. | |
| Password of the private key in the key store file. | |
| Location of the key store file. | |
| Store password for the key store file. | |
| Type of the key store. | |
| SSL protocol to use. | |
| Location of the trust store file. | |
| Store password for the trust store file. | |
| Type of the trust store. | |
| When non empty, enables transaction support for producer. | |
| Serializer class for values. | |
| Additional properties, common to producers and consumers, used to configure the client. | |
| Password of the private key in the key store file. | |
| Location of the key store file. | |
| Store password for the key store file. | |
| Type of the key store. | |
| SSL protocol to use. | |
| Location of the trust store file. | |
| Store password for the trust store file. | |
| Type of the trust store. | |
| Kafka streams application.id property; default spring.application.name. | |
|
| Whether or not to auto-start the streams factory bean. |
| Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for streams. | |
| Maximum memory size to be used for buffering across all threads. | |
| ID to pass to the server when making requests. Used for server-side logging. | |
| Additional Kafka properties used to configure the streams. | |
| The replication factor for change log topics and repartition topics created by the stream processing application. | |
| Password of the private key in the key store file. | |
| Location of the key store file. | |
| Store password for the key store file. | |
| Type of the key store. | |
| SSL protocol to use. | |
| Location of the trust store file. | |
| Store password for the trust store file. | |
| Type of the trust store. | |
| Directory location for the state store. | |
| Default topic to which messages are sent. | |
| Comma-separated list of addresses to which the client should connect. | |
| Duration to wait to obtain a channel if the cache size has been reached. If 0, always create a new channel. | |
| Number of channels to retain in the cache. When "check-timeout" > 0, max channels per connection. | |
|
| |
| Number of connections to cache. Only applies when mode is CONNECTION. | |
| Connection timeout. Set it to zero to wait forever. | |
|
| Whether to create an AmqpAdmin bean. |
|
| RabbitMQ host. |
| Acknowledge mode of container. | |
|
| Whether to start the container automatically on startup. |
| Number of consumers per queue. | |
| Whether rejected deliveries are re-queued by default. | |
| How often idle container events should be published. | |
|
| Whether to fail if the queues declared by the container are not available on the broker. |
| Maximum number of unacknowledged messages that can be outstanding at each consumer. | |
|
| Whether publishing retries are enabled. |
|
| Duration between the first and second attempt to deliver a message. |
|
| Maximum number of attempts to deliver a message. |
|
| Maximum duration between attempts. |
|
| Multiplier to apply to the previous retry interval. |
|
| Whether retries are stateless or stateful. |
| Acknowledge mode of container. | |
|
| Whether to start the container automatically on startup. |
| Batch size, expressed as the number of physical messages, to be used by the container. | |
| Minimum number of listener invoker threads. | |
| Whether rejected deliveries are re-queued by default. | |
| How often idle container events should be published. | |
| Maximum number of listener invoker threads. | |
|
| 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. |
| Maximum number of unacknowledged messages that can be outstanding at each consumer. | |
|
| Whether publishing retries are enabled. |
|
| Duration between the first and second attempt to deliver a message. |
|
| Maximum number of attempts to deliver a message. |
|
| Maximum duration between attempts. |
|
| Multiplier to apply to the previous retry interval. |
|
| Whether retries are stateless or stateful. |
|
| |
|
| Login to authenticate against the broker. |
|
| RabbitMQ port. |
| Type of publisher confirms to use. | |
|
| Whether to enable publisher returns. |
| Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used. | |
| SSL algorithm to use. By default, configured by the Rabbit client library. | |
|
| Whether to enable SSL support. |
| Path to the key store that holds the SSL certificate. | |
| Password used to access the key store. | |
|
| Key store type. |
| Trust store that holds SSL certificates. | |
| Password used to access the trust store. | |
|
| Trust store type. |
|
| Whether to enable server side certificate validation. |
|
| Whether to enable hostname verification. |
| Name of the default queue to receive messages from when none is specified explicitly. | |
| Name of the default exchange to use for send operations. | |
| Whether to enable mandatory messages. | |
| Timeout for `receive()` operations. | |
| Timeout for `sendAndReceive()` operations. | |
|
| Whether publishing retries are enabled. |
|
| Duration between the first and second attempt to deliver a message. |
|
| Maximum number of attempts to deliver a message. |
|
| Maximum duration between attempts. |
|
| Multiplier to apply to the previous retry interval. |
| Value of a default routing key to use for send operations. | |
|
| Login user to authenticate to the broker. |
| Virtual host to use when connecting to the broker. | |
|
| Path that serves as the base URI for the services. |
| Servlet init parameters to pass to Spring Web Services. | |
|
| Load on startup priority of the Spring Web Services servlet. |
| Comma-separated list of locations of WSDLs and accompanying XSDs to be exposed as beans. |