JarCastingSalesforce Messaging Client
Salesforce Messaging Client, is a java client used to subscribe to enterprise messages (Platform Events & Streaming API Push Topics).
Reference Links:
Platform Events Developer Guide
Getting Started
To include the client in your maven project, add the following dependency to your pom.xml file:
<dependency>
<groupId>io.cdsoft</groupId>
<artifactId>sf-messaging-client</artifactId>
<version>1.0.3</version>
</dependency>
Prerequisites
You will need a Salesforce sandbox. Get a free account
Configuration
To configure the client use the ConnectionConfig.
public class ConnectionConfig {
private String loginUrl = "https://login.salesforce.com"; // Salesforce login URL https://login.salesforce.com or https://test.salesforce.com or your custom domain name
private String clientId; // Salesforce OAuth connected app client ID
private String clientSecret; // Salesforce OAuth connected app client secret
private String userName; // Salesforce username
private String password; // Salesforce password
private String securityToken; // Salesforce security token for username
private String apiVersion = "40.0"; // Salesforce API version
private Boolean enableKeepAlive = true; // This will periodically login to extend the Salesforce session
private Long keepAliveMinutes = 60L; // Number of minutes between keep alive logins
private Long maxRetries = 3L; // Number of retries to login/connect when an exception/error occurs
}
Usage
To use the client:
import io.cdsoft.sf.messaging.api.client.MessagingClient;
import io.cdsoft.sf.messaging.api.config.ConnectionConfig;
import io.cdsoft.sf.messaging.api.consumer.JsonEventConsumer;
import io.cdsoft.sf.messaging.api.subscription.PlatformEventSubscription;
import io.cdsoft.sf.messaging.api.subscription.Subscription;
public class Client {
public static void main(String[] args) throws Exception {
// Set up ConnectionConfig instance with your values
ConnectionConfig config = new ConnectionConfig();
config.setLoginUrl("");
config.setClientId("");
config.setClientSecret("");
config.setUserName("");
config.setPassword("");
config.setSecurityToken("");
// Create an instance of the MessagingClient
MessagingClient client = new MessagingClient(config);
// Start the client
client.start();
// Create a message consumer
JsonEventConsumer consumer = message -> System.out.println("Received message: " + message);
// Create a Platform Event Subscription
// Param 1: The paltform event API name
// Param 2: Replay events from (-2 = earliest, -1 = tip, or specific event ID)
// Param 2: An instance of EventConsumer (Either JsonEventConsumer or MapEventConsumer)
Subscription subscription = new PlatformEventSubscription("Some_Event__e", -1L, consumer);
// Subscribe to the event
client.addSubscription(subscription);
}
}
Consumers
-
MapEventConsumerImplement this consumer to receive the payload from Salesforce inMap<String, Object>structured. This map is the JSON key to value map. Nested objects are themselvesMap<String, Object>.Example
MapEventConsumer consumer = message -> System.out.println("Received message on channel: " + message.get("channel");
-
JsonEventConsumerImplement this consumer to receive the raw JSON payload from Salesforce.Example
JsonEventConsumer consumer = message -> System.out.println("Received message: " + message);
-
JacksonPlatformEventConsumerExtend and implement this abstract class to receive a strongly typed platform event parsed by Jackson.Example
public class SomePayloadEventConsumer extends JacksonPlatformEventConsumer<SomePayload> { public SomePayloadEventConsumer(ObjectMapper objectMapper) { super(SomePayload.class, objectMapper); } @Override public void handleEvent(PlatformEvent<SomePayload> event) { SomePayload payload = event.getData().getPayload(); // Do something interesting with payload } @Override public void handleException(IOException exception, String json, JavaType type) { log.warn("Failed to parse event tyep {} from {}", type.getTypeName(), json); } }
-
JacksonPushTopicEventConsumerExtend and implement this abstract class to receive a strongly typed push topic event parsed by Jackson.Example
public class SomePayloadEventConsumer extends JacksonPushTopicEventConsumer<SomePayload> { public SomePayloadEventConsumer(ObjectMapper objectMapper) { super(SomePayload.class, objectMapper); } @Override public void handleEvent(PushTopicEvent<SomePayload> event) { SomePayload payload = event.getData().getSObject(); // Do something interesting with payload } @Override public void handleException(IOException exception, String json, JavaType type) { log.warn("Failed to parse event tyep {} from {}", type.getTypeName(), json); } }
Built With
Versioning
Use SemVer for versioning. For the versions available, see the tags on this repository.
License
This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details.