io.perfana.event

Interface PerfanaEvent

All Known Implementing Classes:

PerfanaEventAdapter

public interface PerfanaEvent

This interface can be implemented in other jars and be put on the classpath. Provide a file in META-INF/services/io.perfana.event.PerfanaEvent that contains the fully qualified name of the implementing class. This class will be used when these events are called. Possibly you can even provide multiple implementations on the classpath that will all be called. For more information on how this technically works, check out javadoc of java.util.ServiceLoader.

Method Summary

Modifier and Type	Method and Description
void	afterTest(TestContext context, EventProperties properties) Called after the test run is done.
void	beforeTest(TestContext context, EventProperties properties) Called before the test run starts.
void	customEvent(TestContext context, EventProperties properties, ScheduleEvent scheduleEvent) Called for each custom event, according to the custom even schedule.
String	getName()
void	keepAlive(TestContext context, EventProperties properties) Called for each keep alive event for this test run.

Method Detail

getName

String getName()

Returns:

name of the test event.

beforeTest

void beforeTest(TestContext context,
                EventProperties properties)

Called before the test run starts. You can for instance cleanup the test environment and/or restart the server under test.

Parameters:

context - the test run context

properties - e.g. REST_URL="https://my-rest-url"

afterTest

void afterTest(TestContext context,
               EventProperties properties)

Called after the test run is done. Use for instance to start creating a report of some sort or remove the test environment.

Parameters:

context - the test run context

properties - e.g. REST_URL="https://my-rest-url"

keepAlive

void keepAlive(TestContext context,
               EventProperties properties)

Called for each keep alive event for this test run.

Parameters:

context - the test run context

properties - e.g. REST_URL="https://my-rest-url"

customEvent

void customEvent(TestContext context,
                 EventProperties properties,
                 ScheduleEvent scheduleEvent)

Called for each custom event, according to the custom even schedule.

Parameters:

context - the test run context

properties - e.g. REST_URL="https://my-rest-url"

scheduleEvent - the custom event, use to execute specific behaviour in the event handler