Step 3: Download and Build the Project

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

Prerequisites:

Java Development Kit 8 or later (see Java Downloads)
Eclipse IDE for Java Developers (get a recent version from http://www.eclipse.org/downloads/eclipse-packages/). This example walks you through the steps of building the project with the Eclipse IDE but you can you use your preferred IDE to build the Java client.

The EMP Connector project includes examples in the GitHub repository’s example folder that use the connector to log in and subscribe to events. In the next steps, you run the following examples locally on your system.

LoginExample.java logs in to your production instance. To pass in a custom login URL, such as for sandbox or My Domain, use DevLoginExample.java instead. DevLoginExample.java also provides debug logging for the Bayeux messages received.

Note

To download and build the EMP connector project:

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.
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.
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.

Streaming API Developer Guide

Step 3: Download and Build the Project