org.maestro.common.client

Interface MaestroRequester

All Known Implementing Classes:

Maestro

public interface MaestroRequester

Method Summary

Modifier and Type	Method and Description
CompletableFuture<List<? extends MaestroNote>>	flushRequest() Deprecated.
CompletableFuture<List<? extends MaestroNote>>	flushRequest(String topic) Deprecated.
CompletableFuture<List<? extends MaestroNote>>	getDataServer() Sends a get request
CompletableFuture<List<? extends MaestroNote>>	halt() Sends a halt request
CompletableFuture<List<? extends MaestroNote>>	pingRequest() Sends a ping request
CompletableFuture<List<? extends MaestroNote>>	pingRequest(String topic) Sends a ping request
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) Deprecated.
CompletableFuture<List<? extends MaestroNote>>	setLogLevel(String topic, String value) Sends a set log level request
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 variable and fixed 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) Deprecated.
CompletableFuture<List<? extends MaestroNote>>	setThrottle(String topic, int value) Deprecated.
CompletableFuture<List<? extends MaestroNote>>	startAgent() Sends a start agent request
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>>	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 agent general execution request

Method Detail

stop

void stop()
   throws MaestroConnectionException

Stops maestro

Throws:

MaestroConnectionException - if unable to send the MQTT request

flushRequest

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

Deprecated.

Sends a flush request

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

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

Deprecated.

Sends a flush request

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

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

Sends a ping request

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

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

Sends a ping request

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

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

Sends a set broker request

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

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

Sends a set broker request

Parameters:

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

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

setDuration

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

Sends a set duration request

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

MaestroException

setDuration

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

Sends a set duration request

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

MaestroException

setLogLevel

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

Deprecated.

Sends a set log level request

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

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

Sends a set log level request

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

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

Sends a set parallel count request

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

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

Sends a set parallel count request

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

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

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

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

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

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

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

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

Deprecated.

Sends a set throttle request

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

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

Deprecated.

Sends a set throttle request

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

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

Sends a set rate request

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

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

Sends a set rate request

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

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

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

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

startInspector

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

Sends a start inspector request

Parameters:

value - the name of the inspector to start

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopInspector

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

Sends a stop inspector request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

startSender

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

Sends a start sender request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopSender

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

Sends a stop sender request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

startReceiver

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

Sends a start receiver request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopReceiver

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

Sends a stop receiver request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

statsRequest

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

Sends a stats request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

halt

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

Sends a halt request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

getDataServer

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

Sends a get request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

startAgent

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

Sends a start agent request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopAgent

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

Sends a stop agent request

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

userCommand

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

Sends a agent general execution request

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 that can be used to collect the replies for the request

Throws:

MaestroConnectionException - if unable to send the MQTT request