Package 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	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)

Method Details

getBaseUrl

URL getBaseUrl()

getServerInformation

ServerInformation getServerInformation()
                                throws EnterprisePluginException

Throws:

EnterprisePluginException

getSimulations

List<Simulation> getSimulations()
                         throws EnterprisePluginException

Throws:

EnterprisePluginException

getSimulation

Simulation getSimulation(UUID simulationId)
                  throws EnterprisePluginException

Throws:

EnterprisePluginException

getTeams

List<Team> getTeams()
             throws EnterprisePluginException

Throws:

EnterprisePluginException

getLocations

Locations getLocations()
                throws EnterprisePluginException

Throws:

EnterprisePluginException

getPackages

List<PkgIndex> getPackages()
                    throws EnterprisePluginException

Throws:

EnterprisePluginException

getPackage

Pkg getPackage(UUID pkgId)
        throws EnterprisePluginException

Throws:

EnterprisePluginException

uploadPackage

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

uploadPackageConfiguration

UUID uploadPackageConfiguration(String jsonConfiguration)
                         throws EnterprisePluginException

Parameters:

jsonConfiguration - Package configuration file, serialized JSON

Returns:

Package id

Throws:

EnterprisePluginException

startSimulation

RunSummary startSimulation(UUID simulationId,
 Map<String,String> systemProperties,
 Map<String,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(UUID packageId,
 File file)
                        throws EnterprisePluginException

Parameters:

packageId - Required

file - Required

Returns:

file size if uploaded, -1 when checksum are equals

Throws:

EnterprisePluginException

updateSimulationClassName

SimulationClassName updateSimulationClassName(UUID simulationId,
 String className)
                                       throws EnterprisePluginException

Parameters:

simulationId - Required

className - Required

Returns:

updated simulation

Throws:

EnterprisePluginException

createSimulation

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

Throws:

EnterprisePluginException

createPackage

Pkg createPackage(String packageName,
 UUID teamId)
           throws EnterprisePluginException

Throws:

EnterprisePluginException

getRunInformation

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

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

Parameters:

runId - Required

scenario - Required

Throws:

EnterprisePluginException

getRequestsSummary

RequestsSummary getRequestsSummary(UUID runId)
                            throws EnterprisePluginException

Parameters:

runId - Required

Throws:

EnterprisePluginException

abortRun

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