This is an automated email from the ASF dual-hosted git repository.

jeremyross pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/main by this push:
     new 97a4a38ca99 CAMEL-18046: Support sObjectName param for queries
97a4a38ca99 is described below

commit 97a4a38ca9920e3b7cb2b1fbefcc501b6a0ad7b3
Author: Jeremy Ross <[email protected]>
AuthorDate: Tue May 3 10:05:38 2022 -0500

    CAMEL-18046: Support sObjectName param for queries
    
    sObjectName allows theuser to specify the simple class name, vs
    sObjectClass which requires the fully qualified class name.
---
 .../src/main/docs/salesforce-component.adoc           | 10 +++++++---
 .../component/salesforce/SalesforceComponent.java     |  4 ++--
 .../internal/processor/AbstractRestProcessor.java     |  9 ++++++---
 .../component/salesforce/RestApiIntegrationTest.java  | 19 +++++++++++++++++++
 4 files changed, 34 insertions(+), 8 deletions(-)

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 db55f8c0d37..7add05acdc6 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
@@ -529,7 +529,8 @@ Runs a Salesforce SOQL query
 
 | Body or `sObjectQuery` | `String`  | SOQL query | | x
 | streamQueryResult | `Boolean` | If true, returns a streaming `Iterator` and 
transparently retrieves all pages as needed. The `sObjectClass` option must 
reference an `AbstractQueryRecordsBase` subclass. | false |
-| `sObjectClass` | `String` | Fully qualified name of class to deserialize 
response to. Usually a subclass of `AbstractQueryRecordsBase`, e.g. 
`org.my.dto.QueryRecordsAccount`| |x
+| `sObjectClass` | `String` | Fully qualified name of class to deserialize 
response to. Usually a subclass of `AbstractQueryRecordsBase`, e.g. 
`org.my.dto.QueryRecordsAccount`| | One of sObjectClass or sObjectName is 
required
+| `sObjectName` | `String` | Simple name of class to deserialize response to. 
Usually a subclass of `AbstractQueryRecordsBase`, e.g. `QueryRecordsAccount`. 
Requires the `package` option be set.| |One of sObjectClass or sObjectName is 
required
 |===
 
 *Output*
@@ -547,7 +548,9 @@ Retrieves more results (in case of large number of results) 
using result link re
 | Parameter | Type | Description | Default | Required
 
 | Body or `sObjectQuery` | `String`  | `nextRecords` value. Can be found in a 
prior query result in the `AbstractQueryRecordsBase.nextRecordsUrl` property | 
| X
-| `sObjectClass` | `String` | Fully qualified name of class to deserialize 
response to. Usually a subclass of `AbstractQueryRecordsBase`, e.g. 
`org.my.dto.QueryRecordsAccount`| |x
+| `sObjectClass` | `String` | Fully qualified name of class to deserialize 
response to. Usually a subclass of `AbstractQueryRecordsBase`, e.g. 
`org.my.dto.QueryRecordsAccount`| |One of sObjectClass or sObjectName is 
required
+| `sObjectName` | `String` | Simple name of class to deserialize response to. 
Usually a subclass of `AbstractQueryRecordsBase`, e.g. `QueryRecordsAccount`. 
Requires the `package` option be set. | |One of sObjectClass or sObjectName is 
required
+
 |===
 
 *Output*
@@ -566,7 +569,8 @@ Executes the specified SOQL query. Unlike the `query` 
operation , `queryAll` ret
 
 | Body or `sObjectQuery` | `String`  | SOQL query | | x
 | streamQueryResult | `Boolean` | If true, returns a streaming `Iterable` and 
transparently retrieves all pages as needed. The `sObjectClass` option must 
reference an `AbstractQueryRecordsBase` subclass. | false |
-| `sObjectClass` | `String` | Fully qualified name of class to deserialize 
response to. Usually a subclass of `AbstractQueryRecordsBase`, e.g. 
`org.my.dto.QueryRecordsAccount`| |x
+| `sObjectClass` | `String` | Fully qualified name of class to deserialize 
response to. Usually a subclass of `AbstractQueryRecordsBase`, e.g. 
`org.my.dto.QueryRecordsAccount`| |One of sObjectClass or sObjectName is 
required
+| `sObjectName` | `String` | Simple name of class to deserialize response to. 
Usually a subclass of `AbstractQueryRecordsBase`, e.g. `QueryRecordsAccount`. 
Requires the `package` option be set.| |One of sObjectClass or sObjectName is 
required
 |===
 
 *Output*
diff --git 
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
 
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
index 248e65033b3..80a699c47f3 100644
--- 
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
+++ 
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceComponent.java
@@ -30,7 +30,7 @@ import org.apache.camel.ExtendedCamelContext;
 import org.apache.camel.SSLContextParametersAware;
 import org.apache.camel.TypeConverter;
 import org.apache.camel.component.salesforce.api.SalesforceException;
-import org.apache.camel.component.salesforce.api.dto.AbstractSObjectBase;
+import org.apache.camel.component.salesforce.api.dto.AbstractDTOBase;
 import org.apache.camel.component.salesforce.api.utils.SecurityUtils;
 import org.apache.camel.component.salesforce.internal.OperationName;
 import org.apache.camel.component.salesforce.internal.PayloadFormat;
