Package io.gatling.plugin.client

Class HttpEnterpriseClient

java.lang.Object

io.gatling.plugin.client.EnterpriseClient

io.gatling.plugin.client.HttpEnterpriseClient

public final class HttpEnterpriseClient
extends EnterpriseClient

Field Summary

Fields inherited from class io.gatling.plugin.client.EnterpriseClient

buildPlugin

Constructor Summary

Constructors

Constructor	Description
HttpEnterpriseClient(URL apiUrl, String token, URL privateControlPlaneUrl, BuildPlugin buildPlugin)

Method Summary

Modifier and Type	Method	Description
boolean	abortRun(UUID runId)
Pkg	createPackage(String packageName, UUID teamId)
DeployedPkgInfo	deployPkg(com.fasterxml.jackson.databind.JsonNode descriptor, String artifactId, Boolean usePrivateRepository)
List<DeployedSimulationInfo>	deploySimulations(UUID pkgId, com.fasterxml.jackson.databind.JsonNode descriptor)
List<Series>	getConcurrentUserMetric(UUID runId, String scenario)
Pkg	getPackage(UUID pkgId)
List<PkgIndex>	getPackages()
RequestsSummary	getRequestsSummary(UUID runId)
RunInformation	getRunInformation(UUID runId)
ServerInformation	getServerInformation()
Simulation	getSimulation(UUID simulationId)
RunSummary	startSimulation(UUID simulationId, RunComment runComment)
long	uploadPackage(UUID packageId, File file)
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 apiUrl,
 String token,
 URL privateControlPlaneUrl,
 BuildPlugin buildPlugin)
                     throws EnterprisePluginException

Parameters:

apiUrl - Base URL for the Gatling Enterprise API, e.g. https://api.gatling.io

token - Authentication token used to access the public 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

getServerInformation

public ServerInformation getServerInformation()
                                       throws EnterprisePluginException

Specified by:

getServerInformation in class EnterpriseClient

Throws:

EnterprisePluginException

getSimulation

public Simulation getSimulation(UUID simulationId)
                         throws EnterprisePluginException

Specified by:

getSimulation in class EnterpriseClient

Throws:

EnterprisePluginException

getPackages

public List<PkgIndex> getPackages()
                           throws EnterprisePluginException

Specified by:

getPackages in class EnterpriseClient

Throws:

EnterprisePluginException

getPackage

public Pkg getPackage(UUID pkgId)
               throws EnterprisePluginException

Specified by:

getPackage in class EnterpriseClient

Throws:

EnterprisePluginException

uploadPackage

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

Specified by:

uploadPackage in class EnterpriseClient

Parameters:

packageId - Required

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

Throws:

EnterprisePluginException

uploadPackageWithChecksum

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

Specified by:

uploadPackageWithChecksum in class EnterpriseClient

Parameters:

packageId - Required

file - Required

Returns:

file size if uploaded, -1 when checksum are equals

Throws:

EnterprisePluginException

createPackage

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

Specified by:

createPackage in class EnterpriseClient

Throws:

EnterprisePluginException

getRunInformation

public RunInformation getRunInformation(UUID runId)
                                 throws EnterprisePluginException

Specified by:

getRunInformation in class 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 class EnterpriseClient

Parameters:

runId - Required

scenario - Required

Throws:

EnterprisePluginException

getRequestsSummary

public RequestsSummary getRequestsSummary(UUID runId)
                                   throws EnterprisePluginException

Specified by:

getRequestsSummary in class EnterpriseClient

Parameters:

runId - Required

Throws:

EnterprisePluginException

abortRun

public boolean abortRun(UUID runId)
                 throws EnterprisePluginException

Specified by:

abortRun in class EnterpriseClient

Parameters:

runId - Required

Returns:

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

Throws:

EnterprisePluginException

deployPkg

public DeployedPkgInfo deployPkg(com.fasterxml.jackson.databind.JsonNode descriptor,
 String artifactId,
 Boolean usePrivateRepository)
                          throws EnterprisePluginException

Specified by:

deployPkg in class EnterpriseClient

Throws:

EnterprisePluginException

deploySimulations

public List<DeployedSimulationInfo> deploySimulations(UUID pkgId,
 com.fasterxml.jackson.databind.JsonNode descriptor)
                                               throws EnterprisePluginException

Specified by:

deploySimulations in class EnterpriseClient

Throws:

EnterprisePluginException

startSimulation

public RunSummary startSimulation(UUID simulationId,
 RunComment runComment)
                           throws EnterprisePluginException

Specified by:

startSimulation in class EnterpriseClient

Throws:

EnterprisePluginException