Package io.gatling.plugin.client

Class EnterpriseClient

java.lang.Object

io.gatling.plugin.client.EnterpriseClient

Direct Known Subclasses:

HttpEnterpriseClient

public abstract class EnterpriseClient
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final BuildPlugin	buildPlugin

Constructor Summary

Constructors

Constructor	Description
EnterpriseClient(BuildPlugin buildPlugin)

Method Summary

Modifier and Type	Method	Description
abstract boolean	abortRun(UUID runId)
abstract Pkg	createPackage(String packageName, UUID teamId)
abstract DeployedPkgInfo	deployPkg(com.fasterxml.jackson.databind.JsonNode descriptor, String artifactId, Boolean usePrivateRepository)
abstract List<DeployedSimulationInfo>	deploySimulations(UUID pkgId, com.fasterxml.jackson.databind.JsonNode descriptor)
abstract List<Series>	getConcurrentUserMetric(UUID runId, String scenario)
abstract Pkg	getPackage(UUID pkgId)
abstract List<PkgIndex>	getPackages()
abstract RequestsSummary	getRequestsSummary(UUID runId)
abstract RunInformation	getRunInformation(UUID runId)
abstract ServerInformation	getServerInformation()
abstract Simulation	getSimulation(UUID simulationId)
abstract RunSummary	startSimulation(UUID simulationId, RunComment runComment)
abstract long	uploadPackage(UUID packageId, File file)
abstract long	uploadPackageWithChecksum(UUID packageId, File file)

Methods inherited from class java.lang.Object

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

Field Details

buildPlugin

protected final BuildPlugin buildPlugin

Constructor Details

EnterpriseClient

public EnterpriseClient(BuildPlugin buildPlugin)

Method Details

getServerInformation

public abstract ServerInformation getServerInformation()
                                                throws EnterprisePluginException

Throws:

EnterprisePluginException

getSimulation

public abstract Simulation getSimulation(UUID simulationId)
                                  throws EnterprisePluginException

Throws:

EnterprisePluginException

getPackages

public abstract List<PkgIndex> getPackages()
                                    throws EnterprisePluginException

Throws:

EnterprisePluginException

getPackage

public abstract Pkg getPackage(UUID pkgId)
                        throws EnterprisePluginException

Throws:

EnterprisePluginException

uploadPackage

public abstract long uploadPackage(UUID packageId,
 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

uploadPackageWithChecksum

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

Parameters:

packageId - Required

file - Required

Returns:

file size if uploaded, -1 when checksum are equals

Throws:

EnterprisePluginException

createPackage

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

Throws:

EnterprisePluginException

getRunInformation

public abstract RunInformation getRunInformation(UUID runId)
                                          throws EnterprisePluginException

Parameters:

runId - Required

Returns:

Information on the requested run

Throws:

RunNotFoundException - if the runId does not exist

EnterprisePluginException

getConcurrentUserMetric

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

Parameters:

runId - Required

scenario - Required

Throws:

EnterprisePluginException

getRequestsSummary

public abstract RequestsSummary getRequestsSummary(UUID runId)
                                            throws EnterprisePluginException

Parameters:

runId - Required

Throws:

EnterprisePluginException

abortRun

public abstract boolean abortRun(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

deployPkg

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

Throws:

EnterprisePluginException

deploySimulations

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

Throws:

EnterprisePluginException

startSimulation

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

Throws:

EnterprisePluginException