全局配置

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) cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs)

根据白名单过滤全局配置并输出到 XML 文件。

File cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) 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) 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) 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) 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

全局配置服务器

public static final String GLOBAL_CONFIG_SERVER

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_SERVER_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 关闭时进行适当的清理。

带过滤器的克隆配置

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

根据白名单过滤全局配置并输出到 XML 文件。

参数
exclusionPatterns :要从转储中排除的类名模式。

allowlistConfigs String :要包含在新 XML 文件中的配置的String数组。如果它设置为null , a default list should be used.
退货
File包含新过滤的全局配置的文件。

带过滤器的克隆配置

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包含新过滤的全局配置的文件。

带过滤器的克隆配置

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包含新过滤的全局配置的文件。

创建全局配置

public static  createGlobalConfiguration (String[] args)

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

参数
args String

退货

投掷
IllegalStateException如果多次调用
ConfigurationException

获取命令调度程序

public ICommandScheduler getCommandScheduler ()

从配置中获取要使用的ICommandScheduler

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

获取配置对象

public Object getConfigurationObject (String typeName)

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

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

退货
Object对象或 null 如果未找到具有该名称的对象

获取凭证工厂

public ICredentialFactory getCredentialFactory ()

获取用于创建凭据的ICredentialFactory

退货
ICredentialFactory ICredentialFactorynull (如果未指定)。

获取描述

public String getDescription ()

退货
StringConfiguration的简短用户可读描述

获取设备管理服务器

public DeviceManagementGrpcServer getDeviceManagementServer ()

返回DeviceManagementGrpcServer或 null(如果未定义)。

退货
DeviceManagementGrpcServer

获取设备管理器

public IDeviceManager getDeviceManager ()

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

退货
IDeviceManager配置中提供的IDeviceManager

获取设备管理器实例

public static IDeviceManager getDeviceManagerInstance ()

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

退货
IDeviceManager

投掷
IllegalStateException如果尚未调用createGlobalConfiguration(String[])

获取设备监视器

public  getDeviceMonitors ()

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

退货
全局配置中的IDeviceMonitor列表,如果未指定,则为null

获取设备需求

public IDeviceSelection getDeviceRequirements ()

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

退货
IDeviceSelection配置中提供的IDeviceSelection

获取特征服务器

public TradefedFeatureServer getFeatureServer ()

返回TradefedFeatureServer或 null(如果未定义)。

退货
TradefedFeatureServer

获取全局配置服务器

public IConfigurationServer getGlobalConfigServer ()

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

退货
IConfigurationServer

获取主机监视器实例

public static  getHostMonitorInstances ()

退货

获取主机监视器

public  getHostMonitors ()

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

退货
全局配置中的IHostMonitor列表,如果未指定,则为null

获取主机选项

public IHostOptions getHostOptions ()

从配置中获取要使用的IHostOptions

退货
IHostOptions配置中提供的IDeviceManager

获取主机资源管理器

public IHostResourceManager getHostResourceManager ()

从全局配置中获取IHostResourceManager

退货
IHostResourceManager全局配置中的IHostResourceManager ,如果主机配置中未指定,则默认实现LocalHostResourceManager

获取实例

public static IGlobalConfiguration getInstance ()

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

退货
IGlobalConfiguration

投掷
IllegalStateException如果尚未调用createGlobalConfiguration(String[])

获取KeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

从配置中获取要使用的IKeyStoreFactory

退货
IKeyStoreFactory如果未设置密钥存储工厂,则为IKeyStoreFactory或 null。

获取多设备恢复处理程序

public  getMultiDeviceRecoveryHandlers ()

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

退货
IMul IMultiDeviceRecovery列表,如果未设置则为null

获取名称

public String getName ()

退货
StringConfiguration的名称

获取选项值

public  getOptionValues (String optionName)

获取选项值的列表。

参数
optionName String : 地图选项名称

退货
给定选项值的列表。如果选项名称不存在,则为null

获取资源度量收集器

public  getResourceMetricCollectors ()

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

退货
全局配置中的IResourceMetricCollector列表,如果未指定,则为null

获取SandboxFactory

public ISandboxFactory getSandboxFactory ()

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

退货
ISandboxFactory

获取分片策略

public IShardHelper getShardingStrategy ()

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

退货
IShardHelper

获取测试调用管理服务器

