io.nats.connector.plugin

Interface NATSConnector

public interface NATSConnector

Interface for the utility class passed to the plug-in, allowing additional NATS functionality such as publishing messsages and subscribing to subjects.

Method Summary

Modifier and Type	Method and Description
void	flush() Flushes any pending NATS data.
io.nats.client.Connection	getConnection() Advanced API to get the NATS connection.
io.nats.client.ConnectionFactory	getConnectionFactory() Advanced API to get the Connection Factory, This allows for NATS functionality beyond the interface here.
void	publish(io.nats.client.Message message) Publishes a message into the NATS cluster.
void	shutdown() In case of a critical failure or security issue, this allows the plugin to request a shutdown of the connector.
void	subscribe(String subject) Adds interest in a NATS subject.
void	subscribe(String subject, io.nats.client.MessageHandler handler) Adds interest in a NATS subject, with a custom handle.
void	subscribe(String subject, String queue) Adds interest in a NATS subject with a queue group.
void	subscribe(String subject, String queue, io.nats.client.MessageHandler handler) Adds interest in a NATS subject with a queue group, with a custom handler.
void	unsubscribe(String subject) Removes interest in a NATS subject

Method Detail

shutdown

void shutdown()

In case of a critical failure or security issue, this allows the plugin to request a shutdown of the connector.

publish

void publish(io.nats.client.Message message)

Publishes a message into the NATS cluster.

Parameters:

message - - the message to publish.

flush

void flush()
    throws Exception

Flushes any pending NATS data.

Throws:

Exception - - an error occurred in the flush.

subscribe

void subscribe(String subject)
        throws Exception

Adds interest in a NATS subject.

Parameters:

subject - - subject of interest.

Throws:

Exception - - an error occurred in the subsciption process.

subscribe

void subscribe(String subject,
               io.nats.client.MessageHandler handler)
        throws Exception

Adds interest in a NATS subject, with a custom handle.

Parameters:

subject - - subject of interest.

handler - - message handler

Throws:

Exception - - an error occurred in the subsciption process.

subscribe

void subscribe(String subject,
               String queue)
        throws Exception

Adds interest in a NATS subject with a queue group.

Parameters:

subject - - subject of interest.

queue - - work queue

Throws:

Exception - - an error occurred in the subsciption process.

subscribe

void subscribe(String subject,
               String queue,
               io.nats.client.MessageHandler handler)
        throws Exception

Adds interest in a NATS subject with a queue group, with a custom handler.

Parameters:

subject - - subject of interest.

queue - - work queue

handler - - message handler

Throws:

Exception - - an error occurred in the subsciption process.

unsubscribe

void unsubscribe(String subject)

Removes interest in a NATS subject

Parameters:

subject - - subject of interest.

getConnection

io.nats.client.Connection getConnection()

Advanced API to get the NATS connection. This allows for NATS functionality beyond the interface here.

Returns:

The connection to the NATS cluster.

getConnectionFactory

io.nats.client.ConnectionFactory getConnectionFactory()

Advanced API to get the Connection Factory, This allows for NATS functionality beyond the interface here.

Returns:

The NATS connector ConnectionFactory