@@ -342,7 +342,7 @@ public class SalesforceComponent extends DefaultComponent 
implements SSLContextP
     private Map<String, Class<?>> parsePackages() {
         Map<String, Class<?>> result = new HashMap<>();
         Set<Class<?>> classes = 
getCamelContext().adapt(ExtendedCamelContext.class).getPackageScanClassResolver()
-                .findImplementations(AbstractSObjectBase.class, 
getPackagesAsArray());
+                .findImplementations(AbstractDTOBase.class, 
getPackagesAsArray());
         for (Class<?> aClass : classes) {
             result.put(aClass.getSimpleName(), aClass);
         }
diff --git 
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/AbstractRestProcessor.java
 
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/AbstractRestProcessor.java
index e78e5a0b511..df4b4efd642 100644
--- 
a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/AbstractRestProcessor.java
+++ 
b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/internal/processor/AbstractRestProcessor.java
@@ -492,9 +492,10 @@ public abstract class AbstractRestProcessor extends 
AbstractSalesforceProcessor
     private void processQuery(final Exchange exchange, final AsyncCallback 
callback) throws SalesforceException {
         final String sObjectQuery = getParameter(SOBJECT_QUERY, exchange, 
USE_BODY, NOT_OPTIONAL);
         final boolean streamQueryResults = getParameter(STREAM_QUERY_RESULT, 
exchange, IGNORE_BODY, IS_OPTIONAL, Boolean.class);
+        final String sObjectName = getParameter(SOBJECT_NAME, exchange, 
IGNORE_BODY, IS_OPTIONAL);
 
         // use custom response class property
-        setResponseClass(exchange, null);
+        setResponseClass(exchange, sObjectName);
 
         if (streamQueryResults) {
             restClient.query(sObjectQuery, determineHeaders(exchange), 
processWithStreamResultCallback(exchange, callback));
@@ -506,9 +507,10 @@ public abstract class AbstractRestProcessor extends 
AbstractSalesforceProcessor
     private void processQueryMore(final Exchange exchange, final AsyncCallback 
callback) throws SalesforceException {
         // reuse SOBJECT_QUERY parameter name for nextRecordsUrl
         final String nextRecordsUrl = getParameter(SOBJECT_QUERY, exchange, 
USE_BODY, NOT_OPTIONAL);
+        final String sObjectName = getParameter(SOBJECT_NAME, exchange, 
IGNORE_BODY, IS_OPTIONAL);
 
         // use custom response class property
-        setResponseClass(exchange, null);
+        setResponseClass(exchange, sObjectName);
 
         restClient.queryMore(nextRecordsUrl, determineHeaders(exchange), 
processWithResponseCallback(exchange, callback));
     }
@@ -516,9 +518,10 @@ public abstract class AbstractRestProcessor extends 
AbstractSalesforceProcessor
     private void processQueryAll(final Exchange exchange, final AsyncCallback 
callback) throws SalesforceException {
         final String sObjectQuery = getParameter(SOBJECT_QUERY, exchange, 
USE_BODY, NOT_OPTIONAL);
         final boolean streamQueryResults = getParameter(STREAM_QUERY_RESULT, 
exchange, IGNORE_BODY, IS_OPTIONAL, Boolean.class);
+        final String sObjectName = getParameter(SOBJECT_NAME, exchange, 
IGNORE_BODY, IS_OPTIONAL);
 
         // use custom response class property
-        setResponseClass(exchange, null);
+        setResponseClass(exchange, sObjectName);
 
         if (streamQueryResults) {
             restClient.queryAll(sObjectQuery, determineHeaders(exchange), 
processWithStreamResultCallback(exchange, callback));
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 01b44ff9f0e..2205e8cf52a 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
@@ -512,6 +512,20 @@ public class RestApiIntegrationTest extends 
AbstractSalesforceTestBase {
         assertNotNull(lineItem.getRecordType());
     }
 
+    @Test
+    public void testQueryWithSObjectName() throws Exception {
+        createLineItem();
+        final QueryRecordsLine_Item__c queryRecords
+                = template().requestBody("direct:queryWithSObjectName", null, 
QueryRecordsLine_Item__c.class);
+        assertNotNull(queryRecords);
+        // verify polymorphic query resulted in the correct type
+        assertEquals(User.class, 
queryRecords.getRecords().get(0).getOwner().getClass());
+        final Line_Item__c lineItem = queryRecords.getRecords().get(0);
+        User user = (User) queryRecords.getRecords().get(0).getOwner();
+        assertNotNull(user.getUsername());
+        assertNotNull(lineItem.getRecordType());
+    }
+
     @Test
     public void testQueryStreamResults() throws Exception {
         final int createCount = 300;
@@ -814,6 +828,11 @@ public class RestApiIntegrationTest extends 
AbstractSalesforceTestBase {
                         .to("salesforce:query?sObjectQuery=SELECT Id, name, 
Typeof Owner WHEN User Then Username End, recordTypeId, RecordType.Name from 
Line_Item__c&sObjectClass="
                             + QueryRecordsLine_Item__c.class.getName());
 
+                // testQuery
+                from("direct:queryWithSObjectName")
+                        .to("salesforce:query?sObjectQuery=SELECT Id, name, 
Typeof Owner WHEN User Then Username End, recordTypeId, RecordType.Name from 
Line_Item__c&sObjectName="
+                            + "QueryRecordsLine_Item__c");
+
                 // testQuery
                 from("direct:queryStreamResult")
                         .setHeader("sObjectClass", 
constant(QueryRecordsLine_Item__c.class.getName()))

Reply via email to