io.nats.examples.jetstream.NatsJsPushSubBindDurable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jnats Show documentation
Client library for working with the NATS messaging system.
There is a newer version: 2.20.5
// Copyright 2021 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package io.nats.examples.jetstream;

import io.nats.client.*;
import io.nats.client.api.ConsumerConfiguration;
import io.nats.examples.ExampleArgs;
import io.nats.examples.ExampleUtils;

import java.nio.charset.StandardCharsets;
import java.time.Duration;

import static io.nats.examples.jetstream.NatsJsUtils.exitIfStreamNotExists;

/**
 * This example will demonstrate JetStream push subscribing with binding to an existing durable.
 * Run NatsJsPub first to setup message data.
 */
public class NatsJsPushSubBindDurable {
    static final String usageString =
        "\nUsage: java -cp  NatsJsPushSubBindDurable [-s server] [-strm stream] [-sub subject] [-mcnt msgCount] [-dur durable] [-deliver deliver]"
            + "\n\nDefault Values:"
            + "\n   [-strm]    example-stream"
            + "\n   [-sub]     example-subject"
            + "\n   [-dur]     bind-durable"
            + "\n   [-deliver] bind-deliver"
            + "\n   [-mcnt]    0"
            + "\n\nRun Notes:"
            + "\n   - make sure you have created and published to the stream and subject, maybe using the NatsJsPub example"
            + "\n   - msg_count < 1 will just loop until there are no more messages"
            + "\n\nUse tls:// or opentls:// to require tls, via the Default SSLContext\n"
            + "\nSet the environment variable NATS_NKEY to use challenge response authentication by setting a file containing your private key.\n"
            + "\nSet the environment variable NATS_CREDS to use JWT/NKey authentication by setting a file containing your user creds.\n"
            + "\nUse the URL in the -s server parameter for user/pass/token authentication.\n";

    public static void main(String[] args) {

        ExampleArgs exArgs = ExampleArgs.builder("Push Subscription Binding With Durable", args, usageString)
            .defaultStream("example-stream")
            .defaultSubject("example-subject")
            .defaultDurable("bind-durable")
            .defaultDeliverSubject("bind-deliver")
            .defaultMsgCount(0, true) // true indicated 0 means unlimited
            .build();

        int count = exArgs.msgCount < 1 ? Integer.MAX_VALUE : exArgs.msgCount;

        try (Connection nc = Nats.connect(ExampleUtils.createExampleOptions(exArgs.server, true))) {

            // The stream (and data) must exist
            exitIfStreamNotExists(nc, exArgs.stream);

            // The durable consumer must already exist. Usually it would be made in configuration
            // or via the NATS CLI but we are making it here.
            // Important: The consumer must have a deliver subject when made this way or it will be
            // understood to be a pull consumer by the server.
            // NOTE: If you ran this example already, the consumer will have been created
            //       This is not a problem if it is exactly the same. Most ConsumerConfiguration
            //       properties are not modifiable once created.
            ConsumerConfiguration cc = ConsumerConfiguration.builder()
                    .durable(exArgs.durable)
                    .deliverSubject(exArgs.deliverSubject)
                    .build();
            nc.jetStreamManagement().addOrUpdateConsumer(exArgs.stream, cc);

            // Create our JetStream context.
            JetStream js = nc.jetStream();

            // bind subscribe to the stream - either variety will work
            // V1. Version designed specifically for this purpose.
            PushSubscribeOptions so = PushSubscribeOptions.bind(exArgs.stream, exArgs.durable);

            // V2. optional long form
            // PushSubscribeOptions so = PushSubscribeOptions.builder()
            //     .bind(true)
            //     .stream(exArgs.stream)
            //     .durable(exArgs.durable)
            //     .build();

            // Subscribe synchronously, then just wait for messages.
            JetStreamSubscription sub = js.subscribe(exArgs.subject, so);
            nc.flush(Duration.ofSeconds(5));

            int red = 0;
            Message msg = sub.nextMessage(Duration.ofSeconds(1)); // timeout can be Duration or millis
            while (msg != null) {
                System.out.println("\nMessage Received:");
                if (msg.hasHeaders()) {
                    System.out.println("  Headers:");
                    for (String key: msg.getHeaders().keySet()) {
                        for (String value : msg.getHeaders().get(key)) {
                            System.out.printf("    %s: %s\n", key, value);
                        }
                    }
                }

                System.out.printf("  Subject: %s\n  Data: %s\n",
                    msg.getSubject(), new String(msg.getData(), StandardCharsets.UTF_8));
                System.out.println("  " + msg.metaData());

                // Because this is a synchronous subscriber, there's no auto-ack.
                // The default Consumer Configuration AckPolicy is Explicit
                // so we need to ack the message or it'll be redelivered.
                msg.ack();

                ++red;
                if (--count == 0) {
                    msg = null;
                }
                else {
                    msg = sub.nextMessage(1000); // timeout can be Duration or millis
                }
            }

            System.out.println("\n" + red + " message(s) were received.\n");

            sub.unsubscribe();
            nc.flush(Duration.ofSeconds(5));
        }
        catch (Exception e) {
            e.printStackTrace();
        }
    }
}