Just a second...


The Java™ API is provided as a JAR file. It can be used with Java 8 (8u131-b11 GA or later) or Java 11 (11.0.3 GA or later).

Get the Java client libraries using Maven™ :

Add the DiffusionData public repository to your pom.xml file:
Declare the following dependency in your pom.xml file:

Get the Java client libraries using Gradle:

Add the DiffusionData public repository to your build.gradle file:
repositories { maven { url "http://download.diffusiondata.com/maven/" } }
Declare the following dependency in your build.gradle file:
compile 'com.pushtechnology.diffusion:diffusion-client:6.10.4'

Get the Java client libraries:

Download the JAR file from the following URL:
The ZIP file is also located in your Diffusion™ server installation:


To see the full list of capabilities supported by the Java API, see Feature support in the Diffusion API.


Table 1. Supported platforms and transport protocols for the client libraries
Platform Minimum supported versions Supported transport protocols
Java Java 8 (8u131-b11 GA or later) or Java 11 (11.0.3 GA or later)
Note: The JVM must be HotSpot™ based.
Note: The JVM must either have passed the Java TCK or be an official AdoptOpenJDK build.


HTTP (Polling)




Diffusion Java clients use certificates to validate the security of their connection to the Diffusion server . The client validates the certificate sent by the Diffusion server against the set of certificates trusted by the Java Development Kit (JDK).

If the certificate sent by the Diffusion server cannot be validated against any certificates in the set trusted by the JDK, you receive an exception that contains the following message: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target.

Diffusion is authenticated using the certificates provided by your certificate authority for the domain you host the Diffusion server on.

To ensure that the certificate is validated, set up a trust store for the client and add the appropriate certificates to that trust store:
  1. Obtain the appropriate intermediate certificate from the certificate authority.
  2. Use keytool to create a trust store for your client that includes this certificate.

    For more information, see https://docs.oracle.com/cd/E19509-01/820-3503/ggfka/index.html

  3. Use system properties to add the trust store to your client.
    For example:
    System.setProperty("javax.net.ssl.trustStore", "truststore_name");
    Or at the command line:
Writing good callbacks
The Java client library invokes callbacks using a thread from Diffusion thread pool. Callbacks for a particular session are called in order, one at a time. Consider the following when writing callbacks:
  • Do not sleep or call blocking operations in a callback. If you do so, other pending callbacks for the session are delayed. If you must call a blocking operation, schedule it in a separate application thread.
  • You can use the full Diffusion API to make other requests to the server. If you want to make many requests based on a single callback notification, be aware that Diffusion client flow control is managed differently in callback threads. Less throttling is applied and it is easier to overflow the servers by issuing many thousands of requests. If you have a lot of requests to make, it is better to schedule the work in an application thread.
Regular expressions

The Java client uses the same regular expression engine to the Diffusion server . Some regular expressions in topic selectors are evaluated on the client and others on the Diffusion server . There is no difference in how these regular expressions are evaluated in the Java client.