org.maestro.client

Class Maestro

java.lang.Object

org.maestro.client.Maestro

All Implemented Interfaces:

MaestroRequester

public final class Maestro
extends Object
implements MaestroRequester

A maestro instance

Constructor Summary

Constructors

Constructor and Description
Maestro(String url) Constructor

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the container of received messages
CompletableFuture<List<? extends MaestroNote>>	drainRequest(String topic, String duration, String url, int parallelCount) Issues a drain request
static <T> void	exec(Function<T,CompletableFuture<List<? extends MaestroNote>>> function, T value)
static <T> void	exec(Supplier<CompletableFuture<List<? extends MaestroNote>>> function)
CompletableFuture<List<? extends MaestroNote>>	flushRequest() Sends a flush request
CompletableFuture<List<? extends MaestroNote>>	flushRequest(String topic) Sends a flush request
MaestroCollector	getCollector() Get the collector receiving the messages
CompletableFuture<List<? extends MaestroNote>>	getDataServer() Sends a get request
CompletableFuture<List<? extends MaestroNote>>	halt() Sends a halt request
void	logRequest(LocationType locationType, String typeName) Sends a log request
void	logRequest(String topic, LocationType locationType, String typeName) Sends a log request
CompletableFuture<List<? extends MaestroNote>>	pingRequest() Sends a ping request
CompletableFuture<List<? extends MaestroNote>>	pingRequest(String topic) Sends a ping request
static <T,U> void	set(BiFunction<T,U,CompletableFuture<List<? extends MaestroNote>>> function, T value1, U value2)
static <T> void	set(Function<T,CompletableFuture<List<? extends MaestroNote>>> function, T value)
CompletableFuture<List<? extends MaestroNote>>	setBroker(String value) Sends a set broker request
CompletableFuture<List<? extends MaestroNote>>	setBroker(String topic, String value) Sends a set broker request
CompletableFuture<List<? extends MaestroNote>>	setDuration(Object value) Sends a set duration request
CompletableFuture<List<? extends MaestroNote>>	setDuration(String topic, Object value) Sends a set duration request
CompletableFuture<List<? extends MaestroNote>>	setFCL(int value) Sends a set fail-condition-latency (FCL) request
CompletableFuture<List<? extends MaestroNote>>	setLogLevel(String value) Sends a set log level request
CompletableFuture<List<? extends MaestroNote>>	setLogLevel(String topic, String value) Sends a set log level request
CompletableFuture<List<? extends MaestroNote>>	setManagementInterface(String value) Sets the management interface URL
CompletableFuture<List<? extends MaestroNote>>	setMessageSize(long value) Sends a set message size request (this one can be used for fixed message sizes)
CompletableFuture<List<? extends MaestroNote>>	setMessageSize(String value) Sends a set message size request (this one can be used for fixed or variable message sizes)
CompletableFuture<List<? extends MaestroNote>>	setParallelCount(int value) Sends a set parallel count request
CompletableFuture<List<? extends MaestroNote>>	setParallelCount(String topic, int value) Sends a set parallel count request
CompletableFuture<List<? extends MaestroNote>>	setRate(int value) Sends a set rate request
CompletableFuture<List<? extends MaestroNote>>	setRate(String topic, int value) Sends a set rate request
CompletableFuture<List<? extends MaestroNote>>	setThrottle(int value) Sends a set throttle request
CompletableFuture<List<? extends MaestroNote>>	setThrottle(String topic, int value) Sends a set throttle request
CompletableFuture<List<? extends MaestroNote>>	sourceRequest(String sourceUrl, String branch) Sends a source request to the agent (which causes it to download the given source)
CompletableFuture<List<? extends MaestroNote>>	startAgent() Sends a start agent request
CompletableFuture<List<? extends MaestroNote>>	startAll(String inspectorName) Starts all of the receivers, senders and inspectors peers on the test cluster
CompletableFuture<List<? extends MaestroNote>>	startInspector(String value) Sends a start inspector request
CompletableFuture<List<? extends MaestroNote>>	startReceiver() Sends a start receiver request
CompletableFuture<List<? extends MaestroNote>>	startSender() Sends a start sender request
CompletableFuture<List<? extends MaestroNote>>	statsRequest() Sends a stats request
void	stop() Stops maestro
CompletableFuture<List<? extends MaestroNote>>	stopAgent() Sends a stop agent request
CompletableFuture<List<? extends MaestroNote>>	stopAll() Sends a stop receiver request
CompletableFuture<List<? extends MaestroNote>>	stopInspector() Sends a stop inspector request
CompletableFuture<List<? extends MaestroNote>>	stopReceiver() Sends a stop receiver request
CompletableFuture<List<? extends MaestroNote>>	stopSender() Sends a stop sender request
CompletableFuture<List<? extends MaestroNote>>	userCommand(long option, String payload) Sends a user command request
CompletableFuture<List<? extends MaestroNote>>	waitForDrain() Waits for the drain notifications
CompletableFuture<List<? extends MaestroNote>>	waitForDrain(int expect) Waits for the drain notifications
CompletableFuture<List<? extends MaestroNote>>	waitForNotifications(int expect) Waits for notifications

