io.nats.connector.plugin

Interface NATSConnectorPlugin

public interface NATSConnectorPlugin

This interface that must be implemented for a NATS Connector plugin.

The order of calls are:

onStartup

onNatsIntialized

During operation: onNatsMessage and onNATSEvent

onShutdown

Method Summary

Modifier and Type	Method and Description
void	onNATSEvent(NATSEvent event, String message) Invoked anytime a NATS event occurs around a connection or error, alerting the plugin to take appropriate action.
boolean	onNatsInitialized(NATSConnector connector) Invoked after startup, when the NATS plug-in has connectivity to the NATS cluster, and is ready to start sending and and receiving messages.
void	onNATSMessage(io.nats.client.Message msg) Invoked anytime a NATS message is received to be processed.
void	onShutdown() Invoked when the Plugin is shutting down.
boolean	onStartup(org.slf4j.Logger logger, io.nats.client.ConnectionFactory factory) Invoked when the connector is started up, before a connection to the NATS cluster is made.

Method Detail

onStartup

boolean onStartup(org.slf4j.Logger logger,
                  io.nats.client.ConnectionFactory factory)

Invoked when the connector is started up, before a connection to the NATS cluster is made. The NATS connection factory is valid at this time, providing an opportunity to alter NATS connection parameters based on other plugin variables.

Parameters:

logger - - logger for the NATS connector process.

factory - - the NATS connection factory.

Returns:

- true if the connector should continue, false otherwise.

onNatsInitialized

boolean onNatsInitialized(NATSConnector connector)

Invoked after startup, when the NATS plug-in has connectivity to the NATS cluster, and is ready to start sending and and receiving messages. This is the place to create NATS subscriptions.

Parameters:

connector - interface to the NATS connector

Returns:

true if the plugin can continue.

onNATSMessage

void onNATSMessage(io.nats.client.Message msg)

Invoked anytime a NATS message is received to be processed.

Parameters:

msg - - NATS message received.

onNATSEvent

void onNATSEvent(NATSEvent event,
                 String message)

Invoked anytime a NATS event occurs around a connection or error, alerting the plugin to take appropriate action. For example, when NATS is reconnecting, buffer or pause incoming data to be sent to NATS.

Parameters:

event - the type of event

message - a string describing the event

onShutdown

void onShutdown()

Invoked when the Plugin is shutting down. This is typically where plugin resources are cleaned up.