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.
BaseConsumerContext	The Consumer Context provides a convenient interface around a defined JetStream Consumer
BaseMessageConsumer	The BaseMessageConsumer interface is the core interface replacing a subscription for a simplified consumer.
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.
ConsumerContext	The Consumer Context provides a convenient interface around a defined JetStream Consumer
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
FetchConsumer	A fetch consumer gets messages by calling nextMessage.
IterableConsumer	A simplified consumer that does endless consume on the style of an iterator
JetStream	JetStream context for access to streams and consumers in NATS.
JetStreamManagement	JetStream Management context for creation and access to streams and consumers in NATS.
JetStreamReader	This interface provides a simple iterative access to a pull consumer.
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.
MessageConsumer	The MessageConsumer interface is the core interface replacing a subscription for a simplified consumer.
MessageHandler	Dispatchers use the MessageHandler interface to define the listener for their messages.
MessageInfoHandler	Handler for MessageInfo.
NatsSystemClockProvider	Interface to implement to provide a custom clock implementation
ObjectStore	Object Store Management context for creation and access to key value buckets.
ObjectStoreManagement	Object Store Management context for creation and access to object stores.
OrderedConsumerContext	The Ordered Consumer and it's context provide a simplification interface to the ordered consumer behavior.
ReadListener	A listener that allows the user to track messages as soon as they come in off the wire.
ReconnectDelayHandler	Allows the developer to provide the duration of time to before reconnecting a second or more time through the servers list
ServerPool	Allows the developer to provide the list of servers to try for connecting/reconnecting
Statistics	Connections can provide an instance of Statistics, getStatistics().
StatisticsCollector	A collector for connection metrics.
StreamContext	The Stream Context provide a set of operations for managing the stream and its contents and for managing consumers.
Subscription	A Subscription encapsulates an incoming queue of messages associated with a single subject and optional queue name.
TimeTraceLogger	Interface to allow debug logging of some connection time tracing

Class Summary

Class	Description
BaseConsumeOptions	Base Consume Options are provided to customize the way the consume and fetch operate.
ConsumeOptions	Consume Options are provided to customize the consume operation.
ConsumeOptions.Builder	The Consume Options Builder
FeatureOptions	The FeatureOptions is a base class of general options for features.
FetchConsumeOptions	Fetch Consume Options are provided to customize the fetch operation.
FetchConsumeOptions.Builder	The builder for FetchConsumeOptions
ForceReconnectOptions	The PublishOptions class specifies the options for publishing with JetStream enabled servers.
ForceReconnectOptions.Builder	ForceReconnectOptions are created using a Builder.
JetStreamOptions	The JetStreamOptions class specifies the general options for JetStream.
JetStreamOptions.Builder	JetStreamOptions can be created using a Builder.
KeyValueOptions	The KeyValueOptions class specifies the general options for KeyValueO.
KeyValueOptions.Builder	KeyValueOptions can be created using a Builder.
MessageTtl	Class to make setting a per message ttl easier.
Nats	The Nats class is the entry point into the NATS client for Java.
NatsSystemClock	Bridge to the NatsSystemClockProvider implementation
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.
ObjectStoreOptions	The ObjectStoreOptions class specifies the general options for ObjectStore.
ObjectStoreOptions.Builder	ObjectStoreOptions can be created using a Builder.
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.
PullRequestOptions	The PullRequestOptions class specifies the options for pull requests
PullRequestOptions.Builder	The builder for PullRequestOptions
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	Builder class for PurgeOptions
PushSubscribeOptions	The PushSubscribeOptions class specifies the options for subscribing with JetStream enabled servers.
PushSubscribeOptions.Builder	PushSubscribeOptions can be created using a Builder.
SubscribeOptions	The SubscribeOptions is the base class for PushSubscribeOptions and PullSubscribeOptions

Enum Summary

Enum	Description
Connection.Status	Enum representing the status of a connection
ConnectionListener.Events	Enum for connection events
ErrorListener.FlowControlSource	Enum for the flow control source
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.
JetStreamStatusCheckedException	A checked version of a JetStreamStatusException
JetStreamStatusException	JetStreamStatusException is used to indicate an unknown status message was received.

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