Package io.gatling.plugin.client.http

Class HttpEnterpriseClient

java.lang.Object

io.gatling.plugin.client.http.HttpEnterpriseClient

All Implemented Interfaces:

EnterpriseClient

public final class HttpEnterpriseClient
extends Object
implements EnterpriseClient

Constructor Summary

Constructors

Constructor	Description
HttpEnterpriseClient(URL baseUrl, String token, String client, String version, URL privateControlPlaneUrl)

Method Summary

Modifier and Type	Method	Description
boolean	abortRun(UUID runId)
Pkg	createPackage(String packageName, UUID teamId)
Simulation	createSimulation(String simulationName, UUID teamId, String className, UUID pkgId, Map<String,HostByLocation> hostsByLocation)
URL	getBaseUrl()
List<Series>	getConcurrentUserMetric(UUID runId, String scenario)
Locations	getLocations()
Pkg	getPackage(UUID pkgId)
List<PkgIndex>	getPackages()
RequestsSummary	getRequestsSummary(UUID runId)
RunInformation	getRunInformation(UUID runId)
ServerInformation	getServerInformation()
Simulation	getSimulation(UUID simulationId)
List<Simulation>	getSimulations()
List<Team>	getTeams()
RunSummary	startSimulation(UUID simulationId, Map<String,String> systemProperties, Map<String,String> environmentVariables)
SimulationClassName	updateSimulationClassName(UUID simulationId, String className)
long	uploadPackage(UUID packageId, File file)
UUID	uploadPackageConfiguration(String jsonConfiguration)
long	uploadPackageWithChecksum(UUID packageId, File file)

Methods inherited from class java.lang.Object

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

Constructor Details

HttpEnterpriseClient

public HttpEnterpriseClient(URL baseUrl,
 String token,
 String client,
 String version,
 URL privateControlPlaneUrl)
                     throws EnterprisePluginException

Parameters:

baseUrl - Base URL for the Gatling Enterprise server, e.g. https://cloud.gatling.io

token - Authentication token used to access the public API

client - Name of the calling client, used to verify if it is supported by the API

version - Version of the calling client, used to verify if it is supported by the API

privateControlPlaneUrl - (optional) Base URL for a Gatling Enterprise private control plane providing a private repository. If this parameter is provided, packages will be registered as private packages and uploaded through this private control plane.

Throws:

EnterprisePluginException

Method Details

getBaseUrl

public URL getBaseUrl()

Specified by:

getBaseUrl in interface EnterpriseClient

getServerInformation

public ServerInformation getServerInformation()
                                       throws EnterprisePluginException

Specified by:

getServerInformation in interface EnterpriseClient

Throws:

EnterprisePluginException

getSimulations

public List<Simulation> getSimulations()
                                throws EnterprisePluginException

Specified by:

getSimulations in interface EnterpriseClient

Throws:

EnterprisePluginException

getSimulation

public Simulation getSimulation(UUID simulationId)
                         throws EnterprisePluginException

Specified by:

getSimulation in interface EnterpriseClient

Throws:

EnterprisePluginException

getTeams

public List<Team> getTeams()
                    throws EnterprisePluginException

Specified by:

getTeams in interface EnterpriseClient

Throws:

EnterprisePluginException

getLocations

public Locations getLocations()
                       throws EnterprisePluginException

Specified by:

getLocations in interface EnterpriseClient

Throws:

EnterprisePluginException

getPackages

public List<PkgIndex> getPackages()
                           throws EnterprisePluginException

Specified by:

getPackages in interface EnterpriseClient

Throws:

EnterprisePluginException

getPackage

public Pkg getPackage(UUID pkgId)
               throws EnterprisePluginException

Specified by:

getPackage in interface EnterpriseClient

Throws:

EnterprisePluginException

uploadPackage

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

Specified by:

uploadPackage in interface EnterpriseClient

Parameters:

packageId - Required

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

Throws:

EnterprisePluginException

uploadPackageConfiguration

public UUID uploadPackageConfiguration(String jsonConfiguration)
                                throws EnterprisePluginException

Specified by:

uploadPackageConfiguration in interface EnterpriseClient

Parameters:

jsonConfiguration - Package configuration file, serialized JSON

Returns:

Package id

Throws:

EnterprisePluginException

startSimulation

public RunSummary startSimulation(UUID simulationId,
 Map<String,String> systemProperties,
 Map<String,String> environmentVariables)
                           throws EnterprisePluginException

Specified by:

startSimulation in interface EnterpriseClient

Parameters:

simulationId - Required

systemProperties - Required (can be an empty map)

environmentVariables - Required (can be an empty map)

Throws:

EnterprisePluginException

uploadPackageWithChecksum

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

Specified by:

uploadPackageWithChecksum in interface EnterpriseClient

Parameters:

packageId - Required

file - Required

Returns:

file size if uploaded, -1 when checksum are equals

Throws:

EnterprisePluginException

updateSimulationClassName

public SimulationClassName updateSimulationClassName(UUID simulationId,
 String className)
                                              throws EnterprisePluginException

Specified by:

updateSimulationClassName in interface EnterpriseClient

Parameters:

simulationId - Required

className - Required

Returns:

updated simulation

Throws:

EnterprisePluginException

createSimulation

public Simulation createSimulation(String simulationName,
 UUID teamId,
 String className,
 UUID pkgId,
 Map<String,HostByLocation> hostsByLocation)
                            throws EnterprisePluginException

Specified by:

createSimulation in interface EnterpriseClient

Throws:

EnterprisePluginException

createPackage

public Pkg createPackage(String packageName,
 UUID teamId)
                  throws EnterprisePluginException

Specified by:

createPackage in interface EnterpriseClient

Throws:

EnterprisePluginException

getRunInformation

public RunInformation getRunInformation(UUID runId)
                                 throws EnterprisePluginException

Specified by:

getRunInformation in interface EnterpriseClient

Parameters:

runId - Required

Returns:

Information on the requested run

Throws:

EnterprisePluginException

getConcurrentUserMetric

public List<Series> getConcurrentUserMetric(UUID runId,
 String scenario)
                                     throws EnterprisePluginException

Specified by:

getConcurrentUserMetric in interface EnterpriseClient

Parameters:

runId - Required

scenario - Required

Throws:

EnterprisePluginException

getRequestsSummary

public RequestsSummary getRequestsSummary(UUID runId)
                                   throws EnterprisePluginException

Specified by:

getRequestsSummary in interface EnterpriseClient

Parameters:

runId - Required

Throws:

EnterprisePluginException

abortRun

public boolean abortRun(UUID runId)
                 throws EnterprisePluginException

Specified by:

abortRun in interface EnterpriseClient

Parameters:

runId - Required

Returns:

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

Throws:

EnterprisePluginException