http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-servicenow/src/main/docs/servicenow-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-servicenow/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/src/main/docs/servicenow-component.adoc index 81d915d..0d1594b 100644 --- a/components/camel-servicenow/src/main/docs/servicenow-component.adoc +++ b/components/camel-servicenow/src/main/docs/servicenow-component.adoc @@ -34,17 +34,25 @@ The ServiceNow component supports 8 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | ServiceNowConfiguration | The ServiceNow default configuration -| apiUrl | producer | | String | The ServiceNow REST API url -| userName | security | | String | ServiceNow user account name -| password | security | | String | ServiceNow account password -| oauthClientId | security | | String | OAuth2 ClientID -| oauthClientSecret | security | | String | OAuth2 ClientSecret -| oauthTokenUrl | security | | String | OAuth token Url -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| configuration | | ServiceNowConfiguration | The ServiceNow default configuration + 4+^s| producer +| apiUrl | | String | The ServiceNow REST API url + 4+^s| security +| userName | | String | ServiceNow user account name + +| password | | String | ServiceNow account password + +| oauthClientId | | String | OAuth2 ClientID + +| oauthClientSecret | | String | OAuth2 ClientSecret + +| oauthTokenUrl | | String | OAuth token Url + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -66,49 +74,89 @@ with the following path and query parameters: #### Query Parameters (40 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| display | producer | true | String | Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default. -| displayValue | producer | false | String | Return the display value (true) actual value (false) or both (all) for reference fields (default: false) -| excludeReferenceLink | producer | | Boolean | True to exclude Table API links for reference fields (default: false) -| favorites | producer | | Boolean | Set this parameter to true to return only scorecards that are favorites of the querying user. -| includeAggregates | producer | | Boolean | Set this parameter to true to always return all available aggregates for an indicator including when an aggregate has already been applied. If a value is not specified this parameter defaults to false and returns no aggregates. -| includeAvailableAggregates | producer | | Boolean | Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified this parameter defaults to false and returns no aggregates. -| includeAvailableBreakdowns | producer | | Boolean | Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified this parameter defaults to false and returns no breakdowns. -| includeScoreNotes | producer | | Boolean | Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added. -| includeScores | producer | | Boolean | Set this parameter to true to return all scores for a scorecard. If a value is not specified this parameter defaults to false and returns only the most recent score value. -| inputDisplayValue | producer | | Boolean | True to set raw value of input fields (default: false) -| key | producer | | Boolean | Set this parameter to true to return only scorecards for key indicators. -| models | producer | | String | Defines both request and response models -| perPage | producer | 10 | Integer | Enter the maximum number of scorecards each query can return. By default this value is 10 and the maximum is 100. -| release | producer | HELSINKI | ServiceNowRelease | The ServiceNow release to target default to Helsinki See https://docs.servicenow.com -| requestModels | producer | | String | Defines the request model -| resource | producer | | String | The default resource can be overridden by header CamelServiceNowResource -| responseModels | producer | | String | Defines the response model -| sortBy | producer | | String | Specify the value to use when sorting results. By default queries sort records by value. -| sortDir | producer | | String | Specify the sort direction ascending or descending. By default queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. -| suppressAutoSysField | producer | | Boolean | True to suppress auto generation of system fields (default: false) -| suppressPaginationHeader | producer | | Boolean | Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit -| table | producer | | String | The default table can be overridden by header CamelServiceNowTable -| target | producer | | Boolean | Set this parameter to true to return only scorecards that have a target. -| topLevelOnly | producer | | Boolean | Gets only those categories whose parent is a catalog. -| apiVersion | advanced | | String | The ServiceNow REST API version default latest -| httpClientPolicy | advanced | | HTTPClientPolicy | To configure http-client -| mapper | advanced | | ObjectMapper | Sets Jackson's ObjectMapper to use for request/reply -| proxyAuthorizationPolicy | advanced | | ProxyAuthorizationPolicy | To configure proxy authentication -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| proxyHost | proxy | | String | The proxy host name -| proxyPort | proxy | | Integer | The proxy port number -| apiUrl | security | | String | The ServiceNow REST API url -| oauthClientId | security | | String | OAuth2 ClientID -| oauthClientSecret | security | | String | OAuth2 ClientSecret -| oauthTokenUrl | security | | String | OAuth token Url -| password | security | | String | *Required* ServiceNow account password MUST be provided -| proxyPassword | security | | String | Password for proxy authentication -| proxyUserName | security | | String | Username for proxy authentication -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html -| userName | security | | String | *Required* ServiceNow user account name MUST be provided +| Name | Default | Java Type | Description + +| display | true | String | Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default. + +| displayValue | false | String | Return the display value (true) actual value (false) or both (all) for reference fields (default: false) + +| excludeReferenceLink | | Boolean | True to exclude Table API links for reference fields (default: false) + +| favorites | | Boolean | Set this parameter to true to return only scorecards that are favorites of the querying user. + +| includeAggregates | | Boolean | Set this parameter to true to always return all available aggregates for an indicator including when an aggregate has already been applied. If a value is not specified this parameter defaults to false and returns no aggregates. + +| includeAvailableAggregates | | Boolean | Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified this parameter defaults to false and returns no aggregates. + +| includeAvailableBreakdowns | | Boolean | Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified this parameter defaults to false and returns no breakdowns. + +| includeScoreNotes | | Boolean | Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added. + +| includeScores | | Boolean | Set this parameter to true to return all scores for a scorecard. If a value is not specified this parameter defaults to false and returns only the most recent score value. + +| inputDisplayValue | | Boolean | True to set raw value of input fields (default: false) + +| key | | Boolean | Set this parameter to true to return only scorecards for key indicators. + +| models | | String | Defines both request and response models + +| perPage | 10 | Integer | Enter the maximum number of scorecards each query can return. By default this value is 10 and the maximum is 100. + +| release | HELSINKI | ServiceNowRelease | The ServiceNow release to target default to Helsinki See https://docs.servicenow.com + +| requestModels | | String | Defines the request model + +| resource | | String | The default resource can be overridden by header CamelServiceNowResource + +| responseModels | | String | Defines the response model + +| sortBy | | String | Specify the value to use when sorting results. By default queries sort records by value. + +| sortDir | | String | Specify the sort direction ascending or descending. By default queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. + +| suppressAutoSysField | | Boolean | True to suppress auto generation of system fields (default: false) + +| suppressPaginationHeader | | Boolean | Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit + +| table | | String | The default table can be overridden by header CamelServiceNowTable + +| target | | Boolean | Set this parameter to true to return only scorecards that have a target. + +| topLevelOnly | | Boolean | Gets only those categories whose parent is a catalog. + 4+^s| advanced +| apiVersion | | String | The ServiceNow REST API version default latest + +| httpClientPolicy | | HTTPClientPolicy | To configure http-client + +| mapper | | ObjectMapper | Sets Jackson's ObjectMapper to use for request/reply + +| proxyAuthorizationPolicy | | ProxyAuthorizationPolicy | To configure proxy authentication + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| proxy +| proxyHost | | String | The proxy host name + +| proxyPort | | Integer | The proxy port number + 4+^s| security +| apiUrl | | String | The ServiceNow REST API url + +| oauthClientId | | String | OAuth2 ClientID + +| oauthClientSecret | | String | OAuth2 ClientSecret + +| oauthTokenUrl | | String | OAuth token Url + +| password | | String | *Required* ServiceNow account password MUST be provided + +| proxyPassword | | String | Password for proxy authentication + +| proxyUserName | | String | Username for proxy authentication + +| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html + +| userName | | String | *Required* ServiceNow user account name MUST be provided |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-servlet/src/main/docs/servlet-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc index 7e9468a..5cabc39 100644 --- a/components/camel-servlet/src/main/docs/servlet-component.adoc +++ b/components/camel-servlet/src/main/docs/servlet-component.adoc @@ -46,17 +46,25 @@ The Servlet component supports 8 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| servletName | consumer | | String | Default name of servlet to use. The default name is CamelServlet. -| httpRegistry | consumer | | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry. -| attachmentMultipartBinding | consumer | false | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. -| httpBinding | advanced | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. -| httpConfiguration | advanced | | HttpConfiguration | To use the shared HttpConfiguration as base configuration. -| allowJavaSerializedObject | advanced | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| consumer +| servletName | | String | Default name of servlet to use. The default name is CamelServlet. + +| httpRegistry | | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry. + +| attachmentMultipartBinding | false | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. + 4+^s| advanced +| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. + +| httpConfiguration | | HttpConfiguration | To use the shared HttpConfiguration as base configuration. + +| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. + 4+^s| filter +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -77,30 +85,51 @@ with the following path and query parameters: #### Query Parameters (21 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca che the response body stream but use the response stream as-is as the message body. -| headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. -| httpBinding | common (advanced) | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. -| async | consumer | false | boolean | Configure the consumer to work in async mode -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| chunked | consumer | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response -| httpMethodRestrict | consumer | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. -| matchOnUriPrefix | consumer | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. -| responseBufferSize | consumer | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse. -| servletName | consumer | CamelServlet | String | Name of the servlet to use -| transferException | consumer | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. -| attachmentMultipartBinding | consumer (advanced) | false | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. -| eagerCheckContentAvailable | consumer (advanced) | false | boolean | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| optionsEnabled | consumer (advanced) | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. -| traceEnabled | consumer (advanced) | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. -| mapHttpMessageBody | advanced | true | boolean | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. -| mapHttpMessageFormUrlEncodedBody | advanced | true | boolean | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. -| mapHttpMessageHeaders | advanced | true | boolean | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + 4+^s| common +| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not cache the r esponse body stream but use the response stream as-is as the message body. + +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| common (advanced) +| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. + 4+^s| consumer +| async | false | boolean | Configure the consumer to work in async mode + +| 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. + +| chunked | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response + +| httpMethodRestrict | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. + +| matchOnUriPrefix | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. + +| responseBufferSize | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse. + +| servletName | CamelServlet | String | Name of the servlet to use + +| transferException | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. + 4+^s| consumer (advanced) +| attachmentMultipartBinding | false | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. + +| eagerCheckContentAvailable | false | boolean | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. + +| 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. + +| optionsEnabled | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. + +| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. + 4+^s| advanced +| mapHttpMessageBody | true | boolean | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. + +| mapHttpMessageFormUrlEncodedBody | true | boolean | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. + +| mapHttpMessageHeaders | true | boolean | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-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 d1daa25..d2e5726 100644 --- a/components/camel-sip/src/main/docs/sip-component.adoc +++ b/components/camel-sip/src/main/docs/sip-component.adoc @@ -91,53 +91,97 @@ with the following path and query parameters: #### Query Parameters (44 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| cacheConnections | common | false | boolean | 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. -| contentSubType | common | plain | String | Setting for contentSubType can be set to any valid MimeSubType. -| contentType | common | text | String | Setting for contentType can be set to any valid MimeType. -| eventHeaderName | common | | String | Setting for a String based event type. -| eventId | common | | String | Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified -| fromHost | common | | String | Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified -| fromPort | common | | int | Port of the message originator. Mandatory setting unless a registry based FromHeader is specified -| fromUser | common | | String | Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. -| msgExpiration | common | 3600 | int | The amount of time a message received at an endpoint is considered valid -| receiveTimeoutMillis | common | 10000 | long | Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack -| stackName | common | NAME_NOT_SET | String | Name of the SIP Stack instance associated with an SIP Endpoint. -| toHost | common | | String | Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified -| toPort | common | | int | Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified -| toUser | common | | String | Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. -| transport | common | tcp | String | Setting for choice of transport protocol. Valid choices are tcp or udp. -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| consumer | consumer | false | boolean | This setting is used to determine whether the kind of header (FromHeaderToHeader etc) that needs to be created for this endpoint -| presenceAgent | consumer | false | boolean | 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. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| addressFactory | advanced | | AddressFactory | To use a custom AddressFactory -| callIdHeader | advanced | | CallIdHeader | A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader -| contactHeader | advanced | | ContactHeader | An optional custom Header object containing verbose contact details (email phone number etc). Must implement the type javax.sip.header.ContactHeader -| contentTypeHeader | advanced | | ContentTypeHeader | A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader -| eventHeader | advanced | | EventHeader | A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader -| expiresHeader | advanced | | ExpiresHeader | A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader -| extensionHeader | advanced | | ExtensionHeader | A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader -| fromHeader | advanced | | FromHeader | A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader -| headerFactory | advanced | | HeaderFactory | To use a custom HeaderFactory -| listeningPoint | advanced | | ListeningPoint | To use a custom ListeningPoint implementation -| maxForwardsHeader | advanced | | MaxForwardsHeader | 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 -| maxMessageSize | advanced | 1048576 | int | Setting for maximum allowed Message size in bytes. -| messageFactory | advanced | | MessageFactory | To use a custom MessageFactory -| sipFactory | advanced | | SipFactory | To use a custom SipFactory to create the SipStack to be used -| sipStack | advanced | | SipStack | To use a custom SipStack -| sipUri | advanced | | SipURI | To use a custom SipURI. If none configured then the SipUri fallback to use the options toUser toHost:toPort -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| toHeader | advanced | | ToHeader | A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader -| viaHeaders | advanced | | List | 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) -| implementationDebugLogFile | logging | | String | Name of client debug log file to use for logging -| implementationServerLogFile | logging | | String | Name of server log file to use for logging -| implementationTraceLevel | logging | 0 | String | Logging level for tracing -| maxForwards | proxy | | int | Number of maximum proxy forwards -| useRouterForAllUris | proxy | false | boolean | This setting is used when requests are sent to the Presence Agent via a proxy. +| Name | Default | Java Type | Description + +| cacheConnections | false | boolean | 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. + +| contentSubType | plain | String | Setting for contentSubType can be set to any valid MimeSubType. + +| contentType | text | String | Setting for contentType can be set to any valid MimeType. + +| eventHeaderName | | String | Setting for a String based event type. + +| eventId | | String | Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified + +| fromHost | | String | Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified + +| fromPort | | int | Port of the message originator. Mandatory setting unless a registry based FromHeader is specified + +| fromUser | | String | Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. + +| msgExpiration | 3600 | int | The amount of time a message received at an endpoint is considered valid + +| receiveTimeoutMillis | 10000 | long | Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack + +| stackName | NAME_NOT_SET | String | Name of the SIP Stack instance associated with an SIP Endpoint. + +| toHost | | String | Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified + +| toPort | | int | Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified + +| toUser | | String | Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. + +| transport | tcp | String | Setting for choice of transport protocol. Valid choices are tcp or udp. + 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. + +| consumer | false | boolean | This setting is used to determine whether the kind of header (FromHeaderToHeader etc) that needs to be created for this endpoint + +| presenceAgent | false | boolean | 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. + 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 +| addressFactory | | AddressFactory | To use a custom AddressFactory + +| callIdHeader | | CallIdHeader | A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader + +| contactHeader | | ContactHeader | An optional custom Header object containing verbose contact details (email phone number etc). Must implement the type javax.sip.header.ContactHeader + +| contentTypeHeader | | ContentTypeHeader | A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader + +| eventHeader | | EventHeader | A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader + +| expiresHeader | | ExpiresHeader | A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader + +| extensionHeader | | ExtensionHeader | A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader + +| fromHeader | | FromHeader | A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader + +| headerFactory | | HeaderFactory | To use a custom HeaderFactory + +| listeningPoint | | ListeningPoint | To use a custom ListeningPoint implementation + +| maxForwardsHeader | | MaxForwardsHeader | 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 + +| maxMessageSize | 1048576 | int | Setting for maximum allowed Message size in bytes. + +| messageFactory | | MessageFactory | To use a custom MessageFactory + +| sipFactory | | SipFactory | To use a custom SipFactory to create the SipStack to be used + +| sipStack | | SipStack | To use a custom SipStack + +| sipUri | | SipURI | To use a custom SipURI. If none configured then the SipUri fallback to use the options toUser toHost:toPort + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + +| toHeader | | ToHeader | A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader + +| viaHeaders | | List | 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) + 4+^s| logging +| implementationDebugLogFile | | String | Name of client debug log file to use for logging + +| implementationServerLogFile | | String | Name of server log file to use for logging + +| implementationTraceLevel | 0 | String | Logging level for tracing + 4+^s| proxy +| maxForwards | | int | Number of maximum proxy forwards + +| useRouterForAllUris | false | boolean | This setting is used when requests are sent to the Presence Agent via a proxy. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 3ee1066..2a2cf47 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc @@ -114,14 +114,19 @@ The Simple JMS Batch component supports 5 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| connectionFactory | advanced | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent. -| asyncStartListener | advanced | false | boolean | 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. -| recoveryInterval | advanced | 5000 | int | 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. -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent. + +| asyncStartListener | false | boolean | 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. + +| recoveryInterval | 5000 | int | 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. + 4+^s| filter +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -150,31 +155,53 @@ with the following path and query parameters: #### Query Parameters (22 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| aggregationStrategy | consumer | | AggregationStrategy | *Required* The aggregation strategy to use which merges all the batched messages into a single message -| allowNullBody | consumer | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| completionInterval | consumer | 1000 | int | 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. -| completionPredicate | consumer | | String | 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. -| completionSize | consumer | 200 | int | The number of messages consumed at which the batch will be completed -| completionTimeout | consumer | 500 | int | 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. -| consumerCount | consumer | 1 | int | The number of JMS sessions to consume from -| eagerCheckCompletion | consumer | false | boolean | 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. -| includeAllJMSXProperties | consumer | false | boolean | 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. -| mapJmsMessage | consumer | true | boolean | 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. -| pollDuration | consumer | 1000 | int | The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started. -| sendEmptyMessageWhenIdle | consumer | false | boolean | 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. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| asyncStartListener | advanced | false | boolean | 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. -| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. -| jmsKeyFormatStrategy | advanced | | JmsKeyFormatStrategy | 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. -| messageCreatedStrategy | advanced | | MessageCreatedStrategy | 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. -| recoveryInterval | advanced | 5000 | int | 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. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| timeoutCheckerExecutorService | advanced | | ScheduledExecutorService | 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. +| Name | Default | Java Type | Description + +| aggregationStrategy | | AggregationStrategy | *Required* The aggregation strategy to use which merges all the batched messages into a single message + +| allowNullBody | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. + +| 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. + +| completionInterval | 1000 | int | 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. + +| completionPredicate | | String | 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. + +| completionSize | 200 | int | The number of messages consumed at which the batch will be completed + +| completionTimeout | 500 | int | 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. + +| consumerCount | 1 | int | The number of JMS sessions to consume from + +| eagerCheckCompletion | false | boolean | 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. + +| includeAllJMSXProperties | false | boolean | 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. + +| mapJmsMessage | true | boolean | 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. + +| pollDuration | 1000 | int | The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started. + +| sendEmptyMessageWhenIdle | false | boolean | 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. + 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 +| asyncStartListener | false | boolean | 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. + +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. + +| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | 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. + +| messageCreatedStrategy | | MessageCreatedStrategy | 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. + +| recoveryInterval | 5000 | int | 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. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + +| timeoutCheckerExecutorService | | ScheduledExecutorService | 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. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 2e38329..71f7a62 100644 --- a/components/camel-sjms/src/main/docs/sjms-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-component.adoc @@ -87,24 +87,39 @@ The Simple JMS component supports 15 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| connectionFactory | advanced | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. -| connectionResource | advanced | | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. -| connectionCount | common | 1 | Integer | The maximum number of connections available to endpoints started under this component -| jmsKeyFormatStrategy | advanced | | JmsKeyFormatStrategy | 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. -| transactionCommitStrategy | transaction | | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. -| destinationCreationStrategy | advanced | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy. -| timedTaskManager | advanced | | TimedTaskManager | To use a custom TimedTaskManager -| messageCreatedStrategy | advanced | | MessageCreatedStrategy | 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. -| connectionTestOnBorrow | advanced | true | boolean | 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. -| connectionUsername | security | | String | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. -| connectionPassword | security | | String | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. -| connectionClientId | advanced | | String | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. -| connectionMaxWait | advanced | 5000 | long | 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. -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. + +| connectionResource | | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. + 4+^s| common +| connectionCount | 1 | Integer | The maximum number of connections available to endpoints started under this component + 4+^s| advanced +| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | 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. + 4+^s| transaction +| transactionCommitStrategy | | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. + 4+^s| advanced +| destinationCreationStrategy | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy. + +| timedTaskManager | | TimedTaskManager | To use a custom TimedTaskManager + +| messageCreatedStrategy | | MessageCreatedStrategy | 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. + +| connectionTestOnBorrow | true | boolean | 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. + 4+^s| security +| connectionUsername | | String | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. + +| connectionPassword | | String | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. + 4+^s| advanced +| connectionClientId | | String | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. + +| connectionMaxWait | 5000 | long | 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. + 4+^s| filter +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -133,43 +148,77 @@ with the following path and query parameters: #### Query Parameters (34 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| acknowledgementMode | common | AUTO_ACKNOWLEDGE | SessionAcknowledgementType | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| consumerCount | consumer | 1 | int | Sets the number of consumer listeners used for this endpoint. -| durableSubscriptionId | consumer | | String | Sets the durable subscription Id required for durable topics. -| synchronous | consumer | true | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| messageSelector | consumer (advanced) | | String | Sets the JMS Message selector syntax. -| namedReplyTo | producer | | String | Sets the reply to destination name used for InOut producer endpoints. -| persistent | producer | true | boolean | Flag used to enable/disable message persistence. -| producerCount | producer | 1 | int | Sets the number of producers used for this endpoint. -| ttl | producer | -1 | long | Flag used to adjust the Time To Live value of produced messages. -| allowNullBody | producer (advanced) | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. -| prefillPool | producer (advanced) | true | boolean | Whether to prefill the producer connection pool on startup or create connections lazy when needed. -| responseTimeOut | producer (advanced) | 5000 | long | Sets the amount of time we should wait before timing out a InOut response. -| asyncStartListener | advanced | false | boolean | 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. -| asyncStopListener | advanced | false | boolean | Whether to stop the consumer message listener asynchronously when stopping a route. -| connectionCount | advanced | | Integer | The maximum number of connections available to this endpoint -| connectionFactory | advanced | | ConnectionFactory | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any -| connectionResource | advanced | | ConnectionResource | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any -| destinationCreationStrategy | advanced | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy. -| exceptionListener | advanced | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. -| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. -| includeAllJMSXProperties | advanced | false | boolean | 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. -| jmsKeyFormatStrategy | advanced | | JmsKeyFormatStrategy | 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. -| mapJmsMessage | advanced | true | boolean | 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. -| messageCreatedStrategy | advanced | | MessageCreatedStrategy | 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. -| errorHandlerLoggingLevel | logging | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions. -| errorHandlerLogStackTrace | logging | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler. -| transacted | transaction | false | boolean | Specifies whether to use transacted mode -| transactionBatchCount | transaction | -1 | int | If transacted sets the number of messages to process before committing a transaction. -| transactionBatchTimeout | transaction | 5000 | long | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. -| transactionCommitStrategy | transaction | | TransactionCommitStrategy | Sets the commit strategy. -| sharedJMSSession | transaction (advanced) | true | boolean | 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. +| Name | Default | Java Type | Description + +| acknowledgementMode | AUTO_ACKNOWLEDGE | SessionAcknowledgementType | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE + 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. + +| consumerCount | 1 | int | Sets the number of consumer listeners used for this endpoint. + +| durableSubscriptionId | | String | Sets the durable subscription Id required for durable topics. + +| synchronous | true | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 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. + +| messageSelector | | String | Sets the JMS Message selector syntax. + 4+^s| producer +| namedReplyTo | | String | Sets the reply to destination name used for InOut producer endpoints. + +| persistent | true | boolean | Flag used to enable/disable message persistence. + +| producerCount | 1 | int | Sets the number of producers used for this endpoint. + +| ttl | -1 | long | Flag used to adjust the Time To Live value of produced messages. + 4+^s| producer (advanced) +| allowNullBody | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. + +| prefillPool | true | boolean | Whether to prefill the producer connection pool on startup or create connections lazy when needed. + +| responseTimeOut | 5000 | long | Sets the amount of time we should wait before timing out a InOut response. + 4+^s| advanced +| asyncStartListener | false | boolean | 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. + +| asyncStopListener | false | boolean | Whether to stop the consumer message listener asynchronously when stopping a route. + +| connectionCount | | Integer | The maximum number of connections available to this endpoint + +| connectionFactory | | ConnectionFactory | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any + +| connectionResource | | ConnectionResource | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any + +| destinationCreationStrategy | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy. + +| exceptionListener | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. + +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. + +| includeAllJMSXProperties | false | boolean | 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. + +| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | 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. + +| mapJmsMessage | true | boolean | 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. + +| messageCreatedStrategy | | MessageCreatedStrategy | 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. + 4+^s| logging +| errorHandlerLoggingLevel | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions. + +| errorHandlerLogStackTrace | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler. + 4+^s| transaction +| transacted | false | boolean | Specifies whether to use transacted mode + +| transactionBatchCount | -1 | int | If transacted sets the number of messages to process before committing a transaction. + +| transactionBatchTimeout | 5000 | long | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. + +| transactionCommitStrategy | | TransactionCommitStrategy | Sets the commit strategy. + 4+^s| transaction (advanced) +| sharedJMSSession | true | boolean | 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. |======================================================================= // endpoint options: END