public TestInvocationManagementServer getTestInvocationManagementSever ()

返回TestInvocationManagementServer或 null(如果未定义)。

退货
TestInvocationManagementServer

获取WtfHandler

public ITerribleFailureHandler getWtfHandler ()

从配置中获取要使用的ITerribleFailureHandler 。处理发生 WTF(多么可怕的故障)时该怎么做。

退货
ITerribleFailureHandler配置中提供的ITerribleFailureHandler ,如果未设置处理程序则为 null

注入选项值

public void injectOptionValue (String optionName, 
                String optionValue)

将选项值注入到配置对象集中。

对于为动态生成的选项提供值很有用。

参数
optionName String : 选项名称

optionValue String : 选项值

投掷
ConfigurationException

注入选项值

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

将选项值注入到配置对象集中。

对于为动态生成的选项提供值很有用。

参数
optionName String : 地图选项名称

optionKey String : 地图选项键

optionValue String : 地图选项值

投掷
ConfigurationException

打印命令用法

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

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

参数
importantOnly boolean

out PrintStream :要使用的ERROR(/PrintStream)

投掷
com.android.tradefed.config.ConfigurationException
ConfigurationException

设置命令调度器

public void setCommandScheduler (ICommandScheduler scheduler)

设置ICommandScheduler ,替换任何现有值。

设置配置工厂

public void setConfigurationFactory (IConfigurationFactory configFactory)

为此配置设置IConfigurationFactory

参数
configFactory IConfigurationFactory

设置配置对象

public void setConfigurationObject (String typeName, 
                Object configObject)

使用给定名称设置配置对象的通用方法,替换任何现有值。

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

configObject Object :配置对象

投掷
ConfigurationException

设置配置对象列表

public void setConfigurationObjectList (String typeName, 
                 configList)

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

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

configList :配置对象列表

投掷
ConfigurationException

设置设备管理服务器

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

设置DeviceManagementGrpcServer

参数
server DeviceManagementGrpcServer

设置设备管理器

public void setDeviceManager (IDeviceManager manager)

设置IDeviceManager ,替换任何现有值。这设置了测试设备的管理器

设置设备监视器

public void setDeviceMonitor (IDeviceMonitor monitor)

设置IDeviceMonitor

参数
monitor IDeviceMonitor :监视器

设置设备要求

public void setDeviceRequirements (IDeviceSelection devRequirements)

设置IDeviceSelection ,替换任何现有值。这将设置全局设备过滤器, DeviceManager可以查看哪些设备。

设置主机监视器

public void setHostMonitors ( hostMonitors)

设置IHostMonitor列表。

参数
hostMonitors :监视器列表

设置主机选项

public void setHostOptions (IHostOptions hostOptions)

设置IHostOptions ,替换任何现有值。

设置主机资源管理器

public void setHostResourceManager (IHostResourceManager hostResourceManager)

设置IHostResourceManager ,替换任何现有值。

设置调用服务器

public void setInvocationServer (TestInvocationManagementServer server)

设置TestInvocationManagementServer

参数
server TestInvocationManagementServer

设置KeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

设置IKeyStoreFactory ,替换任何现有值。

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

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

请参阅ArgsOptionParser了解预期格式

参数
listArgs :命令行参数

退货
未消耗的参数

投掷
ConfigurationException

设置原始配置

public void setOriginalConfig (String config)

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

参数
config String

设置资源度量收集器

public void setResourceMetricCollector (IResourceMetricCollector collector)

设置IResourceMetricCollector

参数
collector IResourceMetricCollector

设置SandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

设置ISandboxFactory ,替换任何现有值。

设置分片策略

public void setShardingStrategy (IShardHelper sharding)

设置分片配置时要使用的IShardHelper

参数
sharding IShardHelper

设置 TradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

设置TradefedFeatureServer

参数
server TradefedFeatureServer

设置WtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

设置ITerribleFailureHandler

参数
wtfHandler ITerribleFailureHandler :WTF 处理程序

设置

public void setup ()

在 tradefed 开始时进行正确的设置。

投掷
ConfigurationException

验证选项

public void validateOptions ()

验证选项值。

目前,这只会验证所有强制选项是否已设置

投掷
ConfigurationException

受保护的方法

获取配置工厂

protected IConfigurationFactory getConfigurationFactory ()

退货
IConfigurationFactory