Configuration
public
class
Configuration
extends Object
implements
IConfiguration
java.lang.Object | |
↳ | com.android.tradefed.config.Configuration |
A concrete IConfiguration
implementation that stores the loaded config objects in a map.
Summary
Fields | |
---|---|
public
static
final
String |
BUILD_PROVIDER_TYPE_NAME
|
public
static
final
String |
CMD_OPTIONS_TYPE_NAME
|
public
static
final
String |
CONFIGURATION_DESCRIPTION_TYPE_NAME
|
public
static
final
String |
COVERAGE_OPTIONS_TYPE_NAME
|
public
static
final
String |
DEVICE_METRICS_COLLECTOR_TYPE_NAME
|
public
static
final
String |
DEVICE_NAME
|
public
static
final
String |
DEVICE_OPTIONS_TYPE_NAME
|
public
static
final
String |
DEVICE_RECOVERY_TYPE_NAME
|
public
static
final
String |
DEVICE_REQUIREMENTS_TYPE_NAME
|
public
static
final
String |
GLOBAL_FILTERS_TYPE_NAME
|
public
static
final
String |
LAB_PREPARER_TYPE_NAME
|
public
static
final
String |
LOGGER_TYPE_NAME
|
public
static
final
String |
LOG_SAVER_TYPE_NAME
|
public
static
final
String |
METRIC_POST_PROCESSOR_TYPE_NAME
|
public
static
final
String |
MULTI_PREPARER_TYPE_NAME
|
public
static
final
String |
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
|
public
static
final
String |
RESULT_REPORTER_TYPE_NAME
|
public
static
final
String |
RETRY_DECISION_TYPE_NAME
|
public
static
final
String |
SANBOX_OPTIONS_TYPE_NAME
|
public
static
final
String |
SANDBOX_TYPE_NAME
|
public
static
final
String |
SYSTEM_STATUS_CHECKER_TYPE_NAME
|
public
static
final
String |
TARGET_PREPARER_TYPE_NAME
|
public
static
final
String |
TEST_TYPE_NAME
|
Public constructors | |
---|---|
Configuration(String name, String description)
Creates an |
Public methods | |
---|---|
void
|
addFilesToClean(
Add files that must be cleaned during |
void
|
cleanConfigurationData()
Delete any files that was downloaded to resolved Option fields of remote files. |
Configuration
|
clone()
Creates a shallow copy of this object. |
void
|
dumpXml(PrintWriter output)
Gets the expanded XML file for the config with all options shown for this
|
void
|
dumpXml(PrintWriter output,
Gets the expanded XML file for the config with all options shown for this |
void
|
dumpXml(PrintWriter output,
Gets the expanded XML file for the config with all options shown for this |
|
getAllConfigurationObjectsOfType(String configType)
Generic interface to get all the object of one given type name across devices. |
IBuildProvider
|
getBuildProvider()
Gets the |
String
|
getCommandLine()
Gets the command line used to create this |
ICommandOptions
|
getCommandOptions()
Gets the |
ConfigurationDescriptor
|
getConfigurationDescription()
Returns the |
Object
|
getConfigurationObject(String typeName)
Generic interface to get the configuration object with the given type name. |
|
getConfigurationObjectList(String typeName)
Similar to |
CoverageOptions
|
getCoverageOptions()
Gets the |
String
|
getDescription()
|
|
getDeviceConfig()
Gets the |
IDeviceConfiguration
|
getDeviceConfigByName(String nameDevice)
Return the |
TestDeviceOptions
|
getDeviceOptions()
Gets the |
IDeviceRecovery
|
getDeviceRecovery()
Gets the |
IDeviceSelection
|
getDeviceRequirements()
Gets the |
|
getFilesToClean()
Get the list of files that will be cleaned during |
GlobalTestFilter
|
getGlobalFilters()
Gets the |
|
getInopOptions()
Get the option names that did not change any values |
|
getLabPreparers()
Gets the |
ILeveledLogOutput
|
getLogOutput()
Gets the |
ILogSaver
|
getLogSaver()
Gets the |
|
getMetricCollectors()
Gets the |
|
getMultiPreTargetPreparers()
Gets the |
|
getMultiTargetPreparers()
Gets the |
String
|
getName()
Returns the name of the configuration. |
|
getPostProcessors()
Gets the |
IRetryDecision
|
getRetryDecision()
Returns the |
|
getSystemStatusCheckers()
Gets the |
|
getTargetPreparers()
Gets the |
|
getTestInvocationListeners()
Gets the |
|
getTests()
Gets the |
void
|
injectOptionValue(String optionName, String optionValue)
Inject a option value into the set of configuration objects. |
void
|
injectOptionValue(String optionName, String optionKey, String optionValue)
Inject a option value into the set of configuration objects. |
void
|
injectOptionValueWithSource(String optionName, String optionKey, String optionValue, String source)
Inject a option value into the set of configuration objects. |
void
|
injectOptionValues(
Inject multiple option values into the set of configuration objects. |
boolean
|
isDeviceConfiguredFake(String deviceName)
Returns whether or not a configured device is tagged isFake=true or not. |
IConfiguration
|
partialDeepClone(
Create a base clone from |
void
|
printCommandUsage(boolean importantOnly, PrintStream out)
Outputs a command line usage help text for this configuration to given printStream. |
void
|
resolveDynamicOptions(DynamicRemoteFileResolver resolver)
Resolve options of |
void
|
safeInjectOptionValues(
Inject multiple option values into the set of configuration objects without throwing if one of the option cannot be applied. |
|
setBestEffortOptionsFromCommandLineArgs(
Set the config |
void
|
setBuildProvider(IBuildProvider provider)
Replace the current |
void
|
setCommandLine(String[] arrayArgs)
Sets the command line used to create this |
void
|
setCommandOptions(ICommandOptions cmdOptions)
Set the |
void
|
setConfigurationObject(String typeName, Object configObject)
Generic method to set the config object with the given name, replacing any existing value. |
void
|
setConfigurationObjectList(String typeName,
Generic method to set the config object list for the given name, replacing any existing value. |
void
|
setCoverageOptions(CoverageOptions coverageOptions)
Set the |
void
|
setDeviceConfig(IDeviceConfiguration deviceConfig)
Set a |
void
|
setDeviceConfigList(
Set the |
void
|
setDeviceMetricCollectors(
Set the list of |
void
|
setDeviceOptions(TestDeviceOptions devOptions)
Set the |
void
|
setDeviceRecovery(IDeviceRecovery recovery)
Set the |
void
|
setDeviceRequirements(IDeviceSelection devRequirements)
Set the |
void
|
setLabPreparer(ITargetPreparer preparer)
Set the |
void
|
setLabPreparers(
Set the list of |
void
|
setLogOutput(ILeveledLogOutput logger)
Set the |
void
|
setLogSaver(ILogSaver logSaver)
Set the |
void
|
setMultiPreTargetPreparer(IMultiTargetPreparer multiPreTargPrep)
Convenience method to set a single |
void
|
setMultiPreTargetPreparers(
Set the list of |
void
|
setMultiTargetPreparer(IMultiTargetPreparer multiTargPrep)
Convenience method to set a single |
void
|
setMultiTargetPreparers(
Set the list of |
|
setOptionsFromCommandLineArgs(
Set the config ArgsOptionParser for expected format
|
|
setOptionsFromCommandLineArgs(
Set the config ArgsOptionParser for expected format
|
void
|
setPostProcessors(
Set the list of |
void
|
setRetryDecision(IRetryDecision decisionRetry)
Set the |
void
|
setSystemStatusChecker(ISystemStatusChecker systemChecker)
Convenience method to set a single |
void
|
setSystemStatusCheckers(
Set the list of |
void
|
setTargetPreparer(ITargetPreparer preparer)
Set the |
void
|
setTargetPreparers(
Set the list of |
void
|
setTest(IRemoteTest test)
Convenience method to set a single |
void
|
setTestInvocationListener(ITestInvocationListener listener)
Convenience method to set a single |
void
|
setTestInvocationListeners(
Set the list of |
void
|
setTests(
Set the list of |
void
|
validateOptions()
Validate option values. |
Protected methods | |
---|---|
boolean
|
isRemoteEnvironment()
Returns whether or not the environment of TF is a remote invocation. |
Fields
BUILD_PROVIDER_TYPE_NAME
public static final String BUILD_PROVIDER_TYPE_NAME
CMD_OPTIONS_TYPE_NAME
public static final String CMD_OPTIONS_TYPE_NAME
CONFIGURATION_DESCRIPTION_TYPE_NAME
public static final String CONFIGURATION_DESCRIPTION_TYPE_NAME
COVERAGE_OPTIONS_TYPE_NAME
public static final String COVERAGE_OPTIONS_TYPE_NAME
DEVICE_METRICS_COLLECTOR_TYPE_NAME
public static final String DEVICE_METRICS_COLLECTOR_TYPE_NAME
DEVICE_NAME
public static final String DEVICE_NAME
DEVICE_OPTIONS_TYPE_NAME
public static final String DEVICE_OPTIONS_TYPE_NAME
DEVICE_RECOVERY_TYPE_NAME
public static final String DEVICE_RECOVERY_TYPE_NAME
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
GLOBAL_FILTERS_TYPE_NAME
public static final String GLOBAL_FILTERS_TYPE_NAME
LAB_PREPARER_TYPE_NAME
public static final String LAB_PREPARER_TYPE_NAME
LOGGER_TYPE_NAME
public static final String LOGGER_TYPE_NAME
LOG_SAVER_TYPE_NAME
public static final String LOG_SAVER_TYPE_NAME
METRIC_POST_PROCESSOR_TYPE_NAME
public static final String METRIC_POST_PROCESSOR_TYPE_NAME
MULTI_PREPARER_TYPE_NAME
public static final String MULTI_PREPARER_TYPE_NAME
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
public static final String MULTI_PRE_TARGET_PREPARER_TYPE_NAME
RESULT_REPORTER_TYPE_NAME
public static final String RESULT_REPORTER_TYPE_NAME
RETRY_DECISION_TYPE_NAME
public static final String RETRY_DECISION_TYPE_NAME
SANBOX_OPTIONS_TYPE_NAME
public static final String SANBOX_OPTIONS_TYPE_NAME
SANDBOX_TYPE_NAME
public static final String SANDBOX_TYPE_NAME
SYSTEM_STATUS_CHECKER_TYPE_NAME
public static final String SYSTEM_STATUS_CHECKER_TYPE_NAME
TARGET_PREPARER_TYPE_NAME
public static final String TARGET_PREPARER_TYPE_NAME
TEST_TYPE_NAME
public static final String TEST_TYPE_NAME
Public constructors
Configuration
public Configuration (String name, String description)
Creates an Configuration
with default config objects.
Parameters | |
---|---|
name |
String |
description |
String |
Public methods
addFilesToClean
public void addFilesToClean (toBeCleaned)
Add files that must be cleaned during cleanConfigurationData()
Parameters | |
---|---|
toBeCleaned |
|
cleanConfigurationData
public void cleanConfigurationData ()
Delete any files that was downloaded to resolved Option fields of remote files.
dumpXml
public void dumpXml (PrintWriter output)
Gets the expanded XML file for the config with all options shown for this
IConfiguration
as a String
.
Parameters | |
---|---|
output |
PrintWriter : the writer to print the xml to. |
dumpXml
public void dumpXml (PrintWriter output,excludeFilters)
Gets the expanded XML file for the config with all options shown for this IConfiguration
minus the objects filters by their key name.
Filter example: Configuration#TARGET_PREPARER_TYPE_NAME
.
Parameters | |
---|---|
output |
PrintWriter : the writer to print the xml to. |
excludeFilters |
: the list of object type that should not be dumped. |
dumpXml
public void dumpXml (PrintWriter output,excludeFilters, boolean printDeprecatedOptions, boolean printUnchangedOptions)
Gets the expanded XML file for the config with all options shown for this IConfiguration
minus the objects filters by their key name.
Filter example: Configuration#TARGET_PREPARER_TYPE_NAME
.
Parameters | |
---|---|
output |
PrintWriter : the writer to print the xml to. |
excludeFilters |
: the list of object type that should not be dumped. |
printDeprecatedOptions |
boolean : Whether or not to print options marked as deprecated |
printUnchangedOptions |
boolean |
getAllConfigurationObjectsOfType
publicgetAllConfigurationObjectsOfType (String configType)
Generic interface to get all the object of one given type name across devices.
Parameters | |
---|---|
configType |
String : the unique type of the configuration object |
Returns | |
---|---|
|
The list of configuration objects of the given type. |
getBuildProvider
public IBuildProvider getBuildProvider ()
Gets the IBuildProvider
from the configuration.
Returns | |
---|---|
IBuildProvider |
the IBuildProvider provided in the configuration
|
getCommandLine
public String getCommandLine ()
Gets the command line used to create this IConfiguration
.
Returns | |
---|---|
String |
the command line used to create this IConfiguration .
|
getCommandOptions
public ICommandOptions getCommandOptions ()
Gets the ICommandOptions
to use from the configuration.
Returns | |
---|---|
ICommandOptions |
the ICommandOptions provided in the configuration.
|
getConfigurationDescription
public ConfigurationDescriptor getConfigurationDescription ()
Returns the ConfigurationDescriptor
provided in the configuration.
Returns | |
---|---|
ConfigurationDescriptor |
getConfigurationObject
public Object getConfigurationObject (String typeName)
Generic interface to get the configuration object with the given type name.
Parameters | |
---|---|
typeName |
String : the unique type of the configuration object |
Returns | |
---|---|
Object |
the configuration object or null if the object type with given name
does not exist.
|
getConfigurationObjectList
publicgetConfigurationObjectList (String typeName)
Similar to getConfigurationObject(String)
, but for configuration
object types that support multiple objects.
Parameters | |
---|---|
typeName |
String : the unique type name of the configuration object |
Returns | |
---|---|
|
the list of configuration objects or null if the object type with
given name does not exist.
|
getCoverageOptions
public CoverageOptions getCoverageOptions ()
Gets the CoverageOptions
to use from the configuration.
Returns | |
---|---|
CoverageOptions |
the CoverageOptions provided in the configuration.
|
getDescription
public String getDescription ()
Returns | |
---|---|
String |
a short user readable description this Configuration
|
getDeviceConfig
publicgetDeviceConfig ()
Gets the IDeviceConfiguration
s from the configuration.
Returns | |
---|---|
|
the IDeviceConfiguration s provided in order in the configuration
|
getDeviceConfigByName
public IDeviceConfiguration getDeviceConfigByName (String nameDevice)
Return the IDeviceConfiguration
associated to the name provided, null if not found.
Parameters | |
---|---|
nameDevice |
String |
Returns | |
---|---|
IDeviceConfiguration |
getDeviceOptions
public TestDeviceOptions getDeviceOptions ()
Gets the TestDeviceOptions
to use from the configuration.
Returns | |
---|---|
TestDeviceOptions |
the TestDeviceOptions provided in the configuration.
|
getDeviceRecovery
public IDeviceRecovery getDeviceRecovery ()
Gets the IDeviceRecovery
to use from the configuration.
Returns | |
---|---|
IDeviceRecovery |
the IDeviceRecovery provided in the configuration.
|
getDeviceRequirements
public IDeviceSelection getDeviceRequirements ()
Gets the IDeviceSelection
to use from the configuration.
Returns | |
---|---|
IDeviceSelection |
the IDeviceSelection provided in the configuration.
|
getFilesToClean
publicgetFilesToClean ()
Get the list of files that will be cleaned during cleanConfigurationData()
Returns | |
---|---|
|
getGlobalFilters
public GlobalTestFilter getGlobalFilters ()
Gets the GlobalTestFilter
for the invocation.
Returns | |
---|---|
GlobalTestFilter |
getInopOptions
publicgetInopOptions ()
Get the option names that did not change any values
Returns | |
---|---|
|
getLabPreparers
publicgetLabPreparers ()
Gets the ITargetPreparer
s from the configuration.
Returns | |
---|---|
|
the ITargetPreparer s provided in order in the configuration
|
getLogOutput
public ILeveledLogOutput getLogOutput ()
Gets the ILeveledLogOutput
to use from the configuration.
Returns | |
---|---|
ILeveledLogOutput |
the ILeveledLogOutput provided in the configuration.
|
getLogSaver
public ILogSaver getLogSaver ()
Gets the ILogSaver
to use from the configuration.
Returns | |
---|---|
ILogSaver |
the ILogSaver provided in the configuration.
|
getMetricCollectors
publicgetMetricCollectors ()
Gets the IMetricCollector
s from the configuration.
Returns | |
---|---|
|
getMultiPreTargetPreparers
publicgetMultiPreTargetPreparers ()
Gets the IMultiTargetPreparer
s from the configuration that should be executed before
any of the devices target_preparers.
Returns | |
---|---|
|
the IMultiTargetPreparer s provided in order in the configuration
|
getMultiTargetPreparers
publicgetMultiTargetPreparers ()
Gets the IMultiTargetPreparer
s from the configuration.
Returns | |
---|---|
|
the IMultiTargetPreparer s provided in order in the configuration
|
getName
public String getName ()
Returns the name of the configuration.
Returns | |
---|---|
String |
getPostProcessors
publicgetPostProcessors ()
Gets the IPostProcessor
s from the configuration.
Returns | |
---|---|
|
getRetryDecision
public IRetryDecision getRetryDecision ()
Returns the IRetryDecision
used for the invocation.
Returns | |
---|---|
IRetryDecision |
getSystemStatusCheckers
publicgetSystemStatusCheckers ()
Gets the ISystemStatusChecker
s from the configuration.
Returns | |
---|---|
|
the ISystemStatusChecker s provided in order in the configuration
|
getTargetPreparers
publicgetTargetPreparers ()
Gets the ITargetPreparer
s from the configuration.
Returns | |
---|---|
|
the ITargetPreparer s provided in order in the configuration
|
getTestInvocationListeners
publicgetTestInvocationListeners ()
Gets the ITestInvocationListener
s to use from the configuration.
Returns | |
---|---|
|
the ITestInvocationListener s provided in the configuration.
|
getTests
publicgetTests ()
Gets the IRemoteTest
s to run from the configuration.
Returns | |
---|---|
|
the tests provided in the configuration |
injectOptionValue
public void injectOptionValue (String optionName, String optionValue)
Inject a option value into the set of configuration objects.
Useful to provide values for options that are generated dynamically.Parameters | |
---|---|
optionName |
String : the option name |
optionValue |
String : the option value |
Throws | |
---|---|
ConfigurationException |
injectOptionValue
public void injectOptionValue (String optionName, String optionKey, String optionValue)
Inject a option value into the set of configuration objects.
Useful to provide values for options that are generated dynamically.Parameters | |
---|---|
optionName |
String : the option name |
optionKey |
String : the optional key for map options, or null |
optionValue |
String : the map option value |
Throws | |
---|---|
ConfigurationException |
injectOptionValueWithSource
public void injectOptionValueWithSource (String optionName, String optionKey, String optionValue, String source)
Inject a option value into the set of configuration objects.
Useful to provide values for options that are generated dynamically.Parameters | |
---|---|
optionName |
String : the option name |
optionKey |
String : the optional key for map options, or null |
optionValue |
String : the map option value |
source |
String : the source config that provided this option value |
Throws | |
---|---|
ConfigurationException |
injectOptionValues
public void injectOptionValues (optionDefs)
Inject multiple option values into the set of configuration objects.
Useful to inject many option values at once after creating a new object.Parameters | |
---|---|
optionDefs |
: a list of option defs to inject |
Throws | |
---|---|
ConfigurationException |
isDeviceConfiguredFake
public boolean isDeviceConfiguredFake (String deviceName)
Returns whether or not a configured device is tagged isFake=true or not.
Parameters | |
---|---|
deviceName |
String |
Returns | |
---|---|
boolean |
partialDeepClone
public IConfiguration partialDeepClone (objectToDeepClone, IKeyStoreClient client)
Create a base clone from clone()
then deep clone the list of given config object.
Parameters | |
---|---|
objectToDeepClone |
: The list of configuration object to deep clone. |
client |
IKeyStoreClient : The keystore client. |
Returns | |
---|---|
IConfiguration |
The partially deep cloned config. |
Throws | |
---|---|
ConfigurationException |
printCommandUsage
public void printCommandUsage (boolean importantOnly, PrintStream out)
Outputs a command line usage help text for this configuration to given printStream.
Parameters | |
---|---|
importantOnly |
boolean : if true only print help for the important options |
out |
PrintStream : the ERROR(/PrintStream) to use. |
Throws | |
---|---|
ConfigurationException |
resolveDynamicOptions
public void resolveDynamicOptions (DynamicRemoteFileResolver resolver)
Resolve options of ERROR(/File)
pointing to a remote location. This requires cleanConfigurationData()
to be called to clean up the files.
Parameters | |
---|---|
resolver |
DynamicRemoteFileResolver : the DynamicRemoteFileResolver to resolve the files |
Throws | |
---|---|
BuildRetrievalError |
|
ConfigurationException |
safeInjectOptionValues
public void safeInjectOptionValues (optionDefs)
Inject multiple option values into the set of configuration objects without throwing if one of the option cannot be applied.
Useful to inject many option values at once after creating a new object.
Parameters | |
---|---|
optionDefs |
: a list of option defs to inject |
Throws | |
---|---|
ConfigurationException |
setBestEffortOptionsFromCommandLineArgs
publicsetBestEffortOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
Set the config Option
fields with given set of command line arguments using a best
effort approach.
See ArgsOptionParser
for expected format
Parameters | |
---|---|
listArgs |
: the command line arguments |
keyStoreClient |
IKeyStoreClient : IKeyStoreClient to use. |
Returns | |
---|---|
|
the unconsumed arguments |
Throws | |
---|---|
ConfigurationException |
setBuildProvider
public void setBuildProvider (IBuildProvider provider)
Replace the current IBuildProvider
in the configuration.
Parameters | |
---|---|
provider |
IBuildProvider : the new IBuildProvider
|
setCommandLine
public void setCommandLine (String[] arrayArgs)
Sets the command line used to create this IConfiguration
.
This stores the whole command line, including the configuration name,
unlike setOptionsFromCommandLineArgs.
Parameters | |
---|---|
arrayArgs |
String : the command line
|
setCommandOptions
public void setCommandOptions (ICommandOptions cmdOptions)
Set the ICommandOptions
, replacing any existing values
setConfigurationObject
public void setConfigurationObject (String typeName, Object configObject)
Generic method to set the config object with the given name, replacing any existing value.
Parameters | |
---|---|
typeName |
String : the unique name of the config object type. |
configObject |
Object : the config object |
Throws | |
---|---|
ConfigurationException |
setConfigurationObjectList
public void setConfigurationObjectList (String typeName,configList)
Generic method to set the config object list for the given name, replacing any existing value.
Parameters | |
---|---|
typeName |
String : the unique name of the config object type. |
configList |
: the config object list |
Throws | |
---|---|
ConfigurationException |
setCoverageOptions
public void setCoverageOptions (CoverageOptions coverageOptions)
Set the CoverageOptions
, replacing any existing values.
Parameters | |
---|---|
coverageOptions |
CoverageOptions |
setDeviceConfig
public void setDeviceConfig (IDeviceConfiguration deviceConfig)
Set a IDeviceConfiguration
, replacing any existing value.
setDeviceConfigList
public void setDeviceConfigList (deviceConfigs)
Set the IDeviceConfiguration
s, replacing any existing value.
setDeviceMetricCollectors
public void setDeviceMetricCollectors (collectors)
Set the list of IMetricCollector
s, replacing any existing values.
Parameters | |
---|---|
collectors |
|
setDeviceOptions
public void setDeviceOptions (TestDeviceOptions devOptions)
Set the TestDeviceOptions
, replacing any existing values
Parameters | |
---|---|
devOptions |
TestDeviceOptions |
setDeviceRecovery
public void setDeviceRecovery (IDeviceRecovery recovery)
Set the IDeviceRecovery
, replacing any existing value.
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
Set the IDeviceSelection
, replacing any existing values
setLabPreparer
public void setLabPreparer (ITargetPreparer preparer)
Set the ITargetPreparer
, replacing any existing value.
setLabPreparers
public void setLabPreparers (preparers)
Set the list of ITargetPreparer
s, replacing any existing value.
setLogOutput
public void setLogOutput (ILeveledLogOutput logger)
Set the ILeveledLogOutput
, replacing any existing value.
setLogSaver
public void setLogSaver (ILogSaver logSaver)
Set the ILogSaver
, replacing any existing value.
setMultiPreTargetPreparer
public void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPrep)
Convenience method to set a single IMultiTargetPreparer
in this configuration that
should be executed before any of the devices target_preparers, replacing any existing values
setMultiPreTargetPreparers
public void setMultiPreTargetPreparers (multiPreTargPreps)
Set the list of IMultiTargetPreparer
s in this configuration that should be executed
before any of the devices target_preparers, replacing any existing values
setMultiTargetPreparer
public void setMultiTargetPreparer (IMultiTargetPreparer multiTargPrep)
Convenience method to set a single IMultiTargetPreparer
in this configuration,
replacing any existing values
setMultiTargetPreparers
public void setMultiTargetPreparers (multiTargPreps)
Set the list of IMultiTargetPreparer
s in this configuration, replacing any
existing values
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
Set the config Option
fields with given set of command line arguments
ArgsOptionParser
for expected format
Parameters | |
---|---|
listArgs |
: the command line arguments |
Returns | |
---|---|
|
the unconsumed arguments |
Throws | |
---|---|
ConfigurationException |
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
Set the config Option
fields with given set of command line arguments
ArgsOptionParser
for expected format
Parameters | |
---|---|
listArgs |
: the command line arguments |
keyStoreClient |
IKeyStoreClient : IKeyStoreClient to use. |
Returns | |
---|---|
|
the unconsumed arguments |
Throws | |
---|---|
ConfigurationException |
setPostProcessors
public void setPostProcessors (processors)
Set the list of IPostProcessor
s, replacing any existing values.
Parameters | |
---|---|
processors |
|
setRetryDecision
public void setRetryDecision (IRetryDecision decisionRetry)
Set the IRetryDecision
, replacing any existing value.
setSystemStatusChecker
public void setSystemStatusChecker (ISystemStatusChecker systemChecker)
Convenience method to set a single ISystemStatusChecker
in this configuration,
replacing any existing values
setSystemStatusCheckers
public void setSystemStatusCheckers (systemCheckers)
Set the list of ISystemStatusChecker
s in this configuration, replacing any
existing values
setTargetPreparer
public void setTargetPreparer (ITargetPreparer preparer)
Set the ITargetPreparer
, replacing any existing value.
setTargetPreparers
public void setTargetPreparers (preparers)
Set the list of ITargetPreparer
s, replacing any existing value.
setTest
public void setTest (IRemoteTest test)
Convenience method to set a single IRemoteTest
in this configuration, replacing any
existing values
setTestInvocationListener
public void setTestInvocationListener (ITestInvocationListener listener)
Convenience method to set a single ITestInvocationListener
setTestInvocationListeners
public void setTestInvocationListeners (listeners)
Set the list of ITestInvocationListener
s, replacing any existing values
setTests
public void setTests (tests)
Set the list of IRemoteTest
s in this configuration, replacing any
existing values
validateOptions
public void validateOptions ()
Validate option values.
Currently this will just validate that all mandatory options have been setThrows | |
---|---|
ConfigurationException |
Protected methods
isRemoteEnvironment
protected boolean isRemoteEnvironment ()
Returns whether or not the environment of TF is a remote invocation.
Returns | |
---|---|
boolean |