http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 59197c8..0186bea 100644 --- a/components/camel-paho/src/main/docs/paho-component.adoc +++ b/components/camel-paho/src/main/docs/paho-component.adoc @@ -1,4 +1,4 @@ -## Paho Component +== Paho Component *Available as of Camel version 2.16* @@ -122,51 +122,53 @@ The Paho component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 // endpoint options: START The Paho endpoint is configured using URI syntax: - paho:topic +---- +paho:topic +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **topic** | *Required* Name of the topic | | String -|======================================================================= +| *topic* | *Required* Name of the topic | | String +|=== -#### Query Parameters (14 parameters): +==== Query Parameters (14 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **autoReconnect** (common) | Client will automatically attempt to reconnect to the server if the connection is lost | true | boolean -| **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 -| **password** (common) | Password to be used for authentication against the MQTT broker | | 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 -| **userName** (common) | Username to be used for authentication against the MQTT broker | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *autoReconnect* (common) | Client will automatically attempt to reconnect to the server if the connection is lost | true | boolean +| *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 +| *password* (common) | Password to be used for authentication against the MQTT broker | | 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 +| *userName* (common) | Username to be used for authentication against the MQTT broker | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-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 4dd6cfa..b519dea 100644 --- a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc +++ b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc @@ -1,4 +1,4 @@ -## OSGi PAX Logging Component +== OSGi PAX Logging Component *Available as of Camel version 2.6* @@ -42,11 +42,11 @@ The OSGi PAX Logging component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 @@ -55,28 +55,30 @@ The OSGi PAX Logging component supports 2 options which are listed below. // endpoint options: START The OSGi PAX Logging endpoint is configured using URI syntax: - paxlogging:appender +---- +paxlogging:appender +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **appender** | *Required* Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration. | | String -|======================================================================= +| *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): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **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 -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-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 452f850..ba0f78c 100644 --- a/components/camel-pdf/src/main/docs/pdf-component.adoc +++ b/components/camel-pdf/src/main/docs/pdf-component.adoc @@ -1,4 +1,4 @@ -## PDF Component +== PDF Component *Available as of Camel version 2.16* @@ -42,33 +42,35 @@ The PDF component has no options. // endpoint options: START The PDF endpoint is configured using URI syntax: - pdf:operation +---- +pdf:operation +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **operation** | *Required* Operation type | | PdfOperation -|======================================================================= +| *operation* | *Required* Operation type | | PdfOperation +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/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 9c4e6d2..0ec8157 100644 --- a/components/camel-pgevent/src/main/docs/pgevent-component.adoc +++ b/components/camel-pgevent/src/main/docs/pgevent-component.adoc @@ -1,4 +1,4 @@ -## PostgresSQL Event Component +== PostgresSQL Event Component *Available as of Camel version 2.15* @@ -45,34 +45,36 @@ The PostgresSQL Event component has no options. // endpoint options: START The PostgresSQL Event endpoint is configured using URI syntax: - pgevent:host:port/database/channel +---- +pgevent:host:port/database/channel +---- with the following path and query parameters: -#### Path Parameters (4 parameters): +==== Path Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/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 58987a9..08c412b 100644 --- a/components/camel-printer/src/main/docs/lpr-component.adoc +++ b/components/camel-printer/src/main/docs/lpr-component.adoc @@ -1,4 +1,4 @@ -## Printer Component +== Printer Component *Available as of Camel version 2.1* @@ -54,37 +54,39 @@ The Printer component has no options. // endpoint options: START The Printer endpoint is configured using URI syntax: - lpr:hostname:port/printername +---- +lpr:hostname:port/printername +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hostname** | *Required* Hostname of the printer | | String -| **port** | Port number of the printer | | int -| **printername** | Name of the printer | | String -|======================================================================= +| *hostname* | *Required* Hostname of the printer | | String +| *port* | Port number of the printer | | int +| *printername* | Name of the printer | | String +|=== -#### Query Parameters (11 parameters): +==== Query Parameters (11 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc index 091d742..d06efd0 100644 --- a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc +++ b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc @@ -1,4 +1,4 @@ -## Protobuf DataFormat +== Protobuf DataFormat [[Protobuf-Protobuf-ProtocolBuffers]] *Available as of Camel version 2.2.0* @@ -28,12 +28,12 @@ The Protobuf dataformat supports 3 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | instanceClass | | String | Name of class to use when unarmshalling | contentTypeFormat | native | String | Defines a content type format in which protobuf message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native protobuf or json fields representation. The default value is native. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Content type format (starting from *Camel 2.19*) http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-pubnub/src/main/docs/pubnub-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pubnub/src/main/docs/pubnub-component.adoc b/components/camel-pubnub/src/main/docs/pubnub-component.adoc index a721368..769d2a3 100644 --- a/components/camel-pubnub/src/main/docs/pubnub-component.adoc +++ b/components/camel-pubnub/src/main/docs/pubnub-component.adoc @@ -1,4 +1,4 @@ -## PubNub Component +== PubNub Component *Available as of Camel version 2.19* @@ -50,38 +50,40 @@ The PubNub component has no options. // endpoint options: START The PubNub endpoint is configured using URI syntax: - pubnub:channel +---- +pubnub:channel +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **channel** | *Required* The channel used for subscribing/publishing events | | String -|======================================================================= +| *channel* | *Required* The channel used for subscribing/publishing events | | String +|=== -#### Query Parameters (14 parameters): +==== Query Parameters (14 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **uuid** (common) | UUID to be used as a device identifier a default UUID is generated if not passed. | | 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 -| **withPresence** (consumer) | Also subscribe to related presence information | 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 -| **operation** (producer) | The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. WHERENOW: Obtain information about the current list of channels to which a uuid is subscribed to. GETSTATE: Used to get key/value pairs specific to a subscriber uuid. State information is supplied as a JSON object of key/value pairs SETSTATE: Used to set key/value pairs specific to a subscriber uuid GETHISTORY: Fetches historical messages of a channel. | | String -| **pubnub** (advanced) | Reference to a Pubnub client in the registry. | | PubNub -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **authKey** (security) | If Access Manager is utilized client will use this authKey in all restricted requests. | | String -| **cipherKey** (security) | If cipher is passed all communicatons to/from PubNub will be encrypted. | | String -| **publishKey** (security) | The publish key obtained from your PubNub account. Required when publishing messages. | | String -| **secretKey** (security) | The secret key used for message signing. | | String -| **secure** (security) | Use SSL for secure transmission. | true | boolean -| **subscribeKey** (security) | The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events | | String -|======================================================================= +| *uuid* (common) | UUID to be used as a device identifier a default UUID is generated if not passed. | | 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 +| *withPresence* (consumer) | Also subscribe to related presence information | 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 +| *operation* (producer) | The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. WHERENOW: Obtain information about the current list of channels to which a uuid is subscribed to. GETSTATE: Used to get key/value pairs specific to a subscriber uuid. State information is supplied as a JSON object of key/value pairs SETSTATE: Used to set key/value pairs specific to a subscriber uuid GETHISTORY: Fetches historical messages of a channel. | | String +| *pubnub* (advanced) | Reference to a Pubnub client in the registry. | | PubNub +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *authKey* (security) | If Access Manager is utilized client will use this authKey in all restricted requests. | | String +| *cipherKey* (security) | If cipher is passed all communicatons to/from PubNub will be encrypted. | | String +| *publishKey* (security) | The publish key obtained from your PubNub account. Required when publishing messages. | | String +| *secretKey* (security) | The secret key used for message signing. | | String +| *secure* (security) | Use SSL for secure transmission. | true | boolean +| *subscribeKey* (security) | The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events | | String +|=== // endpoint options: END ### Message headers when subscribing http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 30601f3..7bbbf6c 100644 --- a/components/camel-quartz/src/main/docs/quartz-component.adoc +++ b/components/camel-quartz/src/main/docs/quartz-component.adoc @@ -1,4 +1,4 @@ -## Quartz Component (deprecated) +== Quartz Component (deprecated) *Available as of Camel version 1.0* @@ -51,17 +51,17 @@ The Quartz component supports 8 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 @@ -70,38 +70,40 @@ The Quartz component supports 8 options which are listed below. // endpoint options: START The Quartz endpoint is configured using URI syntax: - quartz:groupName/timerName +---- +quartz:groupName/timerName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **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 -|======================================================================= +| *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): +==== Query Parameters (13 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **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 -|======================================================================= +| *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/4f4f2e45/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 b5fc149..ea30c54 100644 --- a/components/camel-quartz2/src/main/docs/quartz2-component.adoc +++ b/components/camel-quartz2/src/main/docs/quartz2-component.adoc @@ -1,4 +1,4 @@ -## Quartz2 Component +== Quartz2 Component *Available as of Camel version 2.12* @@ -52,20 +52,20 @@ The Quartz2 component supports 11 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 @@ -74,44 +74,46 @@ The Quartz2 component supports 11 options which are listed below. // endpoint options: START The Quartz2 endpoint is configured using URI syntax: - quartz2:groupName/triggerName +---- +quartz2:groupName/triggerName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **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 -|======================================================================= +| *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): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **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 -|======================================================================= +| *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/4f4f2e45/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 07bb862..1e8dadb 100644 --- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc +++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc @@ -1,4 +1,4 @@ -## QuickFix Component +== QuickFix Component [[ConfluenceContent]] *Available as of Camel version 2.1.0* @@ -82,44 +82,46 @@ The QuickFix component supports 6 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 // endpoint options: START The QuickFix endpoint is configured using URI syntax: - quickfix:configurationName +---- +quickfix:configurationName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **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 -|======================================================================= +| *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): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 ### Exchange Format http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc index d29472f..0d7a1eb 100644 --- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc @@ -1,4 +1,4 @@ -## RabbitMQ Component +== RabbitMQ Component *Available as of Camel version 2.12* @@ -47,84 +47,86 @@ The RabbitMQ component has no options. // endpoint options: START The RabbitMQ endpoint is configured using URI syntax: - rabbitmq:hostname:portNumber/exchangeName +---- +rabbitmq:hostname:portNumber/exchangeName +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hostname** | *Required* The hostname of the running rabbitmq instance or cluster. | | String -| **portNumber** | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | 5672 | int -| **exchangeName** | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. | | String -|======================================================================= +| *hostname* | *Required* The hostname of the running rabbitmq instance or cluster. | | String +| *portNumber* | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | 5672 | int +| *exchangeName* | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. | | String +|=== -#### Query Parameters (58 parameters): +==== Query Parameters (58 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **autoDelete** (common) | If it is true the exchange will be deleted when it is no longer in use | true | boolean -| **connectionTimeout** (common) | Connection timeout | 60000 | int -| **deadLetterExchange** (common) | The name of the dead letter exchange | | String -| **deadLetterExchangeType** (common) | The type of the dead letter exchange | direct | String -| **deadLetterQueue** (common) | The name of the dead letter queue | | String -| **deadLetterRoutingKey** (common) | The routing key for the dead letter exchange | | String -| **declare** (common) | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server. | true | boolean -| **durable** (common) | If we are declaring a durable exchange (the exchange will survive a server restart) | true | boolean -| **exchangeType** (common) | The exchange type such as direct or topic. | direct | String -| **exclusive** (common) | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes. | false | boolean -| **passive** (common) | Passive queues depend on the queue already to be available at RabbitMQ. | false | boolean -| **queue** (common) | The queue to receive messages from | | String -| **routingKey** (common) | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY. | | String -| **skipExchangeDeclare** (common) | This can be used if we need to declare the queue but not the exchange | false | boolean -| **skipQueueBind** (common) | If true the queue will not be bound to the exchange after declaring it | false | boolean -| **skipQueueDeclare** (common) | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | boolean -| **vhost** (common) | The vhost for the channel | / | String -| **autoAck** (consumer) | If messages should be auto acknowledged | true | boolean -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **concurrentConsumers** (consumer) | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). | 1 | int -| **prefetchCount** (consumer) | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int -| **prefetchEnabled** (consumer) | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean -| **prefetchGlobal** (consumer) | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean -| **prefetchSize** (consumer) | The maximum amount of content (measured in octets) that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int -| **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 -| **threadPoolSize** (consumer) | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. | 10 | int -| **bridgeEndpoint** (producer) | If the bridgeEndpoint is true the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY | false | boolean -| **channelPoolMaxSize** (producer) | Get maximum number of opened channel in pool | 10 | int -| **channelPoolMaxWait** (producer) | Set the maximum number of milliseconds to wait for a channel from the pool | 1000 | long -| **guaranteedDeliveries** (producer) | When true an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case See also a href=https://www.rabbitmq.com/confirms.htmlpublisher acknowledgements - When will messages be confirmed | false | boolean -| **immediate** (producer) | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set the server will return an undeliverable message with a Return method. If this flag is zero the server will queue the message but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. | false | boolean -| **mandatory** (producer) | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set the server will return an unroutable message with a Return method. If this flag is zero the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. | false | boolean -| **publisherAcknowledgements** (producer) | When true the message will be published with publisher acknowledgements turned on | false | boolean -| **publisherAcknowledgements Timeout** (producer) | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server | | long -| **addresses** (advanced) | If this option is set camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345 server2:12345 | | Address[] -| **args** (advanced) | Specify arguments for configuring the different RabbitMQ concepts a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000 | | Map -| **automaticRecoveryEnabled** (advanced) | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application) | | Boolean -| **bindingArgs** (advanced) | *Deprecated* Key/value args for configuring the queue binding parameters when declare=true | | Map -| **clientProperties** (advanced) | Connection client properties (client info used in negotiating with the server) | | Map -| **connectionFactory** (advanced) | To use a custom RabbitMQ connection factory. When this option is set all connection options (connectionTimeout requestedChannelMax...) set on URI are not used | | ConnectionFactory -| **exchangeArgs** (advanced) | *Deprecated* Key/value args for configuring the exchange parameters when declare=true | | Map -| **exchangeArgsConfigurer** (advanced) | *Deprecated* Set the configurer for setting the exchange args in Channel.exchangeDeclare | | ArgsConfigurer -| **networkRecoveryInterval** (advanced) | Network recovery interval in milliseconds (interval used when recovering from network failure) | | Integer -| **queueArgs** (advanced) | *Deprecated* Key/value args for configuring the queue parameters when declare=true | | Map -| **queueArgsConfigurer** (advanced) | *Deprecated* Set the configurer for setting the queue args in Channel.queueDeclare | | ArgsConfigurer -| **requestedChannelMax** (advanced) | Connection requested channel max (max number of channels offered) | 0 | int -| **requestedFrameMax** (advanced) | Connection requested frame max (max size of frame offered) | 0 | int -| **requestedHeartbeat** (advanced) | Connection requested heartbeat (heart-beat in seconds offered) | 60 | int -| **requestTimeout** (advanced) | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | | long -| **requestTimeoutChecker Interval** (advanced) | Set requestTimeoutCheckerInterval for inOut exchange | | long -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **topologyRecoveryEnabled** (advanced) | Enables connection topology recovery (should topology recovery be performed) | | Boolean -| **transferException** (advanced) | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | boolean -| **password** (security) | Password for authenticated access | guest | String -| **sslProtocol** (security) | Enables SSL on connection accepted value are true TLS and 'SSLv3 | | String -| **trustManager** (security) | Configure SSL trust manager SSL should be enabled for this option to be effective | | TrustManager -| **username** (security) | Username in case of authenticated access | guest | String -|======================================================================= +| *autoDelete* (common) | If it is true the exchange will be deleted when it is no longer in use | true | boolean +| *connectionTimeout* (common) | Connection timeout | 60000 | int +| *deadLetterExchange* (common) | The name of the dead letter exchange | | String +| *deadLetterExchangeType* (common) | The type of the dead letter exchange | direct | String +| *deadLetterQueue* (common) | The name of the dead letter queue | | String +| *deadLetterRoutingKey* (common) | The routing key for the dead letter exchange | | String +| *declare* (common) | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server. | true | boolean +| *durable* (common) | If we are declaring a durable exchange (the exchange will survive a server restart) | true | boolean +| *exchangeType* (common) | The exchange type such as direct or topic. | direct | String +| *exclusive* (common) | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes. | false | boolean +| *passive* (common) | Passive queues depend on the queue already to be available at RabbitMQ. | false | boolean +| *queue* (common) | The queue to receive messages from | | String +| *routingKey* (common) | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY. | | String +| *skipExchangeDeclare* (common) | This can be used if we need to declare the queue but not the exchange | false | boolean +| *skipQueueBind* (common) | If true the queue will not be bound to the exchange after declaring it | false | boolean +| *skipQueueDeclare* (common) | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | boolean +| *vhost* (common) | The vhost for the channel | / | String +| *autoAck* (consumer) | If messages should be auto acknowledged | true | boolean +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *concurrentConsumers* (consumer) | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). | 1 | int +| *prefetchCount* (consumer) | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int +| *prefetchEnabled* (consumer) | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean +| *prefetchGlobal* (consumer) | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean +| *prefetchSize* (consumer) | The maximum amount of content (measured in octets) that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int +| *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 +| *threadPoolSize* (consumer) | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. | 10 | int +| *bridgeEndpoint* (producer) | If the bridgeEndpoint is true the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY | false | boolean +| *channelPoolMaxSize* (producer) | Get maximum number of opened channel in pool | 10 | int +| *channelPoolMaxWait* (producer) | Set the maximum number of milliseconds to wait for a channel from the pool | 1000 | long +| *guaranteedDeliveries* (producer) | When true an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case See also a href=https://www.rabbitmq.com/confirms.htmlpublisher acknowledgements - When will messages be confirmed | false | boolean +| *immediate* (producer) | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set the server will return an undeliverable message with a Return method. If this flag is zero the server will queue the message but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. | false | boolean +| *mandatory* (producer) | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set the server will return an unroutable message with a Return method. If this flag is zero the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. | false | boolean +| *publisherAcknowledgements* (producer) | When true the message will be published with publisher acknowledgements turned on | false | boolean +| *publisherAcknowledgements Timeout* (producer) | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server | | long +| *addresses* (advanced) | If this option is set camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345 server2:12345 | | Address[] +| *args* (advanced) | Specify arguments for configuring the different RabbitMQ concepts a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000 | | Map +| *automaticRecoveryEnabled* (advanced) | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application) | | Boolean +| *bindingArgs* (advanced) | *Deprecated* Key/value args for configuring the queue binding parameters when declare=true | | Map +| *clientProperties* (advanced) | Connection client properties (client info used in negotiating with the server) | | Map +| *connectionFactory* (advanced) | To use a custom RabbitMQ connection factory. When this option is set all connection options (connectionTimeout requestedChannelMax...) set on URI are not used | | ConnectionFactory +| *exchangeArgs* (advanced) | *Deprecated* Key/value args for configuring the exchange parameters when declare=true | | Map +| *exchangeArgsConfigurer* (advanced) | *Deprecated* Set the configurer for setting the exchange args in Channel.exchangeDeclare | | ArgsConfigurer +| *networkRecoveryInterval* (advanced) | Network recovery interval in milliseconds (interval used when recovering from network failure) | | Integer +| *queueArgs* (advanced) | *Deprecated* Key/value args for configuring the queue parameters when declare=true | | Map +| *queueArgsConfigurer* (advanced) | *Deprecated* Set the configurer for setting the queue args in Channel.queueDeclare | | ArgsConfigurer +| *requestedChannelMax* (advanced) | Connection requested channel max (max number of channels offered) | 0 | int +| *requestedFrameMax* (advanced) | Connection requested frame max (max size of frame offered) | 0 | int +| *requestedHeartbeat* (advanced) | Connection requested heartbeat (heart-beat in seconds offered) | 60 | int +| *requestTimeout* (advanced) | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | | long +| *requestTimeoutChecker Interval* (advanced) | Set requestTimeoutCheckerInterval for inOut exchange | | long +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *topologyRecoveryEnabled* (advanced) | Enables connection topology recovery (should topology recovery be performed) | | Boolean +| *transferException* (advanced) | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | boolean +| *password* (security) | Password for authenticated access | guest | String +| *sslProtocol* (security) | Enables SSL on connection accepted value are true TLS and 'SSLv3 | | String +| *trustManager* (security) | Configure SSL trust manager SSL should be enabled for this option to be effective | | TrustManager +| *username* (security) | Username in case of authenticated access | guest | String +|=== // endpoint options: END
