io.micronaut.nats

Interface ConsumerRegistry

All Known Implementing Classes:

NatsConsumerAdvice

public interface ConsumerRegistry

A registry for created Nats consumers.

Since:

3.1.0

Author:

jgrimm

Method Summary

Modifier and Type	Method and Description
io.nats.client.Consumer	getConsumer(java.lang.String id) Returns the subscription by given id.
java.util.Set<java.lang.String>	getConsumerIds() The IDs of the available consumers.
java.util.Set<io.nats.client.Subscription>	getConsumerSubscription(java.lang.String id) Returns a managed Consumer's subscriptions.
io.nats.client.Subscription	newSubscription(java.lang.String subject, java.lang.String queue) Create a new subscription with the default connection.
io.nats.client.Subscription	newSubscription(java.lang.String connectionName, java.lang.String subject, java.lang.String queue) Create a new subscription from the given connection name.

Method Detail

getConsumer

@NonNull
io.nats.client.Consumer getConsumer(@NonNull
                                             java.lang.String id)

Returns the subscription by given id.

Parameters:

id - String The id of the listener

Returns:

The consumer

Throws:

java.lang.IllegalArgumentException - If no listener exists for the given ID

getConsumerIds

@NonNull
java.util.Set<java.lang.String> getConsumerIds()

The IDs of the available consumers.

Returns:

The consumers

getConsumerSubscription

@NonNull
java.util.Set<io.nats.client.Subscription> getConsumerSubscription(@NonNull
                                                                            java.lang.String id)

Returns a managed Consumer's subscriptions.

Parameters:

id - The id of the producer.

Returns:

The consumer subscription

Throws:

java.lang.IllegalArgumentException - If no consumer exists for the given ID

newSubscription

io.nats.client.Subscription newSubscription(@NonNull
                                            java.lang.String subject,
                                            @Nullable
                                            java.lang.String queue)

Create a new subscription with the default connection.

Parameters:

subject - String

queue - String optional

Returns:

subscription Subscription

newSubscription

io.nats.client.Subscription newSubscription(@NonNull
                                            java.lang.String connectionName,
                                            @NonNull
                                            java.lang.String subject,
                                            @Nullable
                                            java.lang.String queue)

Create a new subscription from the given connection name.

Parameters:

connectionName - String

subject - String

queue - String optional

Returns:

subscription Subscription