org.ops4j.pax.exam

Interface ExamSystem

public interface ExamSystem

An instance that drives cross cutting concerns when using Pax Exam. - Provides System Resource Locations, - Cross Cutting default properties, - access to API entry (building probes, getting TestContainerFactory etc.)

Author:

Toni Menzel ( toni@okidokiteam.com )

Method Summary

Modifier and Type	Method and Description
void	clear() Clears up resources taken by system (like temporary files)
String	createID(String purposeText) Exam relies on uniquely used identifiers per system.
TestProbeBuilder	createProbe() New Probe creator using this systems "caches".
ExamSystem	fork(Option[] options)
File	getConfigFolder()
<T extends Option> T[]	getOptions(Class<T> optionType) Getting options of this "system".
<T extends Option> T	getSingleOption(Class<T> optionType) A shortcut to getOptions(Class) when expecting a single value.
File	getTempFolder() Each call to this method might create a new folder that is being cleared on clear().
RelativeTimeout	getTimeout()

Method Detail

getSingleOption

<T extends Option> T getSingleOption(Class<T> optionType)

A shortcut to getOptions(Class) when expecting a single value.

Type Parameters:

T - option type

Parameters:

optionType - type of option to be retrieved.

Returns:

option matching the parameter type T or null if no option was found. Implementations may rule of their own how to react when multiple values are found (check their javadoc).

getOptions

<T extends Option> T[] getOptions(Class<T> optionType)

Getting options of this "system". This is the prime method on accessing options of a giving system.

Type Parameters:

T - option type

Parameters:

optionType - type of option to be retrieved.

Returns:

options matching the parameter type T. If none was found, this method returns an empty array.

fork

ExamSystem fork(Option[] options)

Parameters:

options - options to be used additionally in this fork

Returns:

a forked ExamSystem instance (new instance). The parent ExamSysten (the one you called fork on) will notice and take care to bring down forked instances on cleanup (for example).

getConfigFolder

File getConfigFolder()

Returns:

the basic directory that Exam should use to look at user-defaults.

getTempFolder

File getTempFolder()

Each call to this method might create a new folder that is being cleared on clear().

Returns:

the basic directory that Exam should use for all IO write activities.

getTimeout

RelativeTimeout getTimeout()

Returns:

a relative indication of how to deal with timeouts.

createProbe

TestProbeBuilder createProbe()
                      throws IOException

New Probe creator using this systems "caches".

Returns:

a new TestProbeBuilder that can be used to create the actual probe.

Throws:

IOException - in case of an IO problem.

createID

String createID(String purposeText)

Exam relies on uniquely used identifiers per system. This method gives you one UUID.

Parameters:

purposeText - Human readable (short) text that can be used to backtrack the created identifier (for debugging and logging purposes)

Returns:

a new and unqiue identifier.

clear

void clear()

Clears up resources taken by system (like temporary files)