Connect to your cluster using the Spring client

This document describes how to connect to a cluster through a Spring client, and use the Spring producer and consumer to produce and consume messages to and from a topic. The Spring client supports connecting to a Pulsar cluster through either OAuth2 or Token authentication.

Note

This document assumes that you have created a Pulsar cluster and a service account, and have granted the service account produce and consume permissions to the namespace for the target topic.

Prerequisites

See the minimum supported versions required for the underlying libraries.

Connect to cluster through OAuth2 authentication

To connect a Pulsar cluster through OAuth2 authentication, follow these steps.

Step 1: Get the broker service URL of your cluster

To get the service URL of a Pulsar cluster through the StreamNative Cloud Console, follow these steps.

On the left navigation pane, in the Admin area, click Pulsar Clusters.
Select the Overview tab, and in the Access Points area, click Copy at the end of the row of the service URL.

Step 2: Get the OAuth2 credential file of your service account

To get an OAuth2 credential file of a service account through the StreamNative Cloud Console, follow these steps.

On the left navigation pane, click Service Accounts.
In the row of the service account you want to use, in the Key File column, click the Download icon to download the OAuth2 credential file to your local directory.
The OAuth2 credential file should be something like this:
```
{
  "type": "SN_SERVICE_ACCOUNT",
  "client_id": "CLIENT_ID",
  "client_secret": "CLIENT_SECRET",
  "client_email": "[email protected]",
  "issuer_url": "https://auth.streamnative.cloud"
}
```

Step 3: Connect to your cluster

spring:
  pulsar:
    client:
      service-url: { { SERVICE_URL } }
      auth-plugin-class-name: org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2
      authentication:
        issuer-url: 'https://auth.streamnative.cloud/'
        private-key: '{{ file://YOUR-KEY-FILE-PATH }}' # TODO Absolute file path of your downloaded key file
        audience: '{{ YOUR-AUDIENCE }}'

service-url: the broker service URL of your Pulsar cluster.
issuer-url: the URL of your OAuth2 authentication provider. You can get the value from your downloaded OAuth2 credential file.
private-key: the path to your downloaded OAuth2 credential file. The privateKey parameter supports the following three pattern formats:
- file:///path/to/file
- file:/path/to/file
- data:application/json;base64,<base64-encoded value>
audience: the audience parameter is the Uniform Resource Name (URN), which is a combination of the urn:sn:pulsar, the organization name, and the Pulsar instance name, in this format urn:sn:pulsar:<org_name>:<instance_name>.

Create a Spring consumer to consume messages

 @SpringBootApplication
 public class PulsarBootHelloWorld {

     public static void main(String[] args) {
         SpringApplication.run(PulsarBootHelloWorld.class, args);
     }

     @PulsarListener(subscriptionName = "test-sub", topics = "persistent://public/default/test-topic")
     void listen(String message) {
         System.out.println("Message Received: " + message);
     }

 }

Create a Spring producer to produce messages

 @SpringBootApplication
 public class PulsarBootHelloWorld {

     public static void main(String[] args) {
         SpringApplication.run(PulsarBootHelloWorld.class, args);
     }

     @Bean
     ApplicationRunner runner(PulsarTemplate<String> pulsarTemplate) {
         return (args) -> pulsarTemplate.send("persistent://public/default/test-topic", "Hello Pulsar World!");
     }

 }

Connect to cluster through Token authentication

To connect a Pulsar cluster through Token authentication, follow these steps.

Step 1: Get the broker service URL of your cluster

To get the service URL of a Pulsar cluster through the StreamNative Cloud Console, follow these steps.

On the left navigation pane, in the Admin area, click Pulsar Clusters.
Select the Overview tab, and in the Access Points area, click Copy at the end of the row of the service URL.

Step 2: Get the Token of your service account

Note

Before getting the token of a service account, verify that the service account is authorized as a superuser or an admin of the tenants and namespaces.

To get a token using the StreamNative Cloud Console, follow these steps.

On the left navigation pane, click Service Accounts.
In the row of the service account you want to use, in the Token column, click Generate new token, then click the Copy icon to copy the token to your clipboard.

Note

A token has a system-defined Time-To-Live (TTL) of 7 days. Before a token expires, ensure that you generate a new token for your service account.

Step 3: Connect to your cluster

spring:
  pulsar:
    client:
      service-url: { { SERVICE_URL } }
      auth-plugin-class-name: org.apache.pulsar.client.impl.auth.AuthenticationToken
      authentication:
        token: { { AUTH_PARAMS_TOKE } }

service-url: the broker service URL of your Pulsar cluster.
token: the token of your service account.

For a complete example about how to connect to a cluster through the Spring client, see Spring client examples.