nl.stokpop.eventscheduler.api

Interface Event

All Known Implementing Classes:

EventAdapter, EventDefault

public interface Event

This interface can be implemented in other jars and be put on the classpath. Provide a file in META-INF/services/nl.stokpop.eventscheduler.api.Event 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	abortTest() Called for test abort.
void	afterTest() Called after the test run is done.
default java.util.Collection<java.lang.String>	allowedCustomEvents()
default java.util.Collection<java.lang.String>	allowedProperties()
void	beforeTest() Called before the test run starts.
EventCheck	check() Called to check test results (for example the requirements are checked).
void	customEvent(CustomEvent scheduleEvent) Called for each custom event, according to the custom even schedule.
java.lang.String	getName()
void	keepAlive() Called for each keep alive event for this test run.

Method Detail

getName

java.lang.String getName()

Returns:

name of the test event.

beforeTest

void beforeTest()

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

afterTest

void afterTest()

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

keepAlive

void keepAlive()

Called for each keep alive event for this test run.

abortTest

void abortTest()

Called for test abort.

check

EventCheck check()

Called to check test results (for example the requirements are checked). Can be used to have a test run fail or succeed in continuous integration setups.

Returns:

even check that indicated a failed or successful run for this event.

customEvent

void customEvent(CustomEvent scheduleEvent)

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

Parameters:

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

allowedProperties

default java.util.Collection<java.lang.String> allowedProperties()

Returns:

collection of strings for all allowed properties

allowedCustomEvents

default java.util.Collection<java.lang.String> allowedCustomEvents()

Returns:

collection of strings for all allowed custom events