You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by an...@apache.org on 2016/07/03 17:43:53 UTC
[2/2] camel git commit: salesforce: ignore integrationtest,
changed documentation
salesforce: ignore integrationtest, changed documentation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/ddc89511
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ddc89511
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ddc89511
Branch: refs/heads/master
Commit: ddc89511d7bd24930e29b7a2bc695e1bf29c49b6
Parents: 683b53a
Author: Arno Noordover <an...@users.noreply.github.com>
Authored: Sun Jul 3 19:42:26 2016 +0200
Committer: Arno Noordover <an...@users.noreply.github.com>
Committed: Sun Jul 3 19:42:26 2016 +0200
----------------------------------------------------------------------
.../src/main/docs/salesforce.adoc | 270 +++++--------------
.../salesforce/RestApiIntegrationTest.java | 2 +-
2 files changed, 70 insertions(+), 202 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/ddc89511/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce.adoc
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce.adoc
index 1fb5aa7..f931960 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce.adoc
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce.adoc
@@ -200,47 +200,33 @@ Options
+
// component options: START
The Salesforce component supports 16 options which are listed below.
{% raw %}
-
-loginConfig (SalesforceLoginConfig)::
- To use the shared SalesforceLoginConfig as login configuration
-config (SalesforceEndpointConfig)::
- To use the shared SalesforceLoginConfig as configuration
-httpClientProperties (Map)::
- Used for configuring HTTP client properties as key/value pairs
-sslContextParameters (SSLContextParameters)::
- To configure security using SSLContextParameters
-httpProxyHost (String)::
- To configure HTTP proxy host
-httpProxyPort (Integer)::
- To configure HTTP proxy port
-httpProxyUsername (String)::
- To configure HTTP proxy username
-httpProxyPassword (String)::
- To configure HTTP proxy password
-isHttpProxySocks4 (boolean)::
- Enable for Socks4 proxy false by default
-isHttpProxySecure (boolean)::
- Enable for TLS connections true by default
-httpProxyIncludedAddresses (Set)::
- HTTP proxy included addresses
-httpProxyExcludedAddresses (Set)::
- HTTP proxy excluded addresses
-httpProxyAuthUri (String)::
- HTTP proxy authentication URI
-httpProxyRealm (String)::
- HTTP proxy authentication realm
-httpProxyUseDigestAuth (boolean)::
- Use HTTP proxy Digest authentication false by default
-packages (String[])::
- Package names to scan for DTO classes (multiple packages can be separated by comma).
-
-
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| loginConfig | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration
+| config | SalesforceEndpointConfig | To use the shared SalesforceLoginConfig as configuration
+| httpClientProperties | Map | Used for configuring HTTP client properties as key/value pairs
+| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
+| httpProxyHost | String | To configure HTTP proxy host
+| httpProxyPort | Integer | To configure HTTP proxy port
+| httpProxyUsername | String | To configure HTTP proxy username
+| httpProxyPassword | String | To configure HTTP proxy password
+| isHttpProxySocks4 | boolean | Enable for Socks4 proxy false by default
+| isHttpProxySecure | boolean | Enable for TLS connections true by default
+| httpProxyIncludedAddresses | Set | HTTP proxy included addresses
+| httpProxyExcludedAddresses | Set | HTTP proxy excluded addresses
+| httpProxyAuthUri | String | HTTP proxy authentication URI
+| httpProxyRealm | String | HTTP proxy authentication realm
+| httpProxyUseDigestAuth | boolean | Use HTTP proxy Digest authentication false by default
+| packages | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma).
+|=======================================================================
{% endraw %}
// component options: END
@@ -248,180 +234,61 @@ packages (String[])::
+
+
// endpoint options: START
The Salesforce component supports 39 endpoint options which are listed below:
{% raw %}
-
-common::
-
-operationName (OperationName):::
-
-
-
-topicName (String):::
-
-
-
-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
-
-batchId (String):::
-
- Bulk API Batch ID
-
-contentType (ContentType):::
-
- Bulk API content type one of XML CSV ZIP_XML ZIP_CSV
-
-defaultReplayId (Integer):::
-
- 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
-
-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 (boolean; default: false):::
-
- Whether to update an existing Push Topic when using the Streaming API defaults to false
-
-advanced::
-
-exchangePattern (ExchangePattern; default: InOnly):::
-
- Sets the default exchange pattern when creating an exchange
-
-synchronous (boolean; default: false):::
-
- Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-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/ERROR level and ignored.
-
-consumer::
-
-bridgeErrorHandler (boolean; default: false):::
-
- 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/ERROR level and ignored.
-
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| operationName | common | | OperationName |
+| topicName | common | | String |
+| apexMethod | common | | String | APEX method name
+| apexQueryParams | common | | Map | Query params for APEX method
+| apexUrl | common | | String | APEX method URL
+| apiVersion | common | | String | Salesforce API version defaults to SalesforceEndpointConfig.DEFAULT_VERSION
+| batchId | common | | String | Bulk API Batch ID
+| contentType | common | | ContentType | Bulk API content type one of XML CSV ZIP_XML ZIP_CSV
+| defaultReplayId | common | | Integer | Default replayId setting if no value is found in link initialReplayIdMap
+| format | common | | PayloadFormat | Payload format to use for Salesforce API calls either JSON or XML defaults to JSON
+| httpClient | common | | SalesforceHttpClient | Custom Jetty Http Client to use to connect to Salesforce.
+| includeDetails | common | | Boolean | Include details in Salesforce1 Analytics report defaults to false.
+| initialReplayIdMap | common | | Map | Replay IDs to start from per channel name.
+| instanceId | common | | String | Salesforce1 Analytics report execution instance ID
+| jobId | common | | String | Bulk API Job ID
+| notifyForFields | common | | NotifyForFieldsEnum | Notify for fields options are ALL REFERENCED SELECT WHERE
+| notifyForOperationCreate | common | | Boolean | Notify for create operation defaults to false (API version = 29.0)
+| notifyForOperationDelete | common | | Boolean | Notify for delete operation defaults to false (API version = 29.0)
+| notifyForOperations | common | | NotifyForOperationsEnum | Notify for operations options are ALL CREATE EXTENDED UPDATE (API version 29.0)
+| notifyForOperationUndelete | common | | Boolean | Notify for un-delete operation defaults to false (API version = 29.0)
+| notifyForOperationUpdate | common | | Boolean | Notify for update operation defaults to false (API version = 29.0)
+| objectMapper | common | | ObjectMapper | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
+| reportId | common | | String | Salesforce1 Analytics report Id
+| reportMetadata | common | | ReportMetadata | Salesforce1 Analytics report metadata for filtering
+| resultId | common | | String | Bulk API Result ID
+| sObjectBlobFieldName | common | | String | SObject blob field name
+| sObjectClass | common | | String | Fully qualified SObject class name usually generated using camel-salesforce-maven-plugin
+| sObjectFields | common | | String | SObject fields to retrieve
+| sObjectId | common | | String | SObject ID if required by API
+| sObjectIdName | common | | String | SObject external ID field name
+| sObjectIdValue | common | | String | SObject external ID field value
+| sObjectName | common | | String | SObject name if required or supported by API
+| sObjectQuery | common | | String | Salesforce SOQL query string
+| sObjectSearch | common | | String | Salesforce SOSL search string
+| updateTopic | common | false | boolean | Whether to update an existing Push Topic when using the Streaming API defaults to false
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
{% endraw %}
// endpoint options: END
+
For obvious security reasons it is recommended that the clientId,
clientSecret, userName and password fields be not set in the pom.xml.
The plugin should be configured for the rest of the properties, and can
@@ -429,7 +296,8 @@ be executed using the following command:
[source,java]
---------------------------------------------------------------------------------------------------------------------------------
- mvn camel-salesforce:generate -DclientId=<clientid> -DclientSecret=<clientsecret> -DuserName=<username> -Dpassword=<password>
+ mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.clientSecret=<clientsecret> \
+ -DcamelSalesforce.userName=<username> -DcamelSalesforce.password=<password>
---------------------------------------------------------------------------------------------------------------------------------
The generated DTOs use Jackson and XStream annotations. All Salesforce
http://git-wip-us.apache.org/repos/asf/camel/blob/ddc89511/components/camel-salesforce/camel-salesforce-component/src/test/java/org/apache/camel/component/salesforce/RestApiIntegrationTest.java
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/test/java/org/apache/camel/component/salesforce/RestApiIntegrationTest.java b/components/camel-salesforce/camel-salesforce-component/src/test/java/org/apache/camel/component/salesforce/RestApiIntegrationTest.java
index af60692..486447a 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/test/java/org/apache/camel/component/salesforce/RestApiIntegrationTest.java
+++ b/components/camel-salesforce/camel-salesforce-component/src/test/java/org/apache/camel/component/salesforce/RestApiIntegrationTest.java
@@ -234,7 +234,7 @@ public class RestApiIntegrationTest extends AbstractSalesforceTestBase {
}
@Test
- //@Ignore("Depends on a Task object with a datetime field")
+ @Ignore("Depends on a Task object with a datetime field")
public void testCreateUpdateDeleteTasks() throws Exception {
doTestCreateUpdateDeleteTasks("");
doTestCreateUpdateDeleteTasks("Xml");