This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 9c66be0670a110a158c219f2952ce0041c8ff188 Author: Claus Ibsen <[email protected]> AuthorDate: Wed Aug 1 14:39:19 2018 +0200 CAMEL-12702: Improved spring boot docs --- .../src/main/docs/spring-boot.adoc | 34 ++++---- .../spring/boot/CamelConfigurationProperties.java | 91 ++++++++++------------ 2 files changed, 57 insertions(+), 68 deletions(-) diff --git a/components/camel-spring-boot/src/main/docs/spring-boot.adoc b/components/camel-spring-boot/src/main/docs/spring-boot.adoc index 2607825..6cbf379 100644 --- a/components/camel-spring-boot/src/main/docs/spring-boot.adoc +++ b/components/camel-spring-boot/src/main/docs/spring-boot.adoc @@ -140,11 +140,11 @@ The component supports 139 options, which are listed below. | *camel.springboot.duration-max-messages* | To specify how many messages to process by Camel before automatic terminating the JVM. You can use this to run Spring Boot for a short while. | 0 | Integer | *camel.springboot.duration-max-seconds* | To specify for how long time in seconds to keep running the JVM before automatic terminating the JVM. You can use this to run Spring Boot for a short while. | 0 | Integer | *camel.springboot.endpoint-runtime-statistics-enabled* | Sets whether endpoint runtime statistics is enabled (gathers runtime usage of each incoming and outgoing endpoints). The default value is false. | false | Boolean -| *camel.springboot.file-configurations* | Directory to load additional configuration files that contains configuration values that takes precedence over any other configuration. This can be used to refer to files that may have secret configuration that has been mounted on the file system for containers. <p/> You must use either <tt>file:</tt> or <tt>classpath:</tt> as prefix to load from file system or classpath. Then you can specify a pattern to load from sub directories and a name pat [...] +| *camel.springboot.file-configurations* | Directory to load additional configuration files that contains configuration values that takes precedence over any other configuration. This can be used to refer to files that may have secret configuration that has been mounted on the file system for containers. You must use either file: or classpath: as prefix to load from file system or classpath. Then you can specify a pattern to load from sub directories and a name pattern such as file:/var/ [...] | *camel.springboot.handle-fault* | Sets whether fault handling is enabled or not. Default is false. | false | Boolean | *camel.springboot.include-non-singletons* | Whether to include non-singleton beans (prototypes) when scanning for RouteBuilder instances. By default only singleton beans is included in the context scan. | false | Boolean -| *camel.springboot.java-routes-exclude-pattern* | Used for exclusive filtering component scanning of RouteBuilder classes with @Component annotation. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. <p/> For example to exclude all classes starting with Bar use <tt>**/Bar*</tt>. To exclude all routes form a specific package use, <tt>com/mycompany/bar/*</tt> To exc [...] -| *camel.springboot.java-routes-include-pattern* | Used for inclusive filtering component scanning of RouteBuilder classes with @Component annotation. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. <p/> Multiple patterns can be specified separated by comma. For example to include all classes starting with Foo use <tt>**/Foo*</tt>. To include all routes form a specific package use, <tt>com/mycompany/foo/*</tt> To inc [...] +| *camel.springboot.java-routes-exclude-pattern* | Used for exclusive filtering component scanning of RouteBuilder classes with @Component annotation. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to exclude all classes starting with Bar use: **/Bar* To exclude all routes form a specific package use: com/mycompany/bar/* To exclude all routes form a [...] +| *camel.springboot.java-routes-include-pattern* | Used for inclusive filtering component scanning of RouteBuilder classes with @Component annotation. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to include all classes starting with Foo use: **/Foo* To include all routes form a specific package use: com/mycompany/foo/* To include all routes form a [...] | *camel.springboot.jmx-create-connector* | Whether JMX connector is created, allowing clients to connect remotely The default value is false. | false | Boolean | *camel.springboot.jmx-enabled* | Enable JMX in your Camel application. | true | Boolean | *camel.springboot.jmx-management-name-pattern* | The naming pattern for creating the CamelContext JMX management name. The default pattern is #name# | #name# | String @@ -158,22 +158,22 @@ The component supports 139 options, which are listed below. | *camel.springboot.name* | Sets the name of the CamelContext. | | String | *camel.springboot.producer-template-cache-size* | Producer template endpoints cache size. | 1000 | Integer | *camel.springboot.shutdown-log-inflight-exchanges-on-timeout* | Sets whether to log information about the inflight Exchanges which are still running during a shutdown which didn't complete without the given timeout. | true | Boolean -| *camel.springboot.shutdown-now-on-timeout* | Sets whether to force shutdown of all consumers when a timeout occurred and thus not all consumers was shutdown within that period. <p/> You should have good reasons to set this option to <tt>false</tt> as it means that the routes keep running and is halted abruptly when CamelContext has been shutdown. | true | Boolean +| *camel.springboot.shutdown-now-on-timeout* | Sets whether to force shutdown of all consumers when a timeout occurred and thus not all consumers was shutdown within that period. You should have good reasons to set this option to false as it means that the routes keep running and is halted abruptly when CamelContext has been shutdown. | true | Boolean | *camel.springboot.shutdown-routes-in-reverse-order* | Sets whether routes should be shutdown in reverse or the same order as they where started. | true | Boolean -| *camel.springboot.shutdown-suppress-logging-on-timeout* | Whether Camel should try to suppress logging during shutdown and timeout was triggered, meaning forced shutdown is happening. And during forced shutdown we want to avoid logging errors/warnings et all in the logs as a side-effect of the forced timeout. <p/> By default this is <tt>false</tt> <p/> Notice the suppress is a <i>best effort</i> as there may still be some logs coming from 3rd party libraries and whatnot, which Camel ca [...] +| *camel.springboot.shutdown-suppress-logging-on-timeout* | Whether Camel should try to suppress logging during shutdown and timeout was triggered, meaning forced shutdown is happening. And during forced shutdown we want to avoid logging errors/warnings et all in the logs as a side-effect of the forced timeout. Notice the suppress is a best effort as there may still be some logs coming from 3rd party libraries and whatnot, which Camel cannot control. This option is default false. | false [...] | *camel.springboot.shutdown-timeout* | Timeout in seconds to graceful shutdown Camel. | 300 | Integer -| *camel.springboot.stream-caching* | Sets whether stream caching is enabled or not. Default is false. @deprecated use {@link #streamCachingEnabled} | false | Boolean -| *camel.springboot.stream-caching-any-spool-rules* | Sets whether if just any of the {@link org.apache.camel.spi.StreamCachingStrategy.SpoolRule} rules returns <tt>true</tt> then shouldSpoolCache(long) returns <tt>true</tt>. If this option is <tt>false</tt>, then <b>all</b> the {@link org.apache.camel.spi.StreamCachingStrategy.SpoolRule} must return <tt>true</tt>. <p/> The default value is <tt>false</tt> which means that all the rules must return <tt>true</tt>. | false | Boolean -| *camel.springboot.stream-caching-buffer-size* | Sets the stream caching buffer size to use when allocating in-memory buffers used for in-memory stream caches. <p/> The default size is {@link org.apache.camel.util.IOHelper#DEFAULT_BUFFER_SIZE} | 0 | Integer +| *camel.springboot.stream-caching* | Sets whether stream caching is enabled or not. Default is false. | false | Boolean +| *camel.springboot.stream-caching-any-spool-rules* | Sets whether if just any of the org.apache.camel.spi.StreamCachingStrategy.SpoolRule rules returns true then shouldSpoolCache(long) returns true, to allow spooling to disk. If this option is false, then all the org.apache.camel.spi.StreamCachingStrategy.SpoolRule must return true. The default value is false which means that all the rules must return true. | false | Boolean +| *camel.springboot.stream-caching-buffer-size* | Sets the stream caching buffer size to use when allocating in-memory buffers used for in-memory stream caches. The default size is 4096. | 0 | Integer | *camel.springboot.stream-caching-enabled* | Sets whether stream caching is enabled or not. Default is false. | false | Boolean -| *camel.springboot.stream-caching-remove-spool-directory-when-stopping* | Whether to remove stream caching temporary directory when stopping. <p/> This option is default <tt>true</tt> | true | Boolean -| *camel.springboot.stream-caching-spool-chiper* | Sets a stream caching chiper name to use when spooling to disk to write with encryption. <p/> By default the data is not encrypted. | | String -| *camel.springboot.stream-caching-spool-directory* | Sets the stream caching spool (temporary) directory to use for overflow and spooling to disk. <p/> If no spool directory has been explicit configured, then a temporary directory is created in the <tt>java.io.tmpdir</tt> directory. | | String -| *camel.springboot.stream-caching-spool-threshold* | Stream caching threshold in bytes when overflow to disk is activated. <p/> The default threshold is {@link org.apache.camel.StreamCache#DEFAULT_SPOOL_THRESHOLD} bytes (eg 128kb). Use <tt>-1</tt> to disable overflow to disk. | 0 | Long +| *camel.springboot.stream-caching-remove-spool-directory-when-stopping* | Whether to remove stream caching temporary directory when stopping. This option is default true. | true | Boolean +| *camel.springboot.stream-caching-spool-chiper* | Sets a stream caching chiper name to use when spooling to disk to write with encryption. By default the data is not encrypted. | | String +| *camel.springboot.stream-caching-spool-directory* | Sets the stream caching spool (temporary) directory to use for overflow and spooling to disk. If no spool directory has been explicit configured, then a temporary directory is created in the java.io.tmpdir directory. | | String +| *camel.springboot.stream-caching-spool-threshold* | Stream caching threshold in bytes when overflow to disk is activated. The default threshold is 128kb. Use -1 to disable overflow to disk. | 0 | Long | *camel.springboot.stream-caching-spool-used-heap-memory-limit* | Sets what the upper bounds should be when streamCachingSpoolUsedHeapMemoryThreshold is in use. | | String | *camel.springboot.stream-caching-spool-used-heap-memory-threshold* | Sets a percentage (1-99) of used heap memory threshold to activate stream caching spooling to disk. | 0 | Integer | *camel.springboot.stream-caching-statistics-enabled* | Sets whether stream caching statistics is enabled. | false | Boolean -| *camel.springboot.thread-name-pattern* | Sets the thread name pattern used for creating the full thread name. <p/> The default pattern is: <tt>Camel (#camelId#) thread ##counter# - #name#</tt> <p/> Where <tt>#camelId#</tt> is the name of the {@link org.apache.camel.CamelContext} <br/>and <tt>#counter#</tt> is a unique incrementing counter. <br/>and <tt>#name#</tt> is the regular thread name. <br/>You can also use <tt>#longName#</tt> is the long thread name which can includes endpoint p [...] +| *camel.springboot.thread-name-pattern* | Sets the thread name pattern used for creating the full thread name. The default pattern is: Camel (#camelId#) thread ##counter# - #name# Where #camelId# is the name of the CamelContext. and #counter# is a unique incrementing counter. and #name# is the regular thread name. You can also use #longName# which is the long thread name which can includes endpoint parameters etc. | | String | *camel.springboot.trace-formatter-show-body* | Tracer should output message body | true | Boolean | *camel.springboot.trace-formatter-show-bread-crumb* | Tracer should output breadcrumb | true | Boolean | *camel.springboot.trace-formatter-show-exception* | Tracer should output exception | true | Boolean @@ -190,13 +190,13 @@ The component supports 139 options, which are listed below. | *camel.springboot.tracer-formatter-show-body-type* | Tracer should output message body type | true | Boolean | *camel.springboot.tracing* | Sets whether tracing is enabled or not. Default is false. | false | Boolean | *camel.springboot.type-conversion* | Enables enhanced Camel/Spring type conversion. | true | Boolean -| *camel.springboot.use-breadcrumb* | Set whether breadcrumb is enabled. | true | Boolean -| *camel.springboot.use-data-type* | Whether to enable using data type on Camel messages. <p/> Data type are automatic turned on if one ore more routes has been explicit configured with input and output types. Otherwise data type is default off. | false | Boolean -| *camel.springboot.use-m-d-c-logging* | To turn on MDC logging @deprecated use useMdcLogging instead | false | Boolean +| *camel.springboot.use-breadcrumb* | Set whether breadcrumb is enabled. The default value is true. | true | Boolean +| *camel.springboot.use-data-type* | Whether to enable using data type on Camel messages. Data type are automatic turned on if one ore more routes has been explicit configured with input and output types. Otherwise data type is default off. | false | Boolean +| *camel.springboot.use-m-d-c-logging* | To turn on MDC logging | false | Boolean | *camel.springboot.use-mdc-logging* | To turn on MDC logging | false | Boolean | *camel.springboot.xml-rests* | Directory to scan for adding additional XML rests. You can turn this off by setting the value to false. | classpath:camel-rest/*.xml | String | *camel.springboot.xml-routes* | Directory to scan for adding additional XML routes. You can turn this off by setting the value to false. | classpath:camel/*.xml | String -| *camel.springboot.xml-routes-reload-directory* | To watch the directory for file changes which triggers a live reload of the Camel routes on-the-fly. <p/> For example configure this to point to the source code where the Camel XML files are located such as: src/main/resources/camel/ | | String +| *camel.springboot.xml-routes-reload-directory* | To watch the directory for file changes which triggers a live reload of the Camel routes on-the-fly. For example configure this to point to the source code where the Camel XML files are located such as: src/main/resources/camel/ | | String | *camel.ssl.config.camel-context* | | | CamelContext | *camel.ssl.config.cert-alias* | | | String | *camel.ssl.config.cipher-suites* | | | CipherSuitesParameters diff --git a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/CamelConfigurationProperties.java b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/CamelConfigurationProperties.java index d00f597..a37e4e6 100644 --- a/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/CamelConfigurationProperties.java +++ b/components/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/CamelConfigurationProperties.java @@ -38,19 +38,17 @@ public class CamelConfigurationProperties { * Whether Camel should try to suppress logging during shutdown and timeout was triggered, * meaning forced shutdown is happening. And during forced shutdown we want to avoid logging * errors/warnings et all in the logs as a side-effect of the forced timeout. - * <p/> - * By default this is <tt>false</tt> - * <p/> - * Notice the suppress is a <i>best effort</i> as there may still be some logs coming + * Notice the suppress is a best effort as there may still be some logs coming * from 3rd party libraries and whatnot, which Camel cannot control. + * This option is default false. */ private boolean shutdownSuppressLoggingOnTimeout; /** * Sets whether to force shutdown of all consumers when a timeout occurred and thus * not all consumers was shutdown within that period. - * <p/> - * You should have good reasons to set this option to <tt>false</tt> as it means that the routes + * + * You should have good reasons to set this option to false as it means that the routes * keep running and is halted abruptly when CamelContext has been shutdown. */ private boolean shutdownNowOnTimeout = true; @@ -99,14 +97,12 @@ public class CamelConfigurationProperties { * Used for inclusive filtering component scanning of RouteBuilder classes with @Component annotation. * The exclusive filtering takes precedence over inclusive filtering. * The pattern is using Ant-path style pattern. - * <p/> - * Multiple patterns can be specified separated by comma. - * For example to include all classes starting with Foo use <tt>**/Foo*</tt>. - * To include all routes form a specific package use, <tt>com/mycompany/foo/*</tt> - * To include all routes form a specific package and its sub-packages use double wildcards, <tt>com/mycompany/foo/**</tt> - * And to include all routes from two specific packages use, <tt>com/mycompany/foo/*,com/mycompany/stuff/*</tt> * - * @see org.springframework.util.AntPathMatcher + * Multiple patterns can be specified separated by comma. + * For example to include all classes starting with Foo use: **/Foo* + * To include all routes form a specific package use: com/mycompany/foo/* + * To include all routes form a specific package and its sub-packages use double wildcards: com/mycompany/foo/** + * And to include all routes from two specific packages use: com/mycompany/foo/*,com/mycompany/stuff/* */ private String javaRoutesIncludePattern; @@ -115,13 +111,11 @@ public class CamelConfigurationProperties { * The exclusive filtering takes precedence over inclusive filtering. * The pattern is using Ant-path style pattern. * Multiple patterns can be specified separated by comma. - * <p/> - * For example to exclude all classes starting with Bar use <tt>**/Bar*</tt>. - * To exclude all routes form a specific package use, <tt>com/mycompany/bar/*</tt> - * To exclude all routes form a specific package and its sub-packages use double wildcards, <tt>com/mycompany/bar/**</tt> - * And to exclude all routes from two specific packages use, <tt>com/mycompany/bar/*,com/mycompany/stuff/*</tt> * - * @see org.springframework.util.AntPathMatcher + * For example to exclude all classes starting with Bar use: **/Bar* + * To exclude all routes form a specific package use: com/mycompany/bar/* + * To exclude all routes form a specific package and its sub-packages use double wildcards: com/mycompany/bar/** + * And to exclude all routes from two specific packages use: com/mycompany/bar/*,com/mycompany/stuff/* */ private String javaRoutesExcludePattern; @@ -140,7 +134,7 @@ public class CamelConfigurationProperties { /** * To watch the directory for file changes which triggers * a live reload of the Camel routes on-the-fly. - * <p/> + * * For example configure this to point to the source code where the Camel XML files are located * such as: src/main/resources/camel/ */ @@ -151,10 +145,10 @@ public class CamelConfigurationProperties { * configuration values that takes precedence over any other configuration. * This can be used to refer to files that may have secret configuration that * has been mounted on the file system for containers. - * <p/> - * You must use either <tt>file:</tt> or <tt>classpath:</tt> as prefix to load + * + * You must use either file: or classpath: as prefix to load * from file system or classpath. Then you can specify a pattern to load - * from sub directories and a name pattern such as <tt>file:/var/app/secret/*.properties</tt> + * from sub directories and a name pattern such as file:/var/app/secret/*.properties */ private String fileConfigurations; @@ -201,8 +195,6 @@ public class CamelConfigurationProperties { * Sets whether stream caching is enabled or not. * * Default is false. - * - * @deprecated use {@link #streamCachingEnabled} */ @Deprecated private boolean streamCaching; @@ -216,24 +208,22 @@ public class CamelConfigurationProperties { /** * Sets the stream caching spool (temporary) directory to use for overflow and spooling to disk. - * <p/> + * * If no spool directory has been explicit configured, then a temporary directory - * is created in the <tt>java.io.tmpdir</tt> directory. + * is created in the java.io.tmpdir directory. */ private String streamCachingSpoolDirectory; /** * Sets a stream caching chiper name to use when spooling to disk to write with encryption. - * <p/> * By default the data is not encrypted. */ private String streamCachingSpoolChiper; /** * Stream caching threshold in bytes when overflow to disk is activated. - * <p/> - * The default threshold is {@link org.apache.camel.StreamCache#DEFAULT_SPOOL_THRESHOLD} bytes (eg 128kb). - * Use <tt>-1</tt> to disable overflow to disk. + * The default threshold is 128kb. + * Use -1 to disable overflow to disk. */ private long streamCachingSpoolThreshold; @@ -248,26 +238,25 @@ public class CamelConfigurationProperties { private String streamCachingSpoolUsedHeapMemoryLimit; /** - * Sets whether if just any of the {@link org.apache.camel.spi.StreamCachingStrategy.SpoolRule} rules - * returns <tt>true</tt> then shouldSpoolCache(long) returns <tt>true</tt>. - * If this option is <tt>false</tt>, then <b>all</b> the {@link org.apache.camel.spi.StreamCachingStrategy.SpoolRule} must - * return <tt>true</tt>. - * <p/> - * The default value is <tt>false</tt> which means that all the rules must return <tt>true</tt>. + * Sets whether if just any of the org.apache.camel.spi.StreamCachingStrategy.SpoolRule rules + * returns true then shouldSpoolCache(long) returns true, to allow spooling to disk. + * If this option is false, then all the org.apache.camel.spi.StreamCachingStrategy.SpoolRule must + * return true. + * + * The default value is false which means that all the rules must return true. */ private boolean streamCachingAnySpoolRules; /** * Sets the stream caching buffer size to use when allocating in-memory buffers used for in-memory stream caches. - * <p/> - * The default size is {@link org.apache.camel.util.IOHelper#DEFAULT_BUFFER_SIZE} + * + * The default size is 4096. */ private int streamCachingBufferSize; /** * Whether to remove stream caching temporary directory when stopping. - * <p/> - * This option is default <tt>true</tt> + * This option is default true. */ private boolean streamCachingRemoveSpoolDirectoryWhenStopping = true; @@ -341,7 +330,7 @@ public class CamelConfigurationProperties { /** * Whether to enable using data type on Camel messages. - * <p/> + * * Data type are automatic turned on if one ore more routes has been explicit configured with input and output types. * Otherwise data type is default off. */ @@ -349,6 +338,7 @@ public class CamelConfigurationProperties { /** * Set whether breadcrumb is enabled. + * The default value is true. */ private boolean useBreadcrumb = true; @@ -446,8 +436,6 @@ public class CamelConfigurationProperties { /** * To turn on MDC logging - * - * @deprecated use useMdcLogging instead */ @Deprecated private boolean useMDCLogging; @@ -459,13 +447,14 @@ public class CamelConfigurationProperties { /** * Sets the thread name pattern used for creating the full thread name. - * <p/> - * The default pattern is: <tt>Camel (#camelId#) thread ##counter# - #name#</tt> - * <p/> - * Where <tt>#camelId#</tt> is the name of the {@link org.apache.camel.CamelContext} - * <br/>and <tt>#counter#</tt> is a unique incrementing counter. - * <br/>and <tt>#name#</tt> is the regular thread name. - * <br/>You can also use <tt>#longName#</tt> is the long thread name which can includes endpoint parameters etc. + * + * The default pattern is: Camel (#camelId#) thread ##counter# - #name# + * + * Where #camelId# is the name of the CamelContext. + * and #counter# is a unique incrementing counter. + * and #name# is the regular thread name. + * + * You can also use #longName# which is the long thread name which can includes endpoint parameters etc. */ private String threadNamePattern;
