GlobalConfiguration

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Object
↳	com.android.tradefed.config.GlobalConfiguration

---

用于将加载的配置对象存储在映射中的 IGlobalConfiguration 实现

摘要

字段
public static final String	CREDENTIAL_FACTORY_TYPE_NAME
public static final String	DEVICE_MANAGER_TYPE_NAME
public static final String	DEVICE_MONITOR_TYPE_NAME
public static final String	DEVICE_REQUIREMENTS_TYPE_NAME
public static final String	GLOBAL_CONFIG_SERVER
public static final String	GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE
public static final String	GLOBAL_CONFIG_VARIABLE
public static final String	HOST_MONITOR_TYPE_NAME
public static final String	HOST_OPTIONS_TYPE_NAME
public static final String	HOST_RESOURCE_MANAGER_TYPE_NAME
public static final String	KEY_STORE_TYPE_NAME
public static final String	MULTI_DEVICE_RECOVERY_TYPE_NAME
public static final String	RESOURCE_METRIC_COLLECTOR_TYPE_NAME
public static final String	SANDBOX_FACTORY_TYPE_NAME
public static final String	SCHEDULER_TYPE_NAME
public static final String	SHARDING_STRATEGY_TYPE_NAME
public static final String	TF_DEVICE_MANAGEMENT_SERVER_NAME
public static final String	TF_FEATURE_SERVER_NAME
public static final String	TF_INVOCATION_SERVER_NAME
public static final String	WTF_HANDLER_TYPE_NAME

公共方法
void	cleanup() 在 tradefed 关闭时进行适当的清理。
File	cloneConfigWithFilter( exclusionPatterns, String... allowlistConfigs) 根据许可名单过滤 GlobalConfiguration，并输出到 XML 文件。
File	cloneConfigWithFilter( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) 根据白名单过滤 GlobalConfiguration，同时允许操作选项值并输出到 XML 文件。
File	cloneConfigWithFilter(String... allowlistConfigs) 根据许可名单过滤 GlobalConfiguration，并输出到 XML 文件。
static	createGlobalConfiguration(String[] args) 为此 TF 实例设置 GlobalConfiguration 单例。
ICommandScheduler	getCommandScheduler() 从配置中获取要使用的 ICommandScheduler。
Object	getConfigurationObject(String typeName) 获取具有指定名称的自定义配置对象。
ICredentialFactory	getCredentialFactory() 获取用于创建凭据的 ICredentialFactory。
String	getDescription()
DeviceManagementGrpcServer	getDeviceManagementServer() 返回 DeviceManagementGrpcServer，如果未定义，则返回 null。
IDeviceManager	getDeviceManager() 从配置中获取要使用的 IDeviceManager。
static IDeviceManager	getDeviceManagerInstance() 返回此 TF 实例的单例 DeviceManager 实例的引用。
	getDeviceMonitors() 从全局配置中获取 IDeviceMonitor 列表。
IDeviceSelection	getDeviceRequirements() 从配置中获取要使用的 IDeviceSelection。
TradefedFeatureServer	getFeatureServer() 返回 TradefedFeatureServer，如果未定义，则返回 null。
IConfigurationServer	getGlobalConfigServer() 获取全局配置服务器。
static	getHostMonitorInstances()
	getHostMonitors() 从全局配置中获取 IHostMonitor 列表。
IHostOptions	getHostOptions() 从配置中获取要使用的 IHostOptions。
IHostResourceManager	getHostResourceManager() 从全局配置中获取 IHostResourceManager。
static IGlobalConfiguration	getInstance() 返回此 TF 实例的单例 GlobalConfiguration 实例的引用。
IKeyStoreFactory	getKeyStoreFactory() 从配置中获取要使用的 IKeyStoreFactory。
	getMultiDeviceRecoveryHandlers() 从配置中获取要使用的 IMultiDeviceRecovery 列表。
String	getName()
	getOptionValues(String optionName) 获取选项值的列表。
	getResourceMetricCollectors() 从全局配置中获取 IResourceMetricCollector 列表。
