http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-mllp/src/main/docs/mllp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc index 39493a2..63c324d 100644 --- a/components/camel-mllp/src/main/docs/mllp-component.adoc +++ b/components/camel-mllp/src/main/docs/mllp-component.adoc @@ -59,62 +59,40 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| hostname | | String | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address -| port | | int | *Required* Port number for the TCP connection +| Name | Description | Default | Type +| **hostname** | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address | | String +| **port** | *Required* Port number for the TCP connection | | int |======================================================================= #### Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| autoAck | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only - -| bufferWrites | true | boolean | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). - -| hl7Headers | true | boolean | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only - -| keepAlive | true | boolean | Enable/disable the SO_KEEPALIVE socket option. - -| reuseAddress | false | boolean | Enable/disable the SO_REUSEADDR socket option. - -| tcpNoDelay | true | boolean | Enable/disable the TCP_NODELAY socket option. - -| validatePayload | false | boolean | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. - 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 -| backlog | 5 | int | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. - -| receiveBufferSize | | Integer | Sets the SO_RCVBUF option to the specified value (in bytes) - -| sendBufferSize | | Integer | Sets the SO_SNDBUF option to the specified value (in bytes) - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| codec -| charsetName | | String | Set the CamelCharsetName property on the exchange - 4+^s| timeout -| acceptTimeout | 60000 | int | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only - -| bindRetryInterval | 5000 | int | TCP Server Only - The number of milliseconds to wait between bind attempts - -| bindTimeout | 30000 | int | TCP Server Only - The number of milliseconds to retry binding to a server port - -| connectTimeout | 30000 | int | Timeout (in milliseconds) for establishing for a TCP connection TCP Client only - -| maxReceiveTimeouts | -1 | int | The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. - -| readTimeout | 500 | int | The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received - -| receiveTimeout | 10000 | int | The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame +| Name | Description | Default | Type +| **autoAck** (common) | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only | true | boolean +| **bufferWrites** (common) | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). | true | boolean +| **hl7Headers** (common) | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only | true | boolean +| **keepAlive** (common) | Enable/disable the SO_KEEPALIVE socket option. | true | boolean +| **reuseAddress** (common) | Enable/disable the SO_REUSEADDR socket option. | false | boolean +| **tcpNoDelay** (common) | Enable/disable the TCP_NODELAY socket option. | true | boolean +| **validatePayload** (common) | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. | 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 +| **backlog** (advanced) | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. | 5 | int +| **receiveBufferSize** (advanced) | Sets the SO_RCVBUF option to the specified value (in bytes) | | Integer +| **sendBufferSize** (advanced) | Sets the SO_SNDBUF option to the specified value (in bytes) | | Integer +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **charsetName** (codec) | Set the CamelCharsetName property on the exchange | | String +| **acceptTimeout** (timeout) | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only | 60000 | int +| **bindRetryInterval** (timeout) | TCP Server Only - The number of milliseconds to wait between bind attempts | 5000 | int +| **bindTimeout** (timeout) | TCP Server Only - The number of milliseconds to retry binding to a server port | 30000 | int +| **connectTimeout** (timeout) | Timeout (in milliseconds) for establishing for a TCP connection TCP Client only | 30000 | int +| **maxReceiveTimeouts** (timeout) | The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. | -1 | int +| **readTimeout** (timeout) | The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received | 500 | int +| **receiveTimeout** (timeout) | The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame | 10000 | int |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc index 44b7d80..6672f6e 100644 --- a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc +++ b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc @@ -41,51 +41,34 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use. +| Name | Description | Default | Type +| **connectionBean** | *Required* Name of com.mongodb.Mongo to use. | | String |======================================================================= #### Query Parameters (17 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| bucket | fs | String | Sets the name of the GridFS bucket within the database. Default is fs. - -| database | | String | *Required* Sets the name of the MongoDB database to target - -| readPreference | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. - -| writeConcern | | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. - -| writeConcernRef | | WriteConcern | Set the WriteConcern for write operations on MongoDB passing in the bean ref to a custom WriteConcern which exists in the Registry. You can also use standard WriteConcerns by passing in their key. See the link setWriteConcern(String) setWriteConcern method. - 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. - -| delay | 500 | long | Sets the delay between polls within the Consumer. Default is 500ms - -| fileAttributeName | camel-processed | String | If the QueryType uses a FileAttribute this sets the name of the attribute that is used. Default is camel-processed. - -| initialDelay | 1000 | long | Sets the initialDelay before the consumer will start polling. Default is 1000ms - -| persistentTSCollection | camel-timestamps | String | If the QueryType uses a persistent timestamp this sets the name of the collection within the DB to store the timestamp. - -| persistentTSObject | camel-timestamp | String | If the QueryType uses a persistent timestamp this is the ID of the object in the collection to store the timestamp. - -| query | | String | Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer - -| queryStrategy | TimeStamp | QueryStrategy | Sets the QueryStrategy that is used for polling for new files. Default is Timestamp - 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 -| operation | | String | Sets the operation this endpoint will execute against GridRS. - 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 +| **bucket** (common) | Sets the name of the GridFS bucket within the database. Default is fs. | fs | String +| **database** (common) | *Required* Sets the name of the MongoDB database to target | | String +| **readPreference** (common) | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. | | ReadPreference +| **writeConcern** (common) | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. | | WriteConcern +| **writeConcernRef** (common) | Set the WriteConcern for write operations on MongoDB passing in the bean ref to a custom WriteConcern which exists in the Registry. You can also use standard WriteConcerns by passing in their key. See the link setWriteConcern(String) setWriteConcern method. | | WriteConcern +| **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 +| **delay** (consumer) | Sets the delay between polls within the Consumer. Default is 500ms | 500 | long +| **fileAttributeName** (consumer) | If the QueryType uses a FileAttribute this sets the name of the attribute that is used. Default is camel-processed. | camel-processed | String +| **initialDelay** (consumer) | Sets the initialDelay before the consumer will start polling. Default is 1000ms | 1000 | long +| **persistentTSCollection** (consumer) | If the QueryType uses a persistent timestamp this sets the name of the collection within the DB to store the timestamp. | camel-timestamps | String +| **persistentTSObject** (consumer) | If the QueryType uses a persistent timestamp this is the ID of the object in the collection to store the timestamp. | camel-timestamp | String +| **query** (consumer) | Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer | | String +| **queryStrategy** (consumer) | Sets the QueryStrategy that is used for polling for new files. Default is Timestamp | TimeStamp | QueryStrategy +| **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) | Sets the operation this endpoint will execute against GridRS. | | 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/bb3764e3/components/camel-mongodb/src/main/docs/mongodb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc b/components/camel-mongodb/src/main/docs/mongodb-component.adoc index f19cbe2..bc91b18 100644 --- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc +++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc @@ -68,63 +68,40 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use. +| Name | Description | Default | Type +| **connectionBean** | *Required* Name of com.mongodb.Mongo to use. | | String |======================================================================= #### Query Parameters (23 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| collection | | String | Sets the name of the MongoDB collection to bind to this endpoint - -| collectionIndex | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) - -| createCollection | true | boolean | Create collection during initialisation if it doesn't exist. Default is true. - -| database | | String | Sets the name of the MongoDB database to target - -| operation | | MongoDbOperation | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. - -| outputType | | MongoDbOutputType | Convert the output of the producer to the selected type : DBObjectList DBObject or DBCursor. DBObjectList or DBObject applies to findAll. DBCursor applies to all other operations. - -| writeConcern | ACKNOWLEDGED | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. - 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 -| cursorRegenerationDelay | 1000 | long | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. - -| dynamicity | false | boolean | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. - -| readPreference | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| writeResultAsHeader | false | boolean | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. - 4+^s| tail -| persistentId | | String | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. - -| persistentTailTracking | false | boolean | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. - -| persistRecords | -1 | int | Sets the number of tailed records after which the tail tracking data is persisted to MongoDB. - -| tailTrackCollection | | String | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. - -| tailTrackDb | | String | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. - -| tailTrackField | | String | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. - -| tailTrackIncreasingField | | String | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. - -| tailTrackingStrategy | LITERAL | MongoDBTailTrackingEnum | Sets the strategy used to extract the increasing field value and to create the query to position the tail cursor. +| Name | Description | Default | Type +| **collection** (common) | Sets the name of the MongoDB collection to bind to this endpoint | | String +| **collectionIndex** (common) | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) | | String +| **createCollection** (common) | Create collection during initialisation if it doesn't exist. Default is true. | true | boolean +| **database** (common) | Sets the name of the MongoDB database to target | | String +| **operation** (common) | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. | | MongoDbOperation +| **outputType** (common) | Convert the output of the producer to the selected type : DBObjectList DBObject or DBCursor. DBObjectList or DBObject applies to findAll. DBCursor applies to all other operations. | | MongoDbOutputType +| **writeConcern** (common) | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. | ACKNOWLEDGED | WriteConcern +| **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 +| **cursorRegenerationDelay** (advanced) | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. | 1000 | long +| **dynamicity** (advanced) | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. | false | boolean +| **readPreference** (advanced) | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. | | ReadPreference +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **writeResultAsHeader** (advanced) | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. | false | boolean +| **persistentId** (tail) | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. | | String +| **persistentTailTracking** (tail) | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. | false | boolean +| **persistRecords** (tail) | Sets the number of tailed records after which the tail tracking data is persisted to MongoDB. | -1 | int +| **tailTrackCollection** (tail) | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. | | String +| **tailTrackDb** (tail) | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. | | String +| **tailTrackField** (tail) | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. | | String +| **tailTrackIncreasingField** (tail) | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. | | String +| **tailTrackingStrategy** (tail) | Sets the strategy used to extract the increasing field value and to create the query to position the tail cursor. | LITERAL | MongoDBTailTracking Enum |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc index 021a5b2..6ddcef4 100644 --- a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc +++ b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc @@ -70,55 +70,36 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use. +| Name | Description | Default | Type +| **connectionBean** | *Required* Name of com.mongodb.Mongo to use. | | String |======================================================================= #### Query Parameters (19 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| collection | | String | Sets the name of the MongoDB collection to bind to this endpoint - -| collectionIndex | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) - -| createCollection | true | boolean | Create collection during initialisation if it doesn't exist. Default is true. - -| database | | String | Sets the name of the MongoDB database to target - -| operation | | MongoDbOperation | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. - -| outputType | | MongoDbOutputType | Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or Document applies to findAll. MongoIterable applies to all other operations. - 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 -| cursorRegenerationDelay | 1000 | long | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. - -| dynamicity | false | boolean | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| writeResultAsHeader | false | boolean | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. - 4+^s| tail -| persistentId | | String | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. - -| persistentTailTracking | false | boolean | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. - -| tailTrackCollection | | String | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. - -| tailTrackDb | | String | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. - -| tailTrackField | | String | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. - -| tailTrackIncreasingField | | String | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. +| Name | Description | Default | Type +| **collection** (common) | Sets the name of the MongoDB collection to bind to this endpoint | | String +| **collectionIndex** (common) | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) | | String +| **createCollection** (common) | Create collection during initialisation if it doesn't exist. Default is true. | true | boolean +| **database** (common) | Sets the name of the MongoDB database to target | | String +| **operation** (common) | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. | | MongoDbOperation +| **outputType** (common) | Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or Document applies to findAll. MongoIterable applies to all other operations. | | MongoDbOutputType +| **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 +| **cursorRegenerationDelay** (advanced) | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. | 1000 | long +| **dynamicity** (advanced) | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. | false | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **writeResultAsHeader** (advanced) | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. | false | boolean +| **persistentId** (tail) | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. | | String +| **persistentTailTracking** (tail) | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. | false | boolean +| **tailTrackCollection** (tail) | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. | | String +| **tailTrackDb** (tail) | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. | | String +| **tailTrackField** (tail) | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. | | String +| **tailTrackIncreasingField** (tail) | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-mqtt/src/main/docs/mqtt-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mqtt/src/main/docs/mqtt-component.adoc b/components/camel-mqtt/src/main/docs/mqtt-component.adoc index 5bfaa88..90990f7 100644 --- a/components/camel-mqtt/src/main/docs/mqtt-component.adoc +++ b/components/camel-mqtt/src/main/docs/mqtt-component.adoc @@ -39,17 +39,13 @@ The MQTT component supports 4 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| host | | String | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883 - 4+^s| security -| userName | | String | Username to be used for authentication against the MQTT broker - -| password | | String | Password to be used for authentication against the MQTT broker - 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 +| **host** (common) | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883 | | String +| **userName** (security) | Username to be used for authentication against the MQTT broker | | String +| **password** (security) | Password to be used for authentication against the MQTT broker | | String +| **resolvePropertyPlaceholders** (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 @@ -67,95 +63,56 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| name | | String | *Required* A logical name to use which is not the topic name. +| Name | Description | Default | Type +| **name** | *Required* A logical name to use which is not the topic name. | | String |======================================================================= #### Query Parameters (39 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| blockingExecutor | | Executor | SSL connections perform blocking operations against internal thread pool unless you call the setBlockingExecutor method to configure that executor they will use instead. - -| byDefaultRetain | false | boolean | The default retain policy to be used on messages sent to the MQTT broker - -| cleanSession | false | boolean | Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions. Defaults to true. - -| clientId | | String | Use to set the client Id of the session. This is what an MQTT server uses to identify a session where setCleanSession(false); is being used. The id must be 23 characters or less. Defaults to auto generated id (based on your socket address port and timestamp). - -| connectAttemptsMax | -1 | long | The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server. Set to -1 to use unlimited attempts. Defaults to -1. - -| connectWaitInSeconds | 10 | int | Delay in seconds the Component will wait for a connection to be established to the MQTT broker - -| disconnectWaitInSeconds | 5 | int | The number of seconds the Component will wait for a valid disconnect on stop() from the MQTT broker - -| dispatchQueue | | DispatchQueue | A HawtDispatch dispatch queue is used to synchronize access to the connection. If an explicit queue is not configured via the setDispatchQueue method then a new queue will be created for the connection. Setting an explicit queue might be handy if you want multiple connection to share the same queue for synchronization. - -| host | tcp://127.0.0.1:1883 | URI | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883 - -| keepAlive | | short | Configures the Keep Alive timer in seconds. Defines the maximum time interval between messages received from a client. It enables the server to detect that the network connection to a client has dropped without having to wait for the long TCP/IP timeout. - -| localAddress | | URI | The local InetAddress and port to use - -| maxReadRate | | int | Sets the maximum bytes per second that this transport will receive data at. This setting throttles reads so that the rate is not exceeded. Defaults to 0 which disables throttling. - -| maxWriteRate | | int | Sets the maximum bytes per second that this transport will send data at. This setting throttles writes so that the rate is not exceeded. Defaults to 0 which disables throttling. - -| mqttQosPropertyName | MQTTQos | String | The property name to look for on an Exchange for an individual published message. If this is set (one of AtMostOnce AtLeastOnce or ExactlyOnce ) - then that QoS will be set on the message sent to the MQTT message broker. - -| mqttRetainPropertyName | MQTTRetain | String | The property name to look for on an Exchange for an individual published message. If this is set (expects a Boolean value) - then the retain property will be set on the message sent to the MQTT message broker. - -| mqttTopicPropertyName | MQTTTopicPropertyName | String | These a properties that are looked for in an Exchange - to publish to - -| publishTopicName | camel/mqtt/test | String | The default Topic to publish messages on - -| qualityOfService | AtLeastOnce | String | Quality of service level to use for topics. - -| receiveBufferSize | 65536 | int | Sets the size of the internal socket receive buffer. Defaults to 65536 (64k) - -| reconnectAttemptsMax | -1 | long | The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established. Set to -1 to use unlimited attempts. Defaults to -1. - -| reconnectBackOffMultiplier | 2.0 | double | The Exponential backoff be used between reconnect attempts. Set to 1 to disable exponential backoff. Defaults to 2. - -| reconnectDelay | 10 | long | How long to wait in ms before the first reconnect attempt. Defaults to 10. - -| reconnectDelayMax | 30000 | long | The maximum amount of time in ms to wait between reconnect attempts. Defaults to 30000. - -| sendBufferSize | 65536 | int | Sets the size of the internal socket send buffer. Defaults to 65536 (64k) - -| sendWaitInSeconds | 5 | int | The maximum time the Component will wait for a receipt from the MQTT broker to acknowledge a published message before throwing an exception - -| sslContext | | SSLContext | To configure security using SSLContext configuration - -| subscribeTopicName | | String | These are set on the Endpoint - together with properties inherited from MQTT - -| subscribeTopicNames | | String | A comma-delimited list of Topics to subscribe to for messages. Note that each item of this list can contain MQTT wildcards ( and/or ) in order to subscribe to topics matching a certain pattern within a hierarchy. For example is a wildcard for all topics at a level within the hierarchy so if a broker has topics topics/one and topics/two then topics/ can be used to subscribe to both. A caveat to consider here is that if the broker adds topics/three the route would also begin to receive messages from that topic. - -| trafficClass | 8 | int | Sets traffic class or type-of-service octet in the IP header for packets sent from the transport. Defaults to 8 which means the traffic should be optimized for throughput. - -| version | 3.1 | String | Set to 3.1.1 to use MQTT version 3.1.1. Otherwise defaults to the 3.1 protocol version. - -| willMessage | | String | The Will message to send. Defaults to a zero length message. - -| willQos | AtMostOnce | QoS | Sets the quality of service to use for the Will message. Defaults to AT_MOST_ONCE. - -| willRetain | | QoS | Set to true if you want the Will to be published with the retain option. - -| willTopic | | String | If set the server will publish the client's Will message to the specified topics if the client has an unexpected disconnection. - 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 (advanced) -| lazySessionCreation | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. - 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 +| **blockingExecutor** (common) | SSL connections perform blocking operations against internal thread pool unless you call the setBlockingExecutor method to configure that executor they will use instead. | | Executor +| **byDefaultRetain** (common) | The default retain policy to be used on messages sent to the MQTT broker | false | boolean +| **cleanSession** (common) | Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions. Defaults to true. | false | boolean +| **clientId** (common) | Use to set the client Id of the session. This is what an MQTT server uses to identify a session where setCleanSession(false); is being used. The id must be 23 characters or less. Defaults to auto generated id (based on your socket address port and timestamp). | | String +| **connectAttemptsMax** (common) | The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server. Set to -1 to use unlimited attempts. Defaults to -1. | -1 | long +| **connectWaitInSeconds** (common) | Delay in seconds the Component will wait for a connection to be established to the MQTT broker | 10 | int +| **disconnectWaitInSeconds** (common) | The number of seconds the Component will wait for a valid disconnect on stop() from the MQTT broker | 5 | int +| **dispatchQueue** (common) | A HawtDispatch dispatch queue is used to synchronize access to the connection. If an explicit queue is not configured via the setDispatchQueue method then a new queue will be created for the connection. Setting an explicit queue might be handy if you want multiple connection to share the same queue for synchronization. | | DispatchQueue +| **host** (common) | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883 | tcp://127.0.0.1:1883 | URI +| **keepAlive** (common) | Configures the Keep Alive timer in seconds. Defines the maximum time interval between messages received from a client. It enables the server to detect that the network connection to a client has dropped without having to wait for the long TCP/IP timeout. | | short +| **localAddress** (common) | The local InetAddress and port to use | | URI +| **maxReadRate** (common) | Sets the maximum bytes per second that this transport will receive data at. This setting throttles reads so that the rate is not exceeded. Defaults to 0 which disables throttling. | | int +| **maxWriteRate** (common) | Sets the maximum bytes per second that this transport will send data at. This setting throttles writes so that the rate is not exceeded. Defaults to 0 which disables throttling. | | int +| **mqttQosPropertyName** (common) | The property name to look for on an Exchange for an individual published message. If this is set (one of AtMostOnce AtLeastOnce or ExactlyOnce ) - then that QoS will be set on the message sent to the MQTT message broker. | MQTTQos | String +| **mqttRetainPropertyName** (common) | The property name to look for on an Exchange for an individual published message. If this is set (expects a Boolean value) - then the retain property will be set on the message sent to the MQTT message broker. | MQTTRetain | String +| **mqttTopicPropertyName** (common) | These a properties that are looked for in an Exchange - to publish to | MQTTTopicPropertyName | String +| **publishTopicName** (common) | The default Topic to publish messages on | camel/mqtt/test | String +| **qualityOfService** (common) | Quality of service level to use for topics. | AtLeastOnce | String +| **receiveBufferSize** (common) | Sets the size of the internal socket receive buffer. Defaults to 65536 (64k) | 65536 | int +| **reconnectAttemptsMax** (common) | The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established. Set to -1 to use unlimited attempts. Defaults to -1. | -1 | long +| **reconnectBackOffMultiplier** (common) | The Exponential backoff be used between reconnect attempts. Set to 1 to disable exponential backoff. Defaults to 2. | 2.0 | double +| **reconnectDelay** (common) | How long to wait in ms before the first reconnect attempt. Defaults to 10. | 10 | long +| **reconnectDelayMax** (common) | The maximum amount of time in ms to wait between reconnect attempts. Defaults to 30000. | 30000 | long +| **sendBufferSize** (common) | Sets the size of the internal socket send buffer. Defaults to 65536 (64k) | 65536 | int +| **sendWaitInSeconds** (common) | The maximum time the Component will wait for a receipt from the MQTT broker to acknowledge a published message before throwing an exception | 5 | int +| **sslContext** (common) | To configure security using SSLContext configuration | | SSLContext +| **subscribeTopicName** (common) | These are set on the Endpoint - together with properties inherited from MQTT | | String +| **subscribeTopicNames** (common) | A comma-delimited list of Topics to subscribe to for messages. Note that each item of this list can contain MQTT wildcards ( and/or ) in order to subscribe to topics matching a certain pattern within a hierarchy. For example is a wildcard for all topics at a level within the hierarchy so if a broker has topics topics/one and topics/two then topics/ can be used to subscribe to both. A caveat to consider here is that if the broker adds topics/three the route would also begin to receive messages from that topic. | | String +| **trafficClass** (common) | Sets traffic class or type-of-service octet in the IP header for packets sent from the transport. Defaults to 8 which means the traffic should be optimized for throughput. | 8 | int +| **version** (common) | Set to 3.1.1 to use MQTT version 3.1.1. Otherwise defaults to the 3.1 protocol version. | 3.1 | String +| **willMessage** (common) | The Will message to send. Defaults to a zero length message. | | String +| **willQos** (common) | Sets the quality of service to use for the Will message. Defaults to AT_MOST_ONCE. | AtMostOnce | QoS +| **willRetain** (common) | Set to true if you want the Will to be published with the retain option. | | QoS +| **willTopic** (common) | If set the server will publish the client's Will message to the specified topics if the client has an unexpected disconnection. | | 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 +| **lazySessionCreation** (producer) | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean +| **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/bb3764e3/components/camel-msv/src/main/docs/msv-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-msv/src/main/docs/msv-component.adoc b/components/camel-msv/src/main/docs/msv-component.adoc index 9c5bccd..06739fd 100644 --- a/components/camel-msv/src/main/docs/msv-component.adoc +++ b/components/camel-msv/src/main/docs/msv-component.adoc @@ -55,15 +55,12 @@ The MSV component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| schemaFactory | | SchemaFactory | To use the javax.xml.validation.SchemaFactory. - -| resourceResolverFactory | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI - -| 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 +| **schemaFactory** (advanced) | To use the javax.xml.validation.SchemaFactory. | | SchemaFactory +| **resourceResolverFactory** (advanced) | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI | | ValidatorResource ResolverFactory +| **resolvePropertyPlaceholders** (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 @@ -81,39 +78,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,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* URL to a local resource on the classpath or a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. +| Name | Description | Default | Type +| **resourceUri** | *Required* URL to a local resource on the classpath or a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. | | String |======================================================================= #### Query Parameters (11 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| failOnNullBody | true | boolean | Whether to fail if no body exists. - -| failOnNullHeader | true | boolean | Whether to fail if no header exists when validating against a header. - -| headerName | | String | To validate against a header instead of the message body. - 4+^s| advanced -| errorHandler | | ValidatorErrorHandler | To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception. - -| resourceResolver | | LSResourceResolver | To use a custom LSResourceResolver. Do not use together with resourceResolverFactory - -| resourceResolverFactory | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory resturns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver. - -| schemaFactory | | SchemaFactory | To use a custom javax.xml.validation.SchemaFactory - -| schemaLanguage | http://www.w3.org/2001/XMLSchema | String | Configures the W3C XML Schema Namespace URI. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| useDom | false | boolean | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator. - -| useSharedSchema | true | boolean | Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue. +| Name | Description | Default | Type +| **failOnNullBody** (producer) | Whether to fail if no body exists. | true | boolean +| **failOnNullHeader** (producer) | Whether to fail if no header exists when validating against a header. | true | boolean +| **headerName** (producer) | To validate against a header instead of the message body. | | String +| **errorHandler** (advanced) | To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception. | | ValidatorErrorHandler +| **resourceResolver** (advanced) | To use a custom LSResourceResolver. Do not use together with resourceResolverFactory | | LSResourceResolver +| **resourceResolverFactory** (advanced) | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory resturns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver. | | ValidatorResource ResolverFactory +| **schemaFactory** (advanced) | To use a custom javax.xml.validation.SchemaFactory | | SchemaFactory +| **schemaLanguage** (advanced) | Configures the W3C XML Schema Namespace URI. | http://www.w3.org/2001/XMLSchema | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **useDom** (advanced) | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator. | false | boolean +| **useSharedSchema** (advanced) | Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue. | true | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-mustache/src/main/docs/mustache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/docs/mustache-component.adoc b/components/camel-mustache/src/main/docs/mustache-component.adoc index 2e86083..57dff1a 100644 --- a/components/camel-mustache/src/main/docs/mustache-component.adoc +++ b/components/camel-mustache/src/main/docs/mustache-component.adoc @@ -44,13 +44,11 @@ The Mustache component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| mustacheFactory | | MustacheFactory | To use a custom MustacheFactory - -| 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 +| **mustacheFactory** (advanced) | To use a custom MustacheFactory | | MustacheFactory +| **resolvePropertyPlaceholders** (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,27 +68,22 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +| Name | Description | Default | Type +| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| contentCache | false | boolean | Sets whether to use resource content cache or not - -| encoding | | String | Character encoding of the resource content. - -| endDelimiter | }} | String | Characters used to mark template code end. - -| startDelimiter | {{ | String | Characters used to mark template code beginning. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean +| **encoding** (producer) | Character encoding of the resource content. | | String +| **endDelimiter** (producer) | Characters used to mark template code end. | }} | String +| **startDelimiter** (producer) | Characters used to mark template code beginning. | {{ | 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/bb3764e3/components/camel-mvel/src/main/docs/mvel-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mvel/src/main/docs/mvel-component.adoc b/components/camel-mvel/src/main/docs/mvel-component.adoc index 71e93b0..bcc176a 100644 --- a/components/camel-mvel/src/main/docs/mvel-component.adoc +++ b/components/camel-mvel/src/main/docs/mvel-component.adoc @@ -52,23 +52,20 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +| Name | Description | Default | Type +| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String |======================================================================= #### Query Parameters (3 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| contentCache | false | boolean | Sets whether to use resource content cache or not - -| encoding | | String | Character encoding of the resource content. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean +| **encoding** (producer) | Character encoding of the resource content. | | String +| **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/bb3764e3/components/camel-mybatis/src/main/docs/mybatis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mybatis/src/main/docs/mybatis-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-component.adoc index 5c15dda..f19b5be 100644 --- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc @@ -48,15 +48,12 @@ The MyBatis component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| sqlSessionFactory | | SqlSessionFactory | To use the SqlSessionFactory - 4+^s| common -| configurationUri | SqlMapConfig.xml | String | Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath - 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 +| **sqlSessionFactory** (advanced) | To use the SqlSessionFactory | | SqlSessionFactory +| **configurationUri** (common) | Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath | SqlMapConfig.xml | String +| **resolvePropertyPlaceholders** (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,75 +71,46 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| statement | | String | *Required* The statement name in the MyBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. +| Name | Description | Default | Type +| **statement** | *Required* The statement name in the MyBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. | | String |======================================================================= #### Query Parameters (29 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| outputHeader | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time. - 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. - -| inputHeader | | String | User the header value for input parameters instead of the message body. By default inputHeader == null and the input parameters are taken from the message body. If outputHeader is set the value is used and query parameters will be taken from the header instead of the body. - -| maxMessagesPerPoll | 0 | int | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it. - -| onConsume | | String | Statement to run after data has been processed in the route - -| routeEmptyResultSet | false | boolean | Whether allow empty resultset to be routed to the next hop - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| transacted | false | boolean | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager - -| useIterator | true | boolean | Process resultset individually or as a list - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - -| processingStrategy | | MyBatisProcessingStrategy | To use a custom MyBatisProcessingStrategy - 4+^s| producer -| executorType | SIMPLE | ExecutorType | The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates. - -| statementType | | StatementType | Mandatory to specify for the producer to control which kind of operation to invoke. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Description | Default | Type +| **outputHeader** (common) | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time. | | 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 +| **inputHeader** (consumer) | User the header value for input parameters instead of the message body. By default inputHeader == null and the input parameters are taken from the message body. If outputHeader is set the value is used and query parameters will be taken from the header instead of the body. | | String +| **maxMessagesPerPoll** (consumer) | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it. | 0 | int +| **onConsume** (consumer) | Statement to run after data has been processed in the route | | String +| **routeEmptyResultSet** (consumer) | Whether allow empty resultset to be routed to the next hop | false | boolean +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **transacted** (consumer) | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager | false | boolean +| **useIterator** (consumer) | Process resultset individually or as a list | true | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| **processingStrategy** (consumer) | To use a custom MyBatisProcessingStrategy | | MyBatisProcessing Strategy +| **executorType** (producer) | The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates. | SIMPLE | ExecutorType +| **statementType** (producer) | Mandatory to specify for the producer to control which kind of operation to invoke. | | StatementType +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean |======================================================================= // endpoint options: END
