http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-snmp/src/main/docs/snmp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc index e37146d..100b522 100644 --- a/components/camel-snmp/src/main/docs/snmp-component.adoc +++ b/components/camel-snmp/src/main/docs/snmp-component.adoc @@ -57,86 +57,52 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the SNMP enabled device -| port | | Integer | *Required* Port number of the SNMP enabled device +| Name | Description | Default | Type +| **host** | *Required* Hostname of the SNMP enabled device | | String +| **port** | *Required* Port number of the SNMP enabled device | | Integer |======================================================================= #### Query Parameters (34 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| delay | 60000 | long | Sets update rate in seconds - -| oids | | String | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1 - -| protocol | udp | String | Here you can select which protocol to use. You can use either udp or tcp. - -| retries | 2 | int | Defines how often a retry is made before canceling the request. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| snmpCommunity | public | String | Sets the community octet string for the snmp request. - -| snmpContextEngineId | | String | Sets the context engine ID field of the scoped PDU. - -| snmpContextName | | String | Sets the context name field of this scoped PDU. - -| snmpVersion | 0 | int | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3 - -| timeout | 1500 | int | Sets the timeout value for the request in millis. - -| type | | SnmpActionType | Which operation to perform such as poll trap etc. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. - 4+^s| security -| authenticationPassphrase | | String | The authentication passphrase. If not null authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. - -| authenticationProtocol | | String | Authentication protocol to use if security level is set to enable authentication The possible values are: MD5 SHA1 - -| privacyPassphrase | | String | The privacy passphrase. If not null privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. - -| privacyProtocol | | String | The privacy protocol ID to be associated with this user. If set to null this user only supports unencrypted messages. - -| securityLevel | 3 | int | Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level and only the one with the right encryption/decryption key can read the contents of the message. - -| securityName | | String | Sets the security name to be used with this target. +| Name | Description | Default | Type +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **delay** (consumer) | Sets update rate in seconds | 60000 | long +| **oids** (consumer) | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1 | | String +| **protocol** (consumer) | Here you can select which protocol to use. You can use either udp or tcp. | udp | String +| **retries** (consumer) | Defines how often a retry is made before canceling the request. | 2 | int +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **snmpCommunity** (consumer) | Sets the community octet string for the snmp request. | public | String +| **snmpContextEngineId** (consumer) | Sets the context engine ID field of the scoped PDU. | | String +| **snmpContextName** (consumer) | Sets the context name field of this scoped PDU. | | String +| **snmpVersion** (consumer) | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3 | 0 | int +| **timeout** (consumer) | Sets the timeout value for the request in millis. | 1500 | int +| **type** (consumer) | Which operation to perform such as poll trap etc. | | SnmpActionType +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| **authenticationPassphrase** (security) | The authentication passphrase. If not null authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String +| **authenticationProtocol** (security) | Authentication protocol to use if security level is set to enable authentication The possible values are: MD5 SHA1 | | String +| **privacyPassphrase** (security) | The privacy passphrase. If not null privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String +| **privacyProtocol** (security) | The privacy protocol ID to be associated with this user. If set to null this user only supports unencrypted messages. | | String +| **securityLevel** (security) | Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level and only the one with the right encryption/decryption key can read the contents of the message. | 3 | int +| **securityName** (security) | Sets the security name to be used with this target. | | String |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-solr/src/main/docs/solr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-solr/src/main/docs/solr-component.adoc b/components/camel-solr/src/main/docs/solr-component.adoc index 3d240bb..63da91e 100644 --- a/components/camel-solr/src/main/docs/solr-component.adoc +++ b/components/camel-solr/src/main/docs/solr-component.adoc @@ -48,43 +48,30 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| url | | String | *Required* Hostname and port for the solr server +| Name | Description | Default | Type +| **url** | *Required* Hostname and port for the solr server | | String |======================================================================= #### Query Parameters (13 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| allowCompression | | Boolean | Server side must support gzip or deflate for this to have any effect - -| connectionTimeout | | Integer | connectionTimeout on the underlying HttpConnectionManager - -| defaultMaxConnectionsPerHost | | Integer | maxConnectionsPerHost on the underlying HttpConnectionManager - -| followRedirects | | Boolean | indicates whether redirects are used to get to the Solr server - -| maxRetries | | Integer | Maximum number of retries to attempt in the event of transient errors - -| maxTotalConnections | | Integer | maxTotalConnection on the underlying HttpConnectionManager - -| requestHandler | | String | Set the request handler to be used - -| soTimeout | | Integer | Read timeout on the underlying HttpConnectionManager. This is desirable for queries but probably not for indexing - -| streamingQueueSize | 10 | int | Set the queue size for the StreamingUpdateSolrServer - -| streamingThreadCount | 2 | int | Set the number of threads for the StreamingUpdateSolrServer - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| solrCloud -| collection | | String | Set the collection name which the solrCloud server could use - -| zkHost | | String | Set the ZooKeeper host information which the solrCloud could use such as zkhost=localhost:8123. +| Name | Description | Default | Type +| **allowCompression** (producer) | Server side must support gzip or deflate for this to have any effect | | Boolean +| **connectionTimeout** (producer) | connectionTimeout on the underlying HttpConnectionManager | | Integer +| **defaultMaxConnectionsPer Host** (producer) | maxConnectionsPerHost on the underlying HttpConnectionManager | | Integer +| **followRedirects** (producer) | indicates whether redirects are used to get to the Solr server | | Boolean +| **maxRetries** (producer) | Maximum number of retries to attempt in the event of transient errors | | Integer +| **maxTotalConnections** (producer) | maxTotalConnection on the underlying HttpConnectionManager | | Integer +| **requestHandler** (producer) | Set the request handler to be used | | String +| **soTimeout** (producer) | Read timeout on the underlying HttpConnectionManager. This is desirable for queries but probably not for indexing | | Integer +| **streamingQueueSize** (producer) | Set the queue size for the StreamingUpdateSolrServer | 10 | int +| **streamingThreadCount** (producer) | Set the number of threads for the StreamingUpdateSolrServer | 2 | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **collection** (solrCloud) | Set the collection name which the solrCloud server could use | | String +| **zkHost** (solrCloud) | Set the ZooKeeper host information which the solrCloud could use such as zkhost=localhost:8123. | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc index ae92e17..c3f04d8 100644 --- a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc +++ b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc @@ -36,33 +36,21 @@ The Spark Rest component supports 12 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer -| port | 4567 | int | Port number. Will by default use 4567 - -| ipAddress | 0.0.0.0 | String | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. - 4+^s| advanced -| minThreads | | int | Minimum number of threads in Spark thread-pool (shared globally) - -| maxThreads | | int | Maximum number of threads in Spark thread-pool (shared globally) - -| timeOutMillis | | int | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool - 4+^s| security -| keystoreFile | | String | Configures connection to be secure to use the keystore file - -| keystorePassword | | String | Configures connection to be secure to use the keystore password - -| truststoreFile | | String | Configures connection to be secure to use the truststore file - -| truststorePassword | | String | Configures connection to be secure to use the truststore password - 4+^s| advanced -| sparkConfiguration | | SparkConfiguration | To use the shared SparkConfiguration - -| sparkBinding | | SparkBinding | To use a custom SparkBinding to map to/from Camel message. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **port** (consumer) | Port number. Will by default use 4567 | 4567 | int +| **ipAddress** (consumer) | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. | 0.0.0.0 | String +| **minThreads** (advanced) | Minimum number of threads in Spark thread-pool (shared globally) | | int +| **maxThreads** (advanced) | Maximum number of threads in Spark thread-pool (shared globally) | | int +| **timeOutMillis** (advanced) | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool | | int +| **keystoreFile** (security) | Configures connection to be secure to use the keystore file | | String +| **keystorePassword** (security) | Configures connection to be secure to use the keystore password | | String +| **truststoreFile** (security) | Configures connection to be secure to use the truststore file | | String +| **truststorePassword** (security) | Configures connection to be secure to use the truststore password | | String +| **sparkConfiguration** (advanced) | To use the shared SparkConfiguration | | SparkConfiguration +| **sparkBinding** (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -78,40 +66,29 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| verb | | String | *Required* get post put patch delete head trace connect or options. -| path | | String | *Required* The content path which support Spark syntax. +| Name | Description | Default | Type +| **verb** | *Required* get post put patch delete head trace connect or options. | | String +| **path** | *Required* The content path which support Spark syntax. | | String |======================================================================= #### Query Parameters (11 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| accept | | String | Accept type such as: 'text/xml' or 'application/json'. By default we accept all kinds of types. - -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Spark HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Spark raw stream. - -| mapHeaders | true | boolean | If this option is enabled then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance. - -| transferException | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. - -| urlDecodeHeaders | false | boolean | If this option is enabled then during binding from Spark to Camel Message then the header values will be URL decoded (eg 20 will be a space character.) - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| matchOnUriPrefix | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. - -| sparkBinding | | SparkBinding | To use a custom SparkBinding to map to/from Camel message. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **accept** (consumer) | Accept type such as: 'text/xml' or 'application/json'. By default we accept all kinds of types. | | String +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Spark HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Spark raw stream. | false | boolean +| **mapHeaders** (consumer) | If this option is enabled then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance. | true | boolean +| **transferException** (consumer) | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | boolean +| **urlDecodeHeaders** (consumer) | If this option is enabled then during binding from Spark to Camel Message then the header values will be URL decoded (eg 20 will be a space character.) | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **matchOnUriPrefix** (advanced) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean +| **sparkBinding** (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spark/src/main/docs/spark-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spark/src/main/docs/spark-component.adoc b/components/camel-spark/src/main/docs/spark-component.adoc index a967a1a..1213150 100644 --- a/components/camel-spark/src/main/docs/spark-component.adoc +++ b/components/camel-spark/src/main/docs/spark-component.adoc @@ -55,15 +55,12 @@ The Apache Spark component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| producer -| rdd | | JavaRDDLike | RDD to compute against. - -| rddCallback | | RddCallback | Function performing action against an RDD. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **rdd** (producer) | RDD to compute against. | | JavaRDDLike +| **rddCallback** (producer) | Function performing action against an RDD. | | RddCallback +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -79,29 +76,23 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| endpointType | | EndpointType | *Required* Type of the endpoint (rdd dataframe hive). +| Name | Description | Default | Type +| **endpointType** | *Required* Type of the endpoint (rdd dataframe hive). | | EndpointType |======================================================================= #### Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| collect | true | boolean | Indicates if results should be collected or counted. - -| dataFrame | | DataFrame | DataFrame to compute against. - -| dataFrameCallback | | DataFrameCallback | Function performing action against an DataFrame. - -| rdd | | JavaRDDLike | RDD to compute against. - -| rddCallback | | RddCallback | Function performing action against an RDD. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **collect** (producer) | Indicates if results should be collected or counted. | true | boolean +| **dataFrame** (producer) | DataFrame to compute against. | | DataFrame +| **dataFrameCallback** (producer) | Function performing action against an DataFrame. | | DataFrameCallback +| **rdd** (producer) | RDD to compute against. | | JavaRDDLike +| **rddCallback** (producer) | Function performing action against an RDD. | | RddCallback +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-splunk/src/main/docs/splunk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc index 948ef38..7eac5bd 100644 --- a/components/camel-splunk/src/main/docs/splunk-component.adoc +++ b/components/camel-splunk/src/main/docs/splunk-component.adoc @@ -90,13 +90,11 @@ The Splunk component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| splunkConfigurationFactory | | SplunkConfigurationFactory | To use the SplunkConfigurationFactory - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **splunkConfiguration Factory** (advanced) | To use the SplunkConfigurationFactory | | SplunkConfiguration Factory +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -112,101 +110,59 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| name | | String | *Required* Name has no purpose +| Name | Description | Default | Type +| **name** | *Required* Name has no purpose | | String |======================================================================= #### Query Parameters (42 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| app | | String | Splunk app - -| connectionTimeout | 5000 | int | Timeout in MS when connecting to Splunk server - -| host | localhost | String | Splunk host. - -| owner | | String | Splunk owner - -| port | 8089 | int | Splunk port - -| scheme | https | String | Splunk scheme - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| count | | int | A number that indicates the maximum number of entities to return. - -| earliestTime | | String | Earliest time of the search time window. - -| initEarliestTime | | String | Initial start offset of the first search - -| latestTime | | String | Latest time of the search time window. - -| savedSearch | | String | The name of the query saved in Splunk to run - -| search | | String | The Splunk query to run - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| streaming | | Boolean | Sets streaming mode. Streaming mode sends exchanges as they are received rather than in a batch. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| producer -| eventHost | | String | Override the default Splunk event host field - -| index | | String | Splunk index to write to - -| raw | false | boolean | Should the payload be inserted raw - -| source | | String | Splunk source argument - -| sourceType | | String | Splunk sourcetype argument - -| tcpReceiverPort | | int | Splunk tcp receiver port - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. - 4+^s| security -| password | | String | Password for Splunk - -| sslProtocol | TLSv1.2 | SSLSecurityProtocol | Set the ssl protocol to use - -| username | | String | Username for Splunk - -| useSunHttpsHandler | false | boolean | Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. +| Name | Description | Default | Type +| **app** (common) | Splunk app | | String +| **connectionTimeout** (common) | Timeout in MS when connecting to Splunk server | 5000 | int +| **host** (common) | Splunk host. | localhost | String +| **owner** (common) | Splunk owner | | String +| **port** (common) | Splunk port | 8089 | int +| **scheme** (common) | Splunk scheme | https | String +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **count** (consumer) | A number that indicates the maximum number of entities to return. | | int +| **earliestTime** (consumer) | Earliest time of the search time window. | | String +| **initEarliestTime** (consumer) | Initial start offset of the first search | | String +| **latestTime** (consumer) | Latest time of the search time window. | | String +| **savedSearch** (consumer) | The name of the query saved in Splunk to run | | String +| **search** (consumer) | The Splunk query to run | | String +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **streaming** (consumer) | Sets streaming mode. Streaming mode sends exchanges as they are received rather than in a batch. | | Boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| **eventHost** (producer) | Override the default Splunk event host field | | String +| **index** (producer) | Splunk index to write to | | String +| **raw** (producer) | Should the payload be inserted raw | false | boolean +| **source** (producer) | Splunk source argument | | String +| **sourceType** (producer) | Splunk sourcetype argument | | String +| **tcpReceiverPort** (producer) | Splunk tcp receiver port | | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| **password** (security) | Password for Splunk | | String +| **sslProtocol** (security) | Set the ssl protocol to use | TLSv1.2 | SSLSecurityProtocol +| **username** (security) | Username for Splunk | | String +| **useSunHttpsHandler** (security) | Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc index 36c1e89..e996f8c 100644 --- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc +++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc @@ -44,15 +44,12 @@ The Spring Batch component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| producer -| jobLauncher | | JobLauncher | Explicitly specifies a JobLauncher to be used. - -| jobRegistry | | JobRegistry | Explicitly specifies a JobRegistry to be used. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **jobLauncher** (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher +| **jobRegistry** (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -72,25 +69,21 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| jobName | | String | *Required* The name of the Spring Batch job located in the registry. +| Name | Description | Default | Type +| **jobName** | *Required* The name of the Spring Batch job located in the registry. | | String |======================================================================= #### Query Parameters (4 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| jobFromHeader | false | boolean | Explicitly defines if the jobName should be taken from the headers instead of the URI. - -| jobLauncher | | JobLauncher | Explicitly specifies a JobLauncher to be used. - -| jobRegistry | | JobRegistry | Explicitly specifies a JobRegistry to be used. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **jobFromHeader** (producer) | Explicitly defines if the jobName should be taken from the headers instead of the URI. | false | boolean +| **jobLauncher** (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher +| **jobRegistry** (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc index ce01cdc..ab76f1c 100644 --- a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc +++ b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc @@ -53,31 +53,24 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| defaultChannel | | String | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider. +| Name | Description | Default | Type +| **defaultChannel** | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider. | | String |======================================================================= #### Query Parameters (7 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| inOut | false | boolean | The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected either from the Spring Integration Message header or configured on the endpoint. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| inputChannel | | String | The Spring integration input channel name that this endpoint wants to consume from Spring integration. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| outputChannel | | String | The Spring integration output channel name that is used to send messages to Spring integration. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **inOut** (common) | The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected either from the Spring Integration Message header or configured on the endpoint. | false | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **inputChannel** (consumer) | The Spring integration input channel name that this endpoint wants to consume from Spring integration. | | String +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **outputChannel** (producer) | The Spring integration output channel name that is used to send messages to Spring integration. | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc index 1f1e91b..07886ba 100644 --- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc +++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc @@ -48,23 +48,20 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| templateName | | String | *Required* Name of the Spring LDAP Template bean +| Name | Description | Default | Type +| **templateName** | *Required* Name of the Spring LDAP Template bean | | String |======================================================================= #### Query Parameters (3 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| operation | | LdapOperation | *Required* The LDAP operation to be performed. - -| scope | subtree | String | The scope of the search operation. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **operation** (producer) | *Required* The LDAP operation to be performed. | | LdapOperation +| **scope** (producer) | The scope of the search operation. | subtree | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc index 364180c..be9057a 100644 --- a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc +++ b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc @@ -43,38 +43,28 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* The host where Redis server is running. -| port | | Integer | *Required* Redis server port number +| Name | Description | Default | Type +| **host** | *Required* The host where Redis server is running. | | String +| **port** | *Required* Redis server port number | | Integer |======================================================================= #### Query Parameters (10 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| channels | | String | List of topic names or name patterns to subscribe to. Multiple names can be separated by comma. - -| command | SET | Command | Default command which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE - -| connectionFactory | | RedisConnectionFactory | Reference to a pre-configured RedisConnectionFactory instance to use. - -| redisTemplate | | RedisTemplate | Reference to a pre-configured RedisTemplate instance to use. - -| serializer | | RedisSerializer | Reference to a pre-configured RedisSerializer instance to use. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| listenerContainer | | RedisMessageListenerContainer | Reference to a pre-configured RedisMessageListenerContainer instance to use. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **channels** (common) | List of topic names or name patterns to subscribe to. Multiple names can be separated by comma. | | String +| **command** (common) | Default command which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE | SET | Command +| **connectionFactory** (common) | Reference to a pre-configured RedisConnectionFactory instance to use. | | RedisConnectionFactory +| **redisTemplate** (common) | Reference to a pre-configured RedisTemplate instance to use. | | RedisTemplate +| **serializer** (common) | Reference to a pre-configured RedisSerializer instance to use. | | RedisSerializer +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **listenerContainer** (consumer) | Reference to a pre-configured RedisMessageListenerContainer instance to use. | | RedisMessageListener Container +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc index af7fc53..2a671a6 100644 --- a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc +++ b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc @@ -95,63 +95,41 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| type | | EndpointMappingType | Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc -| lookupKey | | String | Endpoint mapping key if endpoint mapping is used -| webServiceEndpointUri | | String | The default Web Service endpoint uri to use for the producer. +| Name | Description | Default | Type +| **type** | Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc | | EndpointMappingType +| **lookupKey** | Endpoint mapping key if endpoint mapping is used | | String +| **webServiceEndpointUri** | The default Web Service endpoint uri to use for the producer. | | String |======================================================================= #### Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| messageFilter | | MessageFilter | Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| endpointDispatcher | | CamelEndpointDispatcher | Spring org.springframework.ws.server.endpoint.MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc. - -| endpointMapping | | CamelSpringWSEndpointMapping | Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName SOAP action etc) - -| expression | | String | The XPath expression to use when option type=xpathresult. Then this option is required to be configured. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| allowResponseAttachmentOverride | false | boolean | Option to override soap response attachments in in/out exchange with attachments from the actual service layer. If the invoked service appends or rewrites the soap attachments this option when set to true allows the modified soap attachments to be overwritten in in/out message attachments - -| allowResponseHeaderOverride | false | boolean | Option to override soap response header in in/out exchange with header info from the actual service layer. If the invoked service appends or rewrites the soap header this option when set to true allows the modified soap header to be overwritten in in/out message headers - -| faultAction | | URI | Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method. - -| faultTo | | URI | Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. - -| messageFactory | | WebServiceMessageFactory | Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ. - -| messageIdStrategy | | MessageIdStrategy | Option to provide a custom MessageIdStrategy to control generation of unique message ids. - -| messageSender | | WebServiceMessageSender | Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports - -| outputAction | | URI | Signifies the value for the response WS-Addressing Action header that is provided by the method. - -| replyTo | | URI | Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. - -| soapAction | | String | SOAP action to include inside a SOAP request when accessing remote web services - -| timeout | | int | Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender it is assumed that you will handle your own timeout configuration. The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated see HttpComponentsMessageSender.setReadTimeout(). - -| webServiceTemplate | | WebServiceTemplate | Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver message sender or message factory. - -| wsAddressingAction | | URI | WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior). - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters +| Name | Description | Default | Type +| **messageFilter** (common) | Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own. | | MessageFilter +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **endpointDispatcher** (consumer) | Spring org.springframework.ws.server.endpoint.MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc. | | CamelEndpointDispatcher +| **endpointMapping** (consumer) | Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName SOAP action etc) | | CamelSpringWSEndpoint Mapping +| **expression** (consumer) | The XPath expression to use when option type=xpathresult. Then this option is required to be configured. | | String +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **allowResponseAttachment Override** (producer) | Option to override soap response attachments in in/out exchange with attachments from the actual service layer. If the invoked service appends or rewrites the soap attachments this option when set to true allows the modified soap attachments to be overwritten in in/out message attachments | false | boolean +| **allowResponseHeaderOverride** (producer) | Option to override soap response header in in/out exchange with header info from the actual service layer. If the invoked service appends or rewrites the soap header this option when set to true allows the modified soap header to be overwritten in in/out message headers | false | boolean +| **faultAction** (producer) | Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method. | | URI +| **faultTo** (producer) | Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. | | URI +| **messageFactory** (producer) | Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ. | | WebServiceMessage Factory +| **messageIdStrategy** (producer) | Option to provide a custom MessageIdStrategy to control generation of unique message ids. | | MessageIdStrategy +| **messageSender** (producer) | Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports | | WebServiceMessage Sender +| **outputAction** (producer) | Signifies the value for the response WS-Addressing Action header that is provided by the method. | | URI +| **replyTo** (producer) | Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. | | URI +| **soapAction** (producer) | SOAP action to include inside a SOAP request when accessing remote web services | | String +| **timeout** (producer) | Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender it is assumed that you will handle your own timeout configuration. The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated see HttpComponentsMessageSender.setReadTimeout(). | | int +| **webServiceTemplate** (producer) | Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver message sender or message factory. | | WebServiceTemplate +| **wsAddressingAction** (producer) | WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior). | | URI +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring/src/main/docs/spring-event-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring/src/main/docs/spring-event-component.adoc b/components/camel-spring/src/main/docs/spring-event-component.adoc index 8d2c475..2ce103b 100644 --- a/components/camel-spring/src/main/docs/spring-event-component.adoc +++ b/components/camel-spring/src/main/docs/spring-event-component.adoc @@ -25,18 +25,7 @@ easily change in future releases, so please check back. // component options: START -The Spring Event component supports 2 options which are listed below. - - - -[width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| applicationContext | | ApplicationContext | The Spring ApplicationContext - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. -|======================================================================= +The Spring Event component has no options. // component options: END @@ -51,25 +40,21 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| name | | String | Name of endpoint +| Name | Description | Default | Type +| **name** | Name of endpoint | | String |======================================================================= #### Query Parameters (4 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END