ISandboxFactory	getSandboxFactory() 获取可用于运行调用的沙盒工厂
IShardHelper	getShardingStrategy() 返回用于定义配置分片方式的 IShardHelper。
TestInvocationManagementServer	getTestInvocationManagementSever() 返回 TestInvocationManagementServer，如果未定义，则返回 null。
ITerribleFailureHandler	getWtfHandler() 从配置中获取要使用的 ITerribleFailureHandler。
void	injectOptionValue(String optionName, String optionValue) 将选项值注入一组配置对象。
void	injectOptionValue(String optionName, String optionKey, String optionValue) 将选项值注入一组配置对象。
void	printCommandUsage(boolean importantOnly, PrintStream out) 将此配置的命令行使用帮助文本输出到给定的 printStream。
void	setCommandScheduler(ICommandScheduler scheduler) 设置 ICommandScheduler，替换所有现有值。
void	setConfigurationFactory(IConfigurationFactory configFactory) 为此配置设置 IConfigurationFactory。
void	setConfigurationObject(String typeName, Object configObject) 用于使用指定名称设置配置对象的通用方法，会替换任何现有值。
void	setConfigurationObjectList(String typeName, configList) 用于为给定名称设置配置对象列表的通用方法，用于替换任何现有值。
void	setDeviceManagementServer(DeviceManagementGrpcServer server) 设置 DeviceManagementGrpcServer。
void	setDeviceManager(IDeviceManager manager) 设置 IDeviceManager，替换所有现有值。
void	setDeviceMonitor(IDeviceMonitor monitor) 设置 IDeviceMonitor。
void	setDeviceRequirements(IDeviceSelection devRequirements) 设置 IDeviceSelection，替换所有现有值。
void	setHostMonitors( hostMonitors) 设置 IHostMonitor 列表。
void	setHostOptions(IHostOptions hostOptions) 设置 IHostOptions，替换所有现有值。
void	setHostResourceManager(IHostResourceManager hostResourceManager) 设置 IHostResourceManager，替换所有现有值。
void	setInvocationServer(TestInvocationManagementServer server) 设置 TestInvocationManagementServer。
void	setKeyStoreFactory(IKeyStoreFactory factory) 设置 IKeyStoreFactory，替换所有现有值。
	setOptionsFromCommandLineArgs( listArgs) 使用给定的一组命令行参数设置全局配置 Option 字段 如需了解预期格式，请参阅 ArgsOptionParser
void	setOriginalConfig(String config) 设置用于创建全局配置的原始配置。
void	setResourceMetricCollector(IResourceMetricCollector collector) 设置 IResourceMetricCollector。
void	setSandboxFactory(ISandboxFactory factory) 设置 ISandboxFactory，替换所有现有值。
void	setShardingStrategy(IShardHelper sharding) 设置在对配置进行分片时要使用的 IShardHelper。
void	setTradefedFeatureServer(TradefedFeatureServer server) 设置 TradefedFeatureServer。
void	setWtfHandler(ITerribleFailureHandler wtfHandler) 设置 ITerribleFailureHandler。
void	setup() 在开始使用 Tradefed 时进行正确设置。
void	validateOptions() 验证选项值。

受保护的方法
IConfigurationFactory	getConfigurationFactory()

字段

CREDENTIAL_FACTORY_TYPE_NAME

public static final String CREDENTIAL_FACTORY_TYPE_NAME

DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

DEVICE_MONITOR_TYPE_NAME

public static final String DEVICE_MONITOR_TYPE_NAME

DEVICE_REQUIREMENTS_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

GLOBAL_CONFIG_SERVER

public static final String GLOBAL_CONFIG_SERVER

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

GLOBAL_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_VARIABLE

HOST_MONITOR_TYPE_NAME

public static final String HOST_MONITOR_TYPE_NAME

HOST_OPTIONS_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

KEY_STORE_TYPE_NAME

public static final String KEY_STORE_TYPE_NAME

MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

RESOURCE_METRIC_COLLECTOR_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

SANDBOX_FACTORY_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

SCHEDULER_TYPE_NAME

public static final String SCHEDULER_TYPE_NAME

SHARDING_STRATEGY_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

TF_FEATURE_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

TF_INVOCATION_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

WTF_HANDLER_TYPE_NAME

public static final String WTF_HANDLER_TYPE_NAME

公共方法

清理

public void cleanup ()

在 tradefed 关闭时进行适当的清理。

cloneConfigWithFilter

public File cloneConfigWithFilter ( exclusionPatterns, 
                String... allowlistConfigs)

根据白名单过滤 GlobalConfiguration，并输出到 XML 文件。

参数
exclusionPatterns	：要从转储中排除的类名的模式。
allowlistConfigs	String：要包含在新 XML 文件中的配置的 String 数组。 如果设置为 null, a default list should be used.

返回
File	包含新的过滤全局配置的文件。

cloneConfigWithFilter

public File cloneConfigWithFilter ( exclusionPatterns, 
                IConfigOptionValueTransformer transformer, 
                boolean deepCopy, 
                String... allowlistConfigs)

根据白名单过滤 GlobalConfiguration，同时允许操作选项值并输出到 XML 文件。

参数
exclusionPatterns	：要从转储中排除的类名的模式。
transformer	IConfigOptionValueTransformer
deepCopy	boolean
allowlistConfigs	String：要包含在新 XML 文件中的配置的 String 数组。 如果设置为 null, a default list should be used.

