http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 df1407d..51e0752 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 @@ -1,4 +1,4 @@ -## Salesforce Component +== Salesforce Component *Available as of Camel version 2.12* @@ -475,37 +475,37 @@ The Salesforce component supports 28 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **authenticationType** (security) | Explicit authentication method to be used one of USERNAME_PASSWORD REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set set this property to eliminate any ambiguity. | | AuthenticationType -| **loginConfig** (security) | All authentication configuration in one nested bean all properties set there can be set directly on the component as well | | SalesforceLoginConfig -| **instanceUrl** (security) | URL of the Salesforce instance used after authantication by default received from Salesforce on successful authentication | | String -| **loginUrl** (security) | *Required* URL of the Salesforce instance used for authentication by default set to https://login.salesforce.com | https://login.salesforce.com | String -| **clientId** (security) | *Required* OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. | | String -| **clientSecret** (security) | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. | | String -| **keystore** (security) | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. | | KeyStoreParameters -| **refreshToken** (security) | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token or configure using the builtin callback at https://login.salesforce.com/services/oauth2/success or https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. | | String -| **userName** (security) | Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow but in general one should avoid it as it is deemed less secure than other flows. | | String -| **password** (security) | Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. | | String -| **lazyLogin** (security) | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generaly set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | boolean -| **config** (common) | Global endpoint configuration - use to set values that are common to all endpoints | | SalesforceEndpoint Config -| **httpClientProperties** (common) | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. | | Map -| **sslContextParameters** (security) | SSL parameters to use see SSLContextParameters class for all available options. | | SSLContextParameters -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters | false | boolean -| **httpProxyHost** (proxy) | Hostname of the HTTP proxy server to use. | | String -| **httpProxyPort** (proxy) | Port number of the HTTP proxy server to use. | | Integer -| **httpProxyUsername** (security) | Username to use to authenticate against the HTTP proxy server. | | String -| **httpProxyPassword** (security) | Password to use to authenticate against the HTTP proxy server. | | String -| **isHttpProxySocks4** (proxy) | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | boolean -| **isHttpProxySecure** (security) | If set to false disables the use of TLS when accessing the HTTP proxy. | true | boolean -| **httpProxyIncluded Addresses** (proxy) | A list of addresses for which HTTP proxy server should be used. | | Set -| **httpProxyExcluded Addresses** (proxy) | A list of addresses for which HTTP proxy server should not be used. | | Set -| **httpProxyAuthUri** (security) | Used in authentication against the HTTP proxy server needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. | | String -| **httpProxyRealm** (security) | Realm of the proxy server used in preemptive Basic/Digest authentication methods against the HTTP proxy server. | | String -| **httpProxyUseDigest Auth** (security) | If set to true Digest authentication will be used when authenticating to the HTTP proxyotherwise Basic authorization method will be used | false | boolean -| **packages** (common) | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. | | 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 -|======================================================================= +| *authenticationType* (security) | Explicit authentication method to be used one of USERNAME_PASSWORD REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set set this property to eliminate any ambiguity. | | AuthenticationType +| *loginConfig* (security) | All authentication configuration in one nested bean all properties set there can be set directly on the component as well | | SalesforceLoginConfig +| *instanceUrl* (security) | URL of the Salesforce instance used after authantication by default received from Salesforce on successful authentication | | String +| *loginUrl* (security) | *Required* URL of the Salesforce instance used for authentication by default set to https://login.salesforce.com | https://login.salesforce.com | String +| *clientId* (security) | *Required* OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. | | String +| *clientSecret* (security) | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. | | String +| *keystore* (security) | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. | | KeyStoreParameters +| *refreshToken* (security) | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token or configure using the builtin callback at https://login.salesforce.com/services/oauth2/success or https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. | | String +| *userName* (security) | Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow but in general one should avoid it as it is deemed less secure than other flows. | | String +| *password* (security) | Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. | | String +| *lazyLogin* (security) | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generaly set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | boolean +| *config* (common) | Global endpoint configuration - use to set values that are common to all endpoints | | SalesforceEndpoint Config +| *httpClientProperties* (common) | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. | | Map +| *sslContextParameters* (security) | SSL parameters to use see SSLContextParameters class for all available options. | | SSLContextParameters +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters | false | boolean +| *httpProxyHost* (proxy) | Hostname of the HTTP proxy server to use. | | String +| *httpProxyPort* (proxy) | Port number of the HTTP proxy server to use. | | Integer +| *httpProxyUsername* (security) | Username to use to authenticate against the HTTP proxy server. | | String +| *httpProxyPassword* (security) | Password to use to authenticate against the HTTP proxy server. | | String +| *isHttpProxySocks4* (proxy) | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | boolean +| *isHttpProxySecure* (security) | If set to false disables the use of TLS when accessing the HTTP proxy. | true | boolean +| *httpProxyIncluded Addresses* (proxy) | A list of addresses for which HTTP proxy server should be used. | | Set +| *httpProxyExcluded Addresses* (proxy) | A list of addresses for which HTTP proxy server should not be used. | | Set +| *httpProxyAuthUri* (security) | Used in authentication against the HTTP proxy server needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. | | String +| *httpProxyRealm* (security) | Realm of the proxy server used in preemptive Basic/Digest authentication methods against the HTTP proxy server. | | String +| *httpProxyUseDigest Auth* (security) | If set to true Digest authentication will be used when authenticating to the HTTP proxyotherwise Basic authorization method will be used | false | boolean +| *packages* (common) | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. | | 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 @@ -520,68 +520,70 @@ The Salesforce component supports 28 options which are listed below. // endpoint options: START The Salesforce endpoint is configured using URI syntax: - salesforce:operationName:topicName +---- +salesforce:operationName:topicName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **operationName** | The operation to use | | OperationName -| **topicName** | The name of the topic to use | | String -|======================================================================= +| *operationName* | The operation to use | | OperationName +| *topicName* | The name of the topic to use | | String +|=== -#### Query Parameters (43 parameters): +==== Query Parameters (43 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **notFoundBehaviour** (common) | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL link NotFoundBehaviourNULL or should a exception be signaled on the exchange link NotFoundBehaviourEXCEPTION - the default. | | NotFoundBehaviour -| **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 -| **rawPayload** (common) | Use raw payload String for request and response (either JSON or XML depending on format) instead of DTOs false by default | false | boolean -| **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 -|======================================================================= +| *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 +| *notFoundBehaviour* (common) | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL link NotFoundBehaviourNULL or should a exception be signaled on the exchange link NotFoundBehaviourEXCEPTION - the default. | | NotFoundBehaviour +| *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 +| *rawPayload* (common) | Use raw payload String for request and response (either JSON or XML depending on format) instead of DTOs false by default | false | boolean +| *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/4f4f2e45/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 6620ed8..e9328ff 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 @@ -1,4 +1,4 @@ -## SAP NetWeaver Component +== SAP NetWeaver Component *Available as of Camel version 2.12* @@ -55,30 +55,32 @@ The SAP NetWeaver component has no options. // endpoint options: START The SAP NetWeaver endpoint is configured using URI syntax: - sap-netweaver:url +---- +sap-netweaver:url +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **url** | *Required* Url to the SAP net-weaver gateway server. | | String -|======================================================================= +| *url* | *Required* Url to the SAP net-weaver gateway server. | | String +|=== -#### Query Parameters (6 parameters): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/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 6fba30e..e5e37a7 100644 --- a/components/camel-saxon/src/main/docs/xquery-component.adoc +++ b/components/camel-saxon/src/main/docs/xquery-component.adoc @@ -1,4 +1,4 @@ -## XQuery Component +== XQuery Component *Available as of Camel version 1.0* @@ -20,13 +20,13 @@ The XQuery component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 @@ -35,55 +35,57 @@ The XQuery component supports 4 options which are listed below. // endpoint options: START The XQuery endpoint is configured using URI syntax: - xquery:resourceUri +---- +xquery:resourceUri +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **resourceUri** | *Required* The name of the template to load from classpath or file system | | String -|======================================================================= +| *resourceUri* | *Required* The name of the template to load from classpath or file system | | String +|=== -#### Query Parameters (31 parameters): +==== Query Parameters (31 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/components/camel-saxon/src/main/docs/xquery-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-saxon/src/main/docs/xquery-language.adoc b/components/camel-saxon/src/main/docs/xquery-language.adoc index 563a0cf..e56d220 100644 --- a/components/camel-saxon/src/main/docs/xquery-language.adoc +++ b/components/camel-saxon/src/main/docs/xquery-language.adoc @@ -1,4 +1,4 @@ -## XQuery Language +== XQuery Language *Available as of Camel version 1.0* @@ -18,12 +18,12 @@ The XQuery language supports 3 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | type | | String | Sets the class name of the result type (type from output) The default result type is NodeSet | headerName | | String | Name of header to use as input instead of the message body | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END ### Examples http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 2c23d9c..e205d4a 100644 --- a/components/camel-schematron/src/main/docs/schematron-component.adoc +++ b/components/camel-schematron/src/main/docs/schematron-component.adoc @@ -1,4 +1,4 @@ -## Schematron Component +== Schematron Component *Available as of Camel version 2.15* @@ -38,28 +38,30 @@ The Schematron component has no options. // endpoint options: START The Schematron endpoint is configured using URI syntax: - schematron:path +---- +schematron:path +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **path** | *Required* The path to the schematron rules file. Can either be in class path or location in the file system. | | String -|======================================================================= +| *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): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/components/camel-script/src/main/docs/javaScript-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/javaScript-language.adoc b/components/camel-script/src/main/docs/javaScript-language.adoc index 5f72ba9..6c093ba 100644 --- a/components/camel-script/src/main/docs/javaScript-language.adoc +++ b/components/camel-script/src/main/docs/javaScript-language.adoc @@ -1,4 +1,4 @@ -## JavaScript Language +== JavaScript Language *Available as of Camel version 1.0* @@ -29,10 +29,10 @@ The JavaScript language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END ### Example http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-script/src/main/docs/php-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/php-language.adoc b/components/camel-script/src/main/docs/php-language.adoc index 62bb2c4..a664d2d 100644 --- a/components/camel-script/src/main/docs/php-language.adoc +++ b/components/camel-script/src/main/docs/php-language.adoc @@ -1,4 +1,4 @@ -## PHP Language (deprecated) +== PHP Language (deprecated) *Available as of Camel version 1.0* @@ -28,10 +28,10 @@ The PHP language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END ### ScriptContext @@ -146,4 +146,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- \ No newline at end of file +--------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-script/src/main/docs/python-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/python-language.adoc b/components/camel-script/src/main/docs/python-language.adoc index df4c859..ce0668b 100644 --- a/components/camel-script/src/main/docs/python-language.adoc +++ b/components/camel-script/src/main/docs/python-language.adoc @@ -1,4 +1,4 @@ -## Python Language (deprecated) +== Python Language (deprecated) *Available as of Camel version 1.0* @@ -28,10 +28,10 @@ The Python language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END ### Example @@ -179,4 +179,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- \ No newline at end of file +--------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-script/src/main/docs/ruby-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/ruby-language.adoc b/components/camel-script/src/main/docs/ruby-language.adoc index 49538fb..5a59c63 100644 --- a/components/camel-script/src/main/docs/ruby-language.adoc +++ b/components/camel-script/src/main/docs/ruby-language.adoc @@ -1,4 +1,4 @@ -## Ruby Language (deprecated) +== Ruby Language (deprecated) *Available as of Camel version 1.0* @@ -28,10 +28,10 @@ The Ruby language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END ### Example @@ -179,4 +179,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- \ No newline at end of file +--------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc index 2b0929d..332d42d 100644 --- a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc +++ b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc @@ -1,4 +1,4 @@ -## ServiceNow Component +== ServiceNow Component *Available as of Camel version 2.18* @@ -35,87 +35,89 @@ The ServiceNow component supports 10 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **instanceName** (advanced) | The ServiceNow instance name | | String -| **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 -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *instanceName* (advanced) | The ServiceNow instance name | | String +| *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 +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The ServiceNow endpoint is configured using URI syntax: - servicenow:instanceName +---- +servicenow:instanceName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **instanceName** | *Required* The ServiceNow instance name | | String -|======================================================================= +| *instanceName* | *Required* The ServiceNow instance name | | String +|=== -#### Query Parameters (44 parameters): +==== Query Parameters (44 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **dateFormat** (advanced) | The date format used for Json serialization/deserialization | yyyy-MM-dd | String -| **dateTimeFormat** (advanced) | The date-time format used for Json serialization/deserialization | yyyy-MM-dd HH:mm:ss | 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 -| **retrieveTargetRecordOn Import** (advanced) | Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record | false | Boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **timeFormat** (advanced) | The time format used for Json serialization/deserialization | HH:mm:ss | String -| **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 -|======================================================================= +| *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 +| *dateFormat* (advanced) | The date format used for Json serialization/deserialization | yyyy-MM-dd | String +| *dateTimeFormat* (advanced) | The date-time format used for Json serialization/deserialization | yyyy-MM-dd HH:mm:ss | 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 +| *retrieveTargetRecordOn Import* (advanced) | Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record | false | Boolean +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *timeFormat* (advanced) | The time format used for Json serialization/deserialization | HH:mm:ss | String +| *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/4f4f2e45/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 08e93dc..e67d059 100644 --- a/components/camel-servlet/src/main/docs/servlet-component.adoc +++ b/components/camel-servlet/src/main/docs/servlet-component.adoc @@ -1,4 +1,4 @@ -## Servlet Component +== Servlet Component *Available as of Camel version 2.0* @@ -47,61 +47,63 @@ The Servlet component supports 8 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 // endpoint options: START The Servlet endpoint is configured using URI syntax: - servlet:contextPath +---- +servlet:contextPath +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **contextPath** | *Required* The context-path to use | | String -|======================================================================= +| *contextPath* | *Required* The context-path to use | | String +|=== -#### Query Parameters (21 parameters): +==== Query Parameters (21 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 response 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 ### Message Headers
