Package io.gatling.plugin

Interface EnterprisePlugin

All Known Subinterfaces:

BatchEnterprisePlugin, InteractiveEnterprisePlugin

All Known Implementing Classes:

BatchEnterprisePluginClient, InteractiveEnterprisePluginClient

public interface EnterprisePlugin

Enterprise plugin features

The following exception sub-classes of EnterprisePluginException can be thrown by all methods of this client:

• UnauthorizedApiCallException: invalid authentication token
• ForbiddenApiCallException: authentication token with insufficient privileges
• ApiCallIOException: unexpected IO error
• InvalidApiCallException: invalid input data

Method Summary

Modifier and Type	Method	Description
boolean	abortRun(UUID runId)
SimulationStartResult	createAndStartSimulation(UUID teamId, String groupId, String artifactId, String simulationClass, UUID packageId, Map<String,String> systemProperties, Map<String,String> environmentVariables, File file)	Create and start a simulation with given parameters
SimulationStartResult	uploadPackageAndStartSimulation(UUID simulationId, Map<String,String> systemProperties, Map<String,String> environmentVariables, String simulationClass, File file)	Upload file to the package configured on the given simulation ID, and start the simulation
SimulationEndResult	waitForRunEnd(RunSummary startedRun)

Method Details

uploadPackageAndStartSimulation

SimulationStartResult uploadPackageAndStartSimulation(UUID simulationId,
 Map<String,String> systemProperties,
 Map<String,String> environmentVariables,
 String simulationClass,
 File file)
                                               throws EnterprisePluginException

Upload file to the package configured on the given simulation ID, and start the simulation

Parameters:

simulationId - Required

systemProperties - Required, can be an empty map

environmentVariables - Required, can be an empty map

simulationClass - Optional, override simulation configured class name for next run

file - Required, Path to the packaged JAR file to upload and run

Throws:

SimulationNotFoundException - if the simulationId does not exist

InvalidSimulationClassException - if simulationClass is defined or simulation class name has not been discovered

EnterprisePluginException

createAndStartSimulation

SimulationStartResult createAndStartSimulation(UUID teamId,
 String groupId,
 String artifactId,
 String simulationClass,
 UUID packageId,
 Map<String,String> systemProperties,
 Map<String,String> environmentVariables,
 File file)
                                        throws EnterprisePluginException

Create and start a simulation with given parameters

Parameters:

teamId - Optional

groupId - Optional

artifactId - Required

simulationClass - Optional

packageId - Optional

systemProperties - Required, can be an empty map

environmentVariables - Required, can be an empty map

file - Required

Throws:

SimulationStartException - if simulation start failed after creation

SeveralTeamsFoundException - if teamId is null and there's more than one team discovered

SeveralSimulationClassNamesFoundException - if simulationClass is null and there's more than one simulation class name discovered

InvalidSimulationClassException - if simulationClass is defined, but not discovered

EnterprisePluginException

waitForRunEnd

SimulationEndResult waitForRunEnd(RunSummary startedRun)
                           throws EnterprisePluginException

Parameters:

startedRun - Required

Throws:

EnterprisePluginException

abortRun

boolean abortRun(UUID runId)
          throws EnterprisePluginException

Parameters:

runId - Required

Returns:

false if there was no run to abort (run does not exist or is already stopped)

Throws:

EnterprisePluginException