Platform Events Developer Guide

Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Testing Your Platform Event in Apex
Encrypting Platform Event Messages at Rest in the Event Bus
Monitor Platform Event Publishing and Delivery Usage
Considerations
Examples
End-to-End Example Using Flows
Java Client Example
Prerequisites
Define a Custom Platform Event
Download and Build the Project
Subscribe to a Channel and Receive Event Notifications
Platform Event Samples
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Download and Build the Project

Before you can run the connector examples, download the Java source files and build the Java project.

The EMP Connector project includes examples in the GitHub repository’s example folder that use the connector to log in and subscribe to events.

  1. To download the project files, do one of the following.
    • Clone the EMP Connector project using git.
      1git clone https://github.com/forcedotcom/EMP-Connector
    • Download the project zip file from GitHub, and then extract the zip to a local folder.
  2. In Eclipse, import the Maven project from the folder where you cloned or extracted the project.
    The dependencies that are specified in the Maven’s pom.xml file, such as CometD, are added in the Java project in Eclipse.
  3. If the Java project wasn’t automatically built, build it.
If you prefer to run the tool from the command line, generate the JAR file using the Maven command mvn clean package. The generated JAR file includes the connector and the example class functionality. The JAR file is a shaded JAR—it contains all dependencies for the connector, so you don’t have to download them separately. The JAR file has a -phat Maven classifier. You can run the login example from the command line. To run the tool against a production instance without specifying a login URL, use this command, which uses the LoginExample.java class by default. 
1$ java -jar target/emp-connector-0.0.1-SNAPSHOT-phat.jar <username> <password> <channel> [optional_replay_id]

To specify a login URL for sandbox or My Domain, use this command, which references the DevLoginExample.java class.

1$ java -classpath target/emp-connector-0.0.1-SNAPSHOT-phat.jar com.salesforce.emp.connector.example.DevLoginExample <login_URL> <username> <password> <channel> [optional_replayId]

For <login_URL>, use your org’s My Domain login URL, including the https:// prefix. For example, https://MyDomainName.my.salesforce.com.

If you don’t have a deployed My Domain, use https://login.salesforce.com for a production org and https://test.salesforce.com for a sandbox or developer environment.

Open Source Project

EMP Connector is an open-source project, so you can contribute to it with your own enhancements by submitting pull requests to the repository.