Methods inherited from class java.lang.Object

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

Constructor Detail

Maestro

public Maestro(String url)
        throws MaestroException

Constructor

Parameters:

url - URL of the maestro broker

Throws:

MaestroException - if unable to connect to the maestro broker

Method Detail

stop

public void stop()
          throws MaestroConnectionException

Stops maestro

Specified by:

stop in interface MaestroRequester

Throws:

MaestroConnectionException - if unable to send the MQTT request

flushRequest

public CompletableFuture<List<? extends MaestroNote>> flushRequest()
                                                            throws MaestroConnectionException

Sends a flush request

Specified by:

flushRequest in interface MaestroRequester

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

flushRequest

public CompletableFuture<List<? extends MaestroNote>> flushRequest(String topic)
                                                            throws MaestroConnectionException

Sends a flush request

Specified by:

flushRequest in interface MaestroRequester

Parameters:

topic - the topic to send the request to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

pingRequest

public CompletableFuture<List<? extends MaestroNote>> pingRequest()
                                                           throws MaestroConnectionException

Sends a ping request

Specified by:

pingRequest in interface MaestroRequester

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

pingRequest

public CompletableFuture<List<? extends MaestroNote>> pingRequest(String topic)
                                                           throws MaestroConnectionException

Sends a ping request

Specified by:

pingRequest in interface MaestroRequester

Parameters:

topic - the topic to send the request to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setBroker

public CompletableFuture<List<? extends MaestroNote>> setBroker(String value)
                                                         throws MaestroConnectionException

Sends a set broker request

Specified by:

setBroker in interface MaestroRequester

Parameters:

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setBroker

public CompletableFuture<List<? extends MaestroNote>> setBroker(String topic,
                                                                String value)
                                                         throws MaestroConnectionException

Sends a set broker request

Specified by:

setBroker in interface MaestroRequester

Parameters:

topic - the topic to send the request to

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setDuration

public CompletableFuture<List<? extends MaestroNote>> setDuration(Object value)
                                                           throws MaestroException

Sends a set duration request

Specified by:

setDuration in interface MaestroRequester

Parameters:

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroException - if unable to send the MQTT request

setDuration

public CompletableFuture<List<? extends MaestroNote>> setDuration(String topic,
                                                                  Object value)
                                                           throws MaestroException

Sends a set duration request

Specified by:

setDuration in interface MaestroRequester

Parameters:

topic - the topic to send the request to

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroException - if unable to send the MQTT request

setLogLevel

public CompletableFuture<List<? extends MaestroNote>> setLogLevel(String value)
                                                           throws MaestroConnectionException

Sends a set log level request

Specified by:

setLogLevel in interface MaestroRequester

Parameters:

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setLogLevel

public CompletableFuture<List<? extends MaestroNote>> setLogLevel(String topic,
                                                                  String value)
                                                           throws MaestroConnectionException

Sends a set log level request

Specified by:

setLogLevel in interface MaestroRequester

Parameters:

topic - the topic to send the request to

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setParallelCount

