JetStream (NATS.IO Java API)

```
public interface JetStream
```
JetStream context for creation and access to streams and consumers in NATS.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ConsumerContext`	`getConsumerContext(java.lang.String streamName, java.lang.String consumerName)` Get a consumer context for a specific named stream and specific named consumer.
`StreamContext`	`getStreamContext(java.lang.String streamName)` Get a stream context for a specific named stream.
`PublishAck`	`publish(Message message)` Send a message to the specified subject and waits for a response from Jetstream.
`PublishAck`	`publish(Message message, PublishOptions options)` Send a message to the specified subject and waits for a response from Jetstream.
`PublishAck`	`publish(java.lang.String subject, byte[] body)` Send a message to the specified subject and waits for a response from Jetstream.
`PublishAck`	`publish(java.lang.String subject, byte[] body, PublishOptions options)` Send a message to the specified subject and waits for a response from Jetstream.
`PublishAck`	`publish(java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body)` Send a message to the specified subject and waits for a response from Jetstream.
`PublishAck`	`publish(java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body, PublishOptions options)` Send a message to the specified subject and waits for a response from Jetstream.
`java.util.concurrent.CompletableFuture<PublishAck>`	`publishAsync(Message message)` Send a message to the specified subject but does not wait for a response from Jetstream.
`java.util.concurrent.CompletableFuture<PublishAck>`	`publishAsync(Message message, PublishOptions options)` Send a message to the specified subject but does not wait for a response from Jetstream.
`java.util.concurrent.CompletableFuture<PublishAck>`	`publishAsync(java.lang.String subject, byte[] body)` Send a message to the specified subject but does not wait for a response from Jetstream.
`java.util.concurrent.CompletableFuture<PublishAck>`	`publishAsync(java.lang.String subject, byte[] body, PublishOptions options)` Send a message to the specified subject but does not wait for a response from Jetstream.
`java.util.concurrent.CompletableFuture<PublishAck>`	`publishAsync(java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body)` Send a message to the specified subject but does not wait for a response from Jetstream.
`java.util.concurrent.CompletableFuture<PublishAck>`	`publishAsync(java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body, PublishOptions options)` Send a message to the specified subject but does not wait for a response from Jetstream.
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject)` Create a synchronous subscription to the specified subject with default options.
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject, Dispatcher dispatcher, MessageHandler handler, boolean autoAck)` Create an asynchronous subscription to the specified subject under the control of the specified dispatcher.
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject, Dispatcher dispatcher, MessageHandler handler, boolean autoAck, PushSubscribeOptions options)` Create an asynchronous subscription to the specified subject under the control of the specified dispatcher.
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject, Dispatcher dispatcher, MessageHandler handler, PullSubscribeOptions options)` Create an asynchronous subscription to the specified subject in the mode of pull, with additional options
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject, PullSubscribeOptions options)` Create a subscription to the specified subject in the mode of pull, with additional options
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject, PushSubscribeOptions options)` Create a synchronous subscription to the specified subject.
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject, java.lang.String queue, Dispatcher dispatcher, MessageHandler handler, boolean autoAck, PushSubscribeOptions options)` Create an asynchronous subscription to the specified subject under the control of the specified dispatcher.
`JetStreamSubscription`	`subscribe(java.lang.String subscribeSubject, java.lang.String queue, PushSubscribeOptions options)` Create a synchronous subscription to the specified subject.

- Method Detail
  - publish
```
PublishAck publish(java.lang.String subject,
                   byte[] body)
            throws java.io.IOException,
                   JetStreamApiException
```
    Send a message to the specified subject and waits for a response from Jetstream. The default publish options will be used. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 js.publish("destination", "message".getBytes("UTF-8"))
 
```
    where the sender creates a byte array immediately before calling publish.
    Parameters:
    
    subject - the subject to send the message to
    
    body - the message body
    
    Returns:
    
    The acknowledgement of the publish
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - publish
```
PublishAck publish(java.lang.String subject,
                   io.nats.client.impl.Headers headers,
                   byte[] body)
            throws java.io.IOException,
                   JetStreamApiException
