http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-apns/src/main/docs/apns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc index 3ad9037..efd2804 100644 --- a/components/camel-apns/src/main/docs/apns-component.adoc +++ b/components/camel-apns/src/main/docs/apns-component.adoc @@ -1,4 +1,4 @@ -## APNS Component +== APNS Component *Available as of Camel version 2.8* @@ -56,11 +56,11 @@ The APNS component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apnsService** (common) | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService | | ApnsService -| **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 -|======================================================================= +| *apnsService* (common) | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService | | ApnsService +| *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 @@ -69,44 +69,46 @@ The APNS component supports 2 options which are listed below. // endpoint options: START The APNS endpoint is configured using URI syntax: - apns:name +---- +apns: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** | Name of the endpoint | | String -|======================================================================= +| *name* | Name of the endpoint | | String +|=== -#### Query Parameters (20 parameters): +==== Query Parameters (20 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **tokens** (common) | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **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 -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **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 -|======================================================================= +| *tokens* (common) | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *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 +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *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-asn1/src/main/docs/asn1-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-asn1/src/main/docs/asn1-dataformat.adoc b/components/camel-asn1/src/main/docs/asn1-dataformat.adoc index 80f84d2..c1684b1 100644 --- a/components/camel-asn1/src/main/docs/asn1-dataformat.adoc +++ b/components/camel-asn1/src/main/docs/asn1-dataformat.adoc @@ -1,4 +1,4 @@ -## ASN.1 File DataFormat +== ASN.1 File DataFormat *Available as of Camel version 2.20* @@ -12,12 +12,12 @@ The ASN.1 File dataformat supports 3 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | usingIterator | false | Boolean | If the asn1 file has more then one entry the setting this option to true allows to work with the splitter EIP to split the data using an iterator in a streaming mode. | clazzName | | String | Name of class to use when unmarshalling | 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 ### Unmarshal http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-asterisk/src/main/docs/asterisk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-asterisk/src/main/docs/asterisk-component.adoc b/components/camel-asterisk/src/main/docs/asterisk-component.adoc index 8f2f706..428c551 100644 --- a/components/camel-asterisk/src/main/docs/asterisk-component.adoc +++ b/components/camel-asterisk/src/main/docs/asterisk-component.adoc @@ -1,4 +1,4 @@ -## Asterisk Component +== Asterisk Component *Available as of Camel version 2.18* @@ -35,32 +35,34 @@ The Asterisk component has no options. // endpoint options: START The Asterisk endpoint is configured using URI syntax: - asterisk:name +---- +asterisk: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* Logical name | | String -|======================================================================= +| *name* | *Required* Logical name | | String +|=== -#### Query Parameters (8 parameters): +==== Query Parameters (8 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hostname** (common) | *Required* The hostname of the asterisk server | | String -| **password** (common) | *Required* Login password | | String -| **username** (common) | *Required* Login username | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **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 -| **action** (producer) | What action to perform such as getting queue status sip peers or extension state. | | AsteriskAction -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *hostname* (common) | *Required* The hostname of the asterisk server | | String +| *password* (common) | *Required* Login password | | String +| *username* (common) | *Required* Login username | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *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 +| *action* (producer) | What action to perform such as getting queue status sip peers or extension state. | | AsteriskAction +| *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 ### Action http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-atmos/src/main/docs/atmos-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atmos/src/main/docs/atmos-component.adoc b/components/camel-atmos/src/main/docs/atmos-component.adoc index 3f8a2ee..9dcbd37 100644 --- a/components/camel-atmos/src/main/docs/atmos-component.adoc +++ b/components/camel-atmos/src/main/docs/atmos-component.adoc @@ -1,4 +1,4 @@ -## Atmos Component +== Atmos Component *Available as of Camel version 2.15* @@ -23,37 +23,39 @@ The Atmos component has no options. // endpoint options: START The Atmos endpoint is configured using URI syntax: - atmos:name/operation +---- +atmos:name/operation +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | Atmos name | | String -| **operation** | *Required* Operation to perform | | AtmosOperation -|======================================================================= +| *name* | Atmos name | | String +| *operation* | *Required* Operation to perform | | AtmosOperation +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **enableSslValidation** (common) | Atmos SSL validation | false | boolean -| **fullTokenId** (common) | Atmos client fullTokenId | | String -| **localPath** (common) | Local path to put files | | String -| **newRemotePath** (common) | New path on Atmos when moving files | | String -| **query** (common) | Search query on Atmos | | String -| **remotePath** (common) | Where to put files on Atmos | | String -| **secretKey** (common) | Atmos shared secret | | String -| **uri** (common) | Atomos server uri | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **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 -|======================================================================= +| *enableSslValidation* (common) | Atmos SSL validation | false | boolean +| *fullTokenId* (common) | Atmos client fullTokenId | | String +| *localPath* (common) | Local path to put files | | String +| *newRemotePath* (common) | New path on Atmos when moving files | | String +| *query* (common) | Search query on Atmos | | String +| *remotePath* (common) | Where to put files on Atmos | | String +| *secretKey* (common) | Atmos shared secret | | String +| *uri* (common) | Atomos server uri | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *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-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc index ef7fcb0..0b37761 100644 --- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc +++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc @@ -1,4 +1,4 @@ -## Atmosphere Websocket Component +== Atmosphere Websocket Component *Available as of Camel version 2.14* @@ -39,17 +39,17 @@ The Atmosphere Websocket component supports 8 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **servletName** (common) | Default name of servlet to use. The default name is CamelServlet. | | String -| **httpRegistry** (common) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry -| **attachmentMultipart Binding** (common) | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. | false | boolean -| **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 -|======================================================================= +| *servletName* (common) | Default name of servlet to use. The default name is CamelServlet. | | String +| *httpRegistry* (common) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry +| *attachmentMultipart Binding* (common) | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. | false | boolean +| *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 @@ -58,61 +58,63 @@ The Atmosphere Websocket component supports 8 options which are listed below. // endpoint options: START The Atmosphere Websocket endpoint is configured using URI syntax: - atmosphere-websocket:servicePath +---- +atmosphere-websocket:servicePath +---- 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 -| **servicePath** | *Required* Name of websocket endpoint | | String -|======================================================================= +| *servicePath* | *Required* Name of websocket endpoint | | String +|=== -#### Query Parameters (37 parameters): +==== Query Parameters (37 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **chunked** (common) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean -| **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 -| **sendToAll** (common) | Whether to send to all (broadcast) or send to a single receiver. | false | boolean -| **transferException** (common) | 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 -| **useStreaming** (common) | To enable streaming to send data as multiple text fragments. | false | boolean -| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding -| **async** (consumer) | Configure the consumer to work in async mode | 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 -| **httpMethodRestrict** (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String -| **matchOnUriPrefix** (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean -| **responseBufferSize** (consumer) | To use a custom buffer size on the javax.servlet.ServletResponse. | | Integer -| **servletName** (consumer) | Name of the servlet to use | CamelServlet | String -| **attachmentMultipartBinding** (consumer) | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. | false | boolean -| **eagerCheckContentAvailable** (consumer) | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. | 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 -| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | false | boolean -| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. | 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 -| **connectionClose** (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean -| **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 -| **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 -| **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 -| **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 -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **proxyAuthScheme** (proxy) | Proxy authentication scheme to use | | String -| **proxyHost** (proxy) | Proxy hostname to use | | String -| **proxyPort** (proxy) | Proxy port to use | | int -| **authHost** (security) | Authentication host to use with NTML | | String -|======================================================================= +| *chunked* (common) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean +| *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 +| *sendToAll* (common) | Whether to send to all (broadcast) or send to a single receiver. | false | boolean +| *transferException* (common) | 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 +| *useStreaming* (common) | To enable streaming to send data as multiple text fragments. | false | boolean +| *httpBinding* (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding +| *async* (consumer) | Configure the consumer to work in async mode | 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 +| *httpMethodRestrict* (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String +| *matchOnUriPrefix* (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean +| *responseBufferSize* (consumer) | To use a custom buffer size on the javax.servlet.ServletResponse. | | Integer +| *servletName* (consumer) | Name of the servlet to use | CamelServlet | String +| *attachmentMultipartBinding* (consumer) | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. | false | boolean +| *eagerCheckContentAvailable* (consumer) | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. | 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 +| *optionsEnabled* (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | false | boolean +| *traceEnabled* (consumer) | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. | 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 +| *connectionClose* (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean +| *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 +| *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 +| *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 +| *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 +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *proxyAuthScheme* (proxy) | Proxy authentication scheme to use | | String +| *proxyHost* (proxy) | Proxy hostname to use | | String +| *proxyPort* (proxy) | Proxy port to use | | int +| *authHost* (security) | Authentication host to use with NTML | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-atom/src/main/docs/atom-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atom/src/main/docs/atom-component.adoc b/components/camel-atom/src/main/docs/atom-component.adoc index 33a8a57..6e7ab06 100644 --- a/components/camel-atom/src/main/docs/atom-component.adoc +++ b/components/camel-atom/src/main/docs/atom-component.adoc @@ -1,4 +1,4 @@ -## Atom Component +== Atom Component *Available as of Camel version 1.2* @@ -42,51 +42,53 @@ The Atom component has no options. // endpoint options: START The Atom endpoint is configured using URI syntax: - atom:feedUri +---- +atom:feedUri +---- 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 -| **feedUri** | *Required* The URI to the feed to poll. | | String -|======================================================================= +| *feedUri* | *Required* The URI to the feed to poll. | | String +|=== -#### Query Parameters (27 parameters): +==== Query Parameters (27 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 -| **feedHeader** (consumer) | Sets whether to add the feed object as a header | true | boolean -| **filter** (consumer) | Sets whether to use filtering or not of the entries. | true | boolean -| **lastUpdate** (consumer) | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. | | Date -| **password** (consumer) | Sets the password to be used for basic authentication when polling from a HTTP feed | | String -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **sortEntries** (consumer) | Sets whether to sort entries by published date. Only works when splitEntries = true. | false | boolean -| **splitEntries** (consumer) | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message | true | boolean -| **throttleEntries** (consumer) | Sets whether all entries identified in a single feed poll should be delivered immediately. If true only one entry is processed per consumer.delay. Only applicable when splitEntries = true. | true | boolean -| **username** (consumer) | Sets the username to be used for basic authentication when polling from a HTTP feed | | String -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **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 -|======================================================================= +| *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 +| *feedHeader* (consumer) | Sets whether to add the feed object as a header | true | boolean +| *filter* (consumer) | Sets whether to use filtering or not of the entries. | true | boolean +| *lastUpdate* (consumer) | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. | | Date +| *password* (consumer) | Sets the password to be used for basic authentication when polling from a HTTP feed | | String +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *sortEntries* (consumer) | Sets whether to sort entries by published date. Only works when splitEntries = true. | false | boolean +| *splitEntries* (consumer) | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message | true | boolean +| *throttleEntries* (consumer) | Sets whether all entries identified in a single feed poll should be delivered immediately. If true only one entry is processed per consumer.delay. Only applicable when splitEntries = true. | true | boolean +| *username* (consumer) | Sets the username to be used for basic authentication when polling from a HTTP feed | | String +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *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-atomix/src/main/docs/atomix-map-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atomix/src/main/docs/atomix-map-component.adoc b/components/camel-atomix/src/main/docs/atomix-map-component.adoc index 5c9cd96..25e16cc 100644 --- a/components/camel-atomix/src/main/docs/atomix-map-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-map-component.adoc @@ -1,4 +1,4 @@ -## Atomix Map Component +== Atomix Map Component *Available as of Camel version 2.20* @@ -30,55 +30,57 @@ The Atomix Map component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | The shared component configuration | | AtomixMapConfiguration -| **atomix** (common) | The shared AtomixClient instance | | AtomixClient -| **nodes** (common) | The nodes the AtomixClient should connect to | | List -| **configurationUri** (common) | The path to the AtomixClient configuration | | String -| **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 -|======================================================================= +| *configuration* (common) | The shared component configuration | | AtomixMapConfiguration +| *atomix* (common) | The shared AtomixClient instance | | AtomixClient +| *nodes* (common) | The nodes the AtomixClient should connect to | | List +| *configurationUri* (common) | The path to the AtomixClient configuration | | String +| *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 Atomix Map endpoint is configured using URI syntax: - atomix-map:mapName +---- +atomix-map:mapName +---- 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 -| **resourceName** | *Required* The distributed resource name | | String -|======================================================================= +| *resourceName* | *Required* The distributed resource name | | String +|=== -#### Query Parameters (18 parameters): +==== Query Parameters (18 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **atomix** (common) | The Atomix instance to use | | Atomix -| **configurationUri** (common) | The Atomix configuration uri. | | String -| **defaultAction** (common) | The default action. | PUT | Action -| **key** (common) | The key to use if none is set in the header or to listen for events for a specific key. | | Object -| **nodes** (common) | The address of the nodes composing the cluster. | | String -| **resultHeader** (common) | The header that wil carry the result. | | String -| **transport** (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport -| **ttl** (common) | The resource ttl. | | long -| **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 -| **defaultResourceConfig** (advanced) | The cluster wide default resource configuration. | | Properties -| **defaultResourceOptions** (advanced) | The local default resource options. | | Properties -| **ephemeral** (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean -| **readConsistency** (advanced) | The read consistency level. | | ReadConsistency -| **resourceConfigs** (advanced) | Cluster wide resources configuration. | | Map -| **resourceOptions** (advanced) | Local resources configurations | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *atomix* (common) | The Atomix instance to use | | Atomix +| *configurationUri* (common) | The Atomix configuration uri. | | String +| *defaultAction* (common) | The default action. | PUT | Action +| *key* (common) | The key to use if none is set in the header or to listen for events for a specific key. | | Object +| *nodes* (common) | The address of the nodes composing the cluster. | | String +| *resultHeader* (common) | The header that wil carry the result. | | String +| *transport* (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport +| *ttl* (common) | The resource ttl. | | long +| *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 +| *defaultResourceConfig* (advanced) | The cluster wide default resource configuration. | | Properties +| *defaultResourceOptions* (advanced) | The local default resource options. | | Properties +| *ephemeral* (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean +| *readConsistency* (advanced) | The read consistency level. | | ReadConsistency +| *resourceConfigs* (advanced) | Cluster wide resources configuration. | | Map +| *resourceOptions* (advanced) | Local resources configurations | | Map +| *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 ### Headers http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc b/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc index 5efec51..d267d06 100644 --- a/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc @@ -1,4 +1,4 @@ -## Atomix Messaging Component +== Atomix Messaging Component *Available as of Camel version 2.20* @@ -29,54 +29,56 @@ The Atomix Messaging component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | The shared component configuration | | AtomixMessaging Configuration -| **atomix** (common) | The shared AtomixClient instance | | AtomixClient -| **nodes** (common) | The nodes the AtomixClient should connect to | | List -| **configurationUri** (common) | The path to the AtomixClient configuration | | String -| **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 -|======================================================================= +| *configuration* (common) | The shared component configuration | | AtomixMessaging Configuration +| *atomix* (common) | The shared AtomixClient instance | | AtomixClient +| *nodes* (common) | The nodes the AtomixClient should connect to | | List +| *configurationUri* (common) | The path to the AtomixClient configuration | | String +| *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 Atomix Messaging endpoint is configured using URI syntax: - atomix-messaging:group +---- +atomix-messaging:group +---- 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 -| **resourceName** | *Required* The distributed resource name | | String -|======================================================================= +| *resourceName* | *Required* The distributed resource name | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **atomix** (common) | The Atomix instance to use | | Atomix -| **broadcastType** (common) | The broadcast type. | ALL | BroadcastType -| **channelName** (common) | The messaging channel name | | String -| **configurationUri** (common) | The Atomix configuration uri. | | String -| **defaultAction** (common) | The default action. | DIRECT | Action -| **memberName** (common) | The Atomix Group member name | | String -| **nodes** (common) | The address of the nodes composing the cluster. | | String -| **resultHeader** (common) | The header that wil carry the result. | | String -| **transport** (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport -| **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 -| **defaultResourceConfig** (advanced) | The cluster wide default resource configuration. | | Properties -| **defaultResourceOptions** (advanced) | The local default resource options. | | Properties -| **ephemeral** (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean -| **readConsistency** (advanced) | The read consistency level. | | ReadConsistency -| **resourceConfigs** (advanced) | Cluster wide resources configuration. | | Map -| **resourceOptions** (advanced) | Local resources configurations | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *atomix* (common) | The Atomix instance to use | | Atomix +| *broadcastType* (common) | The broadcast type. | ALL | BroadcastType +| *channelName* (common) | The messaging channel name | | String +| *configurationUri* (common) | The Atomix configuration uri. | | String +| *defaultAction* (common) | The default action. | DIRECT | Action +| *memberName* (common) | The Atomix Group member name | | String +| *nodes* (common) | The address of the nodes composing the cluster. | | String +| *resultHeader* (common) | The header that wil carry the result. | | String +| *transport* (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport +| *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 +| *defaultResourceConfig* (advanced) | The cluster wide default resource configuration. | | Properties +| *defaultResourceOptions* (advanced) | The local default resource options. | | Properties +| *ephemeral* (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean +| *readConsistency* (advanced) | The read consistency level. | | ReadConsistency +| *resourceConfigs* (advanced) | Cluster wide resources configuration. | | Map +| *resourceOptions* (advanced) | Local resources configurations | | Map +| *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-atomix/src/main/docs/atomix-multimap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc b/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc index 7672baf..b1abaef 100644 --- a/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc @@ -1,4 +1,4 @@ -## Atomix MultiMap Component +== Atomix MultiMap Component *Available as of Camel version 2.20* @@ -29,53 +29,55 @@ The Atomix MultiMap component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (consumer) | The shared component configuration | | AtomixMultiMap Configuration -| **atomix** (consumer) | The shared AtomixClient instance | | AtomixClient -| **nodes** (consumer) | The nodes the AtomixClient should connect to | | List -| **configurationUri** (consumer) | The path to the AtomixClient configuration | | String -| **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 -|======================================================================= +| *configuration* (consumer) | The shared component configuration | | AtomixMultiMap Configuration +| *atomix* (consumer) | The shared AtomixClient instance | | AtomixClient +| *nodes* (consumer) | The nodes the AtomixClient should connect to | | List +| *configurationUri* (consumer) | The path to the AtomixClient configuration | | String +| *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 Atomix MultiMap endpoint is configured using URI syntax: - atomix-multimap:multiMapName +---- +atomix-multimap:multiMapName +---- 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 -| **resourceName** | *Required* The distributed resource name | | String -|======================================================================= +| *resourceName* | *Required* The distributed resource name | | String +|=== -#### Query Parameters (18 parameters): +==== Query Parameters (18 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **atomix** (consumer) | The Atomix instance to use | | Atomix -| **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 -| **configurationUri** (consumer) | The Atomix configuration uri. | | String -| **defaultAction** (consumer) | The default action. | PUT | Action -| **key** (consumer) | The key to use if none is set in the header or to listen for events for a specific key. | | Object -| **nodes** (consumer) | The address of the nodes composing the cluster. | | String -| **resultHeader** (consumer) | The header that wil carry the result. | | String -| **transport** (consumer) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport -| **ttl** (consumer) | The resource ttl. | | 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 -| **defaultResourceConfig** (advanced) | The cluster wide default resource configuration. | | Properties -| **defaultResourceOptions** (advanced) | The local default resource options. | | Properties -| **ephemeral** (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean -| **readConsistency** (advanced) | The read consistency level. | | ReadConsistency -| **resourceConfigs** (advanced) | Cluster wide resources configuration. | | Map -| **resourceOptions** (advanced) | Local resources configurations | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *atomix* (consumer) | The Atomix instance to use | | Atomix +| *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 +| *configurationUri* (consumer) | The Atomix configuration uri. | | String +| *defaultAction* (consumer) | The default action. | PUT | Action +| *key* (consumer) | The key to use if none is set in the header or to listen for events for a specific key. | | Object +| *nodes* (consumer) | The address of the nodes composing the cluster. | | String +| *resultHeader* (consumer) | The header that wil carry the result. | | String +| *transport* (consumer) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport +| *ttl* (consumer) | The resource ttl. | | 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 +| *defaultResourceConfig* (advanced) | The cluster wide default resource configuration. | | Properties +| *defaultResourceOptions* (advanced) | The local default resource options. | | Properties +| *ephemeral* (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean +| *readConsistency* (advanced) | The read consistency level. | | ReadConsistency +| *resourceConfigs* (advanced) | Cluster wide resources configuration. | | Map +| *resourceOptions* (advanced) | Local resources configurations | | Map +| *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-atomix/src/main/docs/atomix-queue-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atomix/src/main/docs/atomix-queue-component.adoc b/components/camel-atomix/src/main/docs/atomix-queue-component.adoc index 60bb8b9..956d8a3 100644 --- a/components/camel-atomix/src/main/docs/atomix-queue-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-queue-component.adoc @@ -1,4 +1,4 @@ -## Atomix Queue Component +== Atomix Queue Component *Available as of Camel version 2.20* @@ -29,51 +29,53 @@ The Atomix Queue component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | The shared component configuration | | AtomixQueue Configuration -| **atomix** (common) | The shared AtomixClient instance | | AtomixClient -| **nodes** (common) | The nodes the AtomixClient should connect to | | List -| **configurationUri** (common) | The path to the AtomixClient configuration | | String -| **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 -|======================================================================= +| *configuration* (common) | The shared component configuration | | AtomixQueue Configuration +| *atomix* (common) | The shared AtomixClient instance | | AtomixClient +| *nodes* (common) | The nodes the AtomixClient should connect to | | List +| *configurationUri* (common) | The path to the AtomixClient configuration | | String +| *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 Atomix Queue endpoint is configured using URI syntax: - atomix-queue:queueName +---- +atomix-queue:queueName +---- 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 -| **resourceName** | *Required* The distributed resource name | | String -|======================================================================= +| *resourceName* | *Required* The distributed resource name | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **atomix** (common) | The Atomix instance to use | | Atomix -| **configurationUri** (common) | The Atomix configuration uri. | | String -| **defaultAction** (common) | The default action. | ADD | Action -| **nodes** (common) | The address of the nodes composing the cluster. | | String -| **resultHeader** (common) | The header that wil carry the result. | | String -| **transport** (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport -| **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 -| **defaultResourceConfig** (advanced) | The cluster wide default resource configuration. | | Properties -| **defaultResourceOptions** (advanced) | The local default resource options. | | Properties -| **ephemeral** (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean -| **readConsistency** (advanced) | The read consistency level. | | ReadConsistency -| **resourceConfigs** (advanced) | Cluster wide resources configuration. | | Map -| **resourceOptions** (advanced) | Local resources configurations | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *atomix* (common) | The Atomix instance to use | | Atomix +| *configurationUri* (common) | The Atomix configuration uri. | | String +| *defaultAction* (common) | The default action. | ADD | Action +| *nodes* (common) | The address of the nodes composing the cluster. | | String +| *resultHeader* (common) | The header that wil carry the result. | | String +| *transport* (common) | Sets the Atomix transport. | io.atomix.catalyst.transport.netty.NettyTransport | Transport +| *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 +| *defaultResourceConfig* (advanced) | The cluster wide default resource configuration. | | Properties +| *defaultResourceOptions* (advanced) | The local default resource options. | | Properties +| *ephemeral* (advanced) | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | boolean +| *readConsistency* (advanced) | The read consistency level. | | ReadConsistency +| *resourceConfigs* (advanced) | Cluster wide resources configuration. | | Map +| *resourceOptions* (advanced) | Local resources configurations | | Map +| *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
