Package io.nats.client

The Java NATS client is encapsulated into this single package io.nats.client.

See: Description

Interface Summary

Interface	Description
AuthHandler	NATS provides a challenge-response based authentication scheme based on NKeys.
Connection	The Connection class is at the heart of the NATS Java client.
ConnectionListener	Applications can use a ConnectionListener to track the status of a Connection.
Consumer	A Consumer in the NATS library is an object that represents an incoming queue of messages.
Dispatcher	This library uses the concept of a Dispatcher to organize message callbacks in a way that the application can control.
ErrorListener	This library groups problems into four categories: Errors The server sent an error message using the -err protocol operation. Exceptions A Java exception occurred, and was handled by the library. Slow Consumers One of the connections consumers, Subscription or Dispatcher, is slow, and starting to drop messages. Fast Producers One of the connections producers is too fast, and is discarding messages
JetStream	JetStream context for creation and access to streams and consumers in NATS.
JetStreamManagement	JetStream Management context for creation and access to streams and consumers in NATS.
JetStreamSubscription	Subscription on a JetStream context.
KeyValue	Key Value Store Management context for creation and access to key value buckets.
KeyValueManagement	Key Value Store Management context for creation and access to key value buckets.
Message	The NATS library uses a Message object to encapsulate incoming messages.
MessageHandler	Dispatchers use the MessageHandler interface to define the listener for their messages.
ReconnectDelayHandler	Allows the developer to provide the duration of time to before reconnecting a second or more time through the servers list
Statistics	Connections can provide an instance of Statistics, getStatistics().
Subscription	A Subscription encapsulates an incoming queue of messages associated with a single subject and optional queue name.

Class Summary

Class	Description
JetStreamOptions	The JetStreamOptions class specifies the general options for JetStream.
JetStreamOptions.Builder	JetStreamOptions can be created using a Builder.
Nats	The Nats class is the entry point into the NATS client for Java.
NKey	The NATS ecosystem will be moving to Ed25519 keys for identity, authentication and authorization for entities such as Accounts, Users, Servers and Clusters.
NUID	A highly performant unique identifier generator.
Options	The Options class specifies the connection options for a new NATs connection, including the default options.
Options.Builder	Options are created using a Builder.
PublishOptions	The PublishOptions class specifies the options for publishing with JetStream enabled servers.
PublishOptions.Builder	PublishOptions are created using a Builder.
PullSubscribeOptions	The PullSubscribeOptions class specifies the options for subscribing with JetStream enabled servers.
PullSubscribeOptions.Builder	PullSubscribeOptions can be created using a Builder.
PurgeOptions	The PurgeOptions class specifies the options for purging a stream
PurgeOptions.Builder
PushSubscribeOptions	The PushSubscribeOptions class specifies the options for subscribing with JetStream enabled servers.
PushSubscribeOptions.Builder	PushSubscribeOptions can be created using a Builder.
SubscribeOptions	The PushSubscribeOptions class specifies the options for subscribing with JetStream enabled servers.
SubscribeOptions.Builder<B,SO>	PushSubscribeOptions can be created using a Builder.

Enum Summary

Enum	Description
Connection.Status
ConnectionListener.Events
NKey.Type	NKeys use a prefix byte to indicate their intended owner: 'N' = server, 'C' = cluster, 'A' = account, and 'U' = user.

Exception Summary

Exception	Description
AuthenticationException	AuthenticationException is used when the connect process fails due to an authentication problem.
JetStreamApiException	JetStreamApiException is used to indicate that the server returned an error while make a request related to JetStream.

Package io.nats.client Description

The Java NATS client is encapsulated into this single package io.nats.client. Applications will start from the Nats class to connect to the NATS server. Once connected, they can use the Connection object to publish messages or create subscriptions.

Since:

2.0.0