public CompletableFuture<List<? extends MaestroNote>> setParallelCount(int value)
                                                                throws MaestroConnectionException

Sends a set parallel count request

Specified by:

setParallelCount in interface MaestroRequester

Parameters:

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setParallelCount

public CompletableFuture<List<? extends MaestroNote>> setParallelCount(String topic,
                                                                       int value)
                                                                throws MaestroConnectionException

Sends a set parallel count request

Specified by:

setParallelCount in interface MaestroRequester

Parameters:

topic - the topic to send the request to

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setMessageSize

public CompletableFuture<List<? extends MaestroNote>> setMessageSize(String value)
                                                              throws MaestroConnectionException

Sends a set message size request (this one can be used for fixed or variable message sizes)

Specified by:

setMessageSize in interface MaestroRequester

Parameters:

value - the value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setMessageSize

public CompletableFuture<List<? extends MaestroNote>> setMessageSize(long value)
                                                              throws MaestroConnectionException

Sends a set message size request (this one can be used for fixed message sizes)

Specified by:

setMessageSize in interface MaestroRequester

Parameters:

value - the value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setThrottle

public CompletableFuture<List<? extends MaestroNote>> setThrottle(int value)
                                                           throws MaestroConnectionException

Sends a set throttle request

Specified by:

setThrottle in interface MaestroRequester

Parameters:

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setThrottle

public CompletableFuture<List<? extends MaestroNote>> setThrottle(String topic,
                                                                  int value)
                                                           throws MaestroConnectionException

Sends a set throttle request

Specified by:

setThrottle in interface MaestroRequester

Parameters:

topic - the topic to send the request to

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setRate

public CompletableFuture<List<? extends MaestroNote>> setRate(int value)
                                                       throws MaestroConnectionException

Sends a set rate request

Specified by:

setRate in interface MaestroRequester

Parameters:

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setRate

public CompletableFuture<List<? extends MaestroNote>> setRate(String topic,
                                                              int value)
                                                       throws MaestroConnectionException

Sends a set rate request

Specified by:

setRate in interface MaestroRequester

Parameters:

topic - the topic to send the request to

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setFCL

public CompletableFuture<List<? extends MaestroNote>> setFCL(int value)
                                                      throws MaestroConnectionException

Sends a set fail-condition-latency (FCL) request

Specified by:

setFCL in interface MaestroRequester

Parameters:

value - The value to set the (remote) parameter to

Returns:

A completable future that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request

setManagementInterface

public CompletableFuture<List<? extends MaestroNote>> setManagementInterface(String value)
                                                                      throws MaestroException

Sets the management interface URL

Parameters:

value - The management interface URL

Returns:

A completable future

Throws:

MaestroException - if unable to send the MQTT request

startInspector

public CompletableFuture<List<? extends MaestroNote>> startInspector(String value)
                                                              throws MaestroConnectionException

Sends a start inspector request

Specified by:

startInspector in interface MaestroRequester

Parameters:

value - The name of the inspector to start. The URL is set via setManagementInterface command

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopInspector

public CompletableFuture<List<? extends MaestroNote>> stopInspector()
                                                             throws MaestroConnectionException

Sends a stop inspector request

Specified by:

stopInspector in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

startSender

public CompletableFuture<List<? extends MaestroNote>> startSender()
                                                           throws MaestroConnectionException

Sends a start sender request

Specified by:

startSender in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopSender

public CompletableFuture<List<? extends MaestroNote>> stopSender()
                                                          throws MaestroConnectionException

Sends a stop sender request

Specified by:

stopSender in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

startReceiver

public CompletableFuture<List<? extends MaestroNote>> startReceiver()
                                                             throws MaestroConnectionException

Sends a start receiver request

Specified by:

startReceiver in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopReceiver

public CompletableFuture<List<? extends MaestroNote>> stopReceiver()
                                                            throws MaestroConnectionException

Sends a stop receiver request

Specified by:

stopReceiver in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopAll

public CompletableFuture<List<? extends MaestroNote>> stopAll()
                                                       throws MaestroConnectionException

