org.apache.nifi.cluster.protocol

Interface ProtocolListener

All Known Implementing Classes:

ClusterCoordinationProtocolSenderListener, NodeProtocolSenderListener, SocketProtocolListener

public interface ProtocolListener

Defines the interface for a listener to process protocol messages.

Method Summary

Modifier and Type	Method and Description
void	addHandler(ProtocolHandler handler) Registers a handler with the listener.
Collection<ProtocolHandler>	getHandlers()
boolean	isRunning()
boolean	removeHandler(ProtocolHandler handler) Unregisters the handler with the listener.
void	setBulletinRepository(BulletinRepository bulletinRepository) Sets the BulletinRepository that can be used to report bulletins
void	start() Starts the instance for listening for messages.
void	stop() Stops the instance from listening for messages.

Method Detail

start

void start()
    throws IOException

Starts the instance for listening for messages. Start may only be called if the instance is not running.

Throws:

IOException - ex

stop

void stop()
   throws IOException

Stops the instance from listening for messages. Stop may only be called if the instance is running.

Throws:

IOException - ex

isRunning

boolean isRunning()

Returns:

true if the instance is started; false otherwise.

getHandlers

Collection<ProtocolHandler> getHandlers()

Returns:

the handlers registered with the listener

addHandler

void addHandler(ProtocolHandler handler)

Registers a handler with the listener.

Parameters:

handler - a handler

setBulletinRepository

void setBulletinRepository(BulletinRepository bulletinRepository)

Sets the BulletinRepository that can be used to report bulletins

Parameters:

bulletinRepository - repo

removeHandler

boolean removeHandler(ProtocolHandler handler)

Unregisters the handler with the listener.

Parameters:

handler - a handler

Returns:

true if the handler was removed; false otherwise