org.apache.nifi.cluster.protocol.impl

Class MulticastProtocolListener

java.lang.Object

org.apache.nifi.io.socket.multicast.MulticastListener

org.apache.nifi.cluster.protocol.impl.MulticastProtocolListener

All Implemented Interfaces:

ProtocolListener

public class MulticastProtocolListener
extends MulticastListener
implements ProtocolListener

Implements a listener for protocol messages sent over multicast. If a message is of type MulticastProtocolMessage, then the underlying protocol message is passed to the handler. If the receiving handler produces a message response, then the message is wrapped with a MulticastProtocolMessage before being sent to the originator. The client caller is responsible for starting and stopping the listener. The instance must be stopped before termination of the JVM to ensure proper resource clean-up.

Author:

unattributed

Field Summary

Fields

Modifier and Type	Field and Description
private BulletinRepository	bulletinRepository
private Collection<ProtocolHandler>	handlers
private String	listenerId
private static org.slf4j.Logger	logger
private ProtocolContext<ProtocolMessage>	protocolContext

Constructor Summary

Constructors

Constructor and Description
MulticastProtocolListener(int numThreads, InetSocketAddress multicastAddress, MulticastConfiguration configuration, ProtocolContext<ProtocolMessage> protocolContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHandler(ProtocolHandler handler) Registers a handler with the listener.
void	dispatchRequest(MulticastSocket multicastSocket, DatagramPacket packet)
Collection<ProtocolHandler>	getHandlers()
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.

Methods inherited from class org.apache.nifi.io.socket.multicast.MulticastListener

getConfiguration, getMaxPacketSizeBytes, getMulticastAddress, getNumThreads, getShutdownListenerSeconds, isRunning, setMaxPacketSizeBytes, setShutdownListenerSeconds

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.cluster.protocol.ProtocolListener

isRunning

Field Detail

logger

private static final org.slf4j.Logger logger

handlers

private final Collection<ProtocolHandler> handlers

listenerId

private final String listenerId

protocolContext

private final ProtocolContext<ProtocolMessage> protocolContext

bulletinRepository

private volatile BulletinRepository bulletinRepository

Constructor Detail

MulticastProtocolListener

public MulticastProtocolListener(int numThreads,
                         InetSocketAddress multicastAddress,
                         MulticastConfiguration configuration,
                         ProtocolContext<ProtocolMessage> protocolContext)

Method Detail

setBulletinRepository

public void setBulletinRepository(BulletinRepository bulletinRepository)

Description copied from interface: ProtocolListener

Sets the BulletinRepository that can be used to report bulletins

Specified by:

setBulletinRepository in interface ProtocolListener

start

public void start()
           throws IOException

Description copied from interface: ProtocolListener

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

Specified by:

start in interface ProtocolListener

Overrides:

start in class MulticastListener

Throws:

IOException

stop

public void stop()
          throws IOException

Description copied from interface: ProtocolListener

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

Specified by:

stop in interface ProtocolListener

Overrides:

stop in class MulticastListener

Throws:

IOException

getHandlers

public Collection<ProtocolHandler> getHandlers()

Specified by:

getHandlers in interface ProtocolListener

Returns:

the handlers registered with the listener

addHandler

public void addHandler(ProtocolHandler handler)

Description copied from interface: ProtocolListener

Registers a handler with the listener.

Specified by:

addHandler in interface ProtocolListener

Parameters:

handler - a handler

removeHandler

public boolean removeHandler(ProtocolHandler handler)

Description copied from interface: ProtocolListener

Unregisters the handler with the listener.

Specified by:

removeHandler in interface ProtocolListener

Parameters:

handler - a handler

Returns:

true if the handler was removed; false otherwise

dispatchRequest

public void dispatchRequest(MulticastSocket multicastSocket,
                   DatagramPacket packet)

Specified by:

dispatchRequest in class MulticastListener