Sends a stop receiver request

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

startAll

public CompletableFuture<List<? extends MaestroNote>> startAll(String inspectorName)
                                                        throws MaestroConnectionException

Starts all of the receivers, senders and inspectors peers on the test cluster

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

statsRequest

public CompletableFuture<List<? extends MaestroNote>> statsRequest()
                                                            throws MaestroConnectionException

Sends a stats request

Specified by:

statsRequest in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

halt

public CompletableFuture<List<? extends MaestroNote>> halt()
                                                    throws MaestroConnectionException

Sends a halt request

Specified by:

halt in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

getDataServer

public CompletableFuture<List<? extends MaestroNote>> getDataServer()
                                                             throws MaestroConnectionException

Sends a get request

Specified by:

getDataServer in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

startAgent

public CompletableFuture<List<? extends MaestroNote>> startAgent()
                                                          throws MaestroConnectionException

Sends a start agent request

Specified by:

startAgent in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopAgent

public CompletableFuture<List<? extends MaestroNote>> stopAgent()
                                                         throws MaestroConnectionException

Sends a stop agent request

Specified by:

stopAgent in interface MaestroRequester

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

userCommand

public CompletableFuture<List<? extends MaestroNote>> userCommand(long option,
                                                                  String payload)
                                                           throws MaestroConnectionException

Sends a user command request

Specified by:

userCommand in interface MaestroRequester

Parameters:

option - An optional numeric option that can be associated w/ the command

payload - An option string payload to be sent along w/ the command

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

sourceRequest

public CompletableFuture<List<? extends MaestroNote>> sourceRequest(String sourceUrl,
                                                                    String branch)
                                                             throws MaestroConnectionException

Sends a source request to the agent (which causes it to download the given source)

Parameters:

sourceUrl - the source url (ie.: git://host/path/to/extension-endpoint.git)

branch - branch to use for the source URL

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

logRequest

public void logRequest(LocationType locationType,
                       String typeName)
                throws MaestroConnectionException

Sends a log request

Parameters:

locationType - The location type

typeName - The optional type name (mandatory if the location type is ANY)

Throws:

MaestroConnectionException - if unable to send the MQTT request

logRequest

public void logRequest(String topic,
                       LocationType locationType,
                       String typeName)
                throws MaestroConnectionException

Sends a log request

Parameters:

topic - the topic to send the request to

locationType - The location type

typeName - The optional type name (mandatory if the location type is ANY)

Throws:

MaestroConnectionException - if unable to send the MQTT request

drainRequest

public CompletableFuture<List<? extends MaestroNote>> drainRequest(String topic,
                                                                   String duration,
                                                                   String url,
                                                                   int parallelCount)

Issues a drain request

Parameters:

topic - the topic to send the request to

duration - duration of the drain

url - URL to drain

parallelCount - parallel count

Returns:

A completable future

clear

public void clear()

Clear the container of received messages

getCollector

public MaestroCollector getCollector()

Get the collector receiving the messages

Returns:

the collector receiving the messages

waitForDrain

public CompletableFuture<List<? extends MaestroNote>> waitForDrain(int expect)

Waits for the drain notifications

Parameters:

expect - Number of retries before considering stale (every retry == 1 second of wait)

Returns:

A completable future

waitForDrain

public CompletableFuture<List<? extends MaestroNote>> waitForDrain()

Waits for the drain notifications

Returns:

A completable future

waitForNotifications

public CompletableFuture<List<? extends MaestroNote>> waitForNotifications(int expect)

Waits for notifications

Parameters:

expect - how many notifications to expect

Returns:

A completable future

set

public static <T> void set(Function<T,CompletableFuture<List<? extends MaestroNote>>> function,
                           T value)

set

public static <T,U> void set(BiFunction<T,U,CompletableFuture<List<? extends MaestroNote>>> function,
                             T value1,
                             U value2)

exec

public static <T> void exec(Supplier<CompletableFuture<List<? extends MaestroNote>>> function)

exec

public static <T> void exec(Function<T,CompletableFuture<List<? extends MaestroNote>>> function,
                            T value)