http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-twitter/src/main/docs/twitter-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter-component.adoc b/components/camel-twitter/src/main/docs/twitter-component.adoc index fb9be54..e05ab1c 100644 --- a/components/camel-twitter/src/main/docs/twitter-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-component.adoc @@ -47,27 +47,18 @@ The Twitter component supports 9 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| security -| accessToken | | String | The access token - -| accessTokenSecret | | String | The access token secret - -| consumerKey | | String | The consumer key - -| consumerSecret | | String | The consumer secret - 4+^s| proxy -| httpProxyHost | | String | The http proxy host which can be used for the camel-twitter. - -| httpProxyUser | | String | The http proxy user which can be used for the camel-twitter. - -| httpProxyPassword | | String | The http proxy password which can be used for the camel-twitter. - -| httpProxyPort | | int | The http proxy port which can be used for the camel-twitter. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **accessToken** (security) | The access token | | String +| **accessTokenSecret** (security) | The access token secret | | String +| **consumerKey** (security) | The consumer key | | String +| **consumerSecret** (security) | The consumer secret | | String +| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. | | String +| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. | | String +| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. | | String +| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. | | int +| **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 @@ -147,101 +138,59 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| kind | | String | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. +| Name | Description | Default | Type +| **kind** | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. | | String |======================================================================= #### Query Parameters (42 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| user | | String | Username used for user timeline consumption direct message production etc. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| type | polling | EndpointType | Endpoint type to use. Only streaming supports event type. - 4+^s| consumer (advanced) -| distanceMetric | km | String | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. - -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| latitude | | Double | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. - -| locations | | String | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. - -| longitude | | Double | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - -| radius | | Double | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. - -| twitterStream | | TwitterStream | To use a custom instance of TwitterStream - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| filter -| count | | Integer | Limiting number of results per page. - -| filterOld | true | boolean | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. - -| keywords | | String | Can be used for search and streaming/filter. Multiple values can be separated with comma. - -| lang | | String | The lang string ISO_639-1 which will be used for searching - -| numberOfPages | 1 | Integer | The number of pages result which you want camel-twitter to consume. - -| sinceId | 1 | long | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. - -| userIds | | String | To filter by user ids for streaming/filter. Multiple values can be separated by comma. - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 60000 | long | Milliseconds before the next poll. - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. - 4+^s| proxy -| httpProxyHost | | String | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. - -| httpProxyPassword | | String | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. - -| httpProxyPort | | Integer | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. - -| httpProxyUser | | String | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. - 4+^s| security -| accessToken | | String | The access token. Can also be configured on the TwitterComponent level instead. - -| accessTokenSecret | | String | The access secret. Can also be configured on the TwitterComponent level instead. - -| consumerKey | | String | The consumer key. Can also be configured on the TwitterComponent level instead. - -| consumerSecret | | String | The consumer secret. Can also be configured on the TwitterComponent level instead. +| Name | Description | Default | Type +| **user** (common) | Username used for user timeline consumption direct message production etc. | | 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 +| **type** (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType +| **distanceMetric** (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | 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 +| **latitude** (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| **locations** (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String +| **longitude** (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| **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 +| **radius** (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| **twitterStream** (consumer) | To use a custom instance of TwitterStream | | TwitterStream +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **count** (filter) | Limiting number of results per page. | | Integer +| **filterOld** (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean +| **keywords** (filter) | Can be used for search and streaming/filter. Multiple values can be separated with comma. | | String +| **lang** (filter) | The lang string ISO_639-1 which will be used for searching | | String +| **numberOfPages** (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer +| **sinceId** (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long +| **userIds** (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String +| **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. | 60000 | 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 +| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer +| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| **accessToken** (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String +| **accessTokenSecret** (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String +| **consumerKey** (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String +| **consumerSecret** (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | String |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-undertow/src/main/docs/undertow-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-undertow/src/main/docs/undertow-component.adoc b/components/camel-undertow/src/main/docs/undertow-component.adoc index baf7c50..d85d7c2 100644 --- a/components/camel-undertow/src/main/docs/undertow-component.adoc +++ b/components/camel-undertow/src/main/docs/undertow-component.adoc @@ -42,15 +42,12 @@ The Undertow component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| undertowHttpBinding | | UndertowHttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **undertowHttpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | UndertowHttpBinding +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **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,51 +66,34 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| httpURI | | URI | *Required* The url of the HTTP endpoint to use. +| Name | Description | Default | Type +| **httpURI** | *Required* The url of the HTTP endpoint to use. | | URI |======================================================================= #### Query Parameters (17 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| httpMethodRestrict | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. - -| matchOnUriPrefix | true | Boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. - -| optionsEnabled | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session - -| keepAlive | true | Boolean | Setting to ensure socket is not closed due to inactivity - -| options | | Map | Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri then prefix each option with option. such as option.close-abort=true&option.send-buffer=8192 - -| reuseAddresses | true | Boolean | Setting to facilitate socket multiplexing - -| tcpNoDelay | true | Boolean | Setting to improve TCP protocol performance - -| throwExceptionOnFailure | true | Boolean | 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 producer send all the fault response back. - -| transferException | false | Boolean | 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. - 4+^s| advanced -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| undertowHttpBinding | | UndertowHttpBinding | To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow. - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters +| 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 +| **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. | true | Boolean +| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | 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 +| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| **keepAlive** (producer) | Setting to ensure socket is not closed due to inactivity | true | Boolean +| **options** (producer) | Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri then prefix each option with option. such as option.close-abort=true&option.send-buffer=8192 | | Map +| **reuseAddresses** (producer) | Setting to facilitate socket multiplexing | true | Boolean +| **tcpNoDelay** (producer) | Setting to improve TCP protocol performance | true | Boolean +| **throwExceptionOnFailure** (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 producer send all the fault response back. | true | Boolean +| **transferException** (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. | false | Boolean +| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **undertowHttpBinding** (advanced) | To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow. | | UndertowHttpBinding +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-velocity/src/main/docs/velocity-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-velocity/src/main/docs/velocity-component.adoc b/components/camel-velocity/src/main/docs/velocity-component.adoc index 6107b7d..31a4a72 100644 --- a/components/camel-velocity/src/main/docs/velocity-component.adoc +++ b/components/camel-velocity/src/main/docs/velocity-component.adoc @@ -43,13 +43,11 @@ The Velocity component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| velocityEngine | | VelocityEngine | To use the VelocityEngine otherwise a new engine is created - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **velocityEngine** (advanced) | To use the VelocityEngine otherwise a new engine is created | | VelocityEngine +| **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 @@ -65,27 +63,22 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +| Name | Description | Default | Type +| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| contentCache | false | boolean | Sets whether to use resource content cache or not - -| encoding | | String | Character encoding of the resource content. - -| loaderCache | true | boolean | Enables / disables the velocity resource loader cache which is enabled by default - -| propertiesFile | | String | The URI of the properties file which is used for VelocityEngine initialization. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean +| **encoding** (producer) | Character encoding of the resource content. | | String +| **loaderCache** (producer) | Enables / disables the velocity resource loader cache which is enabled by default | true | boolean +| **propertiesFile** (producer) | The URI of the properties file which is used for VelocityEngine initialization. | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-vertx/src/main/docs/vertx-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-vertx/src/main/docs/vertx-component.adoc b/components/camel-vertx/src/main/docs/vertx-component.adoc index 04122df..3034c5b 100644 --- a/components/camel-vertx/src/main/docs/vertx-component.adoc +++ b/components/camel-vertx/src/main/docs/vertx-component.adoc @@ -40,23 +40,16 @@ The Vert.x component supports 7 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| vertxFactory | | VertxFactory | To use a custom VertxFactory implementation - 4+^s| common -| host | | String | Hostname for creating an embedded clustered EventBus - -| port | | int | Port for creating an embedded clustered EventBus - -| vertxOptions | | VertxOptions | Options to use for creating vertx - -| vertx | | Vertx | To use the given vertx EventBus instead of creating a new embedded EventBus - -| timeout | 60 | int | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **vertxFactory** (advanced) | To use a custom VertxFactory implementation | | VertxFactory +| **host** (common) | Hostname for creating an embedded clustered EventBus | | String +| **port** (common) | Port for creating an embedded clustered EventBus | | int +| **vertxOptions** (common) | Options to use for creating vertx | | VertxOptions +| **vertx** (common) | To use the given vertx EventBus instead of creating a new embedded EventBus | | Vertx +| **timeout** (common) | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. | 60 | int +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -72,27 +65,22 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| address | | String | *Required* Sets the event bus address used to communicate +| Name | Description | Default | Type +| **address** | *Required* Sets the event bus address used to communicate | | String |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| pubSub | | Boolean | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **pubSub** (common) | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. | | 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 +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-weather/src/main/docs/weather-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-weather/src/main/docs/weather-component.adoc b/components/camel-weather/src/main/docs/weather-component.adoc index 157376c..baaac09 100644 --- a/components/camel-weather/src/main/docs/weather-component.adoc +++ b/components/camel-weather/src/main/docs/weather-component.adoc @@ -55,103 +55,60 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| name | | String | *Required* The name value is not used. +| Name | Description | Default | Type +| **name** | *Required* The name value is not used. | | String |======================================================================= #### Query Parameters (43 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| appid | | String | *Required* APPID ID used to authenticate the user connected to the API Server - -| headerName | | String | To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is. - -| language | en | WeatherLanguage | Language of the response. - -| mode | JSON | WeatherMode | The output format of the weather data. - -| period | | String | If null the current weather will be returned else use values of 5 7 14 days. Only the numeric value for the forecast period is actually parsed so spelling capitalisation of the time period is up to you (its ignored) - -| units | | WeatherUnits | The units for temperature measurement. - -| weatherApi | | WeatherApi | The API to be use (current forecast/3 hour forecast daily station) - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| httpConnectionManager | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. - 4+^s| filter -| cnt | | Integer | Number of results to be found - -| ids | | String | List of id's of city/stations. You can separate multiple ids by comma. - -| lat | | String | Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude. - -| location | | String | If null Camel will try and determine your current location using the geolocation of your ip address else specify the citycountry. For well known city names Open Weather Map will determine the best fit but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location. - -| lon | | String | Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude. - -| rightLon | | String | For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom. - -| topLat | | String | For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom. - -| zip | | String | Zip-code e.g. 94040us - -| zoom | | Integer | For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat. - 4+^s| proxy -| proxyAuthDomain | | String | Domain for proxy NTLM authentication - -| proxyAuthHost | | String | Optional host for proxy NTLM authentication - -| proxyAuthMethod | | String | Authentication method for proxy either as Basic Digest or NTLM. - -| proxyAuthPassword | | String | Password for proxy authentication - -| proxyAuthUsername | | String | Username for proxy authentication - -| proxyHost | | String | The proxy host name - -| proxyPort | | Integer | The proxy port number +| Name | Description | Default | Type +| **appid** (common) | *Required* APPID ID used to authenticate the user connected to the API Server | | String +| **headerName** (common) | To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is. | | String +| **language** (common) | Language of the response. | en | WeatherLanguage +| **mode** (common) | The output format of the weather data. | JSON | WeatherMode +| **period** (common) | If null the current weather will be returned else use values of 5 7 14 days. Only the numeric value for the forecast period is actually parsed so spelling capitalisation of the time period is up to you (its ignored) | | String +| **units** (common) | The units for temperature measurement. | | WeatherUnits +| **weatherApi** (common) | The API to be use (current forecast/3 hour forecast daily station) | | WeatherApi +| **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 +| **httpConnectionManager** (advanced) | To use a custom HttpConnectionManager to manage connections | | HttpConnectionManager +| **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 +| **cnt** (filter) | Number of results to be found | | Integer +| **ids** (filter) | List of id's of city/stations. You can separate multiple ids by comma. | | String +| **lat** (filter) | Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude. | | String +| **location** (filter) | If null Camel will try and determine your current location using the geolocation of your ip address else specify the citycountry. For well known city names Open Weather Map will determine the best fit but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location. | | String +| **lon** (filter) | Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude. | | String +| **rightLon** (filter) | For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom. | | String +| **topLat** (filter) | For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom. | | String +| **zip** (filter) | Zip-code e.g. 94040us | | String +| **zoom** (filter) | For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat. | | Integer +| **proxyAuthDomain** (proxy) | Domain for proxy NTLM authentication | | String +| **proxyAuthHost** (proxy) | Optional host for proxy NTLM authentication | | String +| **proxyAuthMethod** (proxy) | Authentication method for proxy either as Basic Digest or NTLM. | | String +| **proxyAuthPassword** (proxy) | Password for proxy authentication | | String +| **proxyAuthUsername** (proxy) | Username for proxy authentication | | String +| **proxyHost** (proxy) | The proxy host name | | String +| **proxyPort** (proxy) | The proxy port number | | Integer |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-websocket/src/main/docs/websocket-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-websocket/src/main/docs/websocket-component.adoc b/components/camel-websocket/src/main/docs/websocket-component.adoc index 53e84ba..ff4d857 100644 --- a/components/camel-websocket/src/main/docs/websocket-component.adoc +++ b/components/camel-websocket/src/main/docs/websocket-component.adoc @@ -36,35 +36,22 @@ The Jetty Websocket component supports 13 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer -| staticResources | | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. - 4+^s| common -| host | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0 - -| port | 9292 | Integer | The port number. The default value is 9292 - 4+^s| security -| sslKeyPassword | | String | The password for the keystore when using SSL. - -| sslPassword | | String | The password when using SSL. - -| sslKeystore | | String | The path to the keystore. - 4+^s| advanced -| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. - -| minThreads | | Integer | To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1. - -| maxThreads | | Integer | To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores. - -| threadPool | | ThreadPool | To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| common -| socketFactory | | Map | To configure a map which contains custom WebSocketFactory for sub protocols. The key in the map is the sub protocol. The default key is reserved for the default implementation. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **staticResources** (consumer) | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. | | String +| **host** (common) | The hostname. The default value is 0.0.0.0 | 0.0.0.0 | String +| **port** (common) | The port number. The default value is 9292 | 9292 | Integer +| **sslKeyPassword** (security) | The password for the keystore when using SSL. | | String +| **sslPassword** (security) | The password when using SSL. | | String +| **sslKeystore** (security) | The path to the keystore. | | String +| **enableJmx** (advanced) | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. | false | boolean +| **minThreads** (advanced) | To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1. | | Integer +| **maxThreads** (advanced) | To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores. | | Integer +| **threadPool** (advanced) | To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. | | ThreadPool +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **socketFactory** (common) | To configure a map which contains custom WebSocketFactory for sub protocols. The key in the map is the sub protocol. The default key is reserved for the default implementation. | | Map +| **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 @@ -86,55 +73,37 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default. -| port | 9292 | Integer | The port number. The default value is 9292. Setting this option on the component will use the component configured value as default. -| resourceUri | | String | *Required* Name of the websocket channel to use +| Name | Description | Default | Type +| **host** | The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default. | 0.0.0.0 | String +| **port** | The port number. The default value is 9292. Setting this option on the component will use the component configured value as default. | 9292 | Integer +| **resourceUri** | *Required* Name of the websocket channel to use | | String |======================================================================= #### Query Parameters (18 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| maxBinaryMessageSize | -1 | Integer | Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited) - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| sessionSupport | false | boolean | Whether to enable session support which enables HttpSession for each http request. - -| staticResources | | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| sendTimeout | 30000 | Integer | Timeout in millis when sending to a websocket channel. The default timeout is 30000 (30 seconds). - -| sendToAll | | Boolean | To send to all websocket subscribers. Can be used to configure on endpoint level instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message. - 4+^s| advanced -| bufferSize | 8192 | Integer | Set the buffer size of the websocketServlet which is also the max frame byte size (default 8192) - -| maxIdleTime | 300000 | Integer | Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000) - -| maxTextMessageSize | | Integer | Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing. - -| minVersion | 13 | Integer | Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version) - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| cors -| allowedOrigins | | String | The CORS allowed origins. Use to allow all. - -| crossOriginFilterOn | false | boolean | Whether to enable CORS - -| filterPath | | String | Context path for filtering CORS - 4+^s| monitoring -| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters +| Name | Description | Default | Type +| **maxBinaryMessageSize** (common) | Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited) | -1 | Integer +| **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 +| **sessionSupport** (consumer) | Whether to enable session support which enables HttpSession for each http request. | false | boolean +| **staticResources** (consumer) | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. | | 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 +| **sendTimeout** (producer) | Timeout in millis when sending to a websocket channel. The default timeout is 30000 (30 seconds). | 30000 | Integer +| **sendToAll** (producer) | To send to all websocket subscribers. Can be used to configure on endpoint level instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message. | | Boolean +| **bufferSize** (advanced) | Set the buffer size of the websocketServlet which is also the max frame byte size (default 8192) | 8192 | Integer +| **maxIdleTime** (advanced) | Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000) | 300000 | Integer +| **maxTextMessageSize** (advanced) | Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing. | | Integer +| **minVersion** (advanced) | Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version) | 13 | Integer +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **allowedOrigins** (cors) | The CORS allowed origins. Use to allow all. | | String +| **crossOriginFilterOn** (cors) | Whether to enable CORS | false | boolean +| **filterPath** (cors) | Context path for filtering CORS | | String +| **enableJmx** (monitoring) | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. | false | boolean +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc b/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc index 30bf428..da1f1dc 100644 --- a/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc +++ b/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc @@ -109,53 +109,35 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| address | | String | *Required* The server url +| Name | Description | Default | Type +| **address** | *Required* The server url | | String |======================================================================= #### Query Parameters (18 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| basicEncoding | | String | Sets the encoding for basic authentication null means UTF-8 is chosen. - -| connectionTimeout | | int | Set the connection timeout in milliseconds 0 is to disable it - -| contentLengthOptional | false | boolean | Whether a Content-Length header may be omitted. The XML-RPC specification demands that such a header be present. - -| defaultMethodName | | String | The method name which would be used for the xmlrpc requests by default if the Message header CamelXmlRpcMethodName is not set. - -| enabledForExceptions | false | boolean | Whether the response should contain a faultCause element in case of errors. The faultCause is an exception which the server has trapped and written into a byte stream as a serializable object. - -| enabledForExtensions | false | boolean | Whether extensions are enabled. By default the client or server is strictly compliant to the XML-RPC specification and extensions are disabled. - -| encoding | | String | Sets the requests encoding null means UTF-8 is chosen. - -| gzipCompressing | false | boolean | Whether gzip compression is being used for transmitting the request. - -| gzipRequesting | false | boolean | Whether gzip compression is being used for transmitting the request. - -| replyTimeout | | int | Set the reply timeout in milliseconds 0 is to disable it. - 4+^s| advanced -| clientConfig | | XmlRpcClientConfigImpl | To use the given XmlRpcClientConfigImpl as configuration for the client. - -| clientConfigurer | | XmlRpcClientConfigurer | To use a custom XmlRpcClientConfigurer to configure the client - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| timeZone | | TimeZone | The timezone which is used to interpret date/time. Defaults to link TimeZonegetDefault(). - -| userAgent | | String | The http user agent header to set when doing xmlrpc requests - -| xmlRpcServer | | XmlRpcRequestProcessor | To use a custom XmlRpcRequestProcessor as server. - 4+^s| security -| basicPassword | | String | The password for basic authentication. - -| basicUserName | | String | The user name for basic authentication. +| Name | Description | Default | Type +| **basicEncoding** (producer) | Sets the encoding for basic authentication null means UTF-8 is chosen. | | String +| **connectionTimeout** (producer) | Set the connection timeout in milliseconds 0 is to disable it | | int +| **contentLengthOptional** (producer) | Whether a Content-Length header may be omitted. The XML-RPC specification demands that such a header be present. | false | boolean +| **defaultMethodName** (producer) | The method name which would be used for the xmlrpc requests by default if the Message header CamelXmlRpcMethodName is not set. | | String +| **enabledForExceptions** (producer) | Whether the response should contain a faultCause element in case of errors. The faultCause is an exception which the server has trapped and written into a byte stream as a serializable object. | false | boolean +| **enabledForExtensions** (producer) | Whether extensions are enabled. By default the client or server is strictly compliant to the XML-RPC specification and extensions are disabled. | false | boolean +| **encoding** (producer) | Sets the requests encoding null means UTF-8 is chosen. | | String +| **gzipCompressing** (producer) | Whether gzip compression is being used for transmitting the request. | false | boolean +| **gzipRequesting** (producer) | Whether gzip compression is being used for transmitting the request. | false | boolean +| **replyTimeout** (producer) | Set the reply timeout in milliseconds 0 is to disable it. | | int +| **clientConfig** (advanced) | To use the given XmlRpcClientConfigImpl as configuration for the client. | | XmlRpcClientConfig Impl +| **clientConfigurer** (advanced) | To use a custom XmlRpcClientConfigurer to configure the client | | XmlRpcClientConfigurer +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **timeZone** (advanced) | The timezone which is used to interpret date/time. Defaults to link TimeZonegetDefault(). | | TimeZone +| **userAgent** (advanced) | The http user agent header to set when doing xmlrpc requests | | String +| **xmlRpcServer** (advanced) | To use a custom XmlRpcRequestProcessor as server. | | XmlRpcRequestProcessor +| **basicPassword** (security) | The password for basic authentication. | | String +| **basicUserName** (security) | The user name for basic authentication. | | String |======================================================================= // endpoint options: END
