http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc index 8d206d5..c680006 100644 --- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc @@ -47,35 +47,26 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |======================================================================= #### Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| subsystem | | String | *Required* OpenStack Cinder subsystem - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **subsystem** (producer) | *Required* OpenStack Cinder subsystem | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-glance-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc index 1607f18..96cf78b 100644 --- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc @@ -47,33 +47,25 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |======================================================================= #### Query Parameters (8 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc index 394075b..e9ad266 100644 --- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc @@ -49,33 +49,25 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |======================================================================= #### Query Parameters (8 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| subsystem | | String | *Required* OpenStack Keystone subsystem - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **subsystem** (producer) | *Required* OpenStack Keystone subsystem | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc index 1e800fb..d5893bf 100644 --- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc @@ -47,35 +47,26 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |======================================================================= #### Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| subsystem | | String | *Required* OpenStack Neutron subsystem - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **subsystem** (producer) | *Required* OpenStack Neutron subsystem | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-nova-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc index d1f26de..4b49103 100644 --- a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc @@ -47,35 +47,26 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |======================================================================= #### Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| subsystem | | String | *Required* OpenStack Nova subsystem - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **subsystem** (producer) | *Required* OpenStack Nova subsystem | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-swift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc index 7c28b11..e6091e8 100644 --- a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc @@ -47,35 +47,26 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |======================================================================= #### Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| subsystem | | String | *Required* OpenStack Swift subsystem - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **subsystem** (producer) | *Required* OpenStack Swift subsystem | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc index bea1a7c..300926a 100644 --- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc +++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc @@ -53,31 +53,24 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| configFile | | String | *Required* Specifies the location to the solver file +| Name | Description | Default | Type +| **configFile** | *Required* Specifies the location to the solver file | | String |======================================================================= #### Query Parameters (7 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| solverId | DEFAULT_SOLVER | String | Specifies the solverId to user for the solver instance key - 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| producer -| async | false | boolean | Specifies to perform operations in async mode - -| threadPoolSize | 10 | int | Specifies the thread pool size to use when async is true - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **solverId** (common) | Specifies the solverId to user for the solver instance key | DEFAULT_SOLVER | String +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **async** (producer) | Specifies to perform operations in async mode | false | boolean +| **threadPoolSize** (producer) | Specifies the thread pool size to use when async is true | 10 | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-paho/src/main/docs/paho-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-paho/src/main/docs/paho-component.adoc b/components/camel-paho/src/main/docs/paho-component.adoc index d9cd6d2..8c3f578 100644 --- a/components/camel-paho/src/main/docs/paho-component.adoc +++ b/components/camel-paho/src/main/docs/paho-component.adoc @@ -121,17 +121,13 @@ The Paho component supports 4 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| brokerUrl | | String | The URL of the MQTT broker. - -| clientId | | String | MQTT client identifier. - 4+^s| advanced -| connectOptions | | MqttConnectOptions | Client connection options - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **brokerUrl** (common) | The URL of the MQTT broker. | | String +| **clientId** (common) | MQTT client identifier. | | String +| **connectOptions** (advanced) | Client connection options | | MqttConnectOptions +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -147,39 +143,28 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| topic | | String | *Required* Name of the topic +| Name | Description | Default | Type +| **topic** | *Required* Name of the topic | | String |======================================================================= #### Query Parameters (11 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| brokerUrl | tcp://localhost:1883 | String | The URL of the MQTT broker. - -| clientId | | String | MQTT client identifier. - -| connectOptions | | MqttConnectOptions | Client connection options - -| filePersistenceDirectory | | String | Base directory used by the file persistence provider. - -| persistence | MEMORY | PahoPersistence | Client persistence to be used - memory or file. - -| qos | 2 | int | Client quality of service level (0-2). - -| retained | false | boolean | Retain option - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **brokerUrl** (common) | The URL of the MQTT broker. | tcp://localhost:1883 | String +| **clientId** (common) | MQTT client identifier. | | String +| **connectOptions** (common) | Client connection options | | MqttConnectOptions +| **filePersistenceDirectory** (common) | Base directory used by the file persistence provider. | | String +| **persistence** (common) | Client persistence to be used - memory or file. | MEMORY | PahoPersistence +| **qos** (common) | Client quality of service level (0-2). | 2 | int +| **retained** (common) | Retain option | false | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc index 5974329..4dd6cfa 100644 --- a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc +++ b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc @@ -41,13 +41,11 @@ The OSGi PAX Logging component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer -| bundleContext | | BundleContext | The OSGi BundleContext is automatic injected by Camel - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **bundleContext** (consumer) | The OSGi BundleContext is automatic injected by Camel | | BundleContext +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -63,25 +61,21 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| appender | | String | *Required* Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration. +| Name | Description | Default | Type +| **appender** | *Required* Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration. | | String |======================================================================= #### Query Parameters (4 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-pdf/src/main/docs/pdf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pdf/src/main/docs/pdf-component.adoc b/components/camel-pdf/src/main/docs/pdf-component.adoc index f9eb779..452f850 100644 --- a/components/camel-pdf/src/main/docs/pdf-component.adoc +++ b/components/camel-pdf/src/main/docs/pdf-component.adoc @@ -48,35 +48,26 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| operation | | PdfOperation | *Required* Operation type +| Name | Description | Default | Type +| **operation** | *Required* Operation type | | PdfOperation |======================================================================= #### Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| font | Helvetica | PDFont | Font - -| fontSize | 14 | float | Font size in pixels - -| marginBottom | 20 | int | Margin bottom in pixels - -| marginLeft | 20 | int | Margin left in pixels - -| marginRight | 40 | int | Margin right in pixels - -| marginTop | 20 | int | Margin top in pixels - -| pageSize | PAGE_SIZE_A4 | PDRectangle | Page size - -| textProcessingFactory | lineTermination | TextProcessingFactory | Text processing to use. autoFormatting: Text is getting sliced by words then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **font** (producer) | Font | Helvetica | PDFont +| **fontSize** (producer) | Font size in pixels | 14 | float +| **marginBottom** (producer) | Margin bottom in pixels | 20 | int +| **marginLeft** (producer) | Margin left in pixels | 20 | int +| **marginRight** (producer) | Margin right in pixels | 40 | int +| **marginTop** (producer) | Margin top in pixels | 20 | int +| **pageSize** (producer) | Page size | PAGE_SIZE_A4 | PDRectangle +| **textProcessingFactory** (producer) | Text processing to use. autoFormatting: Text is getting sliced by words then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not. | lineTermination | TextProcessingFactory +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-pgevent/src/main/docs/pgevent-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pgevent/src/main/docs/pgevent-component.adoc b/components/camel-pgevent/src/main/docs/pgevent-component.adoc index 3ee8d3b..9c4e6d2 100644 --- a/components/camel-pgevent/src/main/docs/pgevent-component.adoc +++ b/components/camel-pgevent/src/main/docs/pgevent-component.adoc @@ -51,34 +51,27 @@ with the following path and query parameters: #### Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | localhost | String | To connect using hostname and port to the database. -| port | 5432 | Integer | To connect using hostname and port to the database. -| database | | String | *Required* The database name -| channel | | String | *Required* The channel name +| Name | Description | Default | Type +| **host** | To connect using hostname and port to the database. | localhost | String +| **port** | To connect using hostname and port to the database. | 5432 | Integer +| **database** | *Required* The database name | | String +| **channel** | *Required* The channel name | | String |======================================================================= #### Query Parameters (7 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| datasource | | DataSource | To connect using the given javax.sql.DataSource instead of using hostname and port. - 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). - 4+^s| security -| pass | | String | Password for login - -| user | postgres | String | Username for login +| Name | Description | Default | Type +| **datasource** (common) | To connect using the given javax.sql.DataSource instead of using hostname and port. | | DataSource +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **pass** (security) | Password for login | | String +| **user** (security) | Username for login | postgres | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-printer/src/main/docs/lpr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-printer/src/main/docs/lpr-component.adoc b/components/camel-printer/src/main/docs/lpr-component.adoc index 47e63c3..58987a9 100644 --- a/components/camel-printer/src/main/docs/lpr-component.adoc +++ b/components/camel-printer/src/main/docs/lpr-component.adoc @@ -60,41 +60,30 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| hostname | | String | *Required* Hostname of the printer -| port | | int | Port number of the printer -| printername | | String | Name of the printer +| Name | Description | Default | Type +| **hostname** | *Required* Hostname of the printer | | String +| **port** | Port number of the printer | | int +| **printername** | Name of the printer | | String |======================================================================= #### Query Parameters (11 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| copies | 1 | int | Number of copies to print - -| docFlavor | | DocFlavor | Sets DocFlavor to use. - -| flavor | | String | Sets DocFlavor to use. - -| mediaSize | na-letter | String | Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored e.g. values of iso_a4 and ISO_A4 may be used. - -| mediaTray | | String | Sets MediaTray supported by the javax.print.DocFlavor API for example uppermiddle etc. - -| mimeType | | String | Sets mimeTypes supported by the javax.print.DocFlavor API - -| orientation | portrait | String | Sets the page orientation. - -| printerPrefix | | String | Sets the prefix name of the printer it is useful when the printer name does not start with //hostname/printer - -| sendToPrinter | true | boolean | etting this option to false prevents sending of the print data to the printer - -| sides | one-sided | String | Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **copies** (producer) | Number of copies to print | 1 | int +| **docFlavor** (producer) | Sets DocFlavor to use. | | DocFlavor +| **flavor** (producer) | Sets DocFlavor to use. | | String +| **mediaSize** (producer) | Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored e.g. values of iso_a4 and ISO_A4 may be used. | na-letter | String +| **mediaTray** (producer) | Sets MediaTray supported by the javax.print.DocFlavor API for example uppermiddle etc. | | String +| **mimeType** (producer) | Sets mimeTypes supported by the javax.print.DocFlavor API | | String +| **orientation** (producer) | Sets the page orientation. | portrait | String +| **printerPrefix** (producer) | Sets the prefix name of the printer it is useful when the printer name does not start with //hostname/printer | | String +| **sendToPrinter** (producer) | etting this option to false prevents sending of the print data to the printer | true | boolean +| **sides** (producer) | Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API | one-sided | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-quartz/src/main/docs/quartz-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc index 6b93372..30601f3 100644 --- a/components/camel-quartz/src/main/docs/quartz-component.adoc +++ b/components/camel-quartz/src/main/docs/quartz-component.adoc @@ -50,25 +50,17 @@ The Quartz component supports 8 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| factory | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler. - -| scheduler | | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler. - 4+^s| consumer -| properties | | Properties | Properties to configure the Quartz scheduler. - -| propertiesFile | | String | File name of the properties to load from the classpath - 4+^s| scheduler -| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler. - 4+^s| consumer -| autoStartScheduler | true | boolean | Whether or not the scheduler should be auto started. This options is default true - -| enableJmx | true | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **factory** (advanced) | To use the custom SchedulerFactory which is used to create the Scheduler. | | SchedulerFactory +| **scheduler** (advanced) | To use the custom configured Quartz scheduler instead of creating a new Scheduler. | | Scheduler +| **properties** (consumer) | Properties to configure the Quartz scheduler. | | Properties +| **propertiesFile** (consumer) | File name of the properties to load from the classpath | | String +| **startDelayedSeconds** (scheduler) | Seconds to wait before starting the quartz scheduler. | | int +| **autoStartScheduler** (consumer) | Whether or not the scheduler should be auto started. This options is default true | true | boolean +| **enableJmx** (consumer) | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true | true | boolean +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -84,44 +76,31 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| groupName | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique. -| timerName | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. +| Name | Description | Default | Type +| **groupName** | The quartz group name to use. The combination of group name and timer name should be unique. | Camel | String +| **timerName** | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. | | String |======================================================================= #### Query Parameters (13 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| 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. - -| cron | | String | Specifies a cron expression to define when to trigger. - -| deleteJob | true | boolean | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. - -| fireNow | false | boolean | Whether to fire the scheduler asap when its started using the simple trigger (this option does not support cron) - -| pauseJob | false | boolean | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. - -| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler. - -| stateful | false | boolean | Uses a Quartz StatefulJob instead of the default job. - -| usingFixedCamelContextName | false | boolean | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time. - 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 -| jobParameters | | Map | To configure additional options on the job. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| triggerParameters | | Map | To configure additional options on the trigger. +| Name | Description | Default | Type +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **cron** (consumer) | Specifies a cron expression to define when to trigger. | | String +| **deleteJob** (consumer) | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | true | boolean +| **fireNow** (consumer) | Whether to fire the scheduler asap when its started using the simple trigger (this option does not support cron) | false | boolean +| **pauseJob** (consumer) | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | false | boolean +| **startDelayedSeconds** (consumer) | Seconds to wait before starting the quartz scheduler. | | int +| **stateful** (consumer) | Uses a Quartz StatefulJob instead of the default job. | false | boolean +| **usingFixedCamelContextName** (consumer) | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time. | 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 +| **jobParameters** (advanced) | To configure additional options on the job. | | Map +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **triggerParameters** (advanced) | To configure additional options on the trigger. | | Map |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-quartz2/src/main/docs/quartz2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quartz2/src/main/docs/quartz2-component.adoc b/components/camel-quartz2/src/main/docs/quartz2-component.adoc index b0080e4..b5fc149 100644 --- a/components/camel-quartz2/src/main/docs/quartz2-component.adoc +++ b/components/camel-quartz2/src/main/docs/quartz2-component.adoc @@ -51,31 +51,20 @@ The Quartz2 component supports 11 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| scheduler -| autoStartScheduler | true | boolean | Whether or not the scheduler should be auto started. This options is default true - -| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler. - 4+^s| consumer -| prefixJobNameWithEndpointId | false | boolean | Whether to prefix the quartz job with the endpoint id. This option is default false. - -| enableJmx | true | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true - -| properties | | Properties | Properties to configure the Quartz scheduler. - -| propertiesFile | | String | File name of the properties to load from the classpath - -| prefixInstanceName | true | boolean | Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's. - 4+^s| scheduler -| interruptJobsOnShutdown | false | boolean | Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted. - 4+^s| advanced -| schedulerFactory | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler. - -| scheduler | | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **autoStartScheduler** (scheduler) | Whether or not the scheduler should be auto started. This options is default true | true | boolean +| **startDelayedSeconds** (scheduler) | Seconds to wait before starting the quartz scheduler. | | int +| **prefixJobNameWith EndpointId** (consumer) | Whether to prefix the quartz job with the endpoint id. This option is default false. | false | boolean +| **enableJmx** (consumer) | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true | true | boolean +| **properties** (consumer) | Properties to configure the Quartz scheduler. | | Properties +| **propertiesFile** (consumer) | File name of the properties to load from the classpath | | String +| **prefixInstanceName** (consumer) | Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's. | true | boolean +| **interruptJobsOn Shutdown** (scheduler) | Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted. | false | boolean +| **schedulerFactory** (advanced) | To use the custom SchedulerFactory which is used to create the Scheduler. | | SchedulerFactory +| **scheduler** (advanced) | To use the custom configured Quartz scheduler instead of creating a new Scheduler. | | Scheduler +| **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 @@ -91,56 +80,37 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| groupName | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique. -| triggerName | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. +| Name | Description | Default | Type +| **groupName** | The quartz group name to use. The combination of group name and timer name should be unique. | Camel | String +| **triggerName** | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. | | String |======================================================================= #### Query Parameters (19 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| 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. - -| cron | | String | Specifies a cron expression to define when to trigger. - -| deleteJob | true | boolean | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. - -| durableJob | false | boolean | Whether or not the job should remain stored after it is orphaned (no triggers point to it). - -| pauseJob | false | boolean | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. - -| recoverableJob | false | boolean | Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered. - -| stateful | false | boolean | Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job. - 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 -| customCalendar | | Calendar | Specifies a custom calendar to avoid specific range of date - -| jobParameters | | Map | To configure additional options on the job. - -| prefixJobNameWithEndpointId | false | boolean | Whether the job name should be prefixed with endpoint id - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| triggerParameters | | Map | To configure additional options on the trigger. - -| usingFixedCamelContextName | false | boolean | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time. - 4+^s| scheduler -| autoStartScheduler | true | boolean | Whether or not the scheduler should be auto started. - -| fireNow | false | boolean | If it is true will fire the trigger when the route is start when using SimpleTrigger. - -| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler. - -| triggerStartDelay | 500 | long | In case of scheduler has already started we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in. +| Name | Description | Default | Type +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **cron** (consumer) | Specifies a cron expression to define when to trigger. | | String +| **deleteJob** (consumer) | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | true | boolean +| **durableJob** (consumer) | Whether or not the job should remain stored after it is orphaned (no triggers point to it). | false | boolean +| **pauseJob** (consumer) | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | false | boolean +| **recoverableJob** (consumer) | Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered. | false | boolean +| **stateful** (consumer) | Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job. | 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 +| **customCalendar** (advanced) | Specifies a custom calendar to avoid specific range of date | | Calendar +| **jobParameters** (advanced) | To configure additional options on the job. | | Map +| **prefixJobNameWithEndpoint Id** (advanced) | Whether the job name should be prefixed with endpoint id | false | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **triggerParameters** (advanced) | To configure additional options on the trigger. | | Map +| **usingFixedCamelContextName** (advanced) | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time. | false | boolean +| **autoStartScheduler** (scheduler) | Whether or not the scheduler should be auto started. | true | boolean +| **fireNow** (scheduler) | If it is true will fire the trigger when the route is start when using SimpleTrigger. | false | boolean +| **startDelayedSeconds** (scheduler) | Seconds to wait before starting the quartz scheduler. | | int +| **triggerStartDelay** (scheduler) | In case of scheduler has already started we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in. | 500 | long |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-quickfix/src/main/docs/quickfix-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc index 8bd9308..07bb862 100644 --- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc +++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc @@ -81,21 +81,15 @@ The QuickFix component supports 6 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| messageFactory | | MessageFactory | To use the given MessageFactory - -| logFactory | | LogFactory | To use the given LogFactory - -| messageStoreFactory | | MessageStoreFactory | To use the given MessageStoreFactory - 4+^s| common -| configurations | | Map | To use the given map of pre configured QuickFix configurations mapped to the key - -| lazyCreateEngines | false | boolean | If set to true the engines will be created and started when needed (when first message is send) - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **messageFactory** (advanced) | To use the given MessageFactory | | MessageFactory +| **logFactory** (advanced) | To use the given LogFactory | | LogFactory +| **messageStoreFactory** (advanced) | To use the given MessageStoreFactory | | MessageStoreFactory +| **configurations** (common) | To use the given map of pre configured QuickFix configurations mapped to the key | | Map +| **lazyCreateEngines** (common) | If set to true the engines will be created and started when needed (when first message is send) | false | boolean +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -108,29 +102,23 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| configurationName | | String | *Required* The configFile is the name of the QuickFIX/J configuration to use for the FIX engine (located as a resource found in your classpath). +| Name | Description | Default | Type +| **configurationName** | *Required* The configFile is the name of the QuickFIX/J configuration to use for the FIX engine (located as a resource found in your classpath). | | String |======================================================================= #### Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| lazyCreateEngine | false | boolean | This option allows to create QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used the engine is started at the endpoint creation. When this parameter is missing the value of component's property lazyCreateEngines is being used. - -| sessionID | | SessionID | The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID) - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **lazyCreateEngine** (common) | This option allows to create QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used the engine is started at the endpoint creation. When this parameter is missing the value of component's property lazyCreateEngines is being used. | false | boolean +| **sessionID** (common) | The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID) | | SessionID +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END
