Package io.gatling.plugin

Class BatchEnterprisePluginClient

java.lang.Object

io.gatling.plugin.BatchEnterprisePluginClient

All Implemented Interfaces:

BatchEnterprisePlugin, EnterprisePlugin

public final class BatchEnterprisePluginClient
extends Object
implements BatchEnterprisePlugin

Field Summary

Fields

Modifier and Type	Field	Description
protected final EnterpriseClient	enterpriseClient
protected final PluginLogger	logger

Constructor Summary

Constructors

Constructor	Description
BatchEnterprisePluginClient(EnterpriseClient enterpriseClient, PluginLogger logger)

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
protected List<String>	getSimulationClasses(File file)
long	uploadPackage(UUID packageId, File file)	Upload file to the package associated with given packageId
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
UUID	uploadPackageConfiguration(String jsonConfiguration)	Upload a package configuration description to apply.
protected long	uploadPackageWithChecksum(UUID packageId, File file)
long	uploadPackageWithSimulationId(UUID simulationId, File file)	Upload file to the package associated to the given simulationId
protected void	validateJavaVersion(File file)
SimulationEndResult	waitForRunEnd(RunSummary startedRun)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.gatling.plugin.EnterprisePlugin

abortRun, waitForRunEnd

Field Details

enterpriseClient

protected final EnterpriseClient enterpriseClient

logger

protected final PluginLogger logger

Constructor Details

BatchEnterprisePluginClient

public BatchEnterprisePluginClient(EnterpriseClient enterpriseClient,
 PluginLogger logger)

Method Details

uploadPackage

public long uploadPackage(UUID packageId,
 File file)
                   throws EnterprisePluginException

Description copied from interface: BatchEnterprisePlugin

Upload file to the package associated with given packageId

Specified by:

uploadPackage in interface BatchEnterprisePlugin

Parameters:

packageId - Required

file - File to upload and run; required

Throws:

EnterprisePluginException

uploadPackageWithSimulationId

public long uploadPackageWithSimulationId(UUID simulationId,
 File file)
                                   throws EnterprisePluginException

Description copied from interface: BatchEnterprisePlugin

Upload file to the package associated to the given simulationId

Specified by:

uploadPackageWithSimulationId in interface BatchEnterprisePlugin

Parameters:

simulationId - Required

file - File to upload and run; required

Throws:

EnterprisePluginException

uploadPackageConfiguration

public UUID uploadPackageConfiguration(String jsonConfiguration)
                                throws EnterprisePluginException

Description copied from interface: BatchEnterprisePlugin

Upload a package configuration description to apply.

Specified by:

uploadPackageConfiguration in interface BatchEnterprisePlugin

Parameters:

jsonConfiguration - Serialized json package configuration to apply; required

Returns:

Package id

Throws:

EnterprisePluginException

uploadPackageAndStartSimulation

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

Description copied from interface: EnterprisePlugin

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

Specified by:

uploadPackageAndStartSimulation in interface EnterprisePlugin

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:

EnterprisePluginException

createAndStartSimulation

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

Description copied from interface: EnterprisePlugin

Create and start a simulation with given parameters

Specified by:

createAndStartSimulation in interface EnterprisePlugin

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:

EnterprisePluginException

uploadPackageWithChecksum

protected long uploadPackageWithChecksum(UUID packageId,
 File file)
                                  throws EnterprisePluginException

Throws:

EnterprisePluginException

validateJavaVersion

protected void validateJavaVersion(File file)
                            throws EnterprisePluginException

Throws:

EnterprisePluginException

getSimulationClasses

protected List<String> getSimulationClasses(File file)
                                     throws EnterprisePluginException

Throws:

EnterprisePluginException

waitForRunEnd

public SimulationEndResult waitForRunEnd(RunSummary startedRun)
                                  throws EnterprisePluginException

Specified by:

waitForRunEnd in interface EnterprisePlugin

Parameters:

startedRun - Required

Throws:

EnterprisePluginException

abortRun

public boolean abortRun(UUID runId)
                 throws EnterprisePluginException

Specified by:

abortRun in interface EnterprisePlugin

Parameters:

runId - Required

Returns:

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

Throws:

EnterprisePluginException