org.maestro.client.exchange

Class MaestroCollector

java.lang.Object

org.maestro.client.exchange.AbstractMaestroPeer<MaestroNote>

org.maestro.client.exchange.MaestroCollector

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.MqttCallback, org.eclipse.paho.client.mqttv3.MqttCallbackExtended

public class MaestroCollector
extends AbstractMaestroPeer<MaestroNote>

An specialized peer that is used on the front-end side of the code to collect messages published on front-end related topics

Field Summary

Fields inherited from class org.maestro.client.exchange.AbstractMaestroPeer

clientName

Constructor Summary

Constructors

Constructor and Description
MaestroCollector(String url) Constructor

Method Summary

Modifier and Type	Method and Description
void	addCallback(MaestroNoteCallback callback) Adds a callback to be executed on note arrival
void	clear() Clear the collected messages
List<MaestroNote>	collect(Predicate<? super MaestroNote> predicate) Collect notes matching a given predicate
boolean	isRunning() Checks the running state of the collector
void	monitor(MaestroMonitor monitor) Adds a monitor for message arrival
protected void	noteArrived(MaestroNote note) The entry point for handling Maestro messages
void	remove(MaestroMonitor monitor) Removes a monitor

Methods inherited from class org.maestro.client.exchange.AbstractMaestroPeer

connect, connectComplete, connectionLost, deliveryComplete, disconnect, getClientName, getId, isConnected, messageArrived, reconnect, setClientName, subscribe, subscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

MaestroCollector

public MaestroCollector(String url)
                 throws MaestroConnectionException

Constructor

Parameters:

url - the URL to the Maestro broker

Throws:

MaestroConnectionException - if unable to connect

Method Detail

noteArrived

protected void noteArrived(MaestroNote note)

Description copied from class: AbstractMaestroPeer

The entry point for handling Maestro messages

Specified by:

noteArrived in class AbstractMaestroPeer<MaestroNote>

Parameters:

note - the note that arrived

isRunning

public boolean isRunning()

Checks the running state of the collector

Specified by:

isRunning in class AbstractMaestroPeer<MaestroNote>

Returns:

true if running or false otherwise

clear

public void clear()

Clear the collected messages

collect

public List<MaestroNote> collect(Predicate<? super MaestroNote> predicate)

Collect notes matching a given predicate

Parameters:

predicate - the predicate that notes need to match in order to be collected

Returns:

A list of collected notes

addCallback

public void addCallback(MaestroNoteCallback callback)

Adds a callback to be executed on note arrival

Parameters:

callback - the callback to execute

monitor

public void monitor(MaestroMonitor monitor)

Adds a monitor for message arrival

Parameters:

monitor - the monitor to add

remove

public void remove(MaestroMonitor monitor)

Removes a monitor

Parameters:

monitor - the monitor to remove