http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 35bf19e..36c1e89 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,12 +44,15 @@ The Spring Batch component supports 3 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| jobLauncher | producer | | JobLauncher | Explicitly specifies a JobLauncher to be used. -| jobRegistry | producer | | JobRegistry | Explicitly specifies a JobRegistry to be used. -| resolvePropertyPlaceholders | advanced | 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 | 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. |======================================================================= // component options: END @@ -77,13 +80,17 @@ with the following path and query parameters: #### Query Parameters (4 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| jobFromHeader | producer | false | boolean | Explicitly defines if the jobName should be taken from the headers instead of the URI. -| jobLauncher | producer | | JobLauncher | Explicitly specifies a JobLauncher to be used. -| jobRegistry | producer | | JobRegistry | Explicitly specifies a JobRegistry to be used. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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). |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 6c8f057..ce01cdc 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 @@ -61,16 +61,23 @@ with the following path and query parameters: #### Query Parameters (7 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| inOut | common | 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. -| bridgeErrorHandler | consumer | 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 | consumer | | String | The Spring integration input channel name that this endpoint wants to consume from Spring integration. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| outputChannel | producer | | String | The Spring integration output channel name that is used to send messages to Spring integration. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 6f80e9c..1f1e91b 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 @@ -56,12 +56,15 @@ with the following path and query parameters: #### Query Parameters (3 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| operation | producer | | LdapOperation | *Required* The LDAP operation to be performed. -| scope | producer | subtree | String | The scope of the search operation. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 d4fed9f..364180c 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 @@ -52,19 +52,29 @@ with the following path and query parameters: #### Query Parameters (10 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| channels | common | | String | List of topic names or name patterns to subscribe to. Multiple names can be separated by comma. -| command | common | SET | Command | Default command which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE -| connectionFactory | common | | RedisConnectionFactory | Reference to a pre-configured RedisConnectionFactory instance to use. -| redisTemplate | common | | RedisTemplate | Reference to a pre-configured RedisTemplate instance to use. -| serializer | common | | RedisSerializer | Reference to a pre-configured RedisSerializer instance to use. -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| listenerContainer | consumer (advanced) | | RedisMessageListenerContainer | Reference to a pre-configured RedisMessageListenerContainer instance to use. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 a99fd22..af7fc53 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 @@ -105,31 +105,53 @@ with the following path and query parameters: #### Query Parameters (22 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| messageFilter | common | | MessageFilter | Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own. -| bridgeErrorHandler | consumer | 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 | consumer | | 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 | consumer | | 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 | consumer | | String | The XPath expression to use when option type=xpathresult. Then this option is required to be configured. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| allowResponseAttachmentOverride | producer | 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 | producer | 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 | producer | | URI | Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method. -| faultTo | producer | | URI | Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. -| messageFactory | producer | | WebServiceMessageFactory | Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ. -| messageIdStrategy | producer | | MessageIdStrategy | Option to provide a custom MessageIdStrategy to control generation of unique message ids. -| messageSender | producer | | WebServiceMessageSender | Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports -| outputAction | producer | | URI | Signifies the value for the response WS-Addressing Action header that is provided by the method. -| replyTo | producer | | URI | Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. -| soapAction | producer | | String | SOAP action to include inside a SOAP request when accessing remote web services -| timeout | producer | | 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 | producer | | 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 | producer | | 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). -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 190aadc..8d2c475 100644 --- a/components/camel-spring/src/main/docs/spring-event-component.adoc +++ b/components/camel-spring/src/main/docs/spring-event-component.adoc @@ -29,11 +29,13 @@ The Spring Event component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| applicationContext | common | | ApplicationContext | The Spring ApplicationContext -| resolvePropertyPlaceholders | advanced | 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 | 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. |======================================================================= // component options: END @@ -57,13 +59,17 @@ with the following path and query parameters: #### Query Parameters (4 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-sql/src/main/docs/sql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc index 66c96b6..92dee04 100644 --- a/components/camel-sql/src/main/docs/sql-component.adoc +++ b/components/camel-sql/src/main/docs/sql-component.adoc @@ -111,12 +111,15 @@ The SQL component supports 3 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| dataSource | common | | DataSource | Sets the DataSource to use to communicate with the database. -| usePlaceholder | advanced | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true -| resolvePropertyPlaceholders | advanced | 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 | Default | Java Type | Description + 4+^s| common +| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. + 4+^s| advanced +| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true + +| 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. |======================================================================= // component options: END @@ -140,54 +143,99 @@ with the following path and query parameters: #### Query Parameters (45 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| allowNamedParameters | common | true | boolean | Whether to allow using named parameters in the queries. -| dataSource | common | | DataSource | Sets the DataSource to use to communicate with the database. -| dataSourceRef | common | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. -| outputClass | common | | String | Specify the full package and class name to use as conversion when outputType=SelectOne. -| outputHeader | common | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. -| outputType | common | SelectList | SqlOutputType | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way: a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column then it will return a Map of that result. c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows it throws an non-unique result exception. -| separator | common | , | char | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders. Notice if you use named parameters then a Map type is used instead. The default value is comma. -| breakBatchOnConsumeFail | consumer | false | boolean | Sets whether to break batch if onConsume failed. -| bridgeErrorHandler | consumer | 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. -| expectedUpdateCount | consumer | -1 | int | Sets an expected update count to validate when using onConsume. -| maxMessagesPerPoll | consumer | | int | Sets the maximum number of messages to poll -| onConsume | consumer | | String | After processing each row then this query can be executed if the Exchange was processed successfully for example to mark the row as processed. The query can have parameter. -| onConsumeBatchComplete | consumer | | String | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. -| onConsumeFailed | consumer | | String | After processing each row then this query can be executed if the Exchange failed for example to mark the row as failed. The query can have parameter. -| routeEmptyResultSet | consumer | false | boolean | Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| transacted | consumer | false | boolean | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager -| useIterator | consumer | true | boolean | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | 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. -| processingStrategy | consumer (advanced) | | SqlProcessingStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. -| batch | producer | false | boolean | Enables or disables batch mode -| noop | producer | false | boolean | If set will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing -| useMessageBodyForSql | producer | false | boolean | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. -| alwaysPopulateStatement | producer (advanced) | false | boolean | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. -| parametersCount | producer (advanced) | | int | If set greater than zero then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count then user may override instead. -| placeholder | advanced | # | String | Specifies a character that will be replaced to in SQL query. Notice that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change). -| prepareStatementStrategy | advanced | | SqlPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| templateOptions | advanced | | Map | Configures the Spring JdbcTemplate with the key/values from the Map -| usePlaceholder | advanced | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | 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 | scheduler | 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 | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 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 | scheduler | 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 | scheduler | | 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 | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Default | Java Type | Description + +| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries. + +| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. + +| dataSourceRef | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. + +| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne. + +| outputHeader | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. + +| outputType | SelectList | SqlOutputType | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way: a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column then it will return a Map of that result. c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows it throws an non-unique result exception. + +| separator | , | char | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders. Notice if you use named parameters then a Map type is used instead. The default value is comma. + 4+^s| consumer +| breakBatchOnConsumeFail | false | boolean | Sets whether to break batch if onConsume failed. + +| 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. + +| expectedUpdateCount | -1 | int | Sets an expected update count to validate when using onConsume. + +| maxMessagesPerPoll | | int | Sets the maximum number of messages to poll + +| onConsume | | String | After processing each row then this query can be executed if the Exchange was processed successfully for example to mark the row as processed. The query can have parameter. + +| onConsumeBatchComplete | | String | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. + +| onConsumeFailed | | String | After processing each row then this query can be executed if the Exchange failed for example to mark the row as failed. The query can have parameter. + +| routeEmptyResultSet | false | boolean | Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out. + +| 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. + +| transacted | false | boolean | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager + +| useIterator | true | boolean | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. + 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. + +| processingStrategy | | SqlProcessingStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. + 4+^s| producer +| batch | false | boolean | Enables or disables batch mode + +| noop | false | boolean | If set will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing + +| useMessageBodyForSql | false | boolean | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. + 4+^s| producer (advanced) +| alwaysPopulateStatement | false | boolean | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. + +| parametersCount | | int | If set greater than zero then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count then user may override instead. + 4+^s| advanced +| placeholder | # | String | Specifies a character that will be replaced to in SQL query. Notice that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change). + +| prepareStatementStrategy | | SqlPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + +| templateOptions | | Map | Configures the Spring JdbcTemplate with the key/values from the Map + +| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true + 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. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-sql/src/main/docs/sql-stored-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc index 6a30269..a02d139 100644 --- a/components/camel-sql/src/main/docs/sql-stored-component.adoc +++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc @@ -67,11 +67,13 @@ The SQL StoredProcedure component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| dataSource | producer | | DataSource | Sets the DataSource to use to communicate with the database. -| resolvePropertyPlaceholders | advanced | 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 | Default | Java Type | Description + 4+^s| producer +| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. + 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. |======================================================================= // component options: END @@ -95,15 +97,21 @@ with the following path and query parameters: #### Query Parameters (6 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| batch | producer | false | boolean | Enables or disables batch mode -| dataSource | producer | | DataSource | Sets the DataSource to use to communicate with the database. -| noop | producer | false | boolean | If set will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing -| outputHeader | producer | | String | Store the template result in a header instead of the message body. By default outputHeader == null and the template result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the template result and the original message body is preserved. -| useMessageBodyForTemplate | producer | false | boolean | Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not used. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| batch | false | boolean | Enables or disables batch mode + +| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. + +| noop | false | boolean | If set will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing + +| outputHeader | | String | Store the template result in a header instead of the message body. By default outputHeader == null and the template result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the template result and the original message body is preserved. + +| useMessageBodyForTemplate | false | boolean | Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not 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). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-ssh/src/main/docs/ssh-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc index f8164de..69403e8 100644 --- a/components/camel-ssh/src/main/docs/ssh-component.adoc +++ b/components/camel-ssh/src/main/docs/ssh-component.adoc @@ -34,21 +34,33 @@ The SSH component supports 12 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | SshConfiguration | To use the shared SSH configuration -| host | common | | String | Sets the hostname of the remote SSH server. -| port | common | | int | Sets the port number for the remote SSH server. -| username | security | | String | Sets the username to use in logging into the remote SSH server. -| password | security | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. -| pollCommand | common | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A -| keyPairProvider | security | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. -| keyType | security | | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. -| timeout | common | | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. -| certFilename | security | | String | Sets the resource path of the certificate to use for Authentication. -| certResource | security | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. -| resolvePropertyPlaceholders | advanced | 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 | Default | Java Type | Description + 4+^s| advanced +| configuration | | SshConfiguration | To use the shared SSH configuration + 4+^s| common +| host | | String | Sets the hostname of the remote SSH server. + +| port | | int | Sets the port number for the remote SSH server. + 4+^s| security +| username | | String | Sets the username to use in logging into the remote SSH server. + +| password | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. + 4+^s| common +| pollCommand | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A + 4+^s| security +| keyPairProvider | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. + +| keyType | | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. + 4+^s| common +| timeout | | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. + 4+^s| security +| certFilename | | String | Sets the resource path of the certificate to use for Authentication. + +| certResource | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. + 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. |======================================================================= // component options: END @@ -73,35 +85,61 @@ with the following path and query parameters: #### Query Parameters (26 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| timeout | common | 30000 | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. -| bridgeErrorHandler | consumer | 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. -| pollCommand | consumer | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | 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. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | 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 | scheduler | 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 | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 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 | scheduler | 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 | scheduler | | 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 | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. -| certResource | security | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. -| keyPairProvider | security | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. -| keyType | security | ssh-rsa | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. -| password | security | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. -| username | security | | String | Sets the username to use in logging into the remote SSH server. +| Name | Default | Java Type | Description + +| timeout | 30000 | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. + 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. + +| pollCommand | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A + +| 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. + 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. + +| 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 +| certResource | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. + +| keyPairProvider | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. + +| keyType | ssh-rsa | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. + +| password | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. + +| username | | String | Sets the username to use in logging into the remote SSH server. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-stax/src/main/docs/stax-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc index baa026c..c2befeb 100644 --- a/components/camel-stax/src/main/docs/stax-component.adoc +++ b/components/camel-stax/src/main/docs/stax-component.adoc @@ -70,10 +70,11 @@ with the following path and query parameters: #### Query Parameters (1 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-stomp/src/main/docs/stomp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc index 9beaac4..0296941 100644 --- a/components/camel-stomp/src/main/docs/stomp-component.adoc +++ b/components/camel-stomp/src/main/docs/stomp-component.adoc @@ -38,15 +38,21 @@ The Stomp component supports 6 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | StompConfiguration | To use the shared stomp configuration -| brokerURL | common | | String | The URI of the Stomp broker to connect to -| login | security | | String | The username -| passcode | security | | String | The password -| host | common | | String | The virtual host -| resolvePropertyPlaceholders | advanced | 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 | Default | Java Type | Description + 4+^s| advanced +| configuration | | StompConfiguration | To use the shared stomp configuration + 4+^s| common +| brokerURL | | String | The URI of the Stomp broker to connect to + 4+^s| security +| login | | String | The username + +| passcode | | String | The password + 4+^s| common +| host | | String | The virtual host + 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. |======================================================================= // component options: END @@ -71,18 +77,27 @@ with the following path and query parameters: #### Query Parameters (9 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| brokerURL | common | tcp://localhost:61613 | String | *Required* The URI of the Stomp broker to connect to -| host | common | | String | The virtual host name -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| login | security | | String | The username -| passcode | security | | String | The password -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters +| Name | Default | Java Type | Description + +| brokerURL | tcp://localhost:61613 | String | *Required* The URI of the Stomp broker to connect to + +| host | | String | The virtual host name + 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). + 4+^s| security +| login | | String | The username + +| passcode | | String | The password + +| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-stream/src/main/docs/stream-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stream/src/main/docs/stream-component.adoc b/components/camel-stream/src/main/docs/stream-component.adoc index 3531e11..492a1f4 100644 --- a/components/camel-stream/src/main/docs/stream-component.adoc +++ b/components/camel-stream/src/main/docs/stream-component.adoc @@ -69,27 +69,45 @@ with the following path and query parameters: #### Query Parameters (18 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| encoding | common | | String | You can configure the encoding (is a charset name) to use text-based streams (for example message body is a String object). If not provided Camel uses the JVM default Charset. -| fileName | common | | String | When using the stream:file URI format this option specifies the filename to stream to/from. -| url | common | | String | When using the stream:url URI format this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility. -| bridgeErrorHandler | consumer | 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. -| groupLines | consumer | | int | To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines instead of 1 Exchange per line. -| groupStrategy | consumer | | GroupStrategy | Allows to use a custom GroupStrategy to control how to group lines. -| initialPromptDelay | consumer | 2000 | long | Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. -| promptDelay | consumer | | long | Optional delay in milliseconds before showing the message prompt. -| promptMessage | consumer | | String | Message prompt to use when reading from stream:in; for example you could set this to Enter a command: -| retry | consumer | false | boolean | Will retry opening the file if it's overwritten somewhat like tail --retry -| scanStream | consumer | false | boolean | To be used for continuously reading a stream such as the unix tail command. -| scanStreamDelay | consumer | | long | Delay in milliseconds between read attempts when using scanStream. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| autoCloseCount | producer | | int | Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent the stream is reopened for another autoCloseCount batch. -| closeOnDone | producer | false | boolean | This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done to improve performance. Mind this requires that you only stream to the same file and not 2 or more files. -| delay | producer | | long | Initial delay in milliseconds before producing the stream. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| encoding | | String | You can configure the encoding (is a charset name) to use text-based streams (for example message body is a String object). If not provided Camel uses the JVM default Charset. + +| fileName | | String | When using the stream:file URI format this option specifies the filename to stream to/from. + +| url | | String | When using the stream:url URI format this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility. + 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. + +| groupLines | | int | To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines instead of 1 Exchange per line. + +| groupStrategy | | GroupStrategy | Allows to use a custom GroupStrategy to control how to group lines. + +| initialPromptDelay | 2000 | long | Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. + +| promptDelay | | long | Optional delay in milliseconds before showing the message prompt. + +| promptMessage | | String | Message prompt to use when reading from stream:in; for example you could set this to Enter a command: + +| retry | false | boolean | Will retry opening the file if it's overwritten somewhat like tail --retry + +| scanStream | false | boolean | To be used for continuously reading a stream such as the unix tail command. + +| scanStreamDelay | | long | Delay in milliseconds between read attempts when using scanStream. + 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 +| autoCloseCount | | int | Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent the stream is reopened for another autoCloseCount batch. + +| closeOnDone | false | boolean | This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done to improve performance. Mind this requires that you only stream to the same file and not 2 or more files. + +| delay | | long | Initial delay in milliseconds before producing the stream. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-stringtemplate/src/main/docs/string-template-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc index 23b58b5..f60fc57 100644 --- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc +++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc @@ -59,13 +59,17 @@ with the following path and query parameters: #### Query Parameters (4 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| contentCache | producer | false | boolean | Sets whether to use resource content cache or not -| delimiterStart | producer | < | char | The variable start delimiter -| delimiterStop | producer | > | char | The variable end delimiter -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| contentCache | false | boolean | Sets whether to use resource content cache or not + +| delimiterStart | < | char | The variable start delimiter + +| delimiterStop | > | char | The variable end delimiter + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END
