io.nats.client.utility

Class Retrier

java.lang.Object

io.nats.client.utility.Retrier

public class Retrier
extends java.lang.Object

The Retrier is designed to give generic retry ability to retry anything. There are also static methods which are use the generic ability that are built specifically for JetStream publishing.

THIS CLASS IS EXPERIMENTAL AND THE API IS SUBJECT TO CHANGE

Method Summary

Modifier and Type	Method and Description
static <T> T	execute(RetryConfig config, RetryAction<T> action) Execute the supplied action with the given retry config.
static <T> T	execute(RetryConfig config, RetryAction<T> action, RetryObserver observer) Execute the supplied action with the given retry config.
static PublishAck	publish(JetStream js, Message message) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.
static PublishAck	publish(JetStream js, Message message, PublishOptions options) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.
static PublishAck	publish(JetStream js, java.lang.String subject, byte[] body) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.
static PublishAck	publish(JetStream js, java.lang.String subject, byte[] body, PublishOptions options) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.
static PublishAck	publish(JetStream js, 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, retrying until the ack is received or the default retry config is exhausted.
static PublishAck	publish(JetStream js, 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, retrying until the ack is received or the default retry config is exhausted.
static PublishAck	publish(RetryConfig config, JetStream js, Message message) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.
static PublishAck	publish(RetryConfig config, JetStream js, Message message, PublishOptions options) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.
static PublishAck	publish(RetryConfig config, JetStream js, java.lang.String subject, byte[] body) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.
static PublishAck	publish(RetryConfig config, JetStream js, java.lang.String subject, byte[] body, PublishOptions options) Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.
static PublishAck	publish(RetryConfig config, JetStream js, 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, retrying until the ack is received or the retry config is exhausted.
static PublishAck	publish(RetryConfig config, JetStream js, 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, retrying until the ack is received or the retry config is exhausted.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(JetStream js, Message message) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(JetStream js, Message message, PublishOptions options) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(JetStream js, java.lang.String subject, byte[] body) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(JetStream js, java.lang.String subject, byte[] body, PublishOptions options) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(JetStream js, java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(JetStream js, java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body, PublishOptions options) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(RetryConfig config, JetStream js, Message message) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(RetryConfig config, JetStream js, Message message, PublishOptions options) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(RetryConfig config, JetStream js, java.lang.String subject, byte[] body) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(RetryConfig config, JetStream js, java.lang.String subject, byte[] body, PublishOptions options) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(RetryConfig config, JetStream js, java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body) Send a message to the specified subject, executing in a future.
static java.util.concurrent.CompletableFuture<PublishAck>	publishAsync(RetryConfig config, JetStream js, java.lang.String subject, io.nats.client.impl.Headers headers, byte[] body, PublishOptions options) Send a message to the specified subject, executing in a future.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

execute

public static <T> T execute(RetryConfig config,
                            RetryAction<T> action)
                     throws java.lang.Exception

Execute the supplied action with the given retry config.

Type Parameters:

T - the return type

Parameters:

config - The custom retry config

action - The retry action

Returns:

an instance of the return type

Throws:

java.lang.Exception - various execution exceptions; only thrown if all retries failed.

execute

public static <T> T execute(RetryConfig config,
                            RetryAction<T> action,
                            RetryObserver observer)
                     throws java.lang.Exception

Execute the supplied action with the given retry config.

Type Parameters:

T - the return type

Parameters:

config - The custom retry config

action - The retry action

observer - The retry observer

Returns:

an instance of the return type

Throws:

java.lang.Exception - various execution exceptions; only thrown if all retries failed or the observer declines to retry.

publish

public static PublishAck publish(RetryConfig config,
                                 JetStream js,
                                 java.lang.String subject,
                                 io.nats.client.impl.Headers headers,
                                 byte[] body,
                                 PublishOptions options)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

subject - the subject to send the message to

headers - optional headers to publish with the message.

body - the message body

options - publish options

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(RetryConfig config,
                                 JetStream js,
                                 java.lang.String subject,
                                 byte[] body)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

subject - the subject to send the message to

body - the message body

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(RetryConfig config,
                                 JetStream js,
                                 java.lang.String subject,
                                 io.nats.client.impl.Headers headers,
                                 byte[] body)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

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.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(RetryConfig config,
                                 JetStream js,
                                 java.lang.String subject,
                                 byte[] body,
                                 PublishOptions options)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

subject - the subject to send the message to

body - the message body

options - publish options

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(RetryConfig config,
                                 JetStream js,
                                 Message message)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

message - the message to publish

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(RetryConfig config,
                                 JetStream js,
                                 Message message,
                                 PublishOptions options)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

message - the message to publish

options - publish options

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(JetStream js,
                                 java.lang.String subject,
                                 io.nats.client.impl.Headers headers,
                                 byte[] body,
                                 PublishOptions options)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.

Parameters:

js - the JetStream context

subject - the subject to send the message to

headers - optional headers to publish with the message.

body - the message body

options - publish options

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(JetStream js,
                                 java.lang.String subject,
                                 byte[] body)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.

Parameters:

js - the JetStream context

subject - the subject to send the message to

body - the message body

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(JetStream js,
                                 java.lang.String subject,
                                 io.nats.client.impl.Headers headers,
                                 byte[] body)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.

Parameters:

js - the JetStream context

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.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(JetStream js,
                                 java.lang.String subject,
                                 byte[] body,
                                 PublishOptions options)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.

Parameters:

js - the JetStream context

subject - the subject to send the message to

body - the message body

options - publish options

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(JetStream js,
                                 Message message)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the default retry config is exhausted.

Parameters:

js - the JetStream context

message - the message to publish

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publish

public static PublishAck publish(JetStream js,
                                 Message message,
                                 PublishOptions options)
                          throws java.lang.Exception

Send a message to the specified subject and waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

js - the JetStream context

message - the message to publish

options - publish options

Returns:

The acknowledgement of the publish

Throws:

java.lang.Exception - various communication issues with the NATS server; only thrown if all retries failed.

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(RetryConfig config,
                                                                              JetStream js,
                                                                              java.lang.String subject,
                                                                              io.nats.client.impl.Headers headers,
                                                                              byte[] body,
                                                                              PublishOptions options)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

subject - the subject to send the message to

headers - optional headers to publish with the message.

body - the message body

options - publish options

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(RetryConfig config,
                                                                              JetStream js,
                                                                              java.lang.String subject,
                                                                              byte[] body)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

subject - the subject to send the message to

body - the message body

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(RetryConfig config,
                                                                              JetStream js,
                                                                              java.lang.String subject,
                                                                              io.nats.client.impl.Headers headers,
                                                                              byte[] body)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

subject - the subject to send the message to

headers - optional headers to publish with the message.

body - the message body

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(RetryConfig config,
                                                                              JetStream js,
                                                                              java.lang.String subject,
                                                                              byte[] body,
                                                                              PublishOptions options)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

subject - the subject to send the message to

body - the message body

options - publish options

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(RetryConfig config,
                                                                              JetStream js,
                                                                              Message message)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

message - the message to publish

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(RetryConfig config,
                                                                              JetStream js,
                                                                              Message message,
                                                                              PublishOptions options)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

config - The custom retry config

js - the JetStream context

message - the message to publish

options - publish options

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(JetStream js,
                                                                              java.lang.String subject,
                                                                              io.nats.client.impl.Headers headers,
                                                                              byte[] body,
                                                                              PublishOptions options)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

js - the JetStream context

subject - the subject to send the message to

headers - optional headers to publish with the message.

body - the message body

options - publish options

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(JetStream js,
                                                                              java.lang.String subject,
                                                                              byte[] body)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

js - the JetStream context

subject - the subject to send the message to

body - the message body

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(JetStream js,
                                                                              java.lang.String subject,
                                                                              io.nats.client.impl.Headers headers,
                                                                              byte[] body)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

js - the JetStream context

subject - the subject to send the message to

headers - optional headers to publish with the message.

body - the message body

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(JetStream js,
                                                                              java.lang.String subject,
                                                                              byte[] body,
                                                                              PublishOptions options)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

js - the JetStream context

subject - the subject to send the message to

body - the message body

options - publish options

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(JetStream js,
                                                                              Message message)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

js - the JetStream context

message - the message to publish

Returns:

The future

publishAsync

public static java.util.concurrent.CompletableFuture<PublishAck> publishAsync(JetStream js,
                                                                              Message message,
                                                                              PublishOptions options)

Send a message to the specified subject, executing in a future. Waits for a response from Jetstream, retrying until the ack is received or the retry config is exhausted.

Parameters:

js - the JetStream context

message - the message to publish

options - publish options

Returns:

The future