http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 baaac09..2197535 100644 --- a/components/camel-weather/src/main/docs/weather-component.adoc +++ b/components/camel-weather/src/main/docs/weather-component.adoc @@ -1,4 +1,4 @@ -## Weather Component +== Weather Component *Available as of Camel version 2.12* @@ -49,67 +49,69 @@ The Weather component has no options. // endpoint options: START The Weather endpoint is configured using URI syntax: - weather:name +---- +weather:name +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* The name value is not used. | | String -|======================================================================= +| *name* | *Required* The name value is not used. | | String +|=== -#### Query Parameters (43 parameters): +==== Query Parameters (43 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/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 0183e35..b887b71 100644 --- a/components/camel-websocket/src/main/docs/websocket-component.adoc +++ b/components/camel-websocket/src/main/docs/websocket-component.adoc @@ -1,4 +1,4 @@ -## Jetty Websocket Component +== Jetty Websocket Component *Available as of Camel version 2.10* @@ -37,23 +37,23 @@ The Jetty Websocket component supports 14 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **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 -|======================================================================= +| *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 +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *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 @@ -68,44 +68,46 @@ The Jetty Websocket component supports 14 options which are listed below. // endpoint options: START The Jetty Websocket endpoint is configured using URI syntax: - websocket:host:port/resourceUri +---- +websocket:host:port/resourceUri +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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): +==== Query Parameters (18 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc b/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc index 8fbb1c2..4ad408e 100644 --- a/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc +++ b/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc @@ -1,4 +1,4 @@ -## XML Beans DataFormat +== XML Beans DataFormat *Available as of Camel version 1.2* @@ -22,11 +22,11 @@ The XML Beans dataformat supports 2 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | prettyPrint | false | Boolean | To enable pretty printing output nicely formatted. Is by default false. | 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 ### Dependencies http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc b/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc index 7bed1f0..c8cf4c7 100644 --- a/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc +++ b/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc @@ -1,4 +1,4 @@ -## XML JSon DataFormat +== XML JSon DataFormat *Available as of Camel version 2.10* @@ -25,7 +25,7 @@ The XML JSon dataformat supports 13 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | encoding | | String | Sets the encoding. Used for unmarshalling (JSON to XML conversion). | elementName | | String | Specifies the name of the XML elements representing each array element. Used for unmarshalling (JSON to XML conversion). @@ -40,7 +40,7 @@ The XML JSon dataformat supports 13 options which are listed below. | expandableProperties | | List | With expandable properties JSON array elements are converted to XML as a sequence of repetitive XML elements with the local name equal to the JSON key for example: number: 123 normally converted to: 123 (where e can be modified by setting elementName) would instead translate to 123 if number is set as an expandable property Used for unmarshalling (JSON to XML conversion). | typeHints | | String | Adds type hints to the resulting XML to aid conversion back to JSON. Used for unmarshalling (JSON to XML conversion). | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Basic Usage with Java DSL http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 da1f1dc..b399846 100644 --- a/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc +++ b/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc @@ -1,4 +1,4 @@ -## XML RPC Component +== XML RPC Component *Available as of Camel version 2.11* @@ -103,42 +103,44 @@ The XML RPC component has no options. // endpoint options: START The XML RPC endpoint is configured using URI syntax: - xmlrpc:address +---- +xmlrpc:address +---- 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 -| **address** | *Required* The server url | | String -|======================================================================= +| *address* | *Required* The server url | | String +|=== -#### Query Parameters (18 parameters): +==== Query Parameters (18 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc b/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc index 6eacc01..ed46af3 100644 --- a/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc +++ b/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc @@ -1,4 +1,4 @@ -## XML RPC DataFormat +== XML RPC DataFormat *Available as of Camel version 2.11* @@ -44,9 +44,9 @@ The XML RPC dataformat supports 2 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | request | false | Boolean | Whether to marshal/unmarshal request or response Is by default false | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc b/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc index 63eadfb..51492e1 100644 --- a/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc +++ b/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc @@ -1,4 +1,4 @@ -## XML Security DataFormat +== XML Security DataFormat *Available as of Camel version 2.0* @@ -43,7 +43,7 @@ The XML Security dataformat supports 12 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | xmlCipherAlgorithm | TRIPLEDES | String | The cipher algorithm to be used for encryption/decryption of the XML message content. The available choices are: XMLCipher.TRIPLEDES XMLCipher.AES_128 XMLCipher.AES_128_GCM XMLCipher.AES_192 XMLCipher.AES_192_GCM XMLCipher.AES_256 XMLCipher.AES_256_GCM XMLCipher.SEED_128 XMLCipher.CAMELLIA_128 XMLCipher.CAMELLIA_192 XMLCipher.CAMELLIA_256 The default value is MLCipher.TRIPLEDES | passPhrase | | String | A String used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. If no passPhrase is specified a default passPhrase is used. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a Only another 24 Byte key @@ -57,7 +57,7 @@ The XML Security dataformat supports 12 options which are listed below. | mgfAlgorithm | MGF1_SHA1 | String | The MGF Algorithm to use with the RSA OAEP algorithm. The available choices are: EncryptionConstants.MGF1_SHA1 EncryptionConstants.MGF1_SHA256 EncryptionConstants.MGF1_SHA512 The default value is EncryptionConstants.MGF1_SHA1 | addKeyValueForEncryptedKey | true | Boolean | Whether to add the public key used to encrypt the session key as a KeyValue in the EncryptedKey structure or not. | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc index aa617d1..ade6cae 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc @@ -1,4 +1,4 @@ -## XML Security Component +== XML Security Component *Available as of Camel version 2.12* @@ -230,12 +230,12 @@ The XML Security component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **signerConfiguration** (advanced) | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. | | XmlSignerConfiguration -| **verifierConfiguration** (advanced) | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. | | XmlVerifier Configuration -| **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 -|======================================================================= +| *signerConfiguration* (advanced) | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. | | XmlSignerConfiguration +| *verifierConfiguration* (advanced) | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. | | XmlVerifier Configuration +| *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 @@ -249,60 +249,62 @@ The XML Security component supports 3 options which are listed below. // endpoint options: START The XML Security endpoint is configured using URI syntax: - xmlsecurity:command:name +---- +xmlsecurity:command:name +---- 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 -| **command** | *Required* Whether to sign or verify. | | XmlCommand -| **name** | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. | | String -|======================================================================= +| *command* | *Required* Whether to sign or verify. | | XmlCommand +| *name* | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. | | String +|=== -#### Query Parameters (35 parameters): +==== Query Parameters (35 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **baseUri** (common) | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. | | String -| **clearHeaders** (common) | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. | true | Boolean -| **cryptoContextProperties** (common) | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference | | Map -| **disallowDoctypeDecl** (common) | Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is link BooleanTRUE. | true | Boolean -| **omitXmlDeclaration** (common) | Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION. | false | Boolean -| **outputXmlEncoding** (common) | The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used. | | String -| **schemaResourceUri** (common) | Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes might be set in the enveloped and enveloping case. If set then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header link XmlSignatureConstantsHEADER_SCHEMA_RESOURCE_URI. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **uriDereferencer** (advanced) | If you want to restrict the remote access via reference URIs you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments HTTP file and XPpointer URIs. Attention: The implementation is provider dependent! | | URIDereferencer -| **addKeyInfoReference** (sign) | In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor. and link KeyInfogetId() is not null. | true | Boolean -| **canonicalizationMethod** (sign) | Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm List inclusiveNamespacePrefixes) to create a canonicalization method. | http://www.w3.org/TR/2001/REC-xml-c14n-20010315 | AlgorithmMethod -| **contentObjectId** (sign) | Sets the content object Id attribute value. By default a UUID is generated. If you set the null value then a new UUID will be generated. Only used in the enveloping case. | | String -| **contentReferenceType** (sign) | Type of the content reference. The default value is null. This value can be overwritten by the header link XmlSignatureConstantsHEADER_CONTENT_REFERENCE_TYPE. | | String -| **contentReferenceUri** (sign) | Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value then the resource schema URI ( link setSchemaResourceUri(String)) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case. | | String -| **digestAlgorithm** (sign) | Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlencsha256 | | String -| **keyAccessor** (sign) | For the signing process a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore. | | KeyAccessor -| **parentLocalName** (sign) | Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use link setParentXpath(XPathFilterParameterSpec). Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter link setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter link setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. | | String -| **parentNamespace** (sign) | Namespace of the parent element to which the XML signature element will be added. | | String -| **parentXpath** (sign) | Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods link setParentLocalName(String) and link setParentNamespace(String). Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. | | XPathFilterParameter Spec -| **plainText** (sign) | Indicator whether the message body contains plain text. The default value is false indicating that the message body contains XML. The value can be overwritten by the header link XmlSignatureConstantsHEADER_MESSAGE_IS_PLAIN_TEXT. | false | Boolean -| **plainTextEncoding** (sign) | Encoding of the plain text. Only relevant if the message body is plain text (see parameter link plainText. Default value is UTF-8. | UTF-8 | String -| **prefixForXmlSignature Namespace** (sign) | Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/signing-xml- without-namespaces | ds | String -| **properties** (sign) | For adding additional References and Objects to the XML signature which contain additional properties you can provide a bean which implements the XmlSignatureProperties interface. | | XmlSignatureProperties -| **signatureAlgorithm** (sign) | Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsigrsa-sha1. | http://www.w3.org/2000/09/xmldsig#rsa-sha1 | String -| **signatureId** (sign) | Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element. | | String -| **transformMethods** (sign) | Transforms which are executed on the message body before the digest is calculated. By default C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsigenveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods. | | List -| **xpathsToIdAttributes** (sign) | Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by ''). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header link XmlSignatureConstantsHEADER_XPATHS_TO_ID_ATTRIBUTES. The parameter link setParentLocalName(String) or link setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration. | | List -| **keySelector** (verify) | Provides the key for validating the XML signature. | | KeySelector -| **outputNodeSearch** (verify) | Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message. | | String -| **outputNodeSearchType** (verify) | Determines the search type for determining the output node which is serialized into the output message bodyF. See link setOutputNodeSearch(Object). The supported default search types you can find in DefaultXmlSignature2Message. | Default | String -| **removeSignatureElements** (verify) | Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig) shall be removed from the document set to the output message. Normally this is only necessary if the XML signature is enveloped. The default value is link BooleanFALSE. This parameter is forwarded to XmlSignature2Message. This indicator has no effect if the output node search is of type link DefaultXmlSignature2MessageOUTPUT_NODE_SEARCH_TYPE_DEFAULT.F | false | Boolean -| **secureValidation** (verify) | Enables secure validation. If true then secure validation is enabled. | true | Boolean -| **validationFailedHandler** (verify) | Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails a XmlSignatureInvalidValueException is thrown. If a reference validation fails a XmlSignatureInvalidContentHashException is thrown. For more detailed information see the JavaDoc. | | ValidationFailedHandler -| **xmlSignature2Message** (verify) | Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType outputNodeSearch and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default ElementName and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signature case (the re is a reference with URI= and transform http://www.w3.org/2000/09/xmldsigenveloped-signature) the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case. | | XmlSignature2Message -| **xmlSignatureChecker** (verify) | This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/check-what-is-signed | | XmlSignatureChecker -|======================================================================= +| *baseUri* (common) | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. | | String +| *clearHeaders* (common) | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. | true | Boolean +| *cryptoContextProperties* (common) | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference | | Map +| *disallowDoctypeDecl* (common) | Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is link BooleanTRUE. | true | Boolean +| *omitXmlDeclaration* (common) | Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION. | false | Boolean +| *outputXmlEncoding* (common) | The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used. | | String +| *schemaResourceUri* (common) | Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes might be set in the enveloped and enveloping case. If set then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header link XmlSignatureConstantsHEADER_SCHEMA_RESOURCE_URI. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *uriDereferencer* (advanced) | If you want to restrict the remote access via reference URIs you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments HTTP file and XPpointer URIs. Attention: The implementation is provider dependent! | | URIDereferencer +| *addKeyInfoReference* (sign) | In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor. and link KeyInfogetId() is not null. | true | Boolean +| *canonicalizationMethod* (sign) | Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm List inclusiveNamespacePrefixes) to create a canonicalization method. | http://www.w3.org/TR/2001/REC-xml-c14n-20010315 | AlgorithmMethod +| *contentObjectId* (sign) | Sets the content object Id attribute value. By default a UUID is generated. If you set the null value then a new UUID will be generated. Only used in the enveloping case. | | String +| *contentReferenceType* (sign) | Type of the content reference. The default value is null. This value can be overwritten by the header link XmlSignatureConstantsHEADER_CONTENT_REFERENCE_TYPE. | | String +| *contentReferenceUri* (sign) | Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value then the resource schema URI ( link setSchemaResourceUri(String)) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case. | | String +| *digestAlgorithm* (sign) | Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlencsha256 | | String +| *keyAccessor* (sign) | For the signing process a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore. | | KeyAccessor +| *parentLocalName* (sign) | Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use link setParentXpath(XPathFilterParameterSpec). Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter link setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter link setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. | | String +| *parentNamespace* (sign) | Namespace of the parent element to which the XML signature element will be added. | | String +| *parentXpath* (sign) | Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods link setParentLocalName(String) and link setParentNamespace(String). Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. | | XPathFilterParameter Spec +| *plainText* (sign) | Indicator whether the message body contains plain text. The default value is false indicating that the message body contains XML. The value can be overwritten by the header link XmlSignatureConstantsHEADER_MESSAGE_IS_PLAIN_TEXT. | false | Boolean +| *plainTextEncoding* (sign) | Encoding of the plain text. Only relevant if the message body is plain text (see parameter link plainText. Default value is UTF-8. | UTF-8 | String +| *prefixForXmlSignature Namespace* (sign) | Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/signing-xml- without-namespaces | ds | String +| *properties* (sign) | For adding additional References and Objects to the XML signature which contain additional properties you can provide a bean which implements the XmlSignatureProperties interface. | | XmlSignatureProperties +| *signatureAlgorithm* (sign) | Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsigrsa-sha1. | http://www.w3.org/2000/09/xmldsig#rsa-sha1 | String +| *signatureId* (sign) | Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element. | | String +| *transformMethods* (sign) | Transforms which are executed on the message body before the digest is calculated. By default C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsigenveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods. | | List +| *xpathsToIdAttributes* (sign) | Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by ''). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header link XmlSignatureConstantsHEADER_XPATHS_TO_ID_ATTRIBUTES. The parameter link setParentLocalName(String) or link setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration. | | List +| *keySelector* (verify) | Provides the key for validating the XML signature. | | KeySelector +| *outputNodeSearch* (verify) | Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message. | | String +| *outputNodeSearchType* (verify) | Determines the search type for determining the output node which is serialized into the output message bodyF. See link setOutputNodeSearch(Object). The supported default search types you can find in DefaultXmlSignature2Message. | Default | String +| *removeSignatureElements* (verify) | Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig) shall be removed from the document set to the output message. Normally this is only necessary if the XML signature is enveloped. The default value is link BooleanFALSE. This parameter is forwarded to XmlSignature2Message. This indicator has no effect if the output node search is of type link DefaultXmlSignature2MessageOUTPUT_NODE_SEARCH_TYPE_DEFAULT.F | false | Boolean +| *secureValidation* (verify) | Enables secure validation. If true then secure validation is enabled. | true | Boolean +| *validationFailedHandler* (verify) | Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails a XmlSignatureInvalidValueException is thrown. If a reference validation fails a XmlSignatureInvalidContentHashException is thrown. For more detailed information see the JavaDoc. | | ValidationFailedHandler +| *xmlSignature2Message* (verify) | Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType outputNodeSearch and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default ElementName and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signature case (there is a reference with URI= and transform http://www.w3.org/2000/09/xmldsigenveloped-signature) the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case. | | XmlSignature2Message +| *xmlSignatureChecker* (verify) | This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/check-what-is-signed | | XmlSignatureChecker +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-xmpp/src/main/docs/xmpp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmpp/src/main/docs/xmpp-component.adoc b/components/camel-xmpp/src/main/docs/xmpp-component.adoc index 54aa7d9..8d6da74 100644 --- a/components/camel-xmpp/src/main/docs/xmpp-component.adoc +++ b/components/camel-xmpp/src/main/docs/xmpp-component.adoc @@ -1,4 +1,4 @@ -## XMPP Component +== XMPP Component *Available as of Camel version 1.0* @@ -45,44 +45,46 @@ The XMPP component has no options. // endpoint options: START The XMPP endpoint is configured using URI syntax: - xmpp:host:port/participant +---- +xmpp:host:port/participant +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* Hostname for the chat server | | String -| **port** | *Required* Port number for the chat server | | int -| **participant** | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant. | | String -|======================================================================= +| *host* | *Required* Hostname for the chat server | | String +| *port* | *Required* Port number for the chat server | | int +| *participant* | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant. | | String +|=== -#### Query Parameters (18 parameters): +==== Query Parameters (18 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **login** (common) | Whether to login the user. | true | boolean -| **nickname** (common) | Use nickname when joining room. If room is specified and nickname is not user will be used for the nickname. | | String -| **pubsub** (common) | Accept pubsub packets on input default is false | false | boolean -| **room** (common) | If this option is specified the component will connect to MUC (Multi User Chat). Usually the domain name for MUC is different from the login domain. For example if you are supermanjabber.org and want to join the krypton room then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol the domain part will be discovered and added by Camel | | String -| **serviceName** (common) | The name of the service you are connecting to. For Google Talk this would be gmail.com. | | String -| **testConnectionOnStartup** (common) | Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false Camel will attempt to establish a lazy connection when needed by a producer and will poll for a consumer connection until the connection is established. Default is true. | true | boolean -| **createAccount** (common) | If true an attempt to create an account will be made. Default is false. | false | boolean -| **resource** (common) | XMPP resource. The default is Camel. | Camel | 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 -| **connectionPollDelay** (consumer) | The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds. | 10 | int -| **doc** (consumer) | Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true otherwise false | 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 -| **connectionConfig** (advanced) | To use an existing connection configuration. Currently org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration is only supported (XMPP over TCP). | | ConnectionConfiguration -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **headerFilterStrategy** (filter) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **password** (security) | Password for login | | String -| **user** (security) | User name (without server name). If not specified anonymous login will be attempted. | | String -|======================================================================= +| *login* (common) | Whether to login the user. | true | boolean +| *nickname* (common) | Use nickname when joining room. If room is specified and nickname is not user will be used for the nickname. | | String +| *pubsub* (common) | Accept pubsub packets on input default is false | false | boolean +| *room* (common) | If this option is specified the component will connect to MUC (Multi User Chat). Usually the domain name for MUC is different from the login domain. For example if you are supermanjabber.org and want to join the krypton room then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol the domain part will be discovered and added by Camel | | String +| *serviceName* (common) | The name of the service you are connecting to. For Google Talk this would be gmail.com. | | String +| *testConnectionOnStartup* (common) | Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false Camel will attempt to establish a lazy connection when needed by a producer and will poll for a consumer connection until the connection is established. Default is true. | true | boolean +| *createAccount* (common) | If true an attempt to create an account will be made. Default is false. | false | boolean +| *resource* (common) | XMPP resource. The default is Camel. | Camel | 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 +| *connectionPollDelay* (consumer) | The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds. | 10 | int +| *doc* (consumer) | Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true otherwise false | 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 +| *connectionConfig* (advanced) | To use an existing connection configuration. Currently org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration is only supported (XMPP over TCP). | | ConnectionConfiguration +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *headerFilterStrategy* (filter) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *password* (security) | Password for login | | String +| *user* (security) | User name (without server name). If not specified anonymous login will be attempted. | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc b/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc index a71394f..89102c1 100644 --- a/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc +++ b/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc @@ -1,4 +1,4 @@ -## JSon XStream DataFormat +== JSon XStream DataFormat *Available as of Camel version 2.0* @@ -30,7 +30,7 @@ The JSon XStream dataformat supports 17 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | objectMapper | | String | Lookup and use the existing ObjectMapper with the given id when using Jackson. | prettyPrint | false | Boolean | To enable pretty printing output nicely formatted. Is by default false. @@ -49,7 +49,7 @@ The JSon XStream dataformat supports 17 options which are listed below. | permissions | | String | Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans. A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow and minus sign is deny. Wildcards is supported by using . as prefix. For example to allow com.foo and all subpackages then specfy com.foo.. Multiple permissions can be configured separated by comma such as com.foo.-com.foo.bar.MySecretBean. The following default permission is always included: -java.lang.java.util. unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions. | allowUnmarshallType | false | Boolean | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-xstream/src/main/docs/xstream-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc index 59186d3..f397493 100644 --- a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc +++ b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc @@ -1,4 +1,4 @@ -## XStream DataFormat +== XStream DataFormat *Available as of Camel version 1.3* @@ -30,7 +30,7 @@ The XStream dataformat supports 10 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | permissions | | String | Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans. A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow and minus sign is deny. Wildcards is supported by using . as prefix. For example to allow com.foo and all subpackages then specfy com.foo.. Multiple permissions can be configured separated by comma such as com.foo.-com.foo.bar.MySecretBean. The following default permission is always included: -java.lang.java.util. unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions. | encoding | | String | Sets the encoding to use @@ -42,7 +42,7 @@ The XStream dataformat supports 10 options which are listed below. | omitFields | | Map | Prevents a field from being serialized. To omit a field you must always provide the declaring type and not necessarily the type that is converted. | implicitCollections | | Map | Adds a default implicit collection which is used for any unmapped XML tag. | 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
