http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-sip/src/main/docs/sip-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sip/src/main/docs/sip-component.adoc b/components/camel-sip/src/main/docs/sip-component.adoc index fe8a889..5c9b62f 100644 --- a/components/camel-sip/src/main/docs/sip-component.adoc +++ b/components/camel-sip/src/main/docs/sip-component.adoc @@ -1,4 +1,4 @@ -## SIP Component +== SIP Component *Available as of Camel version 2.5* @@ -77,68 +77,70 @@ The SIP component has no options. // endpoint options: START The SIP endpoint is configured using URI syntax: - sip:uri +---- +sip:uri +---- 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 -| **uri** | *Required* URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999) | | URI -|======================================================================= +| *uri* | *Required* URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999) | | URI +|=== -#### Query Parameters (44 parameters): +==== Query Parameters (44 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cacheConnections** (common) | Should connections be cached by the SipStack to reduce cost of connection creation. This is useful if the connection is used for long running conversations. | false | boolean -| **contentSubType** (common) | Setting for contentSubType can be set to any valid MimeSubType. | plain | String -| **contentType** (common) | Setting for contentType can be set to any valid MimeType. | text | String -| **eventHeaderName** (common) | Setting for a String based event type. | | String -| **eventId** (common) | Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified | | String -| **fromHost** (common) | Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified | | String -| **fromPort** (common) | Port of the message originator. Mandatory setting unless a registry based FromHeader is specified | | int -| **fromUser** (common) | Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. | | String -| **msgExpiration** (common) | The amount of time a message received at an endpoint is considered valid | 3600 | int -| **receiveTimeoutMillis** (common) | Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack | 10000 | long -| **stackName** (common) | Name of the SIP Stack instance associated with an SIP Endpoint. | NAME_NOT_SET | String -| **toHost** (common) | Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified | | String -| **toPort** (common) | Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified | | int -| **toUser** (common) | Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. | | String -| **transport** (common) | Setting for choice of transport protocol. Valid choices are tcp or udp. | tcp | 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 -| **consumer** (consumer) | This setting is used to determine whether the kind of header (FromHeaderToHeader etc) that needs to be created for this endpoint | false | boolean -| **presenceAgent** (consumer) | This setting is used to distinguish between a Presence Agent & a consumer. This is due to the fact that the SIP Camel component ships with a basic Presence Agent (for testing purposes only). Consumers have to set this flag to true. | 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 -| **addressFactory** (advanced) | To use a custom AddressFactory | | AddressFactory -| **callIdHeader** (advanced) | A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader | | CallIdHeader -| **contactHeader** (advanced) | An optional custom Header object containing verbose contact details (email phone number etc). Must implement the type javax.sip.header.ContactHeader | | ContactHeader -| **contentTypeHeader** (advanced) | A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader | | ContentTypeHeader -| **eventHeader** (advanced) | A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader | | EventHeader -| **expiresHeader** (advanced) | A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader | | ExpiresHeader -| **extensionHeader** (advanced) | A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader | | ExtensionHeader -| **fromHeader** (advanced) | A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader | | FromHeader -| **headerFactory** (advanced) | To use a custom HeaderFactory | | HeaderFactory -| **listeningPoint** (advanced) | To use a custom ListeningPoint implementation | | ListeningPoint -| **maxForwardsHeader** (advanced) | A custom Header object containing details on maximum proxy forwards. This header places a limit on the viaHeaders possible. Must implement the type javax.sip.header.MaxForwardsHeader | | MaxForwardsHeader -| **maxMessageSize** (advanced) | Setting for maximum allowed Message size in bytes. | 1048576 | int -| **messageFactory** (advanced) | To use a custom MessageFactory | | MessageFactory -| **sipFactory** (advanced) | To use a custom SipFactory to create the SipStack to be used | | SipFactory -| **sipStack** (advanced) | To use a custom SipStack | | SipStack -| **sipUri** (advanced) | To use a custom SipURI. If none configured then the SipUri fallback to use the options toUser toHost:toPort | | SipURI -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **toHeader** (advanced) | A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader | | ToHeader -| **viaHeaders** (advanced) | List of custom Header objects of the type javax.sip.header.ViaHeader. Each ViaHeader containing a proxy address for request forwarding. (Note this header is automatically updated by each proxy when the request arrives at its listener) | | List -| **implementationDebugLogFile** (logging) | Name of client debug log file to use for logging | | String -| **implementationServerLogFile** (logging) | Name of server log file to use for logging | | String -| **implementationTraceLevel** (logging) | Logging level for tracing | 0 | String -| **maxForwards** (proxy) | Number of maximum proxy forwards | | int -| **useRouterForAllUris** (proxy) | This setting is used when requests are sent to the Presence Agent via a proxy. | false | boolean -|======================================================================= +| *cacheConnections* (common) | Should connections be cached by the SipStack to reduce cost of connection creation. This is useful if the connection is used for long running conversations. | false | boolean +| *contentSubType* (common) | Setting for contentSubType can be set to any valid MimeSubType. | plain | String +| *contentType* (common) | Setting for contentType can be set to any valid MimeType. | text | String +| *eventHeaderName* (common) | Setting for a String based event type. | | String +| *eventId* (common) | Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified | | String +| *fromHost* (common) | Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified | | String +| *fromPort* (common) | Port of the message originator. Mandatory setting unless a registry based FromHeader is specified | | int +| *fromUser* (common) | Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. | | String +| *msgExpiration* (common) | The amount of time a message received at an endpoint is considered valid | 3600 | int +| *receiveTimeoutMillis* (common) | Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack | 10000 | long +| *stackName* (common) | Name of the SIP Stack instance associated with an SIP Endpoint. | NAME_NOT_SET | String +| *toHost* (common) | Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified | | String +| *toPort* (common) | Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified | | int +| *toUser* (common) | Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. | | String +| *transport* (common) | Setting for choice of transport protocol. Valid choices are tcp or udp. | tcp | 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 +| *consumer* (consumer) | This setting is used to determine whether the kind of header (FromHeaderToHeader etc) that needs to be created for this endpoint | false | boolean +| *presenceAgent* (consumer) | This setting is used to distinguish between a Presence Agent & a consumer. This is due to the fact that the SIP Camel component ships with a basic Presence Agent (for testing purposes only). Consumers have to set this flag to true. | 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 +| *addressFactory* (advanced) | To use a custom AddressFactory | | AddressFactory +| *callIdHeader* (advanced) | A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader | | CallIdHeader +| *contactHeader* (advanced) | An optional custom Header object containing verbose contact details (email phone number etc). Must implement the type javax.sip.header.ContactHeader | | ContactHeader +| *contentTypeHeader* (advanced) | A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader | | ContentTypeHeader +| *eventHeader* (advanced) | A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader | | EventHeader +| *expiresHeader* (advanced) | A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader | | ExpiresHeader +| *extensionHeader* (advanced) | A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader | | ExtensionHeader +| *fromHeader* (advanced) | A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader | | FromHeader +| *headerFactory* (advanced) | To use a custom HeaderFactory | | HeaderFactory +| *listeningPoint* (advanced) | To use a custom ListeningPoint implementation | | ListeningPoint +| *maxForwardsHeader* (advanced) | A custom Header object containing details on maximum proxy forwards. This header places a limit on the viaHeaders possible. Must implement the type javax.sip.header.MaxForwardsHeader | | MaxForwardsHeader +| *maxMessageSize* (advanced) | Setting for maximum allowed Message size in bytes. | 1048576 | int +| *messageFactory* (advanced) | To use a custom MessageFactory | | MessageFactory +| *sipFactory* (advanced) | To use a custom SipFactory to create the SipStack to be used | | SipFactory +| *sipStack* (advanced) | To use a custom SipStack | | SipStack +| *sipUri* (advanced) | To use a custom SipURI. If none configured then the SipUri fallback to use the options toUser toHost:toPort | | SipURI +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *toHeader* (advanced) | A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader | | ToHeader +| *viaHeaders* (advanced) | List of custom Header objects of the type javax.sip.header.ViaHeader. Each ViaHeader containing a proxy address for request forwarding. (Note this header is automatically updated by each proxy when the request arrives at its listener) | | List +| *implementationDebugLogFile* (logging) | Name of client debug log file to use for logging | | String +| *implementationServerLogFile* (logging) | Name of server log file to use for logging | | String +| *implementationTraceLevel* (logging) | Logging level for tracing | 0 | String +| *maxForwards* (proxy) | Number of maximum proxy forwards | | int +| *useRouterForAllUris* (proxy) | This setting is used when requests are sent to the Presence Agent via a proxy. | false | boolean +|=== // endpoint options: END ### Sending Messages to/from a SIP endpoint
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-sjms/src/main/docs/sjms-batch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc index 3ed1d86..21e8a9c 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc @@ -1,4 +1,4 @@ -## Simple JMS Batch Component +== Simple JMS Batch Component *Available as of Camel version 2.16* @@ -115,14 +115,14 @@ The Simple JMS Batch component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsBatchComponent. | | ConnectionFactory -| **asyncStartListener** (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean -| **recoveryInterval** (advanced) | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. | 5000 | int -| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **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 -|======================================================================= +| *connectionFactory* (advanced) | A ConnectionFactory is required to enable the SjmsBatchComponent. | | ConnectionFactory +| *asyncStartListener* (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean +| *recoveryInterval* (advanced) | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. | 5000 | int +| *headerFilterStrategy* (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *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 @@ -136,47 +136,49 @@ The Simple JMS Batch component supports 5 options which are listed below. // endpoint options: START The Simple JMS Batch endpoint is configured using URI syntax: - sjms-batch:destinationName +---- +sjms-batch:destinationName +---- 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 -| **destinationName** | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. | | String -|======================================================================= +| *destinationName* | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. | | String +|=== -#### Query Parameters (23 parameters): +==== Query Parameters (23 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **aggregationStrategy** (consumer) | *Required* The aggregation strategy to use which merges all the batched messages into a single message | | AggregationStrategy -| **allowNullBody** (consumer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | 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 -| **completionInterval** (consumer) | The completion interval in millis which causes batches to be completed in a scheduled fixed rate every interval. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured. | 1000 | int -| **completionPredicate** (consumer) | The completion predicate which causes batches to be completed when the predicate evaluates as true. The predicate can also be configured using the simple language using the string syntax. You may want to set the option eagerCheckCompletion to true to let the predicate match the incoming message as otherwise it matches the aggregated message. | | String -| **completionSize** (consumer) | The number of messages consumed at which the batch will be completed | 200 | int -| **completionTimeout** (consumer) | The timeout in millis from receipt of the first first message when the batch will be completed. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured. | 500 | int -| **consumerCount** (consumer) | The number of JMS sessions to consume from | 1 | int -| **eagerCheckCompletion** (consumer) | Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange. | false | boolean -| **includeAllJMSXProperties** (consumer) | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. | false | boolean -| **mapJmsMessage** (consumer) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean -| **pollDuration** (consumer) | The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started. | 1000 | int -| **sendEmptyMessageWhenIdle** (consumer) | If using completion timeout or interval then the batch may be empty if the timeout triggered and there was no messages in the batch. If this option is true and the batch is empty then an empty message is added to the batch so an empty message is routed. | 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 -| **asyncStartListener** (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean -| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **jmsKeyFormatStrategy** (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy -| **keepAliveDelay** (advanced) | The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an IllegalStateException during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value (default is -1) then the SjmsBatchConsumer will behave as it always has before - that is it will bail out and the route will shut down if it sees an IllegalStateException. | -1 | int -| **messageCreatedStrategy** (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy -| **recoveryInterval** (advanced) | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. | 5000 | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **timeoutCheckerExecutor Service** (advanced) | If using the completionInterval option a background thread is created to trigger the completion interval. Set this option to provide a custom thread pool to be used rather than creating a new thread for every consumer. | | ScheduledExecutor Service -|======================================================================= +| *aggregationStrategy* (consumer) | *Required* The aggregation strategy to use which merges all the batched messages into a single message | | AggregationStrategy +| *allowNullBody* (consumer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | 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 +| *completionInterval* (consumer) | The completion interval in millis which causes batches to be completed in a scheduled fixed rate every interval. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured. | 1000 | int +| *completionPredicate* (consumer) | The completion predicate which causes batches to be completed when the predicate evaluates as true. The predicate can also be configured using the simple language using the string syntax. You may want to set the option eagerCheckCompletion to true to let the predicate match the incoming message as otherwise it matches the aggregated message. | | String +| *completionSize* (consumer) | The number of messages consumed at which the batch will be completed | 200 | int +| *completionTimeout* (consumer) | The timeout in millis from receipt of the first first message when the batch will be completed. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured. | 500 | int +| *consumerCount* (consumer) | The number of JMS sessions to consume from | 1 | int +| *eagerCheckCompletion* (consumer) | Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange. | false | boolean +| *includeAllJMSXProperties* (consumer) | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. | false | boolean +| *mapJmsMessage* (consumer) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean +| *pollDuration* (consumer) | The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started. | 1000 | int +| *sendEmptyMessageWhenIdle* (consumer) | If using completion timeout or interval then the batch may be empty if the timeout triggered and there was no messages in the batch. If this option is true and the batch is empty then an empty message is added to the batch so an empty message is routed. | 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 +| *asyncStartListener* (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean +| *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *jmsKeyFormatStrategy* (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy +| *keepAliveDelay* (advanced) | The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an IllegalStateException during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value (default is -1) then the SjmsBatchConsumer will behave as it always has before - that is it will bail out and the route will shut down if it sees an IllegalStateException. | -1 | int +| *messageCreatedStrategy* (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy +| *recoveryInterval* (advanced) | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. | 5000 | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *timeoutCheckerExecutor Service* (advanced) | If using the completionInterval option a background thread is created to trigger the completion interval. Set this option to provide a custom thread pool to be used rather than creating a new thread for every consumer. | | ScheduledExecutor Service +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-sjms/src/main/docs/sjms-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc index 2c5ad51..34c1914 100644 --- a/components/camel-sjms/src/main/docs/sjms-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-component.adoc @@ -1,4 +1,4 @@ -## Simple JMS Component +== Simple JMS Component *Available as of Camel version 2.11* @@ -88,24 +88,24 @@ The Simple JMS component supports 15 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. | | ConnectionFactory -| **connectionResource** (advanced) | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. | | ConnectionResource -| **connectionCount** (common) | The maximum number of connections available to endpoints started under this component | 1 | Integer -| **jmsKeyFormatStrategy** (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy -| **transactionCommit Strategy** (transaction) | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. | | TransactionCommit Strategy -| **destinationCreation Strategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy -| **timedTaskManager** (advanced) | To use a custom TimedTaskManager | | TimedTaskManager -| **messageCreatedStrategy** (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy -| **connectionTestOnBorrow** (advanced) | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. | true | boolean -| **connectionUsername** (security) | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String -| **connectionPassword** (security) | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String -| **connectionClientId** (advanced) | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String -| **connectionMaxWait** (advanced) | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | 5000 | long -| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **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 -|======================================================================= +| *connectionFactory* (advanced) | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. | | ConnectionFactory +| *connectionResource* (advanced) | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. | | ConnectionResource +| *connectionCount* (common) | The maximum number of connections available to endpoints started under this component | 1 | Integer +| *jmsKeyFormatStrategy* (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy +| *transactionCommit Strategy* (transaction) | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. | | TransactionCommit Strategy +| *destinationCreation Strategy* (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy +| *timedTaskManager* (advanced) | To use a custom TimedTaskManager | | TimedTaskManager +| *messageCreatedStrategy* (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy +| *connectionTestOnBorrow* (advanced) | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. | true | boolean +| *connectionUsername* (security) | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String +| *connectionPassword* (security) | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String +| *connectionClientId* (advanced) | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String +| *connectionMaxWait* (advanced) | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | 5000 | long +| *headerFilterStrategy* (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *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 @@ -118,59 +118,61 @@ The Simple JMS component supports 15 options which are listed below. // endpoint options: START The Simple JMS endpoint is configured using URI syntax: - sjms:destinationType:destinationName +---- +sjms:destinationType:destinationName +---- 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 -| **destinationType** | The kind of destination to use | queue | String -| **destinationName** | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. | | String -|======================================================================= +| *destinationType* | The kind of destination to use | queue | String +| *destinationName* | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. | | String +|=== -#### Query Parameters (34 parameters): +==== Query Parameters (34 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **acknowledgementMode** (common) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | SessionAcknowledgement 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 -| **consumerCount** (consumer) | Sets the number of consumer listeners used for this endpoint. | 1 | int -| **durableSubscriptionId** (consumer) | Sets the durable subscription Id required for durable topics. | | String -| **synchronous** (consumer) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | 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 -| **messageSelector** (consumer) | Sets the JMS Message selector syntax. | | String -| **namedReplyTo** (producer) | Sets the reply to destination name used for InOut producer endpoints. | | String -| **persistent** (producer) | Flag used to enable/disable message persistence. | true | boolean -| **producerCount** (producer) | Sets the number of producers used for this endpoint. | 1 | int -| **ttl** (producer) | Flag used to adjust the Time To Live value of produced messages. | -1 | long -| **allowNullBody** (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean -| **prefillPool** (producer) | Whether to prefill the producer connection pool on startup or create connections lazy when needed. | true | boolean -| **responseTimeOut** (producer) | Sets the amount of time we should wait before timing out a InOut response. | 5000 | long -| **asyncStartListener** (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean -| **asyncStopListener** (advanced) | Whether to stop the consumer message listener asynchronously when stopping a route. | false | boolean -| **connectionCount** (advanced) | The maximum number of connections available to this endpoint | | Integer -| **connectionFactory** (advanced) | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any | | ConnectionFactory -| **connectionResource** (advanced) | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any | | ConnectionResource -| **destinationCreationStrategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy -| **exceptionListener** (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener -| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **includeAllJMSXProperties** (advanced) | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. | false | boolean -| **jmsKeyFormatStrategy** (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy -| **mapJmsMessage** (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean -| **messageCreatedStrategy** (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy -| **errorHandlerLoggingLevel** (logging) | Allows to configure the default errorHandler logging level for logging uncaught exceptions. | WARN | LoggingLevel -| **errorHandlerLogStackTrace** (logging) | Allows to control whether stacktraces should be logged or not by the default errorHandler. | true | boolean -| **transacted** (transaction) | Specifies whether to use transacted mode | false | boolean -| **transactionBatchCount** (transaction) | If transacted sets the number of messages to process before committing a transaction. | -1 | int -| **transactionBatchTimeout** (transaction) | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. | 5000 | long -| **transactionCommitStrategy** (transaction) | Sets the commit strategy. | | TransactionCommit Strategy -| **sharedJMSSession** (transaction) | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction. | true | boolean -|======================================================================= +| *acknowledgementMode* (common) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | SessionAcknowledgement 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 +| *consumerCount* (consumer) | Sets the number of consumer listeners used for this endpoint. | 1 | int +| *durableSubscriptionId* (consumer) | Sets the durable subscription Id required for durable topics. | | String +| *synchronous* (consumer) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | 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 +| *messageSelector* (consumer) | Sets the JMS Message selector syntax. | | String +| *namedReplyTo* (producer) | Sets the reply to destination name used for InOut producer endpoints. | | String +| *persistent* (producer) | Flag used to enable/disable message persistence. | true | boolean +| *producerCount* (producer) | Sets the number of producers used for this endpoint. | 1 | int +| *ttl* (producer) | Flag used to adjust the Time To Live value of produced messages. | -1 | long +| *allowNullBody* (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean +| *prefillPool* (producer) | Whether to prefill the producer connection pool on startup or create connections lazy when needed. | true | boolean +| *responseTimeOut* (producer) | Sets the amount of time we should wait before timing out a InOut response. | 5000 | long +| *asyncStartListener* (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean +| *asyncStopListener* (advanced) | Whether to stop the consumer message listener asynchronously when stopping a route. | false | boolean +| *connectionCount* (advanced) | The maximum number of connections available to this endpoint | | Integer +| *connectionFactory* (advanced) | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any | | ConnectionFactory +| *connectionResource* (advanced) | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any | | ConnectionResource +| *destinationCreationStrategy* (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy +| *exceptionListener* (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener +| *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *includeAllJMSXProperties* (advanced) | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. | false | boolean +| *jmsKeyFormatStrategy* (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy +| *mapJmsMessage* (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean +| *messageCreatedStrategy* (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy +| *errorHandlerLoggingLevel* (logging) | Allows to configure the default errorHandler logging level for logging uncaught exceptions. | WARN | LoggingLevel +| *errorHandlerLogStackTrace* (logging) | Allows to control whether stacktraces should be logged or not by the default errorHandler. | true | boolean +| *transacted* (transaction) | Specifies whether to use transacted mode | false | boolean +| *transactionBatchCount* (transaction) | If transacted sets the number of messages to process before committing a transaction. | -1 | int +| *transactionBatchTimeout* (transaction) | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. | 5000 | long +| *transactionCommitStrategy* (transaction) | Sets the commit strategy. | | TransactionCommit Strategy +| *sharedJMSSession* (transaction) | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction. | true | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-sjms2/src/main/docs/sjms2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms2/src/main/docs/sjms2-component.adoc b/components/camel-sjms2/src/main/docs/sjms2-component.adoc index f3c5e75..f4cb70b 100644 --- a/components/camel-sjms2/src/main/docs/sjms2-component.adoc +++ b/components/camel-sjms2/src/main/docs/sjms2-component.adoc @@ -1,4 +1,4 @@ -## Simple JMS2 Component +== Simple JMS2 Component *Available as of Camel version 2.19* @@ -88,24 +88,24 @@ The Simple JMS2 component supports 15 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. | | ConnectionFactory -| **connectionResource** (advanced) | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. | | ConnectionResource -| **connectionCount** (common) | The maximum number of connections available to endpoints started under this component | 1 | Integer -| **jmsKeyFormatStrategy** (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy -| **transactionCommit Strategy** (transaction) | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. | | TransactionCommit Strategy -| **destinationCreation Strategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy -| **timedTaskManager** (advanced) | To use a custom TimedTaskManager | | TimedTaskManager -| **messageCreatedStrategy** (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy -| **connectionTestOnBorrow** (advanced) | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. | true | boolean -| **connectionUsername** (security) | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String -| **connectionPassword** (security) | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String -| **connectionClientId** (advanced) | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String -| **connectionMaxWait** (advanced) | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | 5000 | long -| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **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 -|======================================================================= +| *connectionFactory* (advanced) | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. | | ConnectionFactory +| *connectionResource* (advanced) | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. | | ConnectionResource +| *connectionCount* (common) | The maximum number of connections available to endpoints started under this component | 1 | Integer +| *jmsKeyFormatStrategy* (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy +| *transactionCommit Strategy* (transaction) | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. | | TransactionCommit Strategy +| *destinationCreation Strategy* (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy +| *timedTaskManager* (advanced) | To use a custom TimedTaskManager | | TimedTaskManager +| *messageCreatedStrategy* (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy +| *connectionTestOnBorrow* (advanced) | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. | true | boolean +| *connectionUsername* (security) | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String +| *connectionPassword* (security) | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String +| *connectionClientId* (advanced) | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String +| *connectionMaxWait* (advanced) | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | 5000 | long +| *headerFilterStrategy* (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *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 @@ -118,62 +118,64 @@ The Simple JMS2 component supports 15 options which are listed below. // endpoint options: START The Simple JMS2 endpoint is configured using URI syntax: - sjms2:destinationType:destinationName +---- +sjms2:destinationType:destinationName +---- 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 -| **destinationType** | The kind of destination to use | queue | String -| **destinationName** | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. | | String -|======================================================================= +| *destinationType* | The kind of destination to use | queue | String +| *destinationName* | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. | | String +|=== -#### Query Parameters (37 parameters): +==== Query Parameters (37 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **acknowledgementMode** (common) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | SessionAcknowledgement 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 -| **consumerCount** (consumer) | Sets the number of consumer listeners used for this endpoint. | 1 | int -| **durable** (consumer) | Sets topic consumer to durable. | false | boolean -| **durableSubscriptionId** (consumer) | Sets the durable subscription Id required for durable topics. | | String -| **shared** (consumer) | Sets the consumer to shared. | false | boolean -| **subscriptionId** (consumer) | Sets the subscription Id required for durable or shared topics. | | String -| **synchronous** (consumer) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | 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 -| **messageSelector** (consumer) | Sets the JMS Message selector syntax. | | String -| **namedReplyTo** (producer) | Sets the reply to destination name used for InOut producer endpoints. | | String -| **persistent** (producer) | Flag used to enable/disable message persistence. | true | boolean -| **producerCount** (producer) | Sets the number of producers used for this endpoint. | 1 | int -| **ttl** (producer) | Flag used to adjust the Time To Live value of produced messages. | -1 | long -| **allowNullBody** (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean -| **prefillPool** (producer) | Whether to prefill the producer connection pool on startup or create connections lazy when needed. | true | boolean -| **responseTimeOut** (producer) | Sets the amount of time we should wait before timing out a InOut response. | 5000 | long -| **asyncStartListener** (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean -| **asyncStopListener** (advanced) | Whether to stop the consumer message listener asynchronously when stopping a route. | false | boolean -| **connectionCount** (advanced) | The maximum number of connections available to this endpoint | | Integer -| **connectionFactory** (advanced) | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any | | ConnectionFactory -| **connectionResource** (advanced) | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any | | ConnectionResource -| **destinationCreationStrategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy -| **exceptionListener** (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener -| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **includeAllJMSXProperties** (advanced) | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. | false | boolean -| **jmsKeyFormatStrategy** (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy -| **mapJmsMessage** (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean -| **messageCreatedStrategy** (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy -| **errorHandlerLoggingLevel** (logging) | Allows to configure the default errorHandler logging level for logging uncaught exceptions. | WARN | LoggingLevel -| **errorHandlerLogStackTrace** (logging) | Allows to control whether stacktraces should be logged or not by the default errorHandler. | true | boolean -| **transacted** (transaction) | Specifies whether to use transacted mode | false | boolean -| **transactionBatchCount** (transaction) | If transacted sets the number of messages to process before committing a transaction. | -1 | int -| **transactionBatchTimeout** (transaction) | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. | 5000 | long -| **transactionCommitStrategy** (transaction) | Sets the commit strategy. | | TransactionCommit Strategy -| **sharedJMSSession** (transaction) | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction. | true | boolean -|======================================================================= +| *acknowledgementMode* (common) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | SessionAcknowledgement 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 +| *consumerCount* (consumer) | Sets the number of consumer listeners used for this endpoint. | 1 | int +| *durable* (consumer) | Sets topic consumer to durable. | false | boolean +| *durableSubscriptionId* (consumer) | Sets the durable subscription Id required for durable topics. | | String +| *shared* (consumer) | Sets the consumer to shared. | false | boolean +| *subscriptionId* (consumer) | Sets the subscription Id required for durable or shared topics. | | String +| *synchronous* (consumer) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | 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 +| *messageSelector* (consumer) | Sets the JMS Message selector syntax. | | String +| *namedReplyTo* (producer) | Sets the reply to destination name used for InOut producer endpoints. | | String +| *persistent* (producer) | Flag used to enable/disable message persistence. | true | boolean +| *producerCount* (producer) | Sets the number of producers used for this endpoint. | 1 | int +| *ttl* (producer) | Flag used to adjust the Time To Live value of produced messages. | -1 | long +| *allowNullBody* (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean +| *prefillPool* (producer) | Whether to prefill the producer connection pool on startup or create connections lazy when needed. | true | boolean +| *responseTimeOut* (producer) | Sets the amount of time we should wait before timing out a InOut response. | 5000 | long +| *asyncStartListener* (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean +| *asyncStopListener* (advanced) | Whether to stop the consumer message listener asynchronously when stopping a route. | false | boolean +| *connectionCount* (advanced) | The maximum number of connections available to this endpoint | | Integer +| *connectionFactory* (advanced) | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any | | ConnectionFactory +| *connectionResource* (advanced) | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any | | ConnectionResource +| *destinationCreationStrategy* (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy +| *exceptionListener* (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener +| *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *includeAllJMSXProperties* (advanced) | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. | false | boolean +| *jmsKeyFormatStrategy* (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. | | JmsKeyFormatStrategy +| *mapJmsMessage* (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean +| *messageCreatedStrategy* (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy +| *errorHandlerLoggingLevel* (logging) | Allows to configure the default errorHandler logging level for logging uncaught exceptions. | WARN | LoggingLevel +| *errorHandlerLogStackTrace* (logging) | Allows to control whether stacktraces should be logged or not by the default errorHandler. | true | boolean +| *transacted* (transaction) | Specifies whether to use transacted mode | false | boolean +| *transactionBatchCount* (transaction) | If transacted sets the number of messages to process before committing a transaction. | -1 | int +| *transactionBatchTimeout* (transaction) | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. | 5000 | long +| *transactionCommitStrategy* (transaction) | Sets the commit strategy. | | TransactionCommit Strategy +| *sharedJMSSession* (transaction) | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction. | true | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-slack/src/main/docs/slack-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc index 0302eb5..c51960d 100644 --- a/components/camel-slack/src/main/docs/slack-component.adoc +++ b/components/camel-slack/src/main/docs/slack-component.adoc @@ -1,4 +1,4 @@ -## Slack Component +== Slack Component *Available as of Camel version 2.16* @@ -47,11 +47,11 @@ The Slack component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **webhookUrl** (producer) | The incoming webhook URL | | String -| **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 -|======================================================================= +| *webhookUrl* (producer) | The incoming webhook URL | | String +| *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 @@ -60,29 +60,31 @@ The Slack component supports 2 options which are listed below. // endpoint options: START The Slack endpoint is configured using URI syntax: - slack:channel +---- +slack: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 name (syntax name) or slackuser (syntax userName) to send a message directly to an user. | | String -|======================================================================= +| *channel* | *Required* The channel name (syntax name) or slackuser (syntax userName) to send a message directly to an user. | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **iconEmoji** (producer) | Use a Slack emoji as an avatar | | String -| **iconUrl** (producer) | The avatar that the component will use when sending message to a channel or user. | | String -| **username** (producer) | This is the username that the bot will have when sending messages to a channel or user. | | String -| **webhookUrl** (producer) | The incoming webhook URL | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *iconEmoji* (producer) | Use a Slack emoji as an avatar | | String +| *iconUrl* (producer) | The avatar that the component will use when sending message to a channel or user. | | String +| *username* (producer) | This is the username that the bot will have when sending messages to a channel or user. | | String +| *webhookUrl* (producer) | The incoming webhook URL | | 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
