io.gatling.plugin.client

Interface EnterpriseClient

All Known Implementing Classes:

HttpEnterpriseClient

public interface EnterpriseClient

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

• 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
boolean	abortRun(java.util.UUID runId)
Pkg	createPackage(java.lang.String packageName, java.util.UUID teamId)
Simulation	createSimulation(java.lang.String simulationName, java.util.UUID teamId, java.lang.String className, java.util.UUID pkgId, java.util.Map<java.lang.String,HostByLocation> hostsByLocation)
java.net.URL	getBaseUrl()
java.util.List<Series>	getConcurrentUserMetric(java.util.UUID runId, java.lang.String scenario)
Locations	getLocations()
Pkg	getPackage(java.util.UUID pkgId)
java.util.List<PkgIndex>	getPackages()
RequestsSummary	getRequestsSummary(java.util.UUID runId)
RunInformation	getRunInformation(java.util.UUID runId)
ServerInformation	getServerInformation()
Simulation	getSimulation(java.util.UUID simulationId)
java.util.List<Simulation>	getSimulations()
java.util.List<Team>	getTeams()
RunSummary	startSimulation(java.util.UUID simulationId, java.util.Map<java.lang.String,java.lang.String> systemProperties, java.util.Map<java.lang.String,java.lang.String> environmentVariables)
SimulationClassName	updateSimulationClassName(java.util.UUID simulationId, java.lang.String className)
long	uploadPackage(java.util.UUID packageId, java.io.File file)
long	uploadPackageWithChecksum(java.util.UUID packageId, java.io.File file)

Method Detail

getBaseUrl

java.net.URL getBaseUrl()

getServerInformation

ServerInformation getServerInformation()
                                throws EnterprisePluginException

Throws:

EnterprisePluginException

getSimulations

java.util.List<Simulation> getSimulations()
                                   throws EnterprisePluginException

Throws:

EnterprisePluginException

getSimulation

Simulation getSimulation(java.util.UUID simulationId)
                  throws EnterprisePluginException

Throws:

EnterprisePluginException

getTeams

java.util.List<Team> getTeams()
                       throws EnterprisePluginException

Throws:

EnterprisePluginException

getLocations

Locations getLocations()
                throws EnterprisePluginException

Throws:

EnterprisePluginException

getPackages

java.util.List<PkgIndex> getPackages()
                              throws EnterprisePluginException

Throws:

EnterprisePluginException

getPackage

Pkg getPackage(java.util.UUID pkgId)
        throws EnterprisePluginException

Throws:

EnterprisePluginException

uploadPackage

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

Parameters:

packageId - Required

file - Required path to the packaged JAR file to upload; required

Throws:

PackageNotFoundException - if the packageId does not exist

EnterprisePluginException

startSimulation

RunSummary startSimulation(java.util.UUID simulationId,
                           java.util.Map<java.lang.String,java.lang.String> systemProperties,
                           java.util.Map<java.lang.String,java.lang.String> environmentVariables)
                    throws EnterprisePluginException

Parameters:

simulationId - Required

systemProperties - Required (can be an empty map)

environmentVariables - Required (can be an empty map)

Throws:

SimulationStartException - when start failed for any reason

EnterprisePluginException

uploadPackageWithChecksum

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

Parameters:

packageId - Required

file - Required

Returns:

file size if uploaded, -1 when checksum are equals

Throws:

EnterprisePluginException

updateSimulationClassName

SimulationClassName updateSimulationClassName(java.util.UUID simulationId,
                                              java.lang.String className)
                                       throws EnterprisePluginException

Parameters:

simulationId - Required

className - Required

Returns:

updated simulation

Throws:

EnterprisePluginException

createSimulation

Simulation createSimulation(java.lang.String simulationName,
                            java.util.UUID teamId,
                            java.lang.String className,
                            java.util.UUID pkgId,
                            java.util.Map<java.lang.String,HostByLocation> hostsByLocation)
                     throws EnterprisePluginException

Throws:

EnterprisePluginException

createPackage

Pkg createPackage(java.lang.String packageName,
                  java.util.UUID teamId)
           throws EnterprisePluginException

Throws:

EnterprisePluginException

getRunInformation

RunInformation getRunInformation(java.util.UUID runId)
                          throws EnterprisePluginException

Parameters:

runId - Required

Returns:

Information on the requested run

Throws:

RunNotFoundException - if the runId does not exist

EnterprisePluginException

getConcurrentUserMetric

java.util.List<Series> getConcurrentUserMetric(java.util.UUID runId,
                                               java.lang.String scenario)
                                        throws EnterprisePluginException

Parameters:

runId - Required

scenario - Required

Throws:

EnterprisePluginException

getRequestsSummary

RequestsSummary getRequestsSummary(java.util.UUID runId)
                            throws EnterprisePluginException

Parameters:

runId - Required

Throws:

EnterprisePluginException

abortRun

boolean abortRun(java.util.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