You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2019/06/05 10:23:30 UTC
[camel] 03/03: Spring Boot Auto configuration docs in readme should
include deprecation details
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 8a8cb30b45919df5f912bc2e48f95a74df003b06
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Jun 5 12:22:29 2019 +0200
Spring Boot Auto configuration docs in readme should include deprecation details
---
components/camel-consul/src/main/docs/consul-component.adoc | 6 +++---
.../camel-disruptor/src/main/docs/disruptor-component.adoc | 4 ++--
.../camel-ehcache/src/main/docs/ehcache-component.adoc | 2 +-
.../camel-infinispan/src/main/docs/infinispan-component.adoc | 2 +-
components/camel-mllp/src/main/docs/mllp-component.adoc | 4 ++--
components/camel-nagios/src/main/docs/nagios-component.adoc | 2 +-
components/camel-netty4/src/main/docs/netty4-component.adoc | 12 ++++++------
components/camel-rest/src/main/docs/rest-component.adoc | 2 +-
components/camel-ssh/src/main/docs/ssh-component.adoc | 4 ++--
.../camel-zookeeper/src/main/docs/zookeeper-component.adoc | 2 +-
10 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc
index a6bc893..61d3ce3 100644
--- a/components/camel-consul/src/main/docs/consul-component.adoc
+++ b/components/camel-consul/src/main/docs/consul-component.adoc
@@ -204,9 +204,9 @@ The component supports 91 options, which are listed below.
| *camel.component.consul.url* | The Consul agent URL | | String
| *camel.component.consul.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | Boolean
| *camel.component.consul.user-name* | Sets the username to be used for basic authentication | | String
-| *camel.component.consul.cluster.service.dc* | | | String
-| *camel.component.consul.configuration.dc* | The data center | | String
-| *camel.component.consul.service-registry.dc* | | | String
+| *camel.component.consul.cluster.service.dc* | *Deprecated* | | String
+| *camel.component.consul.configuration.dc* | *Deprecated* The data center | | String
+| *camel.component.consul.service-registry.dc* | *Deprecated* | | String
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
index 3a8aeab..bd3c7e8 100644
--- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc
+++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
@@ -198,8 +198,8 @@ The component supports 20 options, which are listed below.
| *camel.component.disruptor.default-wait-strategy* | To configure the default value for DisruptorWaitStrategy The default value is Blocking. | | DisruptorWaitStrategy
| *camel.component.disruptor.enabled* | Enable disruptor component | true | Boolean
| *camel.component.disruptor.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.disruptor-vm.queue-size* | To configure the ring buffer size | | Integer
-| *camel.component.disruptor.queue-size* | To configure the ring buffer size | | Integer
+| *camel.component.disruptor-vm.queue-size* | *Deprecated* To configure the ring buffer size | | Integer
+| *camel.component.disruptor.queue-size* | *Deprecated* To configure the ring buffer size | | Integer
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-ehcache/src/main/docs/ehcache-component.adoc b/components/camel-ehcache/src/main/docs/ehcache-component.adoc
index b6feb71..9b591b3 100644
--- a/components/camel-ehcache/src/main/docs/ehcache-component.adoc
+++ b/components/camel-ehcache/src/main/docs/ehcache-component.adoc
@@ -151,7 +151,7 @@ The component supports 26 options, which are listed below.
| *camel.component.ehcache.customizer.cache-manager.override* | Configure if the cache manager eventually set on the component should be overridden by the customizer. | false | Boolean
| *camel.component.ehcache.enabled* | Enable ehcache component | true | Boolean
| *camel.component.ehcache.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.ehcache.configuration.config-uri* | URI pointing to the Ehcache XML configuration file's location | | String
+| *camel.component.ehcache.configuration.config-uri* | *Deprecated* URI pointing to the Ehcache XML configuration file's location | | String
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-infinispan/src/main/docs/infinispan-component.adoc b/components/camel-infinispan/src/main/docs/infinispan-component.adoc
index e8a3d83..a0a01a8 100644
--- a/components/camel-infinispan/src/main/docs/infinispan-component.adoc
+++ b/components/camel-infinispan/src/main/docs/infinispan-component.adoc
@@ -148,7 +148,7 @@ The component supports 23 options, which are listed below.
| *camel.component.infinispan.customizer.remote-cache-manager.override* | Configure if the cache manager eventually set on the component should be overridden by the customizer. | false | Boolean
| *camel.component.infinispan.enabled* | Enable infinispan component | true | Boolean
| *camel.component.infinispan.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.infinispan.configuration.command* | The operation to perform. | PUT | String
+| *camel.component.infinispan.configuration.command* | *Deprecated* The operation to perform. | PUT | String
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc
index 41ebbb6..7129a85 100644
--- a/components/camel-mllp/src/main/docs/mllp-component.adoc
+++ b/components/camel-mllp/src/main/docs/mllp-component.adoc
@@ -173,8 +173,8 @@ The component supports 32 options, which are listed below.
| *camel.component.mllp.log-phi* | Set the component to log PHI data. | true | Boolean
| *camel.component.mllp.log-phi-max-bytes* | Set the maximum number of bytes of PHI that will be logged in a log entry. | 5120 | Integer
| *camel.component.mllp.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.mllp.configuration.buffer-writes* | Enable/Disable the buffering of HL7 payloads before writing to the socket. | false | Boolean
-| *camel.component.mllp.configuration.max-receive-timeouts* | The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. | | Integer
+| *camel.component.mllp.configuration.buffer-writes* | *Deprecated* Enable/Disable the buffering of HL7 payloads before writing to the socket. | false | Boolean
+| *camel.component.mllp.configuration.max-receive-timeouts* | *Deprecated* The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. | | Integer
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc
index 18af85e..6c3c38b 100644
--- a/components/camel-nagios/src/main/docs/nagios-component.adoc
+++ b/components/camel-nagios/src/main/docs/nagios-component.adoc
@@ -127,7 +127,7 @@ The component supports 11 options, which are listed below.
| *camel.component.nagios.configuration.timeout* | Sending timeout in millis. | 5000 | Integer
| *camel.component.nagios.enabled* | Enable nagios component | true | Boolean
| *camel.component.nagios.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.nagios.configuration.encryption-method* | To specify an encryption method. | | NagiosEncryptionMethod
+| *camel.component.nagios.configuration.encryption-method* | *Deprecated* To specify an encryption method. | | NagiosEncryptionMethod
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc
index a45b8b2..7ca8561 100644
--- a/components/camel-netty4/src/main/docs/netty4-component.adoc
+++ b/components/camel-netty4/src/main/docs/netty4-component.adoc
@@ -266,12 +266,12 @@ The component supports 79 options, which are listed below.
| *camel.component.netty4.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
| *camel.component.netty4.ssl-context-parameters* | To configure security using SSLContextParameters. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | | String
| *camel.component.netty4.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | Boolean
-| *camel.component.netty4.configuration.client-pipeline-factory* | | | ClientInitializer Factory
-| *camel.component.netty4.configuration.decoder* | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. | | ChannelHandler
-| *camel.component.netty4.configuration.encoder* | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. | | ChannelHandler
-| *camel.component.netty4.configuration.key-store-file* | Client side certificate keystore to be used for encryption | | File
-| *camel.component.netty4.configuration.server-pipeline-factory* | | | ServerInitializer Factory
-| *camel.component.netty4.configuration.trust-store-file* | Server side certificate keystore to be used for encryption | | File
+| *camel.component.netty4.configuration.client-pipeline-factory* | *Deprecated* | | ClientInitializer Factory
+| *camel.component.netty4.configuration.decoder* | *Deprecated* A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. | | ChannelHandler
+| *camel.component.netty4.configuration.encoder* | *Deprecated* A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. | | ChannelHandler
+| *camel.component.netty4.configuration.key-store-file* | *Deprecated* Client side certificate keystore to be used for encryption | | File
+| *camel.component.netty4.configuration.server-pipeline-factory* | *Deprecated* | | ServerInitializer Factory
+| *camel.component.netty4.configuration.trust-store-file* | *Deprecated* Server side certificate keystore to be used for encryption | | File
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-rest/src/main/docs/rest-component.adoc b/components/camel-rest/src/main/docs/rest-component.adoc
index 8811b64..e71e8c3 100644
--- a/components/camel-rest/src/main/docs/rest-component.adoc
+++ b/components/camel-rest/src/main/docs/rest-component.adoc
@@ -113,7 +113,7 @@ The component supports 8 options, which are listed below.
| *camel.component.rest.host* | Host and port of HTTP service to use (override host in swagger schema) | | String
| *camel.component.rest.producer-component-name* | The Camel Rest component to use for (producer) the REST transport, such as http, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory is registered in the registry. If either one is found, then that is being used. | | String
| *camel.component.rest.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.rest.component-name* | The Camel Rest component to use for (producer) the REST transport, such as http, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory is registered in the registry. If either one is found, then that is being used. | | String
+| *camel.component.rest.component-name* | *Deprecated* The Camel Rest component to use for (producer) the REST transport, such as http, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory is registered in the registry. If either one is found, then that is being used. | | String
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc
index 96ba0e0..2f6f3a3 100644
--- a/components/camel-ssh/src/main/docs/ssh-component.adoc
+++ b/components/camel-ssh/src/main/docs/ssh-component.adoc
@@ -172,8 +172,8 @@ The component supports 31 options, which are listed below.
| *camel.component.ssh.sleep-for-shell-prompt* | Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. | | Long
| *camel.component.ssh.timeout* | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | | Long
| *camel.component.ssh.username* | Sets the username to use in logging into the remote SSH server. | | String
-| *camel.component.ssh.cert-filename* | Sets the resource path of the certificate to use for Authentication. | | String
-| *camel.component.ssh.configuration.cert-filename* | @deprecated As of version 2.11, replaced by certResource. | | String
+| *camel.component.ssh.cert-filename* | *Deprecated* Sets the resource path of the certificate to use for Authentication. | | String
+| *camel.component.ssh.configuration.cert-filename* | *Deprecated* @deprecated As of version 2.11, replaced by certResource. | | String
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
index 92720fb..c3d2947 100644
--- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
+++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
@@ -173,7 +173,7 @@ The component supports 58 options, which are listed below.
| *camel.component.zookeeper.service-registry.service-host* | | | String
| *camel.component.zookeeper.service-registry.session-timeout* | | | Long
| *camel.component.zookeeper.service-registry.session-timeout-unit* | | | TimeUnit
-| *camel.component.zookeeper.configuration.await-existence* | Not in use | true | Boolean
+| *camel.component.zookeeper.configuration.await-existence* | *Deprecated* Not in use | true | Boolean
|===
// spring-boot-auto-configure options: END