Repository: camel Updated Branches: refs/heads/master df556c4a5 -> 3035cdc27
CAMEL-8772: Added documentation for salesforce login config and endpoint options Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/3035cdc2 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3035cdc2 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3035cdc2 Branch: refs/heads/master Commit: 3035cdc2726fa2bc32ad05c7e07c678505a7f59b Parents: df556c4 Author: Dhiraj Bokde <dhira...@yahoo.com> Authored: Fri Sep 18 02:31:39 2015 -0700 Committer: Dhiraj Bokde <dhira...@yahoo.com> Committed: Fri Sep 18 02:31:39 2015 -0700 ---------------------------------------------------------------------- .../salesforce/SalesforceEndpointConfig.java | 90 ++++++++++++++++++++ .../salesforce/SalesforceLoginConfig.java | 18 ++++ 2 files changed, 108 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/3035cdc2/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java ---------------------------------------------------------------------- diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java index f8f7e9b..e25198e5c 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java +++ b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpointConfig.java @@ -157,6 +157,9 @@ public class SalesforceEndpointConfig implements Cloneable { return format; } + /** + * Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON + */ public void setFormat(PayloadFormat format) { this.format = format; } @@ -165,6 +168,9 @@ public class SalesforceEndpointConfig implements Cloneable { return apiVersion; } + /** + * Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION + */ public void setApiVersion(String apiVersion) { this.apiVersion = apiVersion; } @@ -173,6 +179,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectName; } + /** + * SObject name if required or supported by API + */ public void setSObjectName(String sObjectName) { this.sObjectName = sObjectName; } @@ -181,6 +190,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectId; } + /** + * SObject ID if required by API + */ public void setSObjectId(String sObjectId) { this.sObjectId = sObjectId; } @@ -189,6 +201,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectFields; } + /** + * SObject fields to retrieve + */ public void setSObjectFields(String sObjectFields) { this.sObjectFields = sObjectFields; } @@ -197,6 +212,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectIdName; } + /** + * SObject external ID field name + */ public void setSObjectIdName(String sObjectIdName) { this.sObjectIdName = sObjectIdName; } @@ -205,6 +223,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectIdValue; } + /** + * SObject external ID field value + */ public void setSObjectIdValue(String sObjectIdValue) { this.sObjectIdValue = sObjectIdValue; } @@ -213,6 +234,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectBlobFieldName; } + /** + * SObject blob field name + */ public void setSObjectBlobFieldName(String sObjectBlobFieldName) { this.sObjectBlobFieldName = sObjectBlobFieldName; } @@ -221,6 +245,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectClass; } + /** + * Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin + */ public void setSObjectClass(String sObjectClass) { this.sObjectClass = sObjectClass; } @@ -229,6 +256,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectQuery; } + /** + * Salesforce SOQL query string + */ public void setSObjectQuery(String sObjectQuery) { this.sObjectQuery = sObjectQuery; } @@ -237,6 +267,9 @@ public class SalesforceEndpointConfig implements Cloneable { return sObjectSearch; } + /** + * Salesforce SOSL search string + */ public void setSObjectSearch(String sObjectSearch) { this.sObjectSearch = sObjectSearch; } @@ -245,6 +278,9 @@ public class SalesforceEndpointConfig implements Cloneable { return apexMethod; } + /** + * APEX method name + */ public void setApexMethod(String apexMethod) { this.apexMethod = apexMethod; } @@ -253,6 +289,9 @@ public class SalesforceEndpointConfig implements Cloneable { return apexUrl; } + /** + * APEX method URL + */ public void setApexUrl(String apexUrl) { this.apexUrl = apexUrl; } @@ -261,6 +300,9 @@ public class SalesforceEndpointConfig implements Cloneable { return apexQueryParams == null ? Collections.EMPTY_MAP : Collections.unmodifiableMap(apexQueryParams); } + /** + * Query params for APEX method + */ public void setApexQueryParams(Map<String, Object> apexQueryParams) { this.apexQueryParams = apexQueryParams; } @@ -269,6 +311,9 @@ public class SalesforceEndpointConfig implements Cloneable { return contentType; } + /** + * Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV + */ public void setContentType(ContentType contentType) { this.contentType = contentType; } @@ -277,6 +322,9 @@ public class SalesforceEndpointConfig implements Cloneable { return jobId; } + /** + * Bulk API Job ID + */ public void setJobId(String jobId) { this.jobId = jobId; } @@ -285,6 +333,9 @@ public class SalesforceEndpointConfig implements Cloneable { return batchId; } + /** + * Bulk API Batch ID + */ public void setBatchId(String batchId) { this.batchId = batchId; } @@ -293,6 +344,9 @@ public class SalesforceEndpointConfig implements Cloneable { return resultId; } + /** + * Bulk API Result ID + */ public void setResultId(String resultId) { this.resultId = resultId; } @@ -301,6 +355,9 @@ public class SalesforceEndpointConfig implements Cloneable { return updateTopic; } + /** + * Whether to update an existing Push Topic when using the Streaming API, defaults to false + */ public void setUpdateTopic(boolean updateTopic) { this.updateTopic = updateTopic; } @@ -309,6 +366,9 @@ public class SalesforceEndpointConfig implements Cloneable { return notifyForFields; } + /** + * Notify for fields, options are ALL, REFERENCED, SELECT, WHERE + */ public void setNotifyForFields(NotifyForFieldsEnum notifyForFields) { this.notifyForFields = notifyForFields; } @@ -317,6 +377,9 @@ public class SalesforceEndpointConfig implements Cloneable { return notifyForOperations; } + /** + * Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0) + */ public void setNotifyForOperations(NotifyForOperationsEnum notifyForOperations) { this.notifyForOperations = notifyForOperations; } @@ -325,6 +388,9 @@ public class SalesforceEndpointConfig implements Cloneable { return notifyForOperationCreate; } + /** + * Notify for create operation, defaults to false (API version >= 29.0) + */ public void setNotifyForOperationCreate(Boolean notifyForOperationCreate) { this.notifyForOperationCreate = notifyForOperationCreate; } @@ -333,6 +399,9 @@ public class SalesforceEndpointConfig implements Cloneable { return notifyForOperationUpdate; } + /** + * Notify for update operation, defaults to false (API version >= 29.0) + */ public void setNotifyForOperationUpdate(Boolean notifyForOperationUpdate) { this.notifyForOperationUpdate = notifyForOperationUpdate; } @@ -341,6 +410,9 @@ public class SalesforceEndpointConfig implements Cloneable { return notifyForOperationDelete; } + /** + * Notify for delete operation, defaults to false (API version >= 29.0) + */ public void setNotifyForOperationDelete(Boolean notifyForOperationDelete) { this.notifyForOperationDelete = notifyForOperationDelete; } @@ -349,6 +421,9 @@ public class SalesforceEndpointConfig implements Cloneable { return notifyForOperationUndelete; } + /** + * Notify for un-delete operation, defaults to false (API version >= 29.0) + */ public void setNotifyForOperationUndelete(Boolean notifyForOperationUndelete) { this.notifyForOperationUndelete = notifyForOperationUndelete; } @@ -357,6 +432,9 @@ public class SalesforceEndpointConfig implements Cloneable { return reportId; } + /** + * Salesforce1 Analytics report Id + */ public void setReportId(String reportId) { this.reportId = reportId; } @@ -365,6 +443,9 @@ public class SalesforceEndpointConfig implements Cloneable { return includeDetails; } + /** + * Include details in Salesforce1 Analytics report, defaults to false. + */ public void setIncludeDetails(Boolean includeDetails) { this.includeDetails = includeDetails; } @@ -373,6 +454,9 @@ public class SalesforceEndpointConfig implements Cloneable { return reportMetadata; } + /** + * Salesforce1 Analytics report metadata for filtering + */ public void setReportMetadata(ReportMetadata reportMetadata) { this.reportMetadata = reportMetadata; } @@ -381,10 +465,16 @@ public class SalesforceEndpointConfig implements Cloneable { return instanceId; } + /** + * Salesforce1 Analytics report execution instance ID + */ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } + /** + * Custom Jetty Http Client to use to connect to Salesforce. + */ public void setHttpClient(HttpClient httpClient) { this.httpClient = httpClient; } http://git-wip-us.apache.org/repos/asf/camel/blob/3035cdc2/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceLoginConfig.java ---------------------------------------------------------------------- diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceLoginConfig.java b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceLoginConfig.java index a6a097f..f363468 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceLoginConfig.java +++ b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceLoginConfig.java @@ -52,6 +52,9 @@ public class SalesforceLoginConfig { return loginUrl; } + /** + * Salesforce login URL, defaults to https://login.salesforce.com + */ public void setLoginUrl(String loginUrl) { this.loginUrl = loginUrl; } @@ -60,6 +63,9 @@ public class SalesforceLoginConfig { return clientId; } + /** + * Salesforce connected application Consumer Key + */ public void setClientId(String clientId) { this.clientId = clientId; } @@ -68,6 +74,9 @@ public class SalesforceLoginConfig { return clientSecret; } + /** + * Salesforce connected application Consumer Secret + */ public void setClientSecret(String clientSecret) { this.clientSecret = clientSecret; } @@ -76,6 +85,9 @@ public class SalesforceLoginConfig { return userName; } + /** + * Salesforce account user name + */ public void setUserName(String userName) { this.userName = userName; } @@ -84,6 +96,9 @@ public class SalesforceLoginConfig { return password; } + /** + * Salesforce account password + */ public void setPassword(String password) { this.password = password; } @@ -92,6 +107,9 @@ public class SalesforceLoginConfig { return lazyLogin; } + /** + * Flag to enable/disable lazy OAuth, default is false. When enabled, OAuth token retrieval or generation is not done until the first API call + */ public void setLazyLogin(boolean lazyLogin) { this.lazyLogin = lazyLogin; }
