Java

RudderStack’s Java SDK allows you to track your customer event data from your Java code. Once enabled, the event requests hit the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you.

You can find this SDK in our GitHub repository.

Installing the RudderStack Java SDK

We distribute our Java SDK through Maven Central. The recommended and easiest way to add the SDK to your project is through the Maven build system.

To install the RudderStack Java SDK, add the following lines of code to pom.xml:

Copy
<dependency>
   <groupId>com.rudderstack.sdk.java</groupId>
     <artifactId>rudderanalytics-client</artifactId>
   <version>1.0.1</version>
</dependency>

Initializing the RudderStack Client

To initialize the RudderStack client, run the following code snippet:

Copy
RudderAnalytics analytics = RudderAnalytics.builder(
        WRITE_KEY,
        DATA_PLANE_URL
).build();

Sending Events from RudderStack

Once the RudderStack client is initialized, you can use it to send relevant customer events from the RudderStack client. An example track call is as shown in the following code snippet:

Copy
Map<String, Object> properties = new LinkedHashMap<>();
    properties.put("key1", "value1");
    properties.put("key2", "value2");
    analytics.enqueue(
       TrackMessage.builder("Java Test")
           .properties(properties)
           .anonymousId(anonymousId)
           .userId(userId)
);

Identify

The identify call lets you associate a user to their actions as well as captures the relevant traits or properties related to that user.

An example identify call is as shown:

Copy
analytics.enqueue(IdentifyMessage.builder()
    .userId("f4ca124298")
    .traits(ImmutableMap.builder()
        .put("name", "Sample Name")
        .put("email", "sample@abc.com")
        .build()
    )
);

The identify method parameters are as described below:

Track

The track call lets you record the users' actions along with their associated properties. Each triggered action is called as an 'event'.

An example track call is as shown:

Copy
Map<String, Object> properties = new LinkedHashMap<>();
    properties.put("key1", "value1");
    properties.put("key2", "value2");
    analytics.enqueue(
       TrackMessage.builder("Java Test")
           .properties(properties)
           .anonymousId(anonymousId)
           .userId(userId)
);

The track method parameters are as described below:

Page

The page call allows you to record the page views on your website. It also records the other relevant information about the page that is being viewed.

An example page call is as shown:

Copy
analytics.enqueue(PageMessage.builder("Schedule")
    .userId("abcfgrg")
    .properties(ImmutableMap.builder()
        .put("category", "Cultural")
        .put("path", "/a/b")
        .build()
    )
);

The page method parameters are as described below:

Screen

The screen call is the mobile equivalent of the page call. It allows you to record the screen views on your mobile app along with the other relevant information about the app screen.

An example screen call is as shown:

Copy
analytics.enqueue(ScreenMessage.builder("Schedule")
    .userId("f4ca124298")
    .properties(ImmutableMap.builder()
        .put("category", "Sports")
        .put("path", "/sports/schedule")
        .build()
    )
);

The screen method parameters are as described below:

Group

The group call allows you to associate an identified user to a group - either a company, project or a team. You can also record custom traits or properties associated with that group.

An example group call is as shown:

Copy
analytics.enqueue(GroupMessage.builder("group123")
    .userId("f4ca124298")
    .traits(ImmutableMap.builder()
        .put("name", "Rudder")
        .put("size", 19)
        .build()
    )
);

The group method parameters are as follows:

Alias

The alias call allows you to associate one identity with another.

An example alias call is as shown:

Copy
analytics.enqueue(AliasMessage.builder("previousId")
    .userId("newId")
);

The alias method parameters are as mentioned below:

Block Flush

If you want to block flush until all the events are uploaded , the Java SDK has a builder method called synchronize() with default value false which needs to be set to true .

An example for blocking the flush is shown:

Copy
RudderAnalytics analytics = RudderAnalytics.builder(
        WRITE_KEY,
        DATA_PLANE_URL
)
// optional (default : false).
// It is required to block further method invocation until the flush completes.
.synchronize(true)
.plugin(new PluginLog()) // optional. Used for Logging
.build();

// ...YOUR CODE...

// optional. Triggers a flush and block until the flush completes.
// Required in case of Synchronize.
// It calls implicitly the `flush` method.
// So, explicit `flush` call is not required.
analytics.blockFlush();
analytics.shutdown(); // Shut down after the flush is complete.

FAQ

Can I use the ImmutableMap class?

Yes. You need to use the Guava library. You can also use the plain old Java Maps instead.

Contact Us

To know more about the RudderStack Java SDK, you can contact us. You can also start a conversation on our Slack channel; we will be happy to talk to you!