返回
File	包含新的过滤全局配置的文件。

cloneConfigWithFilter

public File cloneConfigWithFilter (String... allowlistConfigs)

根据许可名单过滤 GlobalConfiguration，并输出到 XML 文件。

例如，对于以下配置： <xml> <configuration> <device_monitor class="com.android.tradefed.device.DeviceMonitorMultiplexer" /> <wtf_handler class="com.android.tradefed.log.TerribleFailureEmailHandler" /> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

系统会滤除“key_store”以外的所有配置，并生成以下内容的配置文件：<xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

参数
allowlistConfigs	String：要包含在新 XML 文件中的配置的 String 数组。 如果设置为 null, a default list should be used.

返回
File	包含新的过滤全局配置的文件。

createGlobalConfiguration

public static  createGlobalConfiguration (String[] args)

为此 TF 实例设置 GlobalConfiguration 单例。必须在任何内容尝试调用 getInstance() 之前调用一次且仅调用一次

参数
args	String

返回

抛出
IllegalStateException	如果多次调用
ConfigurationException

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

从配置中获取要使用的 ICommandScheduler。

返回
ICommandScheduler	ICommandScheduler。永远不会返回 null。

getConfigurationObject

public Object getConfigurationObject (String typeName)

获取具有指定名称的自定义配置对象。

参数
typeName	String：配置对象的唯一类型

返回
Object	对象，如果未找到具有该名称的对象，则返回 null

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

获取用于创建凭据的 ICredentialFactory。

返回
ICredentialFactory	ICredentialFactory 或 null（如果未指定）。

getDescription

public String getDescription ()

返回
String	此 Configuration 的简短用户可读说明

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

返回 DeviceManagementGrpcServer，如果未定义，则返回 null。

返回
DeviceManagementGrpcServer

getDeviceManager

public IDeviceManager getDeviceManager ()

从配置中获取要使用的 IDeviceManager。管理可用于测试的一组设备

返回
IDeviceManager	配置中提供的 IDeviceManager。

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

返回此 TF 实例的单例 DeviceManager 实例的引用。

返回
IDeviceManager

抛出
IllegalStateException	，如果尚未调用 createGlobalConfiguration(String[])。

getDeviceMonitors

public  getDeviceMonitors ()

从全局配置中获取 IDeviceMonitor 列表。

返回
	全局配置中的 IDeviceMonitor 列表，如果未指定任何 IDeviceMonitor，则为 null。

getDeviceRequirements

public IDeviceSelection getDeviceRequirements ()

从配置中获取要使用的 IDeviceSelection。表示 DeviceManager 可以看到哪些设备的全局过滤器。

返回
IDeviceSelection	配置中提供的 IDeviceSelection。

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

返回 TradefedFeatureServer，如果未定义，则返回 null。

返回
TradefedFeatureServer

getGlobalConfigServer

public IConfigurationServer getGlobalConfigServer ()

获取全局配置服务器。全局配置服务器用于从服务器获取主机配置，而不是从本地文件获取。

返回
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

返回

getHostMonitors

public  getHostMonitors ()

从全局配置中获取 IHostMonitor 列表。

返回
	全局配置中的 IHostMonitor 列表，如果未指定，则为 null。

getHostOptions

public IHostOptions getHostOptions ()

从配置中获取要使用的 IHostOptions。

返回
IHostOptions	配置中提供的 IDeviceManager。

getHostResourceManager

public IHostResourceManager getHostResourceManager ()

从全局配置中获取 IHostResourceManager。

返回
IHostResourceManager	全局配置中的 IHostResourceManager，如果主机配置中未指定任何实现，则使用默认实现 LocalHostResourceManager。

getInstance

public static IGlobalConfiguration getInstance ()

返回此 TF 实例的单例 GlobalConfiguration 实例的引用。

返回
IGlobalConfiguration

抛出
IllegalStateException	，如果尚未调用 createGlobalConfiguration(String[])。

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

从配置中获取要使用的 IKeyStoreFactory。

返回
IKeyStoreFactory	IKeyStoreFactory，如果未设置密钥库工厂，则为 null。

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

从配置中获取要使用的 IMultiDeviceRecovery 列表。

返回
	IMultiDeviceRecovery 的列表，如果未设置，则为 null。

getName

public String getName ()

返回
String	此 Configuration 的名称

getOptionValues

public  getOptionValues (String optionName)

获取选项值的列表。

参数
optionName	String：地图选项名称

返回
	给定选项的值列表。如果选项名称不存在，则为 null。

getResourceMetricCollectors

public  getResourceMetricCollectors ()

从全局配置中获取 IResourceMetricCollector 列表。

返回
	全局配置中的 IResourceMetricCollector 列表，如果未指定，则为 null 。

