blob: 906581ae032bc9e3d5dd13ea761a0377a60c8469 [file] [log] [blame]
// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
= Salesforce
:page-aliases: extensions/salesforce.adoc
:linkattrs:
:cq-artifact-id: camel-quarkus-salesforce
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Communicate with Salesforce using Java DTOs.
:cq-deprecated: false
:cq-jvm-since: 0.2.0
:cq-native-since: 0.0.2
[.badges]
[.badge-key]##JVM since##[.badge-supported]##0.2.0## [.badge-key]##Native since##[.badge-supported]##0.0.2##
Communicate with Salesforce using Java DTOs.
== What's inside
* xref:{cq-camel-components}::salesforce-component.adoc[Salesforce component], URI syntax: `salesforce:operationName:topicName`
Please refer to the above link for usage and configuration details.
== Maven coordinates
https://code.quarkus.io/?extension-search=camel-quarkus-salesforce[Create a new project with this extension on code.quarkus.io, window="_blank"]
Or add the coordinates to your existing project:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-salesforce</artifactId>
</dependency>
----
Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
== Usage
=== Generating Salesforce DTOs with the `salesforce-maven-plugin`
To generate Salesforce DTOs for your project, use the `salesforce-maven-plugin`. The example code snippet below creates a single DTO for the `Account` object.
[source,xml,subs="attributes+"]
----
<plugin>
<groupId>org.apache.camel.maven</groupId>
<artifactId>camel-salesforce-maven-plugin</artifactId>
<version>{camel-version}</version>
<executions>
<execution>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<clientId>${env.SALESFORCE_CLIENTID}</clientId>
<clientSecret>${env.SALESFORCE_CLIENTSECRET}</clientSecret>
<userName>${env.SALESFORCE_USERNAME}</userName>
<password>${env.SALESFORCE_PASSWORD}</password>
<loginUrl>https://login.salesforce.com</loginUrl>
<packageName>org.apache.camel.quarkus.component.salesforce.generated</packageName>
<outputDirectory>src/main/java</outputDirectory>
<includes>
<include>Account</include>
</includes>
</configuration>
</execution>
</executions>
</plugin>
----
== SSL in native mode
This extension auto-enables SSL support in native mode. Hence you do not need to add
`quarkus.ssl.native=true` to your `application.properties` yourself. See also
https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].