Package io.perfana.client

Class PerfanaClient

java.lang.Object

io.perfana.client.PerfanaClient

All Implemented Interfaces:

PerfanaCaller

public final class PerfanaClient
extends Object
implements PerfanaCaller

Field Summary

Fields

Modifier and Type	Field	Description
static PerfanaErrorMessage	PERFANA_ERROR_MESSAGE_NOT_FOUND
static PerfanaSingleMessage	PERFANA_SINGLE_MESSAGE_NOT_FOUND

Method Summary

Modifier and Type	Method	Description
void	addTestRunConfigJson(TestRunConfigJson testRunConfigJson)
void	addTestRunConfigKeys(TestRunConfigKeys testRunConfigKeys)
void	addTestRunConfigKeyValue(TestRunConfigKeyValue testRunConfigKeyValue)
String	assertResults()
String	callInitTest(PerfanaTestContext context)	Call before test starts to get a unique test run id.
void	callPerfanaEvent(PerfanaTestContext context, String eventTitle, String eventDescription)
void	callPerfanaTestEndpoint(PerfanaTestContext context, boolean completed)
void	callPerfanaTestEndpoint(PerfanaTestContext context, boolean completed, Map<String,String> extraVariables)
static String	perfanaMessageToJson(PerfanaTestContext context, boolean completed, Map<String,String> extraVariables)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PERFANA_ERROR_MESSAGE_NOT_FOUND

public static final PerfanaErrorMessage PERFANA_ERROR_MESSAGE_NOT_FOUND

PERFANA_SINGLE_MESSAGE_NOT_FOUND

public static final PerfanaSingleMessage PERFANA_SINGLE_MESSAGE_NOT_FOUND

Method Detail

callPerfanaTestEndpoint

public void callPerfanaTestEndpoint(PerfanaTestContext context,
                                    boolean completed)
                             throws io.perfana.eventscheduler.exception.handler.KillSwitchException

Specified by:

callPerfanaTestEndpoint in interface PerfanaCaller

Throws:

io.perfana.eventscheduler.exception.handler.KillSwitchException

callPerfanaTestEndpoint

public void callPerfanaTestEndpoint(PerfanaTestContext context,
                                    boolean completed,
                                    Map<String,String> extraVariables)
                             throws io.perfana.eventscheduler.exception.handler.KillSwitchException

Specified by:

callPerfanaTestEndpoint in interface PerfanaCaller

Throws:

io.perfana.eventscheduler.exception.handler.KillSwitchException

callPerfanaEvent

public void callPerfanaEvent(PerfanaTestContext context,
                             String eventTitle,
                             String eventDescription)

Specified by:

callPerfanaEvent in interface PerfanaCaller

perfanaMessageToJson

public static String perfanaMessageToJson(PerfanaTestContext context,
                                          boolean completed,
                                          Map<String,String> extraVariables)

assertResults

public String assertResults()
                     throws PerfanaClientException,
                            PerfanaAssertResultsException,
                            PerfanaAssertionsAreFalse

Throws:

PerfanaClientException

PerfanaAssertResultsException

PerfanaAssertionsAreFalse

toString

public String toString()

Overrides:

toString in class Object

addTestRunConfigKeyValue

public void addTestRunConfigKeyValue(TestRunConfigKeyValue testRunConfigKeyValue)

addTestRunConfigJson

public void addTestRunConfigJson(TestRunConfigJson testRunConfigJson)

addTestRunConfigKeys

public void addTestRunConfigKeys(TestRunConfigKeys testRunConfigKeys)

callInitTest

public String callInitTest(PerfanaTestContext context)

Description copied from interface: PerfanaCaller

Call before test starts to get a unique test run id.

Specified by:

callInitTest in interface PerfanaCaller

Parameters:

context - the test context

Returns:

the testRunId or null if the call failed.