http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-http4/src/main/docs/http4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-http4/src/main/docs/http4-component.adoc b/components/camel-http4/src/main/docs/http4-component.adoc index 1ebe77b..a76cd6b 100644 --- a/components/camel-http4/src/main/docs/http4-component.adoc +++ b/components/camel-http4/src/main/docs/http4-component.adoc @@ -1,4 +1,4 @@ -## HTTP4 Component +== HTTP4 Component *Available as of Camel version 2.3* @@ -56,24 +56,24 @@ The HTTP4 component supports 15 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **httpClientConfigurer** (advanced) | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. | | HttpClientConfigurer -| **clientConnectionManager** (advanced) | To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. | | HttpClientConnection Manager -| **httpContext** (advanced) | To use a custom org.apache.http.protocol.HttpContext when executing requests. | | HttpContext -| **sslContextParameters** (security) | To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances you need to define a new HttpComponent per instance you need. | | SSLContextParameters -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **x509HostnameVerifier** (security) | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier. | | HostnameVerifier -| **maxTotalConnections** (advanced) | The maximum number of connections. | 200 | int -| **connectionsPerRoute** (advanced) | The maximum number of connections per route. | 20 | int -| **connectionTimeToLive** (advanced) | The time for connection to live the time unit is millisecond the default value is always keep alive. | | long -| **cookieStore** (producer) | To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). | | CookieStore -| **httpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding -| **httpConfiguration** (advanced) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration -| **allowJavaSerialized Object** (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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 -| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **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 -|======================================================================= +| *httpClientConfigurer* (advanced) | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. | | HttpClientConfigurer +| *clientConnectionManager* (advanced) | To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. | | HttpClientConnection Manager +| *httpContext* (advanced) | To use a custom org.apache.http.protocol.HttpContext when executing requests. | | HttpContext +| *sslContextParameters* (security) | To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances you need to define a new HttpComponent per instance you need. | | SSLContextParameters +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *x509HostnameVerifier* (security) | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier. | | HostnameVerifier +| *maxTotalConnections* (advanced) | The maximum number of connections. | 200 | int +| *connectionsPerRoute* (advanced) | The maximum number of connections per route. | 20 | int +| *connectionTimeToLive* (advanced) | The time for connection to live the time unit is millisecond the default value is always keep alive. | | long +| *cookieStore* (producer) | To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). | | CookieStore +| *httpBinding* (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding +| *httpConfiguration* (advanced) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration +| *allowJavaSerialized Object* (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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 +| *headerFilterStrategy* (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *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 @@ -88,72 +88,74 @@ The HTTP4 component supports 15 options which are listed below. // endpoint options: START The HTTP4 endpoint is configured using URI syntax: - http4:httpUri +---- +http4:httpUri +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **httpUri** | *Required* The url of the HTTP endpoint to call. | | URI -|======================================================================= +| *httpUri* | *Required* The url of the HTTP endpoint to call. | | URI +|=== -#### Query Parameters (48 parameters): +==== Query Parameters (48 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **disableStreamCache** (common) | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it 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. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not cache the respon se body stream but use the response stream as-is as the message body. | false | boolean -| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding -| **authenticationPreemptive** (producer) | If this option is true camel-http4 sends preemptive basic authentication to the server. | false | boolean -| **bridgeEndpoint** (producer) | If the option is true HttpProducer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. | false | boolean -| **chunked** (producer) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean -| **clearExpiredCookies** (producer) | Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. | true | boolean -| **connectionClose** (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean -| **cookieStore** (producer) | To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler. | | CookieStore -| **copyHeaders** (producer) | If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false allows to only include the headers from the HTTP response (not propagating IN headers). | true | boolean -| **deleteWithBody** (producer) | Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP message. However in some rare cases users may need to be able to include the message body. | false | boolean -| **httpMethod** (producer) | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. | | HttpMethods -| **ignoreResponseBody** (producer) | If this option is true The http producer won't read response body and cache the input stream | false | boolean -| **preserveHostHeader** (producer) | If the option is true HttpProducer will set the Host header to the value contained in the current exchange Host header useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client this allows applications which use the Host header to generate accurate URL's for a proxied service | false | boolean -| **throwExceptionOnFailure** (producer) | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. | true | boolean -| **transferException** (producer) | 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. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. 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 -| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler -| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. | 200-299 | String -| **urlRewrite** (producer) | *Deprecated* Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html | | UrlRewrite -| **clientBuilder** (advanced) | Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint. | | HttpClientBuilder -| **clientConnectionManager** (advanced) | To use a custom HttpClientConnectionManager to manage connections | | HttpClientConnection Manager -| **connectionsPerRoute** (advanced) | The maximum number of connections per route. | 20 | int -| **httpClient** (advanced) | Sets a custom HttpClient to be used by the producer | | HttpClient -| **httpClientConfigurer** (advanced) | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc | | HttpClientConfigurer -| **httpClientOptions** (advanced) | To configure the HttpClient using the key/values from the Map. | | Map -| **httpContext** (advanced) | To use a custom HttpContext instance | | HttpContext -| **mapHttpMessageBody** (advanced) | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. | true | boolean -| **mapHttpMessageFormUrl EncodedBody** (advanced) | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. | true | boolean -| **mapHttpMessageHeaders** (advanced) | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. | true | boolean -| **maxTotalConnections** (advanced) | The maximum number of connections. | 200 | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **useSystemProperties** (advanced) | To use System Properties as fallback for configuration | false | boolean -| **proxyAuthDomain** (proxy) | Proxy authentication domain to use with NTML | | String -| **proxyAuthHost** (proxy) | Proxy authentication host | | String -| **proxyAuthMethod** (proxy) | Proxy authentication method to use | | String -| **proxyAuthPassword** (proxy) | Proxy authentication password | | String -| **proxyAuthPort** (proxy) | Proxy authentication port | | int -| **proxyAuthScheme** (proxy) | Proxy authentication scheme to use | | String -| **proxyAuthUsername** (proxy) | Proxy authentication username | | String -| **proxyHost** (proxy) | Proxy hostname to use | | String -| **proxyPort** (proxy) | Proxy port to use | | int -| **authDomain** (security) | Authentication domain to use with NTML | | String -| **authHost** (security) | Authentication host to use with NTML | | String -| **authMethod** (security) | Authentication methods allowed to use as a comma separated list of values Basic Digest or NTLM. | | String -| **authMethodPriority** (security) | Which authentication method to prioritize to use either as Basic Digest or NTLM. | | String -| **authPassword** (security) | Authentication password | | String -| **authUsername** (security) | Authentication username | | String -| **x509HostnameVerifier** (security) | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier. | | HostnameVerifier -|======================================================================= +| *disableStreamCache* (common) | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it 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. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not cache the response body stream but use the response stream as-is as the message body. | false | boolean +| *headerFilterStrategy* (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *httpBinding* (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding +| *authenticationPreemptive* (producer) | If this option is true camel-http4 sends preemptive basic authentication to the server. | false | boolean +| *bridgeEndpoint* (producer) | If the option is true HttpProducer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. | false | boolean +| *chunked* (producer) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean +| *clearExpiredCookies* (producer) | Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. | true | boolean +| *connectionClose* (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean +| *cookieStore* (producer) | To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler. | | CookieStore +| *copyHeaders* (producer) | If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false allows to only include the headers from the HTTP response (not propagating IN headers). | true | boolean +| *deleteWithBody* (producer) | Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP message. However in some rare cases users may need to be able to include the message body. | false | boolean +| *httpMethod* (producer) | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. | | HttpMethods +| *ignoreResponseBody* (producer) | If this option is true The http producer won't read response body and cache the input stream | false | boolean +| *preserveHostHeader* (producer) | If the option is true HttpProducer will set the Host header to the value contained in the current exchange Host header useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client this allows applications which use the Host header to generate accurate URL's for a proxied service | false | boolean +| *throwExceptionOnFailure* (producer) | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. | true | boolean +| *transferException* (producer) | 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. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. 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 +| *cookieHandler* (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| *okStatusCodeRange* (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. | 200-299 | String +| *urlRewrite* (producer) | *Deprecated* Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html | | UrlRewrite +| *clientBuilder* (advanced) | Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint. | | HttpClientBuilder +| *clientConnectionManager* (advanced) | To use a custom HttpClientConnectionManager to manage connections | | HttpClientConnection Manager +| *connectionsPerRoute* (advanced) | The maximum number of connections per route. | 20 | int +| *httpClient* (advanced) | Sets a custom HttpClient to be used by the producer | | HttpClient +| *httpClientConfigurer* (advanced) | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc | | HttpClientConfigurer +| *httpClientOptions* (advanced) | To configure the HttpClient using the key/values from the Map. | | Map +| *httpContext* (advanced) | To use a custom HttpContext instance | | HttpContext +| *mapHttpMessageBody* (advanced) | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. | true | boolean +| *mapHttpMessageFormUrl EncodedBody* (advanced) | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. | true | boolean +| *mapHttpMessageHeaders* (advanced) | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. | true | boolean +| *maxTotalConnections* (advanced) | The maximum number of connections. | 200 | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *useSystemProperties* (advanced) | To use System Properties as fallback for configuration | false | boolean +| *proxyAuthDomain* (proxy) | Proxy authentication domain to use with NTML | | String +| *proxyAuthHost* (proxy) | Proxy authentication host | | String +| *proxyAuthMethod* (proxy) | Proxy authentication method to use | | String +| *proxyAuthPassword* (proxy) | Proxy authentication password | | String +| *proxyAuthPort* (proxy) | Proxy authentication port | | int +| *proxyAuthScheme* (proxy) | Proxy authentication scheme to use | | String +| *proxyAuthUsername* (proxy) | Proxy authentication username | | String +| *proxyHost* (proxy) | Proxy hostname to use | | String +| *proxyPort* (proxy) | Proxy port to use | | int +| *authDomain* (security) | Authentication domain to use with NTML | | String +| *authHost* (security) | Authentication host to use with NTML | | String +| *authMethod* (security) | Authentication methods allowed to use as a comma separated list of values Basic Digest or NTLM. | | String +| *authMethodPriority* (security) | Which authentication method to prioritize to use either as Basic Digest or NTLM. | | String +| *authPassword* (security) | Authentication password | | String +| *authUsername* (security) | Authentication username | | String +| *x509HostnameVerifier* (security) | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier. | | HostnameVerifier +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ibatis/src/main/docs/ibatis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ibatis/src/main/docs/ibatis-component.adoc b/components/camel-ibatis/src/main/docs/ibatis-component.adoc index 2eddd0d..d4d7704 100644 --- a/components/camel-ibatis/src/main/docs/ibatis-component.adoc +++ b/components/camel-ibatis/src/main/docs/ibatis-component.adoc @@ -1,4 +1,4 @@ -## iBatis Component (deprecated) +== iBatis Component (deprecated) *Available as of Camel version 1.2* @@ -61,13 +61,13 @@ The iBatis component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **sqlMapClient** (advanced) | To use the given com.ibatis.sqlmap.client.SqlMapClient | | SqlMapClient -| **sqlMapConfig** (common) | Location of iBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath | classpath:SqlMapConfig.xml | String -| **useTransactions** (common) | Whether to use transactions. This option is by default true. | true | boolean -| **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 -|======================================================================= +| *sqlMapClient* (advanced) | To use the given com.ibatis.sqlmap.client.SqlMapClient | | SqlMapClient +| *sqlMapConfig* (common) | Location of iBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath | classpath:SqlMapConfig.xml | String +| *useTransactions* (common) | Whether to use transactions. This option is by default true. | true | boolean +| *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 @@ -80,51 +80,53 @@ The iBatis component supports 4 options which are listed below. // endpoint options: START The iBatis endpoint is configured using URI syntax: - ibatis:statement +---- +ibatis:statement +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **statement** | *Required* The statement name in the iBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. | | String -|======================================================================= +| *statement* | *Required* The statement name in the iBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **isolation** (common) | Transaction isolation level | TRANSACTION_REPEATABLE_READ | String -| **useTransactions** (common) | Whether to use transactions. This option is by default true. | true | 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 -| **maxMessagesPerPoll** (consumer) | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it. | 0 | int -| **onConsume** (consumer) | Statement to run after data has been processed in the route | | String -| **routeEmptyResultSet** (consumer) | Whether allow empty resultset to be routed to the next hop | false | boolean -| **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 -| **strategy** (consumer) | Allows to plugin a custom IBatisProcessingStrategy to use by the consumer. | | IBatisProcessing Strategy -| **useIterator** (consumer) | Process resultset individually or as a list | true | 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 -| **statementType** (producer) | Mandatory to specify for the producer to control which kind of operation to invoke. | | StatementType -| **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 -|======================================================================= +| *isolation* (common) | Transaction isolation level | TRANSACTION_REPEATABLE_READ | String +| *useTransactions* (common) | Whether to use transactions. This option is by default true. | true | 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 +| *maxMessagesPerPoll* (consumer) | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it. | 0 | int +| *onConsume* (consumer) | Statement to run after data has been processed in the route | | String +| *routeEmptyResultSet* (consumer) | Whether allow empty resultset to be routed to the next hop | false | boolean +| *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 +| *strategy* (consumer) | Allows to plugin a custom IBatisProcessingStrategy to use by the consumer. | | IBatisProcessing Strategy +| *useIterator* (consumer) | Process resultset individually or as a list | true | 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 +| *statementType* (producer) | Mandatory to specify for the producer to control which kind of operation to invoke. | | StatementType +| *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 +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ical/src/main/docs/ical-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ical/src/main/docs/ical-dataformat.adoc b/components/camel-ical/src/main/docs/ical-dataformat.adoc index 0798456..fa843ec 100644 --- a/components/camel-ical/src/main/docs/ical-dataformat.adoc +++ b/components/camel-ical/src/main/docs/ical-dataformat.adoc @@ -1,4 +1,4 @@ -## iCal DataFormat +== iCal DataFormat *Available as of Camel version 2.12* @@ -34,11 +34,11 @@ The iCal dataformat supports 2 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | validating | false | Boolean | Whether to validate. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Basic Usage http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc b/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc index 60367ec..6af9fb8 100644 --- a/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc +++ b/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc @@ -1,4 +1,4 @@ -## IEC 60870 Client Component +== IEC 60870 Client Component *Available as of Camel version 2.20* @@ -30,11 +30,11 @@ The IEC 60870 Client component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultConnection Options** (common) | Default connection options | | ClientOptions -| **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 -|======================================================================= +| *defaultConnection Options* (common) | Default connection options | | ClientOptions +| *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 @@ -60,42 +60,44 @@ with zero. // endpoint options: START The IEC 60870 Client endpoint is configured using URI syntax: - iec60870-client:endpointUri +---- +iec60870-client:endpointUri +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **uriPath** | *Required* The object information address | | ObjectAddress -|======================================================================= +| *uriPath* | *Required* The object information address | | ObjectAddress +|=== -#### Query Parameters (18 parameters): +==== Query Parameters (18 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **dataModuleOptions** (common) | Data module options | | DataModuleOptions -| **protocolOptions** (common) | Protocol options | | ProtocolOptions -| **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 -| **acknowledgeWindow** (connection) | Parameter W - Acknowledgment window. | 10 | short -| **adsuAddressType** (connection) | The common ASDU address size. May be either SIZE_1 or SIZE_2. | | ASDUAddressType -| **causeOfTransmissionType** (connection) | The cause of transmission type. May be either SIZE_1 or SIZE_2. | | CauseOfTransmission Type -| **informationObjectAddress Type** (connection) | The information address size. May be either SIZE_1 SIZE_2 or SIZE_3. | | InformationObject AddressType -| **maxUnacknowledged** (connection) | Parameter K - Maximum number of un-acknowledged messages. | 15 | short -| **timeout1** (connection) | Timeout T1 in milliseconds. | 15000 | int -| **timeout2** (connection) | Timeout T2 in milliseconds. | 10000 | int -| **timeout3** (connection) | Timeout T3 in milliseconds. | 20000 | int -| **ignoreBackgroundScan** (data) | Whether background scan transmissions should be ignored. | true | boolean -| **ignoreDaylightSavingTime** (data) | Whether to ignore or respect DST | false | boolean -| **timeZone** (data) | The timezone to use. May be any Java time zone string | UTC | TimeZone -| **connectionId** (id) | An identifier grouping connection instances | | String -|======================================================================= +| *dataModuleOptions* (common) | Data module options | | DataModuleOptions +| *protocolOptions* (common) | Protocol options | | ProtocolOptions +| *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 +| *acknowledgeWindow* (connection) | Parameter W - Acknowledgment window. | 10 | short +| *adsuAddressType* (connection) | The common ASDU address size. May be either SIZE_1 or SIZE_2. | | ASDUAddressType +| *causeOfTransmissionType* (connection) | The cause of transmission type. May be either SIZE_1 or SIZE_2. | | CauseOfTransmission Type +| *informationObjectAddress Type* (connection) | The information address size. May be either SIZE_1 SIZE_2 or SIZE_3. | | InformationObject AddressType +| *maxUnacknowledged* (connection) | Parameter K - Maximum number of un-acknowledged messages. | 15 | short +| *timeout1* (connection) | Timeout T1 in milliseconds. | 15000 | int +| *timeout2* (connection) | Timeout T2 in milliseconds. | 10000 | int +| *timeout3* (connection) | Timeout T3 in milliseconds. | 20000 | int +| *ignoreBackgroundScan* (data) | Whether background scan transmissions should be ignored. | true | boolean +| *ignoreDaylightSavingTime* (data) | Whether to ignore or respect DST | false | boolean +| *timeZone* (data) | The timezone to use. May be any Java time zone string | UTC | TimeZone +| *connectionId* (id) | An identifier grouping connection instances | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc b/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc index 338e8d7..5915a51 100644 --- a/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc +++ b/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc @@ -1,4 +1,4 @@ -## IEC 60870-5-104 server Component +== IEC 60870-5-104 server Component *Available as of Camel version 2.20* @@ -31,11 +31,11 @@ The IEC 60870-5-104 server component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultConnection Options** (common) | Default connection options | | ServerOptions -| **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 -|======================================================================= +| *defaultConnection Options* (common) | Default connection options | | ServerOptions +| *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 @@ -63,43 +63,45 @@ with zero. // endpoint options: START The IEC 60870-5-104 server endpoint is configured using URI syntax: - iec60870-server:endpointUri +---- +iec60870-server:endpointUri +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **uriPath** | *Required* The object information address | | ObjectAddress -|======================================================================= +| *uriPath* | *Required* The object information address | | ObjectAddress +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **dataModuleOptions** (common) | Data module options | | DataModuleOptions -| **filterNonExecute** (common) | Filter out all requests which don't have the execute bit set | true | boolean -| **protocolOptions** (common) | Protocol options | | ProtocolOptions -| **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 -| **acknowledgeWindow** (connection) | Parameter W - Acknowledgment window. | 10 | short -| **adsuAddressType** (connection) | The common ASDU address size. May be either SIZE_1 or SIZE_2. | | ASDUAddressType -| **causeOfTransmissionType** (connection) | The cause of transmission type. May be either SIZE_1 or SIZE_2. | | CauseOfTransmission Type -| **informationObjectAddress Type** (connection) | The information address size. May be either SIZE_1 SIZE_2 or SIZE_3. | | InformationObject AddressType -| **maxUnacknowledged** (connection) | Parameter K - Maximum number of un-acknowledged messages. | 15 | short -| **timeout1** (connection) | Timeout T1 in milliseconds. | 15000 | int -| **timeout2** (connection) | Timeout T2 in milliseconds. | 10000 | int -| **timeout3** (connection) | Timeout T3 in milliseconds. | 20000 | int -| **ignoreBackgroundScan** (data) | Whether background scan transmissions should be ignored. | true | boolean -| **ignoreDaylightSavingTime** (data) | Whether to ignore or respect DST | false | boolean -| **timeZone** (data) | The timezone to use. May be any Java time zone string | UTC | TimeZone -| **connectionId** (id) | An identifier grouping connection instances | | String -|======================================================================= +| *dataModuleOptions* (common) | Data module options | | DataModuleOptions +| *filterNonExecute* (common) | Filter out all requests which don't have the execute bit set | true | boolean +| *protocolOptions* (common) | Protocol options | | ProtocolOptions +| *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 +| *acknowledgeWindow* (connection) | Parameter W - Acknowledgment window. | 10 | short +| *adsuAddressType* (connection) | The common ASDU address size. May be either SIZE_1 or SIZE_2. | | ASDUAddressType +| *causeOfTransmissionType* (connection) | The cause of transmission type. May be either SIZE_1 or SIZE_2. | | CauseOfTransmission Type +| *informationObjectAddress Type* (connection) | The information address size. May be either SIZE_1 SIZE_2 or SIZE_3. | | InformationObject AddressType +| *maxUnacknowledged* (connection) | Parameter K - Maximum number of un-acknowledged messages. | 15 | short +| *timeout1* (connection) | Timeout T1 in milliseconds. | 15000 | int +| *timeout2* (connection) | Timeout T2 in milliseconds. | 10000 | int +| *timeout3* (connection) | Timeout T3 in milliseconds. | 20000 | int +| *ignoreBackgroundScan* (data) | Whether background scan transmissions should be ignored. | true | boolean +| *ignoreDaylightSavingTime* (data) | Whether to ignore or respect DST | false | boolean +| *timeZone* (data) | The timezone to use. May be any Java time zone string | UTC | TimeZone +| *connectionId* (id) | An identifier grouping connection instances | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ignite/src/main/docs/ignite-cache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ignite/src/main/docs/ignite-cache-component.adoc b/components/camel-ignite/src/main/docs/ignite-cache-component.adoc index 500bd95..18ca924 100644 --- a/components/camel-ignite/src/main/docs/ignite-cache-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-cache-component.adoc @@ -1,4 +1,4 @@ -## Ignite Cache Component +== Ignite Cache Component *Available as of Camel version 2.17* @@ -17,52 +17,54 @@ The Ignite Cache component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ignite** (common) | Sets the Ignite instance. | | Ignite -| **configurationResource** (common) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object -| **igniteConfiguration** (common) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration -| **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 -|======================================================================= +| *ignite* (common) | Sets the Ignite instance. | | Ignite +| *configurationResource* (common) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object +| *igniteConfiguration* (common) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration +| *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 // endpoint options: START The Ignite Cache endpoint is configured using URI syntax: - ignite-cache:cacheName +---- +ignite-cache:cacheName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cacheName** | *Required* The cache name. | | String -|======================================================================= +| *cacheName* | *Required* The cache name. | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **propagateIncomingBodyIfNo ReturnValue** (common) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean -| **treatCollectionsAsCache Objects** (common) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean -| **autoUnsubscribe** (consumer) | Whether auto unsubscribe is enabled in the Continuous Query Consumer. | true | 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 -| **fireExistingQueryResults** (consumer) | Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer. | false | boolean -| **oneExchangePerUpdate** (consumer) | Whether to pack each update in an individual Exchange even if multiple updates are received in one batch. Only used by the Continuous Query Consumer. | true | boolean -| **pageSize** (consumer) | The page size. Only used by the Continuous Query Consumer. | 1 | int -| **query** (consumer) | The Query to execute only needed for operations that require it and for the Continuous Query Consumer. | | Object>> -| **remoteFilter** (consumer) | The remote filter only used by the Continuous Query Consumer. | | Object> -| **timeInterval** (consumer) | The time interval for the Continuous Query Consumer. | 0 | long -| **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 -| **cachePeekMode** (producer) | The CachePeekMode only needed for operations that require it (link IgniteCacheOperationSIZE). | ALL | CachePeekMode -| **failIfInexistentCache** (producer) | Whether to fail the initialization if the cache doesn't exist. | false | boolean -| **operation** (producer) | The cache operation to invoke. Possible values: GET PUT REMOVE SIZE REBALANCE QUERY CLEAR. | | IgniteCacheOperation -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *propagateIncomingBodyIfNo ReturnValue* (common) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean +| *treatCollectionsAsCache Objects* (common) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean +| *autoUnsubscribe* (consumer) | Whether auto unsubscribe is enabled in the Continuous Query Consumer. | true | 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 +| *fireExistingQueryResults* (consumer) | Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer. | false | boolean +| *oneExchangePerUpdate* (consumer) | Whether to pack each update in an individual Exchange even if multiple updates are received in one batch. Only used by the Continuous Query Consumer. | true | boolean +| *pageSize* (consumer) | The page size. Only used by the Continuous Query Consumer. | 1 | int +| *query* (consumer) | The Query to execute only needed for operations that require it and for the Continuous Query Consumer. | | Object>> +| *remoteFilter* (consumer) | The remote filter only used by the Continuous Query Consumer. | | Object> +| *timeInterval* (consumer) | The time interval for the Continuous Query Consumer. | 0 | long +| *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 +| *cachePeekMode* (producer) | The CachePeekMode only needed for operations that require it (link IgniteCacheOperationSIZE). | ALL | CachePeekMode +| *failIfInexistentCache* (producer) | Whether to fail the initialization if the cache doesn't exist. | false | boolean +| *operation* (producer) | The cache operation to invoke. Possible values: GET PUT REMOVE SIZE REBALANCE QUERY CLEAR. | | IgniteCacheOperation +| *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 @@ -94,4 +96,3 @@ It does not allow you to dynamically change the cache against which a producer o | CamelIgniteCacheOldValue | IgniteConstants.IGNITE_CACHE_OLD_VALUE | Object | This header carries the old cache value when passed in the incoming cache event (consumer). |======================================================================= - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ignite/src/main/docs/ignite-compute-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ignite/src/main/docs/ignite-compute-component.adoc b/components/camel-ignite/src/main/docs/ignite-compute-component.adoc index 7ddc600..cf853a7 100644 --- a/components/camel-ignite/src/main/docs/ignite-compute-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-compute-component.adoc @@ -1,4 +1,4 @@ -## Ignite Compute Component +== Ignite Compute Component *Available as of Camel version 2.17* @@ -18,44 +18,46 @@ The Ignite Compute component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ignite** (producer) | Sets the Ignite instance. | | Ignite -| **configurationResource** (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object -| **igniteConfiguration** (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration -| **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 -|======================================================================= +| *ignite* (producer) | Sets the Ignite instance. | | Ignite +| *configurationResource* (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object +| *igniteConfiguration* (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration +| *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 // endpoint options: START The Ignite Compute endpoint is configured using URI syntax: - ignite-compute:endpointId +---- +ignite-compute:endpointId +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **endpointId** | *Required* The endpoint ID (not used). | | String -|======================================================================= +| *endpointId* | *Required* The endpoint ID (not used). | | String +|=== -#### Query Parameters (8 parameters): +==== Query Parameters (8 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **clusterGroupExpression** (producer) | An expression that returns the Cluster Group for the IgniteCompute instance. | | ClusterGroupExpression -| **computeName** (producer) | The name of the compute job which will be set via link IgniteComputewithName(String). | | String -| **executionType** (producer) | *Required* The compute operation to perform. Possible values: CALL BROADCAST APPLY EXECUTE RUN AFFINITY_CALL AFFINITY_RUN. The component expects different payload types depending on the operation. | | IgniteComputeExecution Type -| **propagateIncomingBodyIfNo ReturnValue** (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean -| **taskName** (producer) | The task name only applicable if using the link IgniteComputeExecutionTypeEXECUTE execution type. | | String -| **timeoutMillis** (producer) | The timeout interval for triggered jobs in milliseconds which will be set via link IgniteComputewithTimeout(long). | | Long -| **treatCollectionsAsCache Objects** (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *clusterGroupExpression* (producer) | An expression that returns the Cluster Group for the IgniteCompute instance. | | ClusterGroupExpression +| *computeName* (producer) | The name of the compute job which will be set via link IgniteComputewithName(String). | | String +| *executionType* (producer) | *Required* The compute operation to perform. Possible values: CALL BROADCAST APPLY EXECUTE RUN AFFINITY_CALL AFFINITY_RUN. The component expects different payload types depending on the operation. | | IgniteComputeExecution Type +| *propagateIncomingBodyIfNo ReturnValue* (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean +| *taskName* (producer) | The task name only applicable if using the link IgniteComputeExecutionTypeEXECUTE execution type. | | String +| *timeoutMillis* (producer) | The timeout interval for triggered jobs in milliseconds which will be set via link IgniteComputewithTimeout(long). | | Long +| *treatCollectionsAsCache Objects* (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean +| *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 @@ -95,4 +97,3 @@ Affinity cache name for the AFFINITY_CALL and AFFINITY_RUN operations. | CamelIgniteComputeAffinityKey | IgniteConstants.IGNITE_COMPUTE_AFFINITY_KEY | Object | Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations. |======================================================================= - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ignite/src/main/docs/ignite-events-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ignite/src/main/docs/ignite-events-component.adoc b/components/camel-ignite/src/main/docs/ignite-events-component.adoc index 514ac88..e0c1993 100644 --- a/components/camel-ignite/src/main/docs/ignite-events-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-events-component.adoc @@ -1,4 +1,4 @@ -## Ignite Events Component +== Ignite Events Component *Available as of Camel version 2.17* @@ -15,42 +15,44 @@ The Ignite Events component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ignite** (consumer) | Sets the Ignite instance. | | Ignite -| **configurationResource** (consumer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object -| **igniteConfiguration** (consumer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration -| **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 -|======================================================================= +| *ignite* (consumer) | Sets the Ignite instance. | | Ignite +| *configurationResource* (consumer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object +| *igniteConfiguration* (consumer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration +| *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 // endpoint options: START The Ignite Events endpoint is configured using URI syntax: - ignite-events:endpointId +---- +ignite-events:endpointId +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **endpointId** | The endpoint ID (not used). | | String -|======================================================================= +| *endpointId* | The endpoint ID (not used). | | String +|=== -#### Query Parameters (8 parameters): +==== Query Parameters (8 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **clusterGroupExpression** (consumer) | The cluster group expression. | | ClusterGroupExpression -| **events** (consumer) | The event IDs to subscribe to as a Set directly where the IDs are the different constants in org.apache.ignite.events.EventType. | EventType.EVTS_ALL | Set<Integer>OrString -| **propagateIncomingBodyIfNo ReturnValue** (consumer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean -| **treatCollectionsAsCache Objects** (consumer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | 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 -|======================================================================= +| *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 +| *clusterGroupExpression* (consumer) | The cluster group expression. | | ClusterGroupExpression +| *events* (consumer) | The event IDs to subscribe to as a Set directly where the IDs are the different constants in org.apache.ignite.events.EventType. | EventType.EVTS_ALL | Set<Integer>OrString +| *propagateIncomingBodyIfNo ReturnValue* (consumer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean +| *treatCollectionsAsCache Objects* (consumer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc b/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc index 67d44d4..c5c0e24 100644 --- a/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc @@ -1,4 +1,4 @@ -## Ignite ID Generator Component +== Ignite ID Generator Component *Available as of Camel version 2.17* @@ -14,40 +14,42 @@ The Ignite ID Generator component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ignite** (producer) | Sets the Ignite instance. | | Ignite -| **configurationResource** (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object -| **igniteConfiguration** (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration -| **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 -|======================================================================= +| *ignite* (producer) | Sets the Ignite instance. | | Ignite +| *configurationResource* (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object +| *igniteConfiguration* (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration +| *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 // endpoint options: START The Ignite ID Generator endpoint is configured using URI syntax: - ignite-idgen:name +---- +ignite-idgen:name +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* The sequence name. | | String -|======================================================================= +| *name* | *Required* The sequence name. | | String +|=== -#### Query Parameters (6 parameters): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **batchSize** (producer) | The batch size. | | Integer -| **initialValue** (producer) | The initial value. | 0 | Long -| **operation** (producer) | The operation to invoke on the Ignite ID Generator. Superseded by the IgniteConstants.IGNITE_IDGEN_OPERATION header in the IN message. Possible values: ADD_AND_GET GET GET_AND_ADD GET_AND_INCREMENT INCREMENT_AND_GET. | | IgniteIdGenOperation -| **propagateIncomingBodyIfNo ReturnValue** (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean -| **treatCollectionsAsCache Objects** (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *batchSize* (producer) | The batch size. | | Integer +| *initialValue* (producer) | The initial value. | 0 | Long +| *operation* (producer) | The operation to invoke on the Ignite ID Generator. Superseded by the IgniteConstants.IGNITE_IDGEN_OPERATION header in the IN message. Possible values: ADD_AND_GET GET GET_AND_ADD GET_AND_INCREMENT INCREMENT_AND_GET. | | IgniteIdGenOperation +| *propagateIncomingBodyIfNo ReturnValue* (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean +| *treatCollectionsAsCache Objects* (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean +| *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/4f4f2e45/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc b/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc index 21ed4c3..74ee020 100644 --- a/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc @@ -1,4 +1,4 @@ -## Ignite Messaging Component +== Ignite Messaging Component *Available as of Camel version 2.17* @@ -14,45 +14,47 @@ The Ignite Messaging component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ignite** (common) | Sets the Ignite instance. | | Ignite -| **configurationResource** (common) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object -| **igniteConfiguration** (common) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration -| **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 -|======================================================================= +| *ignite* (common) | Sets the Ignite instance. | | Ignite +| *configurationResource* (common) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object +| *igniteConfiguration* (common) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration +| *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 // endpoint options: START The Ignite Messaging endpoint is configured using URI syntax: - ignite-messaging:topic +---- +ignite-messaging:topic +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **topic** | *Required* The topic name. | | String -|======================================================================= +| *topic* | *Required* The topic name. | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **propagateIncomingBodyIfNo ReturnValue** (common) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean -| **treatCollectionsAsCache Objects** (common) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | 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 -| **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 -| **clusterGroupExpression** (producer) | The cluster group expression. | | ClusterGroupExpression -| **sendMode** (producer) | The send mode to use. Possible values: UNORDERED ORDERED. | UNORDERED | IgniteMessagingSend Mode -| **timeout** (producer) | The timeout for the send operation when using ordered messages. | | Long -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *propagateIncomingBodyIfNo ReturnValue* (common) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean +| *treatCollectionsAsCache Objects* (common) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | 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 +| *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 +| *clusterGroupExpression* (producer) | The cluster group expression. | | ClusterGroupExpression +| *sendMode* (producer) | The send mode to use. Possible values: UNORDERED ORDERED. | UNORDERED | IgniteMessagingSend Mode +| *timeout* (producer) | The timeout for the send operation when using ordered messages. | | Long +| *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
