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>>	drainRequest(String topic, DrainOptions drainOptions) Issues a drain request
CompletableFuture<List<? extends MaestroNote>>	getDataServer() Sends a get data server request
CompletableFuture<List<? extends MaestroNote>>	halt() Sends a halt request
CompletableFuture<List<? extends MaestroNote>>	halt(String topic) Sends a halt 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
CompletableFuture<List<? extends MaestroNote>>	roleAssign(String topic, Role role) Assign a role to one or more peers
CompletableFuture<List<? extends MaestroNote>>	roleUnassign(String topic) Unassign a role to one or more peers
CompletableFuture<List<? extends MaestroNote>>	setBroker(String topic, String value) Sends a set broker request
CompletableFuture<List<? extends MaestroNote>>	setDuration(String topic, Object value) Sends a set duration request
CompletableFuture<List<? extends MaestroNote>>	setFCL(String topic, int value) Sends a set fail-condition-latency (FCL) request
CompletableFuture<List<? extends MaestroNote>>	setManagementInterface(String topic, String value) Sets the management interface URL
CompletableFuture<List<? extends MaestroNote>>	setMessageSize(String topic, long value) Sends a set message size request (this one can be used for fixed message sizes)
CompletableFuture<List<? extends MaestroNote>>	setMessageSize(String topic, String value) Sends a set message size request (This one can be used for variable and fixed message sizes)
CompletableFuture<List<? extends MaestroNote>>	setParallelCount(String topic, int value) Sends a set parallel count request
CompletableFuture<List<? extends MaestroNote>>	setRate(String topic, int value) Sends a set rate request
CompletableFuture<List<? extends MaestroNote>>	sourceRequest(String topic, Source source) 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>>	startInspector(String value) Sends a start inspector request
CompletableFuture<List<? extends MaestroNote>>	startWorker(String topic, WorkerStartOptions options) Sends a start worker request
CompletableFuture<List<? extends MaestroNote>>	statsRequest() Sends a stats request
CompletableFuture<List<? extends MaestroNote>>	statsRequest(String topic) Sends a stats request
void	stop() Stops maestro
CompletableFuture<List<? extends MaestroNote>>	stopAgent() Sends a stop agent request
CompletableFuture<List<? extends MaestroNote>>	stopAll() Stops everything running on the test cluster
CompletableFuture<List<? extends MaestroNote>>	stopInspector() Sends a stop inspector request
CompletableFuture<List<? extends MaestroNote>>	stopInspector(String topic) Sends a stop inspector request
CompletableFuture<List<? extends MaestroNote>>	stopWorker(String topic) Sends a stop worker request
CompletableFuture<List<? extends MaestroNote>>	userCommand(String topic, UserCommandData userCommandData) Sends a user command request
CompletableFuture<List<? extends MaestroNote>>	waitForDrain() Waits for the drain notifications
CompletableFuture<List<? extends MaestroNote>>	waitForNotifications(int expect) Waits for notifications

Method Detail

stop

void stop()
   throws MaestroConnectionException

Stops maestro

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 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(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

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 topic,
                                                              String value)
                                                       throws MaestroConnectionException

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

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 topic,
                                                              long value)
                                                       throws MaestroConnectionException

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

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(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(String topic,
                                                      int value)
                                               throws MaestroConnectionException

Sends a set fail-condition-latency (FCL) 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

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

stopInspector

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

Sends a stop inspector 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

startWorker

CompletableFuture<List<? extends MaestroNote>> startWorker(String topic,
                                                           WorkerStartOptions options)
                                                    throws MaestroConnectionException

Sends a start worker request

Parameters:

topic - the topic to send the request to

options - the worker startup options

Returns:

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

Throws:

MaestroConnectionException - if unable to send the MQTT request

stopWorker

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

Sends a stop worker 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

stopAll

CompletableFuture<List<? extends MaestroNote>> stopAll()

Stops everything running on the test cluster

Returns:

A completable future

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

statsRequest

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

Sends a stats 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

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

halt

CompletableFuture<List<? extends MaestroNote>> halt(String topic)

Sends a halt request

Parameters:

topic - the topic to send the request to

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

getDataServer

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

Sends a get data server 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(String topic,
                                                           UserCommandData userCommandData)
                                                    throws MaestroConnectionException

Sends a user command request

Parameters:

topic - the topic to send the request to

userCommandData - the user command data

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

setManagementInterface

CompletableFuture<List<? extends MaestroNote>> setManagementInterface(String topic,
                                                                      String value)

Sets the management interface URL

Parameters:

topic - the topic to send the request to

value - The management interface URL

Returns:

A completable future

Throws:

MaestroException - if unable to send the MQTT request

sourceRequest

CompletableFuture<List<? extends MaestroNote>> sourceRequest(String topic,
                                                             Source source)
                                                      throws MaestroConnectionException

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

Parameters:

topic - the topic to send the request to

source - the extension point source

Returns:

A completable future

Throws:

MaestroConnectionException - if unable to send the MQTT request

logRequest

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

CompletableFuture<List<? extends MaestroNote>> drainRequest(String topic,
                                                            DrainOptions drainOptions)

Issues a drain request

Parameters:

topic - the topic to send the request to

drainOptions - drain options

Returns:

A completable future

roleAssign

CompletableFuture<List<? extends MaestroNote>> roleAssign(String topic,
                                                          Role role)
                                                   throws MaestroConnectionException

Assign a role to one or more peers

Parameters:

topic - the topic to send the request to

role - The role to assign

Returns:

A completable future

Throws:

MaestroException - if unable to send the MQTT request

MaestroConnectionException

roleUnassign

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

Unassign a role to one or more peers

Parameters:

topic - the topic to send the request to

Returns:

A completable future

Throws:

MaestroException - if unable to send the MQTT request

MaestroConnectionException

waitForDrain

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

Waits for the drain notifications

Returns:

A completable future

waitForNotifications

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

Waits for notifications

Parameters:

expect - how many notifications to expect

Returns:

A completable future