io.gatling.plugin

Interface EnterprisePlugin

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

EnterprisePluginClient

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
long	uploadPackage(java.util.UUID packageId, java.io.File file) Upload file to the package associated with given packageId
SimulationStartResult	uploadPackageAndStartSimulation(java.util.UUID simulationId, java.util.Map<java.lang.String,java.lang.String> systemProperties, java.io.File file) Upload file to the package configured on the given simulation ID, and start the simulation
long	uploadPackageWithSimulationId(java.util.UUID simulationId, java.io.File file) Upload file to the package associated to the given simulationId

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

uploadPackage

long uploadPackage(java.util.UUID packageId,
                   java.io.File file)
            throws EnterprisePluginException

Upload file to the package associated with given packageId

Parameters:

packageId - Required

file - Path to the packaged JAR file to upload and run; required

Throws:

EnterprisePluginException

uploadPackageWithSimulationId

long uploadPackageWithSimulationId(java.util.UUID simulationId,
                                   java.io.File file)
                            throws EnterprisePluginException

Upload file to the package associated to the given simulationId

Parameters:

simulationId - Required

file - Path to the packaged JAR file to upload and run; required

Throws:

EnterprisePluginException

uploadPackageAndStartSimulation

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

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

Throws:

SimulationNotFoundException - if the simulationId does not exist

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

packageId - Optional

systemProperties - Required, can be an empty Map

file - Required

Throws:

SimulationStartException - if simulation start failed after creation

EnterprisePluginException