io.perfana.client

Class PerfanaClient

java.lang.Object

io.perfana.client.PerfanaClient

All Implemented Interfaces:

PerfanaCaller

public final class PerfanaClient
extends Object
implements PerfanaCaller

Method Summary

Modifier and Type	Method and Description
void	abortSession() Call to abort this test run.
void	callPerfanaEvent(TestContext context, String eventDescription)
void	callPerfanaTestEndpoint(TestContext context, boolean completed)
boolean	isSessionStopped()
static String	perfanaMessageToJson(TestContext context, boolean completed)
void	startSession() Start a Perfana test session.
void	stopSession() Stop a Perfana test session.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

startSession

public void startSession()

Start a Perfana test session.

stopSession

public void stopSession()
                 throws PerfanaClientException,
                        PerfanaAssertionsAreFalse

Stop a Perfana test session.

Throws:

PerfanaClientException - when something fails, e.g. Perfana can not be reached

PerfanaAssertionsAreFalse - when the Perfana assertion check returned false

isSessionStopped

public boolean isSessionStopped()

abortSession

public void abortSession()

Call to abort this test run. A Perfana abort event is created. No Perfana assertions are checked.

callPerfanaTestEndpoint

public void callPerfanaTestEndpoint(TestContext context,
                                    boolean completed)

Specified by:

callPerfanaTestEndpoint in interface PerfanaCaller

callPerfanaEvent

public void callPerfanaEvent(TestContext context,
                             String eventDescription)

Specified by:

callPerfanaEvent in interface PerfanaCaller

perfanaMessageToJson

public static String perfanaMessageToJson(TestContext context,
                                          boolean completed)

toString

public String toString()

Overrides:

toString in class Object