http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc index acdde17..9be24f4 100644 --- a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc +++ b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc @@ -80,16 +80,23 @@ The REST Swagger component supports 7 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| basePath | producer | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification. -| componentName | producer | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration. -| consumes | producer | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration -| host | producer | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration. -| produces | producer | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Can be overriden in endpoint configuration. -| specificationUri | producer | swagger.json | URI | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overriden in endpoint configuration. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| producer +| basePath | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification. + +| componentName | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration. + +| consumes | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration + +| host | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration. + +| produces | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Can be overriden in endpoint configuration. + +| specificationUri | swagger.json | URI | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overriden in endpoint configuration. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -111,15 +118,21 @@ with the following path and query parameters: #### Query Parameters (6 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| basePath | producer | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification and in the component configuration. -| componentName | producer | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration. -| consumes | producer | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification and. in the component configuration -| host | producer | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Overrides all other configuration. -| produces | producer | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Overrides all other configuration. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| basePath | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification and in the component configuration. + +| componentName | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration. + +| consumes | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification and. in the component configuration + +| host | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Overrides all other configuration. + +| produces | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Overrides all other configuration. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-restlet/src/main/docs/restlet-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-restlet/src/main/docs/restlet-component.adoc b/components/camel-restlet/src/main/docs/restlet-component.adoc index 0f9033b..7668370 100644 --- a/components/camel-restlet/src/main/docs/restlet-component.adoc +++ b/components/camel-restlet/src/main/docs/restlet-component.adoc @@ -66,30 +66,51 @@ The Restlet component supports 21 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| controllerDaemon | consumer (advanced) | | Boolean | Indicates if the controller thread should be a daemon (not blocking JVM exit). -| controllerSleepTimeMs | consumer (advanced) | | Integer | Time for the controller thread to sleep between each control. -| inboundBufferSize | consumer | | Integer | The size of the buffer when reading messages. -| maxConnectionsPerHost | common | | Integer | Maximum number of concurrent connections per host (IP address). -| maxThreads | consumer (advanced) | | Integer | Maximum threads that will service requests. -| lowThreads | consumer (advanced) | | Integer | Number of worker threads determining when the connector is considered overloaded. -| maxTotalConnections | common | | Integer | Maximum number of concurrent connections in total. -| minThreads | consumer (advanced) | | Integer | Minimum threads waiting to service requests. -| outboundBufferSize | consumer | | Integer | The size of the buffer when writing messages. -| persistingConnections | consumer (advanced) | | Boolean | Indicates if connections should be kept alive after a call. -| pipeliningConnections | consumer (advanced) | | Boolean | Indicates if pipelining connections are supported. -| threadMaxIdleTimeMs | consumer (advanced) | | Integer | Time for an idle thread to wait for an operation before being collected. -| useForwardedForHeader | consumer | | Boolean | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks. -| reuseAddress | consumer | | Boolean | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details. -| maxQueued | consumer (advanced) | | Integer | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected. -| disableStreamCache | consumer (advanced) | false | boolean | Determines whether or not the raw input stream from Restlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Restlet input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. -| port | consumer | | int | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers. -| synchronous | producer | | Boolean | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better. -| enabledConverters | advanced | | List | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| consumer (advanced) +| controllerDaemon | | Boolean | Indicates if the controller thread should be a daemon (not blocking JVM exit). + +| controllerSleepTimeMs | | Integer | Time for the controller thread to sleep between each control. + 4+^s| consumer +| inboundBufferSize | | Integer | The size of the buffer when reading messages. + 4+^s| common +| maxConnectionsPerHost | | Integer | Maximum number of concurrent connections per host (IP address). + 4+^s| consumer (advanced) +| maxThreads | | Integer | Maximum threads that will service requests. + +| lowThreads | | Integer | Number of worker threads determining when the connector is considered overloaded. + 4+^s| common +| maxTotalConnections | | Integer | Maximum number of concurrent connections in total. + 4+^s| consumer (advanced) +| minThreads | | Integer | Minimum threads waiting to service requests. + 4+^s| consumer +| outboundBufferSize | | Integer | The size of the buffer when writing messages. + 4+^s| consumer (advanced) +| persistingConnections | | Boolean | Indicates if connections should be kept alive after a call. + +| pipeliningConnections | | Boolean | Indicates if pipelining connections are supported. + +| threadMaxIdleTimeMs | | Integer | Time for an idle thread to wait for an operation before being collected. + 4+^s| consumer +| useForwardedForHeader | | Boolean | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks. + +| reuseAddress | | Boolean | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details. + 4+^s| consumer (advanced) +| maxQueued | | Integer | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected. + +| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Restlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Restlet input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. + 4+^s| consumer +| port | | int | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers. + 4+^s| producer +| synchronous | | Boolean | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better. + 4+^s| advanced +| enabledConverters | | List | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null + 4+^s| filter +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -116,27 +137,45 @@ with the following path and query parameters: #### Query Parameters (18 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| restletMethod | common | GET | Method | On a producer endpoint specifies the request method to use. On a consumer endpoint specifies that the endpoint consumes only restletMethod requests. -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| restletMethods | consumer | | String | Specify one or more methods separated by commas (e.g. restletMethods=postput) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified the restletMethod setting is ignored. The possible methods are: ALLCONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE -| restletUriPatterns | consumer | | List | Specify one ore more URI templates to be serviced by a restlet consumer endpoint using the notation to reference a List in the Camel Registry. If a URI pattern has been defined in the endpoint URI both the URI pattern defined in the endpoint and the restletUriPatterns option will be honored. -| disableStreamCache | consumer (advanced) | false | boolean | Determines whether or not the raw input stream from Restlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Restlet input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| connectTimeout | producer | 30000 | int | The Client will give up connection if the connection is timeout 0 for unlimited wait. -| cookieHandler | producer | | CookieHandler | Configure a cookie handler to maintain a HTTP session -| socketTimeout | producer | 30000 | int | The Client socket receive timeout 0 for unlimited wait. -| throwExceptionOnFailure | producer | true | boolean | Whether to throw exception on a producer failure. If this option is false then the http status code is set as a message header which can be checked if it has an error value. -| autoCloseStream | producer (advanced) | false | boolean | Whether to auto close the stream representation as response from calling a REST service using the restlet producer. If the response is streaming and the option streamRepresentation is enabled then you may want to auto close the InputStream from the streaming response to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. -| streamRepresentation | producer (advanced) | false | boolean | Whether to support stream representation as response from calling a REST service using the restlet producer. If the response is streaming then this option can be enabled to use an java.io.InputStream as the message body on the Camel Message body. If using this option you may want to enable the autoCloseStream option as well to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. -| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. -| restletBinding | advanced | | RestletBinding | To use a custom RestletBinding to bind between Restlet and Camel message. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| restletRealm | security | | Map | To configure the security realms of restlet as a map. -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. +| Name | Default | Java Type | Description + +| restletMethod | GET | Method | On a producer endpoint specifies the request method to use. On a consumer endpoint specifies that the endpoint consumes only restletMethod requests. + 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. + +| restletMethods | | String | Specify one or more methods separated by commas (e.g. restletMethods=postput) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified the restletMethod setting is ignored. The possible methods are: ALLCONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE + +| restletUriPatterns | | List | Specify one ore more URI templates to be serviced by a restlet consumer endpoint using the notation to reference a List in the Camel Registry. If a URI pattern has been defined in the endpoint URI both the URI pattern defined in the endpoint and the restletUriPatterns option will be honored. + 4+^s| consumer (advanced) +| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Restlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Restlet input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. + +| 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 +| connectTimeout | 30000 | int | The Client will give up connection if the connection is timeout 0 for unlimited wait. + +| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session + +| socketTimeout | 30000 | int | The Client socket receive timeout 0 for unlimited wait. + +| throwExceptionOnFailure | true | boolean | Whether to throw exception on a producer failure. If this option is false then the http status code is set as a message header which can be checked if it has an error value. + 4+^s| producer (advanced) +| autoCloseStream | false | boolean | Whether to auto close the stream representation as response from calling a REST service using the restlet producer. If the response is streaming and the option streamRepresentation is enabled then you may want to auto close the InputStream from the streaming response to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. + +| streamRepresentation | false | boolean | Whether to support stream representation as response from calling a REST service using the restlet producer. If the response is streaming then this option can be enabled to use an java.io.InputStream as the message body on the Camel Message body. If using this option you may want to enable the autoCloseStream option as well to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. + 4+^s| advanced +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. + +| restletBinding | | RestletBinding | To use a custom RestletBinding to bind between Restlet and Camel message. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| security +| restletRealm | | Map | To configure the security realms of restlet as a map. + +| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-rmi/src/main/docs/rmi-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rmi/src/main/docs/rmi-component.adoc b/components/camel-rmi/src/main/docs/rmi-component.adoc index a2b7ce0..15a4f52 100644 --- a/components/camel-rmi/src/main/docs/rmi-component.adoc +++ b/components/camel-rmi/src/main/docs/rmi-component.adoc @@ -71,15 +71,21 @@ with the following path and query parameters: #### Query Parameters (6 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| method | common | | String | You can set the name of the method to invoke. -| remoteInterfaces | common | | List | To specific the remote interfaces. -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| method | | String | You can set the name of the method to invoke. + +| remoteInterfaces | | List | To specific the remote interfaces. + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-routebox/src/main/docs/routebox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-routebox/src/main/docs/routebox-component.adoc b/components/camel-routebox/src/main/docs/routebox-component.adoc index f74b33d..4919683 100644 --- a/components/camel-routebox/src/main/docs/routebox-component.adoc +++ b/components/camel-routebox/src/main/docs/routebox-component.adoc @@ -121,26 +121,43 @@ with the following path and query parameters: #### Query Parameters (17 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| dispatchMap | common | | Map | A string representing a key in the Camel Registry matching an object value of the type HashMap. The HashMap key should contain strings that can be matched against the value set for the exchange header ROUTE_DISPATCH_KEY. The HashMap value should contain inner route consumer URI's to which requests should be directed. -| dispatchStrategy | common | | RouteboxDispatchStrategy | To use a custom RouteboxDispatchStrategy which allows to use custom dispatching instead of the default. -| forkContext | common | true | boolean | Whether to fork and create a new inner CamelContext instead of reusing the same CamelContext. -| innerProtocol | common | direct | String | The Protocol used internally by the Routebox component. Can be Direct or SEDA. The Routebox component currently offers protocols that are JVM bound. -| queueSize | common | | int | Create a fixed size queue to receive requests. -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| pollInterval | consumer | 1000 | long | The timeout used when polling from seda. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. -| threads | consumer | 20 | int | Number of threads to be used by the routebox to receive requests. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| connectionTimeout | producer | 20000 | long | Timeout in millis used by the producer when sending a message. -| sendToConsumer | producer | true | boolean | Dictates whether a Producer endpoint sends a request to an external routebox consumer. If the setting is false the Producer creates an embedded inner context and processes requests internally. -| innerContext | advanced | | CamelContext | A string representing a key in the Camel Registry matching an object value of the type org.apache.camel.CamelContext. If a CamelContext is not provided by the user a CamelContext is automatically created for deployment of inner routes. -| innerProducerTemplate | advanced | | ProducerTemplate | The ProducerTemplate to use by the internal embeded CamelContext -| innerRegistry | advanced | | Registry | To use a custom registry for the internal embedded CamelContext. -| routeBuilders | advanced | | String | A string representing a key in the Camel Registry matching an object value of the type List. If the user does not supply an innerContext pre-primed with inner routes the routeBuilders option must be provided as a non-empty list of RouteBuilders containing inner routes -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| dispatchMap | | Map | A string representing a key in the Camel Registry matching an object value of the type HashMap. The HashMap key should contain strings that can be matched against the value set for the exchange header ROUTE_DISPATCH_KEY. The HashMap value should contain inner route consumer URI's to which requests should be directed. + +| dispatchStrategy | | RouteboxDispatchStrategy | To use a custom RouteboxDispatchStrategy which allows to use custom dispatching instead of the default. + +| forkContext | true | boolean | Whether to fork and create a new inner CamelContext instead of reusing the same CamelContext. + +| innerProtocol | direct | String | The Protocol used internally by the Routebox component. Can be Direct or SEDA. The Routebox component currently offers protocols that are JVM bound. + +| queueSize | | int | Create a fixed size queue to receive requests. + 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. + +| pollInterval | 1000 | long | The timeout used when polling from seda. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. + +| threads | 20 | int | Number of threads to be used by the routebox to receive requests. + 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 +| connectionTimeout | 20000 | long | Timeout in millis used by the producer when sending a message. + +| sendToConsumer | true | boolean | Dictates whether a Producer endpoint sends a request to an external routebox consumer. If the setting is false the Producer creates an embedded inner context and processes requests internally. + 4+^s| advanced +| innerContext | | CamelContext | A string representing a key in the Camel Registry matching an object value of the type org.apache.camel.CamelContext. If a CamelContext is not provided by the user a CamelContext is automatically created for deployment of inner routes. + +| innerProducerTemplate | | ProducerTemplate | The ProducerTemplate to use by the internal embeded CamelContext + +| innerRegistry | | Registry | To use a custom registry for the internal embedded CamelContext. + +| routeBuilders | | String | A string representing a key in the Camel Registry matching an object value of the type List. If the user does not supply an innerContext pre-primed with inner routes the routeBuilders option must be provided as a non-empty list of RouteBuilders containing inner routes + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-rss/src/main/docs/rss-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rss/src/main/docs/rss-component.adoc b/components/camel-rss/src/main/docs/rss-component.adoc index d6c2185..3c4b7ef 100644 --- a/components/camel-rss/src/main/docs/rss-component.adoc +++ b/components/camel-rss/src/main/docs/rss-component.adoc @@ -64,36 +64,63 @@ with the following path and query parameters: #### Query Parameters (27 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| feedHeader | consumer | true | boolean | Sets whether to add the feed object as a header -| filter | consumer | true | boolean | Sets whether to use filtering or not of the entries. -| lastUpdate | consumer | | Date | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. -| password | consumer | | String | Sets the password to be used for basic authentication when polling from a HTTP feed -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| sortEntries | consumer | false | boolean | Sets whether to sort entries by published date. Only works when splitEntries = true. -| splitEntries | consumer | true | boolean | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message -| throttleEntries | consumer | true | boolean | Sets whether all entries identified in a single feed poll should be delivered immediately. If true only one entry is processed per consumer.delay. Only applicable when splitEntries = true. -| username | consumer | | String | Sets the username to be used for basic authentication when polling from a HTTP feed -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. -| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. -| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. -| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Default | Java Type | Description + +| 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. + +| feedHeader | true | boolean | Sets whether to add the feed object as a header + +| filter | true | boolean | Sets whether to use filtering or not of the entries. + +| lastUpdate | | Date | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. + +| password | | String | Sets the password to be used for basic authentication when polling from a HTTP feed + +| 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. + +| sortEntries | false | boolean | Sets whether to sort entries by published date. Only works when splitEntries = true. + +| splitEntries | true | boolean | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message + +| throttleEntries | true | boolean | Sets whether all entries identified in a single feed poll should be delivered immediately. If true only one entry is processed per consumer.delay. Only applicable when splitEntries = true. + +| username | | String | Sets the username to be used for basic authentication when polling from a HTTP feed + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + +| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| scheduler +| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. + +| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. + +| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. + +| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). + +| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. + +| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). + +| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. + +| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. + +| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component + +| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. + +| startScheduler | true | boolean | Whether the scheduler should be auto started. + +| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. + +| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc index 28d6567..46583bc 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc +++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc @@ -431,34 +431,59 @@ The Salesforce component supports 25 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| loginConfig | security | | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration -| loginUrl | security | https://login.salesforce.com | String | Salesforce login URL defaults to https://login.salesforce.com -| clientId | security | | String | Salesforce connected application Consumer Key -| clientSecret | security | | String | Salesforce connected application Consumer Secret -| keystore | security | | KeyStoreParameters | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. -| refreshToken | security | | String | Salesforce connected application Consumer token -| userName | security | | String | Salesforce account user name -| password | security | | String | Salesforce account password -| lazyLogin | security | false | boolean | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call -| config | advanced | | SalesforceEndpointConfig | To use the shared SalesforceEndpointConfig as endpoint configuration -| httpClientProperties | advanced | | Map | Used for configuring HTTP client properties as key/value pairs -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters -| httpProxyHost | proxy | | String | To configure HTTP proxy host -| httpProxyPort | proxy | | Integer | To configure HTTP proxy port -| httpProxyUsername | security | | String | To configure HTTP proxy username -| httpProxyPassword | security | | String | To configure HTTP proxy password -| isHttpProxySocks4 | proxy | false | boolean | Enable for Socks4 proxy false by default -| isHttpProxySecure | security | false | boolean | Enable for TLS connections true by default -| httpProxyIncludedAddresses | proxy | | Set | HTTP proxy included addresses -| httpProxyExcludedAddresses | proxy | | Set | HTTP proxy excluded addresses -| httpProxyAuthUri | security | | String | HTTP proxy authentication URI -| httpProxyRealm | security | | String | HTTP proxy authentication realm -| httpProxyUseDigestAuth | security | false | boolean | Use HTTP proxy Digest authentication false by default -| packages | common | | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma). -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| security +| loginConfig | | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration + +| loginUrl | https://login.salesforce.com | String | Salesforce login URL defaults to https://login.salesforce.com + +| clientId | | String | Salesforce connected application Consumer Key + +| clientSecret | | String | Salesforce connected application Consumer Secret + +| keystore | | KeyStoreParameters | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. + +| refreshToken | | String | Salesforce connected application Consumer token + +| userName | | String | Salesforce account user name + +| password | | String | Salesforce account password + +| lazyLogin | false | boolean | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call + 4+^s| advanced +| config | | SalesforceEndpointConfig | To use the shared SalesforceEndpointConfig as endpoint configuration + +| httpClientProperties | | Map | Used for configuring HTTP client properties as key/value pairs + 4+^s| security +| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters + 4+^s| proxy +| httpProxyHost | | String | To configure HTTP proxy host + +| httpProxyPort | | Integer | To configure HTTP proxy port + 4+^s| security +| httpProxyUsername | | String | To configure HTTP proxy username + +| httpProxyPassword | | String | To configure HTTP proxy password + 4+^s| proxy +| isHttpProxySocks4 | false | boolean | Enable for Socks4 proxy false by default + 4+^s| security +| isHttpProxySecure | false | boolean | Enable for TLS connections true by default + 4+^s| proxy +| httpProxyIncludedAddresses | | Set | HTTP proxy included addresses + +| httpProxyExcludedAddresses | | Set | HTTP proxy excluded addresses + 4+^s| security +| httpProxyAuthUri | | String | HTTP proxy authentication URI + +| httpProxyRealm | | String | HTTP proxy authentication realm + +| httpProxyUseDigestAuth | false | boolean | Use HTTP proxy Digest authentication false by default + 4+^s| common +| packages | | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma). + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -489,50 +514,91 @@ with the following path and query parameters: #### Query Parameters (41 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| apexMethod | common | | String | APEX method name -| apexQueryParams | common | | Map | Query params for APEX method -| apexUrl | common | | String | APEX method URL -| apiVersion | common | | String | Salesforce API version defaults to SalesforceEndpointConfig.DEFAULT_VERSION -| backoffIncrement | common | | long | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. -| batchId | common | | String | Bulk API Batch ID -| contentType | common | | ContentType | Bulk API content type one of XML CSV ZIP_XML ZIP_CSV -| defaultReplayId | common | | Long | Default replayId setting if no value is found in link initialReplayIdMap -| format | common | | PayloadFormat | Payload format to use for Salesforce API calls either JSON or XML defaults to JSON -| httpClient | common | | SalesforceHttpClient | Custom Jetty Http Client to use to connect to Salesforce. -| includeDetails | common | | Boolean | Include details in Salesforce1 Analytics report defaults to false. -| initialReplayIdMap | common | | Map | Replay IDs to start from per channel name. -| instanceId | common | | String | Salesforce1 Analytics report execution instance ID -| jobId | common | | String | Bulk API Job ID -| limit | common | | Integer | Limit on number of returned records. Applicable to some of the API check the Salesforce documentation. -| maxBackoff | common | | long | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. -| notifyForFields | common | | NotifyForFieldsEnum | Notify for fields options are ALL REFERENCED SELECT WHERE -| notifyForOperationCreate | common | | Boolean | Notify for create operation defaults to false (API version = 29.0) -| notifyForOperationDelete | common | | Boolean | Notify for delete operation defaults to false (API version = 29.0) -| notifyForOperations | common | | NotifyForOperationsEnum | Notify for operations options are ALL CREATE EXTENDED UPDATE (API version 29.0) -| notifyForOperationUndelete | common | | Boolean | Notify for un-delete operation defaults to false (API version = 29.0) -| notifyForOperationUpdate | common | | Boolean | Notify for update operation defaults to false (API version = 29.0) -| objectMapper | common | | ObjectMapper | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. -| reportId | common | | String | Salesforce1 Analytics report Id -| reportMetadata | common | | ReportMetadata | Salesforce1 Analytics report metadata for filtering -| resultId | common | | String | Bulk API Result ID -| sObjectBlobFieldName | common | | String | SObject blob field name -| sObjectClass | common | | String | Fully qualified SObject class name usually generated using camel-salesforce-maven-plugin -| sObjectFields | common | | String | SObject fields to retrieve -| sObjectId | common | | String | SObject ID if required by API -| sObjectIdName | common | | String | SObject external ID field name -| sObjectIdValue | common | | String | SObject external ID field value -| sObjectName | common | | String | SObject name if required or supported by API -| sObjectQuery | common | | String | Salesforce SOQL query string -| sObjectSearch | common | | String | Salesforce SOSL search string -| updateTopic | common | false | boolean | Whether to update an existing Push Topic when using the Streaming API defaults to false -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| replayId | consumer | | Long | The replayId value to use when subscribing -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + 4+^s| common +| apexMethod | | String | APEX method name + +| apexQueryParams | | Map | Query params for APEX method + +| apexUrl | | String | APEX method URL + +| apiVersion | | String | Salesforce API version defaults to SalesforceEndpointConfig.DEFAULT_VERSION + +| backoffIncrement | | long | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. + +| batchId | | String | Bulk API Batch ID + +| contentType | | ContentType | Bulk API content type one of XML CSV ZIP_XML ZIP_CSV + +| defaultReplayId | | Long | Default replayId setting if no value is found in link initialReplayIdMap + +| format | | PayloadFormat | Payload format to use for Salesforce API calls either JSON or XML defaults to JSON + +| httpClient | | SalesforceHttpClient | Custom Jetty Http Client to use to connect to Salesforce. + +| includeDetails | | Boolean | Include details in Salesforce1 Analytics report defaults to false. + +| initialReplayIdMap | | Map | Replay IDs to start from per channel name. + +| instanceId | | String | Salesforce1 Analytics report execution instance ID + +| jobId | | String | Bulk API Job ID + +| limit | | Integer | Limit on number of returned records. Applicable to some of the API check the Salesforce documentation. + +| maxBackoff | | long | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. + +| notifyForFields | | NotifyForFieldsEnum | Notify for fields options are ALL REFERENCED SELECT WHERE + +| notifyForOperationCreate | | Boolean | Notify for create operation defaults to false (API version = 29.0) + +| notifyForOperationDelete | | Boolean | Notify for delete operation defaults to false (API version = 29.0) + +| notifyForOperations | | NotifyForOperationsEnum | Notify for operations options are ALL CREATE EXTENDED UPDATE (API version 29.0) + +| notifyForOperationUndelete | | Boolean | Notify for un-delete operation defaults to false (API version = 29.0) + +| notifyForOperationUpdate | | Boolean | Notify for update operation defaults to false (API version = 29.0) + +| objectMapper | | ObjectMapper | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. + +| reportId | | String | Salesforce1 Analytics report Id + +| reportMetadata | | ReportMetadata | Salesforce1 Analytics report metadata for filtering + +| resultId | | String | Bulk API Result ID + +| sObjectBlobFieldName | | String | SObject blob field name + +| sObjectClass | | String | Fully qualified SObject class name usually generated using camel-salesforce-maven-plugin + +| sObjectFields | | String | SObject fields to retrieve + +| sObjectId | | String | SObject ID if required by API + +| sObjectIdName | | String | SObject external ID field name + +| sObjectIdValue | | String | SObject external ID field value + +| sObjectName | | String | SObject name if required or supported by API + +| sObjectQuery | | String | Salesforce SOQL query string + +| sObjectSearch | | String | Salesforce SOSL search string + +| updateTopic | false | boolean | Whether to update an existing Push Topic when using the Streaming API defaults to false + 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. + +| replayId | | Long | The replayId value to use when subscribing + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc index c8083a6..5f93151 100644 --- a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc +++ b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc @@ -69,15 +69,21 @@ with the following path and query parameters: #### Query Parameters (6 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| flatternMap | producer | true | boolean | If the JSON Map contains only a single entry then flattern by storing that single entry value as the message body. -| json | producer | true | boolean | Whether to return data in JSON format. If this option is false then XML is returned in Atom format. -| jsonAsMap | producer | true | boolean | To transform the JSON from a String to a Map in the message body. -| password | producer | | String | *Required* Password for account. -| username | producer | | String | *Required* Username for account. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| flatternMap | true | boolean | If the JSON Map contains only a single entry then flattern by storing that single entry value as the message body. + +| json | true | boolean | Whether to return data in JSON format. If this option is false then XML is returned in Atom format. + +| jsonAsMap | true | boolean | To transform the JSON from a String to a Map in the message body. + +| password | | String | *Required* Password for account. + +| username | | String | *Required* Username for account. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-saxon/src/main/docs/xquery-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc index d485bfb..7d7f838 100644 --- a/components/camel-saxon/src/main/docs/xquery-component.adoc +++ b/components/camel-saxon/src/main/docs/xquery-component.adoc @@ -19,13 +19,17 @@ The XQuery component supports 4 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| moduleURIResolver | advanced | | ModuleURIResolver | To use the custom ModuleURIResolver -| configuration | advanced | | Configuration | To use a custom Saxon configuration -| configurationProperties | advanced | | Map | To set custom Saxon configuration properties -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| moduleURIResolver | | ModuleURIResolver | To use the custom ModuleURIResolver + +| configuration | | Configuration | To use a custom Saxon configuration + +| configurationProperties | | Map | To set custom Saxon configuration properties + +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -49,40 +53,71 @@ with the following path and query parameters: #### Query Parameters (31 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| allowStAX | common | false | boolean | Whether to allow using StAX mode -| headerName | common | | String | To use a Camel Message header as the input source instead of Message body. -| namespacePrefixes | common | | Map | Allows to control which namespace prefixes to use for a set of namespace mappings -| resultsFormat | common | DOM | ResultFormat | What output result to use -| resultType | common | | Class<?> | What output result to use defined as a class -| stripsAllWhiteSpace | common | true | boolean | Whether to strip all whitespaces -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. -| configuration | advanced | | Configuration | To use a custom Saxon configuration -| configurationProperties | advanced | | Map | To set custom Saxon configuration properties -| moduleURIResolver | advanced | | ModuleURIResolver | To use the custom ModuleURIResolver -| parameters | advanced | | Map | Additional parameters -| properties | advanced | | Properties | Properties to configure the serialization parameters -| staticQueryContext | advanced | | StaticQueryContext | To use a custom Saxon StaticQueryContext -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. -| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. -| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. -| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Default | Java Type | Description + +| allowStAX | false | boolean | Whether to allow using StAX mode + +| headerName | | String | To use a Camel Message header as the input source instead of Message body. + +| namespacePrefixes | | Map | Allows to control which namespace prefixes to use for a set of namespace mappings + +| resultsFormat | DOM | ResultFormat | What output result to use + +| resultType | | Class<?> | What output result to use defined as a class + +| stripsAllWhiteSpace | true | boolean | Whether to strip all whitespaces + 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 +| configuration | | Configuration | To use a custom Saxon configuration + +| configurationProperties | | Map | To set custom Saxon configuration properties + +| moduleURIResolver | | ModuleURIResolver | To use the custom ModuleURIResolver + +| parameters | | Map | Additional parameters + +| properties | | Properties | Properties to configure the serialization parameters + +| staticQueryContext | | StaticQueryContext | To use a custom Saxon StaticQueryContext + +| 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. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-schematron/src/main/docs/schematron-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-schematron/src/main/docs/schematron-component.adoc b/components/camel-schematron/src/main/docs/schematron-component.adoc index d017e9a..8e50982 100644 --- a/components/camel-schematron/src/main/docs/schematron-component.adoc +++ b/components/camel-schematron/src/main/docs/schematron-component.adoc @@ -52,13 +52,17 @@ with the following path and query parameters: #### Query Parameters (4 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| abort | producer | false | boolean | Flag to abort the route and throw a schematron validation exception. -| rules | producer | | Templates | To use the given schematron rules instead of loading from the path -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| uriResolver | advanced | | URIResolver | Set the URIResolver to be used for resolving schematron includes in the rules file. +| Name | Default | Java Type | Description + +| abort | false | boolean | Flag to abort the route and throw a schematron validation exception. + +| rules | | Templates | To use the given schematron rules instead of loading from the path + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + +| uriResolver | | URIResolver | Set the URIResolver to be used for resolving schematron includes in the rules file. |======================================================================= // endpoint options: END
