io.nats.client

Interface JetStreamManagement

public interface JetStreamManagement

JetStream Management context for creation and access to streams and consumers in NATS.

Method Summary

Modifier and Type	Method and Description
ConsumerInfo	addOrUpdateConsumer(java.lang.String streamName, ConsumerConfiguration config) Loads or creates a consumer.
StreamInfo	addStream(StreamConfiguration config) Loads or creates a stream.
boolean	deleteConsumer(java.lang.String streamName, java.lang.String consumer) Deletes a consumer.
boolean	deleteMessage(java.lang.String streamName, long seq) Deletes a message.
boolean	deleteStream(java.lang.String streamName) Deletes an existing stream.
AccountStatistics	getAccountStatistics() Gets the account statistics for the logged in account.
ConsumerInfo	getConsumerInfo(java.lang.String streamName, java.lang.String consumer) Gets the info for an existing consumer.
java.util.List<java.lang.String>	getConsumerNames(java.lang.String streamName) Return a list of consumers by name
java.util.List<ConsumerInfo>	getConsumers(java.lang.String streamName) Return a list of ConsumerInfo objects.
MessageInfo	getMessage(java.lang.String streamName, long seq) Return an info object about a message
StreamInfo	getStreamInfo(java.lang.String streamName) Gets the info for an existing stream.
java.util.List<java.lang.String>	getStreamNames() Return a list of streams by name
java.util.List<StreamInfo>	getStreams() Return a list of StreamInfo objects.
PurgeResponse	purgeStream(java.lang.String streamName) Purge stream messages
PurgeResponse	purgeStream(java.lang.String streamName, PurgeOptions options) Purge messages for a specific subject
StreamInfo	updateStream(StreamConfiguration config) Updates an existing stream.

Method Detail

getAccountStatistics

AccountStatistics getAccountStatistics()
                                throws java.io.IOException,
                                       JetStreamApiException

Gets the account statistics for the logged in account.

Returns:

account statistics

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

java.lang.IllegalArgumentException - the server is not JetStream enabled

addStream

StreamInfo addStream(StreamConfiguration config)
              throws java.io.IOException,
                     JetStreamApiException

Loads or creates a stream.

Parameters:

config - the stream configuration to use.

Returns:

stream information

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

java.lang.IllegalArgumentException - the configuration is missing or invalid

updateStream

StreamInfo updateStream(StreamConfiguration config)
                 throws java.io.IOException,
                        JetStreamApiException

Updates an existing stream.

Parameters:

config - the stream configuration to use.

Returns:

stream information

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

java.lang.IllegalArgumentException - the configuration is missing or invalid

deleteStream

boolean deleteStream(java.lang.String streamName)
              throws java.io.IOException,
                     JetStreamApiException

Deletes an existing stream.

Parameters:

streamName - the stream name to use.

Returns:

true if the delete succeeded

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

getStreamInfo

StreamInfo getStreamInfo(java.lang.String streamName)
                  throws java.io.IOException,
                         JetStreamApiException

Gets the info for an existing stream.

Parameters:

streamName - the stream name to use.

Returns:

stream information

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

purgeStream

PurgeResponse purgeStream(java.lang.String streamName)
                   throws java.io.IOException,
                          JetStreamApiException

Purge stream messages

Parameters:

streamName - the stream name to use.

Returns:

PurgeResponse the purge response

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

purgeStream

PurgeResponse purgeStream(java.lang.String streamName,
                          PurgeOptions options)
                   throws java.io.IOException,
                          JetStreamApiException

Purge messages for a specific subject

Parameters:

streamName - the stream name to use.

options - the purge options

Returns:

PurgeResponse the purge response

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

addOrUpdateConsumer

ConsumerInfo addOrUpdateConsumer(java.lang.String streamName,
                                 ConsumerConfiguration config)
                          throws java.io.IOException,
                                 JetStreamApiException

Loads or creates a consumer.

Parameters:

streamName - name of the stream

config - the consumer configuration to use.

Returns:

consumer information.

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

deleteConsumer

boolean deleteConsumer(java.lang.String streamName,
                       java.lang.String consumer)
                throws java.io.IOException,
                       JetStreamApiException

Deletes a consumer.

Parameters:

streamName - name of the stream

consumer - the name of the consumer.

Returns:

true if the delete succeeded

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

getConsumerInfo

ConsumerInfo getConsumerInfo(java.lang.String streamName,
                             java.lang.String consumer)
                      throws java.io.IOException,
                             JetStreamApiException

Gets the info for an existing consumer.

Parameters:

streamName - name of the stream

consumer - the consumer name to use.

Returns:

consumer information

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

getConsumerNames

java.util.List<java.lang.String> getConsumerNames(java.lang.String streamName)
                                           throws java.io.IOException,
                                                  JetStreamApiException

Return a list of consumers by name

Parameters:

streamName - the name of the stream.

Returns:

The list of names

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

getConsumers

java.util.List<ConsumerInfo> getConsumers(java.lang.String streamName)
                                   throws java.io.IOException,
                                          JetStreamApiException

Return a list of ConsumerInfo objects.

Parameters:

streamName - the name of the stream.

Returns:

The list of ConsumerInfo

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

getStreamNames

java.util.List<java.lang.String> getStreamNames()
                                         throws java.io.IOException,
                                                JetStreamApiException

Return a list of streams by name

Returns:

The list of names

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

getStreams

java.util.List<StreamInfo> getStreams()
                               throws java.io.IOException,
                                      JetStreamApiException

Return a list of StreamInfo objects.

Returns:

The list of StreamInfo

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

getMessage

MessageInfo getMessage(java.lang.String streamName,
                       long seq)
                throws java.io.IOException,
                       JetStreamApiException

Return an info object about a message

Parameters:

streamName - the name of the stream.

seq - the sequence number of the message

Returns:

The MessageInfo

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

deleteMessage

boolean deleteMessage(java.lang.String streamName,
                      long seq)
               throws java.io.IOException,
                      JetStreamApiException

Deletes a message.

Parameters:

streamName - name of the stream

seq - the sequence number of the message

Returns:

true if the delete succeeded

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