http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc index 46583bc..5fd49d5 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc +++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc @@ -431,59 +431,34 @@ The Salesforce component supports 25 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| security -| loginConfig | | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration - -| loginUrl | https://login.salesforce.com | String | Salesforce login URL defaults to https://login.salesforce.com - -| clientId | | String | Salesforce connected application Consumer Key - -| clientSecret | | String | Salesforce connected application Consumer Secret - -| keystore | | KeyStoreParameters | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. - -| refreshToken | | String | Salesforce connected application Consumer token - -| userName | | String | Salesforce account user name - -| password | | String | Salesforce account password - -| lazyLogin | false | boolean | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call - 4+^s| advanced -| config | | SalesforceEndpointConfig | To use the shared SalesforceEndpointConfig as endpoint configuration - -| httpClientProperties | | Map | Used for configuring HTTP client properties as key/value pairs - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| proxy -| httpProxyHost | | String | To configure HTTP proxy host - -| httpProxyPort | | Integer | To configure HTTP proxy port - 4+^s| security -| httpProxyUsername | | String | To configure HTTP proxy username - -| httpProxyPassword | | String | To configure HTTP proxy password - 4+^s| proxy -| isHttpProxySocks4 | false | boolean | Enable for Socks4 proxy false by default - 4+^s| security -| isHttpProxySecure | false | boolean | Enable for TLS connections true by default - 4+^s| proxy -| httpProxyIncludedAddresses | | Set | HTTP proxy included addresses - -| httpProxyExcludedAddresses | | Set | HTTP proxy excluded addresses - 4+^s| security -| httpProxyAuthUri | | String | HTTP proxy authentication URI - -| httpProxyRealm | | String | HTTP proxy authentication realm - -| httpProxyUseDigestAuth | false | boolean | Use HTTP proxy Digest authentication false by default - 4+^s| common -| packages | | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma). - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **loginConfig** (security) | To use the shared SalesforceLoginConfig as login configuration | | SalesforceLoginConfig +| **loginUrl** (security) | Salesforce login URL defaults to https://login.salesforce.com | https://login.salesforce.com | String +| **clientId** (security) | Salesforce connected application Consumer Key | | String +| **clientSecret** (security) | Salesforce connected application Consumer Secret | | String +| **keystore** (security) | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. | | KeyStoreParameters +| **refreshToken** (security) | Salesforce connected application Consumer token | | String +| **userName** (security) | Salesforce account user name | | String +| **password** (security) | Salesforce account password | | String +| **lazyLogin** (security) | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call | false | boolean +| **config** (advanced) | To use the shared SalesforceEndpointConfig as endpoint configuration | | SalesforceEndpoint Config +| **httpClientProperties** (advanced) | Used for configuring HTTP client properties as key/value pairs | | Map +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **httpProxyHost** (proxy) | To configure HTTP proxy host | | String +| **httpProxyPort** (proxy) | To configure HTTP proxy port | | Integer +| **httpProxyUsername** (security) | To configure HTTP proxy username | | String +| **httpProxyPassword** (security) | To configure HTTP proxy password | | String +| **isHttpProxySocks4** (proxy) | Enable for Socks4 proxy false by default | false | boolean +| **isHttpProxySecure** (security) | Enable for TLS connections true by default | false | boolean +| **httpProxyIncluded Addresses** (proxy) | HTTP proxy included addresses | | Set +| **httpProxyExcluded Addresses** (proxy) | HTTP proxy excluded addresses | | Set +| **httpProxyAuthUri** (security) | HTTP proxy authentication URI | | String +| **httpProxyRealm** (security) | HTTP proxy authentication realm | | String +| **httpProxyUseDigest Auth** (security) | Use HTTP proxy Digest authentication false by default | false | boolean +| **packages** (common) | Package names to scan for DTO classes (multiple packages can be separated by comma). | | 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 @@ -505,100 +480,59 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| operationName | | OperationName | The operation to use -| topicName | | String | The name of the topic to use +| Name | Description | Default | Type +| **operationName** | The operation to use | | OperationName +| **topicName** | The name of the topic to use | | String |======================================================================= #### Query Parameters (41 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| apexMethod | | String | APEX method name - -| apexQueryParams | | Map | Query params for APEX method - -| apexUrl | | String | APEX method URL - -| apiVersion | | String | Salesforce API version defaults to SalesforceEndpointConfig.DEFAULT_VERSION - -| backoffIncrement | | long | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. - -| batchId | | String | Bulk API Batch ID - -| contentType | | ContentType | Bulk API content type one of XML CSV ZIP_XML ZIP_CSV - -| defaultReplayId | | Long | Default replayId setting if no value is found in link initialReplayIdMap - -| format | | PayloadFormat | Payload format to use for Salesforce API calls either JSON or XML defaults to JSON - -| httpClient | | SalesforceHttpClient | Custom Jetty Http Client to use to connect to Salesforce. - -| includeDetails | | Boolean | Include details in Salesforce1 Analytics report defaults to false. - -| initialReplayIdMap | | Map | Replay IDs to start from per channel name. - -| instanceId | | String | Salesforce1 Analytics report execution instance ID - -| jobId | | String | Bulk API Job ID - -| limit | | Integer | Limit on number of returned records. Applicable to some of the API check the Salesforce documentation. - -| maxBackoff | | long | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. - -| notifyForFields | | NotifyForFieldsEnum | Notify for fields options are ALL REFERENCED SELECT WHERE - -| notifyForOperationCreate | | Boolean | Notify for create operation defaults to false (API version = 29.0) - -| notifyForOperationDelete | | Boolean | Notify for delete operation defaults to false (API version = 29.0) - -| notifyForOperations | | NotifyForOperationsEnum | Notify for operations options are ALL CREATE EXTENDED UPDATE (API version 29.0) - -| notifyForOperationUndelete | | Boolean | Notify for un-delete operation defaults to false (API version = 29.0) - -| notifyForOperationUpdate | | Boolean | Notify for update operation defaults to false (API version = 29.0) - -| objectMapper | | ObjectMapper | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. - -| reportId | | String | Salesforce1 Analytics report Id - -| reportMetadata | | ReportMetadata | Salesforce1 Analytics report metadata for filtering - -| resultId | | String | Bulk API Result ID - -| sObjectBlobFieldName | | String | SObject blob field name - -| sObjectClass | | String | Fully qualified SObject class name usually generated using camel-salesforce-maven-plugin - -| sObjectFields | | String | SObject fields to retrieve - -| sObjectId | | String | SObject ID if required by API - -| sObjectIdName | | String | SObject external ID field name - -| sObjectIdValue | | String | SObject external ID field value - -| sObjectName | | String | SObject name if required or supported by API - -| sObjectQuery | | String | Salesforce SOQL query string - -| sObjectSearch | | String | Salesforce SOSL search string - -| updateTopic | false | boolean | Whether to update an existing Push Topic when using the Streaming API defaults to false - 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. - -| replayId | | Long | The replayId value to use when subscribing - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apexMethod** (common) | APEX method name | | String +| **apexQueryParams** (common) | Query params for APEX method | | Map +| **apexUrl** (common) | APEX method URL | | String +| **apiVersion** (common) | Salesforce API version defaults to SalesforceEndpointConfig.DEFAULT_VERSION | | String +| **backoffIncrement** (common) | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | long +| **batchId** (common) | Bulk API Batch ID | | String +| **contentType** (common) | Bulk API content type one of XML CSV ZIP_XML ZIP_CSV | | ContentType +| **defaultReplayId** (common) | Default replayId setting if no value is found in link initialReplayIdMap | | Long +| **format** (common) | Payload format to use for Salesforce API calls either JSON or XML defaults to JSON | | PayloadFormat +| **httpClient** (common) | Custom Jetty Http Client to use to connect to Salesforce. | | SalesforceHttpClient +| **includeDetails** (common) | Include details in Salesforce1 Analytics report defaults to false. | | Boolean +| **initialReplayIdMap** (common) | Replay IDs to start from per channel name. | | Map +| **instanceId** (common) | Salesforce1 Analytics report execution instance ID | | String +| **jobId** (common) | Bulk API Job ID | | String +| **limit** (common) | Limit on number of returned records. Applicable to some of the API check the Salesforce documentation. | | Integer +| **maxBackoff** (common) | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | long +| **notifyForFields** (common) | Notify for fields options are ALL REFERENCED SELECT WHERE | | NotifyForFieldsEnum +| **notifyForOperationCreate** (common) | Notify for create operation defaults to false (API version = 29.0) | | Boolean +| **notifyForOperationDelete** (common) | Notify for delete operation defaults to false (API version = 29.0) | | Boolean +| **notifyForOperations** (common) | Notify for operations options are ALL CREATE EXTENDED UPDATE (API version 29.0) | | NotifyForOperations Enum +| **notifyForOperationUndelete** (common) | Notify for un-delete operation defaults to false (API version = 29.0) | | Boolean +| **notifyForOperationUpdate** (common) | Notify for update operation defaults to false (API version = 29.0) | | Boolean +| **objectMapper** (common) | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. | | ObjectMapper +| **reportId** (common) | Salesforce1 Analytics report Id | | String +| **reportMetadata** (common) | Salesforce1 Analytics report metadata for filtering | | ReportMetadata +| **resultId** (common) | Bulk API Result ID | | String +| **sObjectBlobFieldName** (common) | SObject blob field name | | String +| **sObjectClass** (common) | Fully qualified SObject class name usually generated using camel-salesforce-maven-plugin | | String +| **sObjectFields** (common) | SObject fields to retrieve | | String +| **sObjectId** (common) | SObject ID if required by API | | String +| **sObjectIdName** (common) | SObject external ID field name | | String +| **sObjectIdValue** (common) | SObject external ID field value | | String +| **sObjectName** (common) | SObject name if required or supported by API | | String +| **sObjectQuery** (common) | Salesforce SOQL query string | | String +| **sObjectSearch** (common) | Salesforce SOSL search string | | String +| **updateTopic** (common) | Whether to update an existing Push Topic when using the Streaming API defaults to false | false | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **replayId** (consumer) | The replayId value to use when subscribing | | Long +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc index 5f93151..6620ed8 100644 --- a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc +++ b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc @@ -61,29 +61,23 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| url | | String | *Required* Url to the SAP net-weaver gateway server. +| Name | Description | Default | Type +| **url** | *Required* Url to the SAP net-weaver gateway server. | | String |======================================================================= #### Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| flatternMap | true | boolean | If the JSON Map contains only a single entry then flattern by storing that single entry value as the message body. - -| json | true | boolean | Whether to return data in JSON format. If this option is false then XML is returned in Atom format. - -| jsonAsMap | true | boolean | To transform the JSON from a String to a Map in the message body. - -| password | | String | *Required* Password for account. - -| username | | String | *Required* Username for account. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **flatternMap** (producer) | If the JSON Map contains only a single entry then flattern by storing that single entry value as the message body. | true | boolean +| **json** (producer) | Whether to return data in JSON format. If this option is false then XML is returned in Atom format. | true | boolean +| **jsonAsMap** (producer) | To transform the JSON from a String to a Map in the message body. | true | boolean +| **password** (producer) | *Required* Password for account. | | String +| **username** (producer) | *Required* Username for account. | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-saxon/src/main/docs/xquery-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc index 7d7f838..6fba30e 100644 --- a/components/camel-saxon/src/main/docs/xquery-component.adoc +++ b/components/camel-saxon/src/main/docs/xquery-component.adoc @@ -19,17 +19,13 @@ The XQuery component supports 4 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| moduleURIResolver | | ModuleURIResolver | To use the custom ModuleURIResolver - -| configuration | | Configuration | To use a custom Saxon configuration - -| configurationProperties | | Map | To set custom Saxon configuration properties - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **moduleURIResolver** (advanced) | To use the custom ModuleURIResolver | | ModuleURIResolver +| **configuration** (advanced) | To use a custom Saxon configuration | | Configuration +| **configurationProperties** (advanced) | To set custom Saxon configuration properties | | Map +| **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 @@ -45,79 +41,48 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* The name of the template to load from classpath or file system +| Name | Description | Default | Type +| **resourceUri** | *Required* The name of the template to load from classpath or file system | | String |======================================================================= #### Query Parameters (31 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| allowStAX | false | boolean | Whether to allow using StAX mode - -| headerName | | String | To use a Camel Message header as the input source instead of Message body. - -| namespacePrefixes | | Map | Allows to control which namespace prefixes to use for a set of namespace mappings - -| resultsFormat | DOM | ResultFormat | What output result to use - -| resultType | | Class<?> | What output result to use defined as a class - -| stripsAllWhiteSpace | true | boolean | Whether to strip all whitespaces - 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. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| configuration | | Configuration | To use a custom Saxon configuration - -| configurationProperties | | Map | To set custom Saxon configuration properties - -| moduleURIResolver | | ModuleURIResolver | To use the custom ModuleURIResolver - -| parameters | | Map | Additional parameters - -| properties | | Properties | Properties to configure the serialization parameters - -| staticQueryContext | | StaticQueryContext | To use a custom Saxon StaticQueryContext - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Description | Default | Type +| **allowStAX** (common) | Whether to allow using StAX mode | false | boolean +| **headerName** (common) | To use a Camel Message header as the input source instead of Message body. | | String +| **namespacePrefixes** (common) | Allows to control which namespace prefixes to use for a set of namespace mappings | | Map +| **resultsFormat** (common) | What output result to use | DOM | ResultFormat +| **resultType** (common) | What output result to use defined as a class | | Class<?> +| **stripsAllWhiteSpace** (common) | Whether to strip all whitespaces | 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 +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| **configuration** (advanced) | To use a custom Saxon configuration | | Configuration +| **configurationProperties** (advanced) | To set custom Saxon configuration properties | | Map +| **moduleURIResolver** (advanced) | To use the custom ModuleURIResolver | | ModuleURIResolver +| **parameters** (advanced) | Additional parameters | | Map +| **properties** (advanced) | Properties to configure the serialization parameters | | Properties +| **staticQueryContext** (advanced) | To use a custom Saxon StaticQueryContext | | StaticQueryContext +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-schematron/src/main/docs/schematron-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-schematron/src/main/docs/schematron-component.adoc b/components/camel-schematron/src/main/docs/schematron-component.adoc index 8e50982..2c23d9c 100644 --- a/components/camel-schematron/src/main/docs/schematron-component.adoc +++ b/components/camel-schematron/src/main/docs/schematron-component.adoc @@ -44,25 +44,21 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| path | | String | *Required* The path to the schematron rules file. Can either be in class path or location in the file system. +| Name | Description | Default | Type +| **path** | *Required* The path to the schematron rules file. Can either be in class path or location in the file system. | | String |======================================================================= #### Query Parameters (4 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| abort | false | boolean | Flag to abort the route and throw a schematron validation exception. - -| rules | | Templates | To use the given schematron rules instead of loading from the path - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| uriResolver | | URIResolver | Set the URIResolver to be used for resolving schematron includes in the rules file. +| Name | Description | Default | Type +| **abort** (producer) | Flag to abort the route and throw a schematron validation exception. | false | boolean +| **rules** (producer) | To use the given schematron rules instead of loading from the path | | Templates +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **uriResolver** (advanced) | Set the URIResolver to be used for resolving schematron includes in the rules file. | | URIResolver |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 0d1594b..2dc64a0 100644 --- a/components/camel-servicenow/src/main/docs/servicenow-component.adoc +++ b/components/camel-servicenow/src/main/docs/servicenow-component.adoc @@ -34,25 +34,17 @@ The ServiceNow component supports 8 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| 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. +| Name | Description | Default | Type +| **configuration** (advanced) | The ServiceNow default configuration | | ServiceNowConfiguration +| **apiUrl** (producer) | The ServiceNow REST API url | | String +| **userName** (security) | ServiceNow user account name | | String +| **password** (security) | ServiceNow account password | | String +| **oauthClientId** (security) | OAuth2 ClientID | | String +| **oauthClientSecret** (security) | OAuth2 ClientSecret | | String +| **oauthTokenUrl** (security) | OAuth token 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 @@ -66,97 +58,57 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| instanceName | | String | *Required* The ServiceNow instance name +| Name | Description | Default | Type +| **instanceName** | *Required* The ServiceNow instance name | | String |======================================================================= #### Query Parameters (40 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| 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 +| Name | Description | Default | Type +| **display** (producer) | 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. | true | String +| **displayValue** (producer) | Return the display value (true) actual value (false) or both (all) for reference fields (default: false) | false | String +| **excludeReferenceLink** (producer) | True to exclude Table API links for reference fields (default: false) | | Boolean +| **favorites** (producer) | Set this parameter to true to return only scorecards that are favorites of the querying user. | | Boolean +| **includeAggregates** (producer) | 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. | | Boolean +| **includeAvailableAggregates** (producer) | 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. | | Boolean +| **includeAvailableBreakdowns** (producer) | 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. | | Boolean +| **includeScoreNotes** (producer) | 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. | | Boolean +| **includeScores** (producer) | 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. | | Boolean +| **inputDisplayValue** (producer) | True to set raw value of input fields (default: false) | | Boolean +| **key** (producer) | Set this parameter to true to return only scorecards for key indicators. | | Boolean +| **models** (producer) | Defines both request and response models | | String +| **perPage** (producer) | Enter the maximum number of scorecards each query can return. By default this value is 10 and the maximum is 100. | 10 | Integer +| **release** (producer) | The ServiceNow release to target default to Helsinki See https://docs.servicenow.com | HELSINKI | ServiceNowRelease +| **requestModels** (producer) | Defines the request model | | String +| **resource** (producer) | The default resource can be overridden by header CamelServiceNowResource | | String +| **responseModels** (producer) | Defines the response model | | String +| **sortBy** (producer) | Specify the value to use when sorting results. By default queries sort records by value. | | String +| **sortDir** (producer) | Specify the sort direction ascending or descending. By default queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. | | String +| **suppressAutoSysField** (producer) | True to suppress auto generation of system fields (default: false) | | Boolean +| **suppressPaginationHeader** (producer) | 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 | | Boolean +| **table** (producer) | The default table can be overridden by header CamelServiceNowTable | | String +| **target** (producer) | Set this parameter to true to return only scorecards that have a target. | | Boolean +| **topLevelOnly** (producer) | Gets only those categories whose parent is a catalog. | | Boolean +| **apiVersion** (advanced) | The ServiceNow REST API version default latest | | String +| **httpClientPolicy** (advanced) | To configure http-client | | HTTPClientPolicy +| **mapper** (advanced) | Sets Jackson's ObjectMapper to use for request/reply | | ObjectMapper +| **proxyAuthorizationPolicy** (advanced) | To configure proxy authentication | | ProxyAuthorization Policy +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **proxyHost** (proxy) | The proxy host name | | String +| **proxyPort** (proxy) | The proxy port number | | Integer +| **apiUrl** (security) | The ServiceNow REST API url | | String +| **oauthClientId** (security) | OAuth2 ClientID | | String +| **oauthClientSecret** (security) | OAuth2 ClientSecret | | String +| **oauthTokenUrl** (security) | OAuth token Url | | String +| **password** (security) | *Required* ServiceNow account password MUST be provided | | String +| **proxyPassword** (security) | Password for proxy authentication | | String +| **proxyUserName** (security) | Username for proxy authentication | | String +| **sslContextParameters** (security) | To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html | | SSLContextParameters +| **userName** (security) | *Required* ServiceNow user account name MUST be provided | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 5cabc39..08e93dc 100644 --- a/components/camel-servlet/src/main/docs/servlet-component.adoc +++ b/components/camel-servlet/src/main/docs/servlet-component.adoc @@ -46,25 +46,17 @@ The Servlet component supports 8 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| 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. +| Name | Description | Default | Type +| **servletName** (consumer) | Default name of servlet to use. The default name is CamelServlet. | | String +| **httpRegistry** (consumer) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry +| **attachmentMultipart Binding** (consumer) | 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. | false | boolean +| **httpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding +| **httpConfiguration** (advanced) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration +| **allowJavaSerialized Object** (advanced) | 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. | false | boolean +| **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 @@ -77,59 +69,38 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| contextPath | | String | *Required* The context-path to use +| Name | Description | Default | Type +| **contextPath** | *Required* The context-path to use | | String |======================================================================= #### Query Parameters (21 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| 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). +| Name | Description | Default | Type +| **disableStreamCache** (common) | 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 respon se body stream but use the response stream as-is as the message body. | false | boolean +| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding +| **async** (consumer) | Configure the consumer to work in async mode | false | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **chunked** (consumer) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean +| **httpMethodRestrict** (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String +| **matchOnUriPrefix** (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean +| **responseBufferSize** (consumer) | To use a custom buffer size on the javax.servlet.ServletResponse. | | Integer +| **servletName** (consumer) | Name of the servlet to use | CamelServlet | String +| **transferException** (consumer) | 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. | false | boolean +| **attachmentMultipartBinding** (consumer) | 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. | false | boolean +| **eagerCheckContentAvailable** (consumer) | 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. | 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 +| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | false | boolean +| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. | false | boolean +| **mapHttpMessageBody** (advanced) | 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. | true | boolean +| **mapHttpMessageFormUrl EncodedBody** (advanced) | 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. | true | boolean +| **mapHttpMessageHeaders** (advanced) | 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. | true | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 d2e5726..fe8a889 100644 --- a/components/camel-sip/src/main/docs/sip-component.adoc +++ b/components/camel-sip/src/main/docs/sip-component.adoc @@ -83,105 +83,61 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| uri | | URI | *Required* URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999) +| 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 |======================================================================= #### Query Parameters (44 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| 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. +| 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 |======================================================================= // endpoint options: END
