Skip to content

CAMEL-24495: camel-salesforce-maven-plugin - support JWT and Client Credentials authentication, backport to camel-4.22.x #25976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davsclaus merged 1 commit into from
Aug 31, 2026
Merged

CAMEL-24495: camel-salesforce-maven-plugin - support JWT and Client Credentials authentication, backport to camel-4.22.x #25976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions .../main/java/org/apache/camel/component/salesforce/codegen/AbstractSalesforceExecution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import java.util.concurrent.ExecutorService;

import org.apache.camel.CamelContext;
import org.apache.camel.component.salesforce.AuthenticationType;
import org.apache.camel.component.salesforce.SalesforceHttpClient;
import org.apache.camel.component.salesforce.SalesforceLoginConfig;
import org.apache.camel.component.salesforce.api.SalesforceException;
Expand Down Expand Up @@ -157,6 +158,11 @@ public abstract class AbstractSalesforceExecution {
*/
String userName;

/**
* Salesforce authentication type.
*/
AuthenticationType authenticationType;

/**
* Salesforce API version.
*/
Expand Down Expand Up @@ -321,14 +327,16 @@ private SalesforceHttpClient createHttpClient() throws Exception {
}

private SalesforceLoginConfig getSalesforceLoginSession() {
if (keyStoreParameters != null) {
SalesforceLoginConfig salesforceLoginConfig
= new SalesforceLoginConfig(loginUrl, clientId, userName, keyStoreParameters, false);
salesforceLoginConfig.setJwtAudience(jwtAudience);

return salesforceLoginConfig;
}
return new SalesforceLoginConfig(loginUrl, clientId, clientSecret, userName, password, false);
SalesforceLoginConfig config = new SalesforceLoginConfig();
config.setLoginUrl(loginUrl);
config.setClientId(clientId);
config.setClientSecret(clientSecret);
config.setUserName(userName);
config.setPassword(password);
config.setKeystore(keyStoreParameters);
config.setJwtAudience(jwtAudience);
config.setType(authenticationType);
return config;
}

private void disconnectFromSalesforce(final RestClient restClient) {
Expand Down Expand Up @@ -416,6 +424,10 @@ public void setKeyStoreParameters(KeyStoreParameters keyStoreParameters) {
this.keyStoreParameters = keyStoreParameters;
}

public void setAuthenticationType(AuthenticationType authenticationType) {
this.authenticationType = authenticationType;
}

public void setUserName(String userName) {
this.userName = userName;
}
Expand Down
182 changes: 116 additions & 66 deletions components/camel-salesforce/camel-salesforce-maven-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,38 @@ This plugin generates DTOs for use with the [Camel Salesforce Component](https:/

## Usage ##

This plugin provides three maven goals:
This plugin provides three Maven goals:

* The `generate` goal generates DTOs for use with the REST API.
* The `generatePubSub` goal generates Apache Avro `SpecificRecord` subclasses for use with the PubSub API.
* The `schema` goal generates JSON Schemas that correspond to objects used with the REST API.

The plugin configuration has the following properties.

* clientId - Salesforce client Id for Remote API access
* clientSecret - Salesforce client secret for Remote API access
* userName - Salesforce account username
* password - Salesforce account password (including secret token)
* jwtAudience - Salesforce JWT audience (defaults to "https://login.salesforce.com")
* keystoreResource - Path to keystore file for JWT authentication
* keystorePassword - Password for keystore file
* keystoreType - Type of keystore file (defaults to "JKS")
* loginUrl - Salesforce loginUrl (defaults to "https://login.salesforce.com")
* version - Salesforce Rest API version, defaults to 25.0
* outputDirectory - Directory where to place generated DTOs, defaults to ${project.build.directory}/generated-sources/camel-salesforce
* includes - List of SObject types to include
* topics - List of topics to include, .e.g., `/event/BatchApexErrorEvent`. This property only applies to the `generatePubSub` goal.
* excludes - List of SObject types to exclude
* includePattern - Java RegEx for SObject types to include
* excludePattern - Java RegEx for SObject types to exclude
* packageName - Java package name for generated DTOs, defaults to org.apache.camel.salesforce.dto.
* customTypes - override default types in generated DTOs
* useStringsForPicklists - Use strings instead of enumerations for picklists. Default is false.
* childRelationshipNameSuffix - Suffix for child relationship property name. Necessary if an SObject
* `clientId` - Salesforce client Id for Remote API access
* `clientSecret` - Salesforce client secret for Remote API access
* `userName` - Salesforce account username (required for Username-Password and JWT flows)
* `password` - Salesforce account password (including secret token)
* `authenticationType` - Salesforce authentication type: USERNAME_PASSWORD, JWT, or CLIENT_CREDENTIALS. If not specified, auto-detected from provided credentials.
* `jwtAudience` - Salesforce JWT audience (defaults to "https://login.salesforce.com")
* `keystoreResource` - Path to keystore file for JWT authentication
* `keystorePassword` - Password for keystore file
* `keystoreType` - Type of keystore file (defaults to "JKS")
* `loginUrl` - Salesforce loginUrl (defaults to "https://login.salesforce.com")
* `version` - Salesforce Rest API version, defaults to 25.0
* `outputDirectory` - Directory where to place generated DTOs, defaults to ${project.build.directory}/generated-sources/camel-salesforce
* `includes` - List of SObject types to include
* `topics` - List of topics to include, e.g., `/event/BatchApexErrorEvent`. This property only applies to the `generatePubSub` goal.
* `excludes` - List of SObject types to exclude
* `includePattern` - Java RegEx for SObject types to include
* `excludePattern` - Java RegEx for SObject types to exclude
* `packageName` - Java package name for generated DTOs, defaults to org.apache.camel.salesforce.dto.
* `customTypes` - override default types in generated DTOs
* `useStringsForPicklists` - Use strings instead of enumerations for picklists. Default is false.
* `childRelationshipNameSuffix` - Suffix for child relationship property name. Necessary if an SObject
has a lookup field with the same name as its Child Relationship Name. If setting to something other
than default, "List" is a sensible value.
* enumerationOverrideProperties - Override picklist enum value generation via a java.util.Properties instance.
* `enumerationOverrideProperties` - Override picklist enum value generation via a java.util.Properties instance.
Property name format: `SObject.FieldName.PicklistValue`. Property value is the desired enum value. E.g.:
```
<enumerationOverrideProperties>
Expand All @@ -47,57 +48,63 @@ Property name format: `SObject.FieldName.PicklistValue`. Property value is the d

Additional properties to provide proxy information, if behind a firewall.

* httpProxyHost
* httpProxyPort
* httpProxyUsername
* httpProxyPassword
* httpProxyRealm
* httpProxyAuthUri
* httpProxyUseDigestAuth
* httpProxyIncludedAddresses
* httpProxyExcludedAddresses
* `httpProxyHost`
* `httpProxyPort`
* `httpProxyUsername`
* `httpProxyPassword`
* `httpProxyRealm`
* `httpProxyAuthUri`
* `httpProxyUseDigestAuth`
* `httpProxyIncludedAddresses`
* `httpProxyExcludedAddresses`

There are two authentication methods supported by the plugin: Username-Password and JWT.
The plugin will use the Username-Password method if the `clientSecret` is specified and will use the JWT method if the `keystoreResource` is specified.
Three authentication methods are supported by the plugin: Username-Password, JWT, and Client Credentials.
The plugin auto-detects the authentication method from the provided credentials, or you can set `authenticationType` explicitly.

Sample pom.xml using Username-Password authentication:
* **Username-Password** requires: `clientId`, `clientSecret`, `userName`, and `password`.<br>
Auto-detected when `password` is specified.
* **JWT** requires: `clientId`, `userName`, `loginUrl` (My Domain URL), `keystoreResource`, and `keystorePassword`.<br>
`keystoreType` defaults to JKS, `jwtAudience` defaults to `https://login.salesforce.com`.<br>
Auto-detected when `keystoreResource` is specified.
* **Client Credentials** requires: `clientId`, `clientSecret`, and `loginUrl` (My Domain URL).<br>
Auto-detected when only `clientId` and `clientSecret` are specified (no `password`, no `userName`, no `keystoreResource`).

___
<br>

### Username-Password Authentication Type ###

Sample pom.xml using **Username-Password** authentication:
```
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<properties>

<camelSalesforce.clientId>5MVG9uudbyLbNPZOFutIHJpIb2nchnCiNE_NqeYcewMCPPT8_6VV_LQF_CJ813456GxzhxZdxlGwbYI_yzHmz</camelSalesforce.clientId>
<camelSalesforce.clientId>5MVG9uudbyLbNPZOFut...GwbYI_yzHmz</camelSalesforce.clientId>
<camelSalesforce.clientSecret>5630289243049151316</camelSalesforce.clientSecret>
<camelSalesforce.userName>foo@bar.com</camelSalesforce.userName>
<camelSalesforce.password>foopasswordCbe5V27JxD0JXYFGJIdIEWB7p</camelSalesforce.password>

<camelSalesforce.loginUrl>https://myDomain.my.salesforce.com</camelSalesforce.loginUrl>

<camelSalesforce.loginUrl>https://myDomain.my.salesforce.com</camelSalesforce.loginUrl>
<camelSalesforce.httpProxyHost>foo.bar.com</camelSalesforce.httpProxyHost>
<camelSalesforce.httpProxyPort>8090</camelSalesforce.httpProxyPort>

</properties>

...

<build>
...
<plugins>
...

<!-- camel maven saleforce for creating salesforce objects -->
<!-- camel maven salesforce for creating salesforce objects -->
<plugin>
<groupId>org.apache.camel.maven</groupId>
<artifactId>camel-salesforce-maven-plugin</artifactId>
<version>2.17.1</version>
<version>${camel.version}</version>
<configuration>
<clientId>${camelSalesforce.clientId}</clientId>
<clientSecret>${camelSalesforce.clientSecret}</clientSecret>
<userName>${camelSalesforce.userName}</userName>
<password>${camelSalesforce.password}</password>
<loginUrl default-value="https://login.salesforce.com">${camelSalesforce.loginUrl}</loginUrl>
<loginUrl>${camelSalesforce.loginUrl}</loginUrl>
<includes>
<include>Account</include>
<include>Contacts</include>
Expand All @@ -106,7 +113,6 @@ Sample pom.xml using Username-Password authentication:
<httpProxyPort>${camelSalesforce.httpProxyPort}</httpProxyPort>
</configuration>
</plugin>

</plugins>
</build>

Expand All @@ -117,49 +123,46 @@ The plugin should be configured for the rest of the properties, and can be execu

mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.clientSecret=<clientsecret> -DcamelSalesforce.userName=<username> -DcamelSalesforce.password=<password>

Sample pom.xml using JWT authentication:
___
<br>

### JWT Authentication Type ###

Sample pom.xml using **JWT** authentication:
```
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<properties>

<camelSalesforce.clientId>5MVG9uudbyLbNPZOFutIHJpIb2nchnCiNE_NqeYcewMCPPT8_6VV_LQF_CJ813456GxzhxZdxlGwbYI_yzHmz</camelSalesforce.clientId>
<camelSalesforce.clientId>5MVG9uudbyLbNPZOFut...GwbYI_yzHmz</camelSalesforce.clientId>
<camelSalesforce.userName>foo@bar.com</camelSalesforce.userName>
<camelSalesforce.keystore.resource>src/main/resources/salesforce.jks</camelSalesforce.keystore.resource>
<camelSalesforce.keystore.password>foopasswordCbe5V27JxD0JXYFGJIdIEWB7p</camelSalesforce.keystore.password>
<camelSalesforce.keystore.type>JKS</camelSalesforce.keystore.type>

<camelSalesforce.jwtAudience>https://login.salesforce.com</camelSalesforce.jwtAudience>

<camelSalesforce.loginUrl>https://myDomain.my.salesforce.com</camelSalesforce.loginUrl>

<camelSalesforce.loginUrl>https://myDomain.my.salesforce.com</camelSalesforce.loginUrl>
<camelSalesforce.httpProxyHost>foo.bar.com</camelSalesforce.httpProxyHost>
<camelSalesforce.httpProxyPort>8090</camelSalesforce.httpProxyPort>

</properties>

...

<build>
...
<plugins>
...

<!-- camel maven saleforce for creating salesforce objects -->
<!-- camel maven salesforce for creating salesforce objects -->
<plugin>
<groupId>org.apache.camel.maven</groupId>
<artifactId>camel-salesforce-maven-plugin</artifactId>
<version>2.17.1</version>
<version>${camel.version}</version>
<configuration>
<clientId>${camelSalesforce.clientId}</clientId>
<userName>${camelSalesforce.userName}</userName>
<keystoreResource>${camelSalesforce.keystore.resource}</keystoreResource>
<keystorePassword>${camelSalesforce.keystore.password}</keystorePassword>
<keystoreType default-value="JKS">${camelSalesforce.keystore.type}</keystoreType>
<jwtAudience default-value="https://login.salesforce.com">${camelSalesforce.jwtAudience}</jwtAudience>
<loginUrl default-value="https://login.salesforce.com">${camelSalesforce.loginUrl}</loginUrl>
<keystoreType>${camelSalesforce.keystore.type}</keystoreType>
<jwtAudience>${camelSalesforce.jwtAudience}</jwtAudience>
<loginUrl>${camelSalesforce.loginUrl}</loginUrl>
<includes>
<include>Account</include>
<include>Contacts</include>
Expand All @@ -168,7 +171,6 @@ Sample pom.xml using JWT authentication:
<httpProxyPort>${camelSalesforce.httpProxyPort}</httpProxyPort>
</configuration>
</plugin>

</plugins>
</build>

Expand All @@ -177,9 +179,57 @@ Sample pom.xml using JWT authentication:
For obvious security reasons it is recommended that the clientId, userName, keystoreResource, keystorePassword, keystoreType and jwtAudience fields be not set in the pom.xml.
The plugin should be configured for the rest of the properties, and can be executed using the following command:

mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.userName=<username> -DcamelSalesforce.keystore.resource=<keystoreResource> -DcamelSalesforce.keystore.password=<keystorePassword> -DcamelSalesforce.keystore.type=<keystoreType> -DcamelSalesforce.jwtAudience=<jwtAudience>
mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.userName=<username> -DcamelSalesforce.keystore.resource=<keystoreResource> -DcamelSalesforce.keystore.password=<keystorePassword> -DcamelSalesforce.keystore.type=<keystoreType> -DcamelSalesforce.jwtAudience=<jwtAudience> -DcamelSalesforce.loginUrl=<login-url>

___
<br>

### Client Credentials Authentication Type ###

Sample pom.xml using **Client Credentials** authentication
```
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<properties>
<camelSalesforce.clientId>5MVG9uudbyLbNPZOFut...GwbYI_yzHmz</camelSalesforce.clientId>
<camelSalesforce.clientSecret>5630289243049151316</camelSalesforce.clientSecret>
<camelSalesforce.loginUrl>https://myDomain.my.salesforce.com</camelSalesforce.loginUrl>
</properties>
...
<build>
...
<plugins>
...
<!-- camel maven salesforce for creating salesforce objects -->
<plugin>
<groupId>org.apache.camel.maven</groupId>
<artifactId>camel-salesforce-maven-plugin</artifactId>
<version>${camel.version}</version>
<configuration>
<clientId>${camelSalesforce.clientId}</clientId>
<clientSecret>${camelSalesforce.clientSecret}</clientSecret>
<loginUrl>${camelSalesforce.loginUrl}</loginUrl>
<includes>
<include>Account</include>
<include>Contacts</include>
</includes>
</configuration>
</plugin>
</plugins>
</build>

</project>
```
For obvious security reasons it is recommended that the clientId and clientSecret fields be not set in the pom.xml.
The plugin should be configured for the rest of the properties, and can be executed using the following command:

mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.clientSecret=<clientsecret> -DcamelSalesforce.loginUrl=<login-url>


___

The generated DTOs use Jackson. All Salesforce field types are supported. Date and time fields are mapped to java.time.ZonedDateTime, and picklist fields are mapped to generated Java Enumerations.

Relationship fields, e.g. `Contact.Account`, will be strongly typed if the referenced SObject type is listed in `includes`. Otherwise, the type of the reference object will be `AbstractDescribedSObjectBase`. Some useful but non-obvious SObjects to include are `RecordType`, `User`, `Group`, and `Name`.
Expand All @@ -205,4 +255,4 @@ You can customize types, i.e. use java.time.LocalDateTime instead of the default
</customTypes>
</configuration>
</plugin>
````
```
Loading