getSandboxFactory

public ISandboxFactory getSandboxFactory ()

获取可用于运行调用的沙盒工厂

返回
ISandboxFactory

getShardingStrategy

public IShardHelper getShardingStrategy ()

返回用于定义配置分片方式的 IShardHelper。

返回
IShardHelper

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

返回 TestInvocationManagementServer，如果未定义，则返回 null。

返回
TestInvocationManagementServer

getWtfHandler

public ITerribleFailureHandler getWtfHandler ()

从配置中获取要使用的 ITerribleFailureHandler。 处理在发生 WTF（糟糕的失败）时要执行的操作。

返回
ITerribleFailureHandler	配置中提供的 ITerribleFailureHandler；如果未设置任何处理程序，则为 null

injectOptionValue

public void injectOptionValue (String optionName, 
                String optionValue)

将选项值注入一组配置对象。

非常适合为动态生成的选项提供值。

参数
optionName	String：选项名称
optionValue	String：选项值

抛出
ConfigurationException

injectOptionValue

public void injectOptionValue (String optionName, 
                String optionKey, 
                String optionValue)

将选项值注入一组配置对象。

非常适合为动态生成的选项提供值。

参数
optionName	String：地图选项名称
optionKey	String：地图选项键
optionValue	String：地图选项值

抛出
ConfigurationException

printCommandUsage

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

将此配置的命令行使用帮助文本输出到给定的 printStream。

参数
importantOnly	boolean
out	PrintStream：要使用的 ERROR(/PrintStream)。

抛出
	com.android.tradefed.config.ConfigurationException
ConfigurationException

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

设置 ICommandScheduler，替换所有现有值。

setConfigurationFactory

public void setConfigurationFactory (IConfigurationFactory configFactory)

为此配置设置 IConfigurationFactory。

参数
configFactory	IConfigurationFactory

setConfigurationObject

public void setConfigurationObject (String typeName, 
                Object configObject)

用于使用指定名称设置配置对象的通用方法，会替换任何现有值。

参数
typeName	String：配置对象类型的唯一名称。
configObject	Object：配置对象

抛出
ConfigurationException

setConfigurationObjectList

public void setConfigurationObjectList (String typeName, 
                 configList)

用于为给定名称设置配置对象列表的通用方法，会替换任何现有值。

参数
typeName	String：配置对象类型的唯一名称。
configList	：配置对象列表

抛出
ConfigurationException

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

设置 DeviceManagementGrpcServer。

参数
server	DeviceManagementGrpcServer

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

设置 IDeviceManager，替换所有现有值。这会为测试设备设置管理器

setDeviceMonitor

public void setDeviceMonitor (IDeviceMonitor monitor)

设置 IDeviceMonitor。

参数
monitor	IDeviceMonitor：监视器

setDeviceRequirements

public void setDeviceRequirements (IDeviceSelection devRequirements)

设置 IDeviceSelection，替换所有现有值。这会设置一个全局设备过滤器，用于指定 DeviceManager 可以看到哪些设备。

setHostMonitors

public void setHostMonitors ( hostMonitors)

设置 IHostMonitor 列表。

参数
hostMonitors	：监视器列表

setHostOptions

public void setHostOptions (IHostOptions hostOptions)

设置 IHostOptions，替换所有现有值。

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

设置 IHostResourceManager，替换所有现有值。

setInvocationServer

public void setInvocationServer (TestInvocationManagementServer server)

设置 TestInvocationManagementServer。

参数
server	TestInvocationManagementServer

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

设置 IKeyStoreFactory，替换所有现有值。

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

使用给定的一组命令行参数设置全局配置 Option 字段

如需了解预期格式，请参阅 ArgsOptionParser

参数
listArgs	：命令行参数

返回
	未使用的实参

抛出
ConfigurationException

setOriginalConfig

public void setOriginalConfig (String config)

设置用于创建全局配置的原始配置。

参数
config	String

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

设置 IResourceMetricCollector。

参数
collector	IResourceMetricCollector

setSandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

设置 ISandboxFactory，替换所有现有值。

setShardingStrategy

public void setShardingStrategy (IShardHelper sharding)

设置在对配置进行分片时要使用的 IShardHelper。

参数
sharding	IShardHelper

setTradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

设置 TradefedFeatureServer。

参数
server	TradefedFeatureServer

setWtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

设置 ITerribleFailureHandler。

参数
wtfHandler	ITerribleFailureHandler：WTF 处理脚本

设置

public void setup ()

在开始使用 Tradefed 时进行正确设置。

抛出
ConfigurationException

validateOptions

public void validateOptions ()

验证选项值。

目前，这只会验证是否已设置所有必需选项

抛出
ConfigurationException

受保护的方法

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

返回
IConfigurationFactory