qat.common
Class Common

java.lang.Object
  qat.common.Common

public abstract class Common

extends java.lang.Object

Field Summary

static java.lang.String	AGENT_COUNT This variable indicates to the test scripts the number of agents * which have been defined in this project session.
static java.lang.String	AGENT_DIR_NAME This is the offset into the BASE_DIR_NAME used to store * info related to the agent.
static java.lang.String	AUTOSAVE_PROJECT
static java.lang.String	BASE_DIR_NAME This directory will be created off the users home directory if it does not exists, * and is used to store session info, and project results.
static java.lang.String	CONSOLE_BUFFER_SIZE
static java.lang.String	CONSOLE_BUFFER_SIZE_VALUE
static java.lang.String	CONSOLE_DEBUG_LEVEL
static java.lang.String	CONSOLE_DEBUG_LEVEL_VALUE
static java.lang.String	CURRENT_PROPERTIES_VERSION
static java.lang.String	DEFAULT_PARSER_CLASSNAMES
static java.lang.String	DEFAULT_PROJECTNAME This is the default name for a project.
static java.lang.String	DEFAULT_TESTFINDER_CLASSNAMES
static java.lang.String	DiscoveryProbeString
static java.lang.String	ENV_TRACE_SUFFIX The name which will be used to suffix environment trace files recieved from the agents.
static java.lang.String	HARNESS_DIR_NAME This is the offset into the BASE_DIR_NAME used to store * info related to the harness.
static java.lang.String	host These are the agent name string used to reference defined agents * from within the test scripts
static java.lang.String	hostArchPattern
static java.lang.String	hostNamePattern
static java.lang.String	hostOSPattern
static java.lang.String	hostPortPattern
static java.lang.String	HTTP_PORT_DEFAULT
static java.lang.String	HTTP_PORT_KEY
static java.lang.String	LOOK_AND_FEEL_KEY
static java.lang.String	MultiCastGroup
static int	MultiCastPort
static java.lang.String	PARSER_CLASSNAMES
static java.lang.String	PARSER_TRACE_SUFFIX The name which will be used to suffix trace files recieved from the agents.
static java.awt.Color	parserOutputBackground
static java.awt.Color	parserOutputForeground
static java.lang.String	PLUGIN_CLASSES
static java.lang.String	PROJECT_FILE_SUFFIX This is the default extension the QAT Harness will use for storing/retrieving * project files via the system menu.
static java.lang.String	PROJECT_PROPERTYNAME_KEY This key maps to the name of our current project name in the session.properties file.
static java.lang.String	PROJECTPATH_KEY This is a variable visible to all test scripts indicating the root * location of the test directory.
static java.lang.String	PROPERTIES_EXTENSION This is the extension which will signify a file is compliant with the java.util.Properties definition.
static java.lang.String	PROPERTIES_VERSION For internal use only.
static java.lang.String	RESET_STATUS
static java.lang.String	RESULTS_DIR_NAME This is the offset into the HARNESS_DIR_NAME used to store * info related to the harness results.
static java.lang.String	REUSE_TRACE_WINDOW
static java.lang.String	SERIALIZED_NODE_HEADERV10 This is the current version of the serialized nodes used to allow backward compatibility * with saved results.
static java.lang.String	SERIALIZED_NODE_HEADERV11
static java.lang.String	SERIALIZED_NODE_HEADERV12
static java.lang.String	SERIALIZED_NODE_HEADERV13
static java.lang.String	SERIALIZED_TREE_EXTENSION This is the extension used to store a serialized version of the Test Tree, to save time reparsing the tests * each time the application is started/stopped.
static java.lang.String	SESSION_FILE_NAME This is the name of the file which will store the users last session values.
static java.lang.String	STDERR_TRACE_SUFFIX The name which will be used to suffix stderr trace files recieved from the agents.
static java.lang.String	STDOUT_TRACE_SUFFIX The name which will be used to suffix stdout trace files recieved from the agents.
static java.lang.String	SYNTAX_HIGHLIGHTING
static java.awt.Color	testDetailDescriptionBackground
static java.awt.Color	testDetailDescriptionForeground
static java.awt.Color	testDetailOutputBackground
static java.awt.Color	testDetailOutputForeground
static java.lang.String	TESTFINDER_CLASSNAMES
static int	TimeToDiscover
static byte	TimeToLive
static java.lang.String	VERSION This is the current version of the package

Constructor Summary

Common()

Method Summary