```
    Send a message to the specified subject and waits for a response from Jetstream. The default publish options will be used. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 Headers h = new Headers().put("foo", "bar");
 js.publish("destination", h, "message".getBytes("UTF-8"))
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect.
    Parameters:
    
    subject - the subject to send the message to
    
    headers - Optional headers to publish with the message.
    
    body - the message body
    
    Returns:
    
    The acknowledgement of the publish
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - publish
```
PublishAck publish(java.lang.String subject,
                   byte[] body,
                   PublishOptions options)
            throws java.io.IOException,
                   JetStreamApiException
```
    Send a message to the specified subject and waits for a response from Jetstream. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 js.publish("destination", "message".getBytes("UTF-8"), publishOptions)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect.
    Parameters:
    
    subject - the subject to send the message to
    
    body - the message body
    
    options - publisher options
    
    Returns:
    
    The acknowledgement of the publish
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - publish
```
PublishAck publish(java.lang.String subject,
                   io.nats.client.impl.Headers headers,
                   byte[] body,
                   PublishOptions options)
            throws java.io.IOException,
                   JetStreamApiException
```
    Send a message to the specified subject and waits for a response from Jetstream. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 Headers h = new Headers().put("foo", "bar");
 js.publish("destination", h, "message".getBytes("UTF-8"), publishOptions)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect.
    Parameters:
    
    subject - the subject to send the message to
    
    headers - Optional headers to publish with the message.
    
    body - the message body
    
    options - publisher options
    
    Returns:
    
    The acknowledgement of the publish
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - publish
```
PublishAck publish(Message message)
            throws java.io.IOException,
                   JetStreamApiException
```
    Send a message to the specified subject and waits for a response from Jetstream. The default publish options will be used. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 js.publish(message)
 
```
    where the sender creates a byte array immediately before calling publish.
    The Message object allows you to set a replyTo, but in publish requests, the replyTo is reserved for internal use as the address for the server to respond to the client with the PublishAck.
    See publish() for more details on publish during reconnect.
    Parameters:
    
    message - the message to send
    
    Returns:
    
    The acknowledgement of the publish
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - publish
```
PublishAck publish(Message message,
                   PublishOptions options)
            throws java.io.IOException,
                   JetStreamApiException
```
    Send a message to the specified subject and waits for a response from Jetstream. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 js.publish(message, publishOptions)
 
```
    where the sender creates a byte array immediately before calling publish.
    The Message object allows you to set a replyTo, but in publish requests, the replyTo is reserved for internal use as the address for the server to respond to the client with the PublishAck.
    See publish() for more details on publish during reconnect.
    Parameters:
    
    message - the message to send
    
    options - publisher options
    
    Returns:
    
    The acknowledgement of the publish
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - publishAsync
```
java.util.concurrent.CompletableFuture<PublishAck> publishAsync(java.lang.String subject,
                                                                byte[] body)
```
    Send a message to the specified subject but does not wait for a response from Jetstream. The default publish options will be used. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 CompletableFuture<PublishAck> future =
     js.publishAsync("destination", "message".getBytes("UTF-8"),)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect. The future me be completed with an exception, either an IOException covers various communication issues with the NATS server such as timeout or interruption - or - a JetStreamApiException the request had an error related to the data
    Parameters:
    
    subject - the subject to send the message to
    
    body - the message body
    
    Returns:
    
    The future
  - publishAsync
```
java.util.concurrent.CompletableFuture<PublishAck> publishAsync(java.lang.String subject,
                                                                io.nats.client.impl.Headers headers,
                                                                byte[] body)
```
    Send a message to the specified subject but does not wait for a response from Jetstream. The default publish options will be used. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 Headers h = new Headers().put("foo", "bar");
 CompletableFuture<PublishAck> future =
     js.publishAsync("destination", h, "message".getBytes("UTF-8"),)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect. The future me be completed with an exception, either an IOException covers various communication issues with the NATS server such as timeout or interruption - or - a JetStreamApiException the request had an error related to the data
    Parameters:
    
    subject - the subject to send the message to
    
    headers - Optional headers to publish with the message.
    
    body - the message body
    
    Returns:
    
    The future
  - publishAsync
```
java.util.concurrent.CompletableFuture<PublishAck> publishAsync(java.lang.String subject,
                                                                byte[] body,
                                                                PublishOptions options)
