io.gatling.plugin

Interface EnterprisePlugin

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

BatchEnterprisePlugin, InteractiveEnterprisePlugin

All Known Implementing Classes:

BatchEnterprisePluginClient, InteractiveEnterprisePluginClient

public interface EnterprisePlugin
extends java.lang.AutoCloseable

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 and Description
SimulationStartResult	createAndStartSimulation(java.util.UUID teamId, java.lang.String groupId, java.lang.String artifactId, java.lang.String simulationClass, java.util.UUID packageId, java.util.Map<java.lang.String,java.lang.String> systemProperties, java.io.File file) Create and start a simulation with given parameters
SimulationStartResult	uploadPackageAndStartSimulation(java.util.UUID simulationId, java.util.Map<java.lang.String,java.lang.String> systemProperties, java.lang.String simulationClass, java.io.File file) Upload file to the package configured on the given simulation ID, and start the simulation

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

uploadPackageAndStartSimulation

SimulationStartResult uploadPackageAndStartSimulation(java.util.UUID simulationId,
                                                      java.util.Map<java.lang.String,java.lang.String> systemProperties,
                                                      java.lang.String simulationClass,
                                                      java.io.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

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(java.util.UUID teamId,
                                               java.lang.String groupId,
                                               java.lang.String artifactId,
                                               java.lang.String simulationClass,
                                               java.util.UUID packageId,
                                               java.util.Map<java.lang.String,java.lang.String> systemProperties,
                                               java.io.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

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