static java.lang.String	getBaseDirectory() This returns the base directory used to store all the agent & harness files.
static java.lang.String	getHarnessBaseDirectory() All files created by the harness are relative to this offset.
static java.lang.String	getProjectName(java.lang.String projectFileName) Returns the name of the project, without any file suffix or path info.
static java.lang.String	getProjectResultsDirectory(java.lang.String projectFileName) This is the directory, based on the project name, which contains all the traces from * a given project run.
static java.lang.String	getUniqueTestIdentifier(java.lang.String testName) We create a short unique name based on the hash value of the root portion * of the path, concat with the name portion of the path.

Methods inherited from class java.lang.Object

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

Field Detail

parserOutputForeground

public static final java.awt.Color parserOutputForeground

parserOutputBackground

public static final java.awt.Color parserOutputBackground

testDetailDescriptionForeground

public static final java.awt.Color testDetailDescriptionForeground

testDetailDescriptionBackground

public static final java.awt.Color testDetailDescriptionBackground

testDetailOutputForeground

public static final java.awt.Color testDetailOutputForeground

testDetailOutputBackground

public static final java.awt.Color testDetailOutputBackground

VERSION

public static final java.lang.String VERSION

This is the current version of the package. * All classes refer to this variable when version control is needed.

See Also:

Constant Field Values

SERIALIZED_NODE_HEADERV10

public static final java.lang.String SERIALIZED_NODE_HEADERV10

This is the current version of the serialized nodes used to allow backward compatibility * with saved results.

See Also:

Constant Field Values

SERIALIZED_NODE_HEADERV11

public static final java.lang.String SERIALIZED_NODE_HEADERV11

See Also:

Constant Field Values

SERIALIZED_NODE_HEADERV12

public static final java.lang.String SERIALIZED_NODE_HEADERV12

See Also:

Constant Field Values

SERIALIZED_NODE_HEADERV13

public static final java.lang.String SERIALIZED_NODE_HEADERV13

See Also:

Constant Field Values

DiscoveryProbeString

public static final java.lang.String DiscoveryProbeString

See Also:

Constant Field Values

MultiCastPort

public static final int MultiCastPort

See Also:

Constant Field Values

TimeToLive

public static final byte TimeToLive

See Also:

Constant Field Values

TimeToDiscover

public static final int TimeToDiscover

See Also:

Constant Field Values

MultiCastGroup

public static final java.lang.String MultiCastGroup

See Also:

Constant Field Values

PROJECT_FILE_SUFFIX

public static final java.lang.String PROJECT_FILE_SUFFIX

This is the default extension the QAT Harness will use for storing/retrieving * project files via the system menu.

See Also:

Constant Field Values

PROPERTIES_EXTENSION

public static final java.lang.String PROPERTIES_EXTENSION

This is the extension which will signify a file is compliant with the java.util.Properties definition.

See Also:

Constant Field Values

SERIALIZED_TREE_EXTENSION

public static final java.lang.String SERIALIZED_TREE_EXTENSION

This is the extension used to store a serialized version of the Test Tree, to save time reparsing the tests * each time the application is started/stopped.

See Also:

Constant Field Values

SESSION_FILE_NAME

public static final java.lang.String SESSION_FILE_NAME

This is the name of the file which will store the users last session values.

See Also:

Constant Field Values

BASE_DIR_NAME

public static final java.lang.String BASE_DIR_NAME

This directory will be created off the users home directory if it does not exists, * and is used to store session info, and project results. It is used/created by both the agent and * the harness.

See Also:

Constant Field Values

STDOUT_TRACE_SUFFIX

public static final java.lang.String STDOUT_TRACE_SUFFIX

The name which will be used to suffix stdout trace files recieved from the agents.

See Also:

Constant Field Values

STDERR_TRACE_SUFFIX

public static final java.lang.String STDERR_TRACE_SUFFIX

The name which will be used to suffix stderr trace files recieved from the agents.

See Also:

Constant Field Values

ENV_TRACE_SUFFIX

public static final java.lang.String ENV_TRACE_SUFFIX

The name which will be used to suffix environment trace files recieved from the agents.

See Also:

Constant Field Values

PARSER_TRACE_SUFFIX

public static final java.lang.String PARSER_TRACE_SUFFIX

The name which will be used to suffix trace files recieved from the agents.

See Also:

Constant Field Values

HARNESS_DIR_NAME

public static final java.lang.String HARNESS_DIR_NAME

This is the offset into the BASE_DIR_NAME used to store * info related to the harness.

See Also:

Constant Field Values

AGENT_DIR_NAME

public static final java.lang.String AGENT_DIR_NAME

This is the offset into the BASE_DIR_NAME used to store * info related to the agent.

See Also:

Constant Field Values

RESULTS_DIR_NAME

public static final java.lang.String RESULTS_DIR_NAME

This is the offset into the HARNESS_DIR_NAME used to store * info related to the harness results.

See Also:

Constant Field Values

PROJECTPATH_KEY

public static final java.lang.String PROJECTPATH_KEY