```
    Send a message to the specified subject but does not wait for a response from Jetstream. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 CompletableFuture<PublishAck> future =
     js.publishAsync("destination", "message".getBytes("UTF-8"), publishOptions)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect. The future me be completed with an exception, either an IOException covers various communication issues with the NATS server such as timeout or interruption - or - a JetStreamApiException the request had an error related to the data
    Parameters:
    
    subject - the subject to send the message to
    
    body - the message body
    
    options - publisher options
    
    Returns:
    
    The future
  - publishAsync
```
java.util.concurrent.CompletableFuture<PublishAck> publishAsync(java.lang.String subject,
                                                                io.nats.client.impl.Headers headers,
                                                                byte[] body,
                                                                PublishOptions options)
```
    Send a message to the specified subject but does not wait for a response from Jetstream. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 Headers h = new Headers().put("foo", "bar");
 CompletableFuture<PublishAck> future =
     js.publishAsync("destination", h, "message".getBytes("UTF-8"), publishOptions)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect. The future me be completed with an exception, either an IOException covers various communication issues with the NATS server such as timeout or interruption - or - a JetStreamApiException the request had an error related to the data
    Parameters:
    
    subject - the subject to send the message to
    
    headers - Optional headers to publish with the message.
    
    body - the message body
    
    options - publisher options
    
    Returns:
    
    The future
  - publishAsync
```
java.util.concurrent.CompletableFuture<PublishAck> publishAsync(Message message)
```
    Send a message to the specified subject but does not wait for a response from Jetstream. The default publish options will be used. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 CompletableFuture<PublishAck> future = js.publishAsync(message)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect. The future me be completed with an exception, either an IOException covers various communication issues with the NATS server such as timeout or interruption - or - a JetStreamApiException the request had an error related to the data
    The Message object allows you to set a replyTo, but in publish requests, the replyTo is reserved for internal use as the address for the server to respond to the client with the PublishAck.
    Parameters:
    
    message - the message to send
    
    Returns:
    
    The future
  - publishAsync
```
java.util.concurrent.CompletableFuture<PublishAck> publishAsync(Message message,
                                                                PublishOptions options)
```
    Send a message to the specified subject but does not wait for a response from Jetstream. The message body will not be copied. The expected usage with string content is something like:
```
 nc = Nats.connect()
 JetStream js = nc.JetStream()
 CompletableFuture<PublishAck> future = js.publishAsync(message, publishOptions)
 
```
    where the sender creates a byte array immediately before calling publish. See publish() for more details on publish during reconnect. The future me be completed with an exception, either an IOException covers various communication issues with the NATS server such as timeout or interruption - or - a JetStreamApiException the request had an error related to the data
    The Message object allows you to set a replyTo, but in publish requests, the replyTo is reserved for internal use as the address for the server to respond to the client with the PublishAck.
    Parameters:
    
    message - the message to publish
    
    options - publisher options
    
    Returns:
    
    The future
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create a synchronous subscription to the specified subject with default options.
    Use the Subscription.nextMessage(Duration) method to read messages for this subscription.
    See createDispatcher for information about creating an asynchronous subscription with callbacks.
    
    Parameters:
    
    subscribeSubject - the subject to subscribe to
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject,
                                PushSubscribeOptions options)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create a synchronous subscription to the specified subject.
    Use the Subscription.nextMessage(Duration) method to read messages for this subscription.
    See createDispatcher for information about creating an asynchronous subscription with callbacks.
    
    Parameters:
    
    subscribeSubject - the subject to subscribe to. Can be null or empty when the options have a ConsumerConfiguration that supplies a filter subject.
    
    options - optional subscription options
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject,
                                java.lang.String queue,
                                PushSubscribeOptions options)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create a synchronous subscription to the specified subject.
    Use the nextMessage method to read messages for this subscription.
    See createDispatcher for information about creating an asynchronous subscription with callbacks.
    
    Parameters:
    
    subscribeSubject - the subject to subscribe to Can be null or empty when the options have a ConsumerConfiguration that supplies a filter subject.
    
    queue - the optional queue group to join
    
    options - optional subscription options
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject,
                                Dispatcher dispatcher,
                                MessageHandler handler,
                                boolean autoAck)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create an asynchronous subscription to the specified subject under the control of the specified dispatcher. Since a MessageHandler is also required, the Dispatcher will not prevent duplicate subscriptions from being made.
    
    Parameters:
    
    subscribeSubject - The subject to subscribe to
    
    dispatcher - The dispatcher to handle this subscription
    
    handler - The target for the messages
    
    autoAck - Whether to auto ack
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject,
                                Dispatcher dispatcher,
                                MessageHandler handler,
                                boolean autoAck,
                                PushSubscribeOptions options)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create an asynchronous subscription to the specified subject under the control of the specified dispatcher. Since a MessageHandler is also required, the Dispatcher will not prevent duplicate subscriptions from being made.
    
    Parameters:
    
    subscribeSubject - The subject to subscribe to. Can be null or empty when the options have a ConsumerConfiguration that supplies a filter subject.
    
    dispatcher - The dispatcher to handle this subscription
    
    handler - The target for the messages
    
    autoAck - Whether to auto ack
    
    options - The options for this subscription.
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject,
                                java.lang.String queue,
                                Dispatcher dispatcher,
                                MessageHandler handler,
                                boolean autoAck,
                                PushSubscribeOptions options)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create an asynchronous subscription to the specified subject under the control of the specified dispatcher. Since a MessageHandler is also required, the Dispatcher will not prevent duplicate subscriptions from being made.
    
    Parameters:
    
    subscribeSubject - The subject to subscribe to. Can be null or empty when the options have a ConsumerConfiguration that supplies a filter subject.
    
    queue - the optional queue group to join
    
    dispatcher - The dispatcher to handle this subscription
    
    handler - The target for the messages
    
    autoAck - Whether to auto ack
    
    options - optional subscription options
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject,
                                PullSubscribeOptions options)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create a subscription to the specified subject in the mode of pull, with additional options
    
    Parameters:
    
    subscribeSubject - The subject to subscribe to Can be null or empty when the options have a ConsumerConfiguration that supplies a filter subject.
    
    options - pull subscription options
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - subscribe
```
JetStreamSubscription subscribe(java.lang.String subscribeSubject,
                                Dispatcher dispatcher,
                                MessageHandler handler,
                                PullSubscribeOptions options)
                         throws java.io.IOException,
                                JetStreamApiException
```
    Create an asynchronous subscription to the specified subject in the mode of pull, with additional options
    
    Parameters:
    
    subscribeSubject - The subject to subscribe to Can be null or empty when the options have a ConsumerConfiguration that supplies a filter subject.
    
    dispatcher - The dispatcher to handle this subscription
    
    handler - The target for the messages
    
    options - pull subscription options
    
    Returns:
    
    The subscription
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - getStreamContext
```
StreamContext getStreamContext(java.lang.String streamName)
                        throws java.io.IOException,
                               JetStreamApiException
```
    Get a stream context for a specific named stream. Verifies that the stream exists.
    
    Parameters:
    
    streamName - the name of the stream
    
    Returns:
    
    a StreamContext object
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data
  - getConsumerContext
```
ConsumerContext getConsumerContext(java.lang.String streamName,
                                   java.lang.String consumerName)
                            throws java.io.IOException,
                                   JetStreamApiException
```
    Get a consumer context for a specific named stream and specific named consumer. Verifies that the stream and consumer exist.
    
    Parameters:
    
    streamName - the name of the stream
    
    consumerName - the name of the consumer
    
    Returns:
    
    a ConsumerContext object
    
    Throws:
    
    java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption
    
    JetStreamApiException - the request had an error related to the data

Interface JetStream

Method Summary

Method Detail

publish

publish

publish

publish

publish

publish

publishAsync

publishAsync

publishAsync

publishAsync

publishAsync

publishAsync

subscribe

subscribe

subscribe

subscribe

subscribe

subscribe

subscribe

subscribe

getStreamContext

getConsumerContext