com.segue.tm.published.api.testlaunch

Interface TestLaunchPluginContext

public interface TestLaunchPluginContext

Represents an access point to obtain various information from the test mananger framework. Currently the plugin may access the plugin configuration file content, a temporary directory associated to a plugin instance and info about local paths of copies of VCS controlled files. Further, the plugin can obtain custom parameters that have been defined in the GUI. This interface is planned to be extended in future versions.

Method Summary

Modifier and Type	Method and Description
org.jdom.Element	getConfigContentRoot() Gets the root element of the JDOM content of the configuration file of this plugin type.
java.util.Map<java.lang.String,java.lang.String>	getParameterValueStrings() Retrieves parameter definitions for this test definition.
java.io.File	getPluginHomeDir() Provides the path to the directory where the archive content for this plugin type has been extracted to.
java.io.File	getPrivateTempDir() Get the path of the private temporary directory of the associated instance.
int	getTestDefinitionId()
TestSourceContext	getTestSourceContext() Provides access to local paths of copies of VCS controlled files.

Method Detail

getPluginHomeDir

java.io.File getPluginHomeDir()

Provides the path to the directory where the archive content for this plugin type has been extracted to. There is one directory for each plugin type, all instances of that plugin share this directory. Note: Don't change files in this directory, only read files and or set classpath or library paths to this directory.

Returns:

the path to the directory where the archive content for this plugin type has been extracted to.

getConfigContentRoot

org.jdom.Element getConfigContentRoot()

Gets the root element of the JDOM content of the configuration file of this plugin type. For each type arbitrary information can be stored in the config.xml file being accessible via this method.

Returns:

the root element of the JDOM structure of the configuration file of this type

getPrivateTempDir

java.io.File getPrivateTempDir()

Get the path of the private temporary directory of the associated instance. Each test instance has an associated exclusive temporary directory where it may store arbitrary files. This directory is cleaned up when the instance is garbage collected. If the test source originates from the database (packaged), this directory also contains the extracted source files.

Returns:

the path of the private temporary directory of the associated instance.

getTestDefinitionId

int getTestDefinitionId()

Returns:

the id (database key) of the associated test definition to be executed.

getTestSourceContext

TestSourceContext getTestSourceContext()

Provides access to local paths of copies of VCS controlled files.

Returns:

access to local paths of copies of VCS controlled files.

getParameterValueStrings

java.util.Map<java.lang.String,java.lang.String> getParameterValueStrings()

Retrieves parameter definitions for this test definition. Numeric parameter values are provided in their string representation.

Returns:

contains mappings from a parameter name (key) to its string value.