This is a variable visible to all test scripts indicating the root * location of the test directory.

See Also:

Constant Field Values

PROJECT_PROPERTYNAME_KEY

public static final java.lang.String PROJECT_PROPERTYNAME_KEY

This key maps to the name of our current project name in the session.properties file.

See Also:

Constant Field Values

DEFAULT_PROJECTNAME

public static final java.lang.String DEFAULT_PROJECTNAME

This is the default name for a project.

See Also:

Constant Field Values

host

public static final java.lang.String host

These are the agent name string used to reference defined agents * from within the test scripts. * Eg if only one agent is defined, it can be referred to in a * test script as : AGENT1_NAME, AGENT1_PORT etc.

See Also:

Constant Field Values

hostNamePattern

public static final java.lang.String hostNamePattern

See Also:

Constant Field Values

hostPortPattern

public static final java.lang.String hostPortPattern

See Also:

Constant Field Values

hostArchPattern

public static final java.lang.String hostArchPattern

See Also:

Constant Field Values

hostOSPattern

public static final java.lang.String hostOSPattern

See Also:

Constant Field Values

AGENT_COUNT

public static final java.lang.String AGENT_COUNT

This variable indicates to the test scripts the number of agents * which have been defined in this project session.

See Also:

Constant Field Values

PROPERTIES_VERSION

public static final java.lang.String PROPERTIES_VERSION

For internal use only. These are accesible from the harness GUI by * editing the project options.

See Also:

Constant Field Values

CURRENT_PROPERTIES_VERSION

public static final java.lang.String CURRENT_PROPERTIES_VERSION

See Also:

Constant Field Values

LOOK_AND_FEEL_KEY

public static final java.lang.String LOOK_AND_FEEL_KEY

See Also:

Constant Field Values

HTTP_PORT_KEY

public static final java.lang.String HTTP_PORT_KEY

See Also:

Constant Field Values

HTTP_PORT_DEFAULT

public static final java.lang.String HTTP_PORT_DEFAULT

See Also:

Constant Field Values

AUTOSAVE_PROJECT

public static final java.lang.String AUTOSAVE_PROJECT

See Also:

Constant Field Values

SYNTAX_HIGHLIGHTING

public static final java.lang.String SYNTAX_HIGHLIGHTING

See Also:

Constant Field Values

RESET_STATUS

public static final java.lang.String RESET_STATUS

See Also:

Constant Field Values

REUSE_TRACE_WINDOW

public static final java.lang.String REUSE_TRACE_WINDOW

See Also:

Constant Field Values

PARSER_CLASSNAMES

public static final java.lang.String PARSER_CLASSNAMES

See Also:

Constant Field Values

TESTFINDER_CLASSNAMES

public static final java.lang.String TESTFINDER_CLASSNAMES

See Also:

Constant Field Values

PLUGIN_CLASSES

public static final java.lang.String PLUGIN_CLASSES

See Also:

Constant Field Values

DEFAULT_PARSER_CLASSNAMES

public static final java.lang.String DEFAULT_PARSER_CLASSNAMES

See Also:

Constant Field Values

DEFAULT_TESTFINDER_CLASSNAMES

public static final java.lang.String DEFAULT_TESTFINDER_CLASSNAMES

See Also:

Constant Field Values

CONSOLE_BUFFER_SIZE

public static final java.lang.String CONSOLE_BUFFER_SIZE

See Also:

Constant Field Values

CONSOLE_BUFFER_SIZE_VALUE

public static final java.lang.String CONSOLE_BUFFER_SIZE_VALUE

See Also:

Constant Field Values

CONSOLE_DEBUG_LEVEL

public static final java.lang.String CONSOLE_DEBUG_LEVEL

See Also:

Constant Field Values

CONSOLE_DEBUG_LEVEL_VALUE

public static final java.lang.String CONSOLE_DEBUG_LEVEL_VALUE

See Also:

Constant Field Values

Constructor Detail

Common

public Common()

Method Detail

getBaseDirectory

public static java.lang.String getBaseDirectory()

This returns the base directory used to store all the agent & harness files.

getHarnessBaseDirectory

public static java.lang.String getHarnessBaseDirectory()

All files created by the harness are relative to this offset.

getProjectName

public static java.lang.String getProjectName(java.lang.String projectFileName)

Returns the name of the project, without any file suffix or path info.

getProjectResultsDirectory

public static java.lang.String getProjectResultsDirectory(java.lang.String projectFileName)

This is the directory, based on the project name, which contains all the traces from * a given project run.

getUniqueTestIdentifier

public static java.lang.String getUniqueTestIdentifier(java.lang.String testName)

We create a short unique name based on the hash value of the root portion * of the path, concat with the name portion of the path.