全局配置

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

包含单个 Trade Federation 实例的全局配置信息的类（包含任意数量的实际配置调用）。

概括

公共方法

abstract void cleanup ()

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

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

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

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

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

abstract File cloneConfigWithFilter (String... allowlistConfigs)

根据允许的列表过滤 GlobalConfiguration 并输出到 XML 文件。

abstract ICommandScheduler getCommandScheduler ()

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

abstract Object getConfigurationObject (String typeName)

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

abstract ICredentialFactory getCredentialFactory ()

获取用于创建凭据的ICredentialFactory 。

abstract DeviceManagementGrpcServer getDeviceManagementServer ()

返回DeviceManagementGrpcServer或 null（如果未定义）。

abstract IDeviceManager getDeviceManager ()

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

abstract getDeviceMonitors ()

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

abstract IDeviceSelection getDeviceRequirements ()

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

abstract TradefedFeatureServer getFeatureServer ()

返回TradefedFeatureServer或 null（如果未定义）。

abstract IConfigurationServer getGlobalConfigServer ()

获取全局配置服务器。

abstract getHostMonitors ()

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

abstract IHostOptions getHostOptions ()

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

abstract IHostResourceManager getHostResourceManager ()

从全局配置中获取IHostResourceManager 。

abstract IKeyStoreFactory getKeyStoreFactory ()

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

abstract getMultiDeviceRecoveryHandlers ()

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

abstract getOptionValues (String optionName)

获取选项值的列表。

abstract getResourceMetricCollectors ()

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

abstract ISandboxFactory getSandboxFactory ()

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

abstract IShardHelper getShardingStrategy ()

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

abstract TestInvocationManagementServer getTestInvocationManagementSever ()

返回TestInvocationManagementServer或 null（如果未定义）。

abstract ITerribleFailureHandler getWtfHandler ()

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

abstract void injectOptionValue (String optionName, String optionValue)

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

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

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

abstract void setCommandScheduler ( ICommandScheduler scheduler)

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

abstract void setConfigurationFactory ( IConfigurationFactory configFactory)

为此配置设置IConfigurationFactory 。

abstract void setConfigurationObject (String name, Object configObject)

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

abstract void setConfigurationObjectList (String typeName, configList) setConfigurationObjectList (String typeName, configList)

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

abstract void setDeviceManagementServer ( DeviceManagementGrpcServer server)

设置DeviceManagementGrpcServer 。

abstract void setDeviceManager ( IDeviceManager deviceManager)

设置IDeviceManager ，替换任何现有值。

abstract void setDeviceMonitor ( IDeviceMonitor deviceMonitor)

设置IDeviceMonitor 。

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

设置IDeviceSelection ，替换任何现有值。

abstract void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

设置IHostMonitor列表。

abstract void setHostOptions ( IHostOptions hostOptions)

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

abstract void setHostResourceManager ( IHostResourceManager hostResourceManager)

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

abstract void setInvocationServer ( TestInvocationManagementServer server)

设置TestInvocationManagementServer 。

abstract void setKeyStoreFactory ( IKeyStoreFactory factory)

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

abstract setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

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

请参阅ArgsOptionParser了解预期格式

abstract void setOriginalConfig (String config)

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

abstract void setResourceMetricCollector ( IResourceMetricCollector collector)

设置IResourceMetricCollector 。

abstract void setSandboxFactory ( ISandboxFactory factory)

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

abstract void setShardingStrategy ( IShardHelper sharding)

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

abstract void setTradefedFeatureServer ( TradefedFeatureServer server)

设置TradefedFeatureServer 。

abstract void setWtfHandler ( ITerribleFailureHandler wtfHandler)

设置ITerribleFailureHandler 。

abstract void setup ()

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

abstract void validateOptions ()

验证选项值。

公共方法

清理

public abstract void cleanup ()

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

带过滤器的克隆配置

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

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

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

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

投掷
IO异常

也可以看看：

带过滤器的克隆配置

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

投掷
IO异常

获取命令调度程序

public abstract ICommandScheduler getCommandScheduler ()

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

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

获取配置对象

public abstract Object getConfigurationObject (String typeName)

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

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

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

获取凭证工厂

public abstract ICredentialFactory getCredentialFactory ()

获取用于创建凭据的ICredentialFactory 。

退货
ICredentialFactory ICredentialFactory或null （如果未指定）。

获取设备管理服务器

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

返回DeviceManagementGrpcServer或 null（如果未定义）。

退货
DeviceManagementGrpcServer

获取设备管理器

public abstract IDeviceManager getDeviceManager ()

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

退货
IDeviceManager配置中提供的IDeviceManager 。

获取设备监视器

public abstract  getDeviceMonitors ()

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

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

获取设备需求

public abstract IDeviceSelection getDeviceRequirements ()

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

退货
IDeviceSelection配置中提供的IDeviceSelection 。

获取特征服务器

public abstract TradefedFeatureServer getFeatureServer ()

返回TradefedFeatureServer或 null（如果未定义）。

退货
TradefedFeatureServer

获取全局配置服务器

public abstract IConfigurationServer getGlobalConfigServer ()

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

退货
IConfigurationServer

获取主机监视器

public abstract  getHostMonitors ()

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

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

获取主机选项

public abstract IHostOptions getHostOptions ()

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

退货
IHostOptions配置中提供的IDeviceManager 。

获取主机资源管理器

public abstract IHostResourceManager getHostResourceManager ()

从全局配置中获取IHostResourceManager 。

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

获取KeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

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

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

获取多设备恢复处理程序

public abstract  getMultiDeviceRecoveryHandlers ()

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

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

获取选项值

public abstract  getOptionValues (String optionName)

获取选项值的列表。

参数
optionName String : 地图选项名称

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

获取资源度量收集器

public abstract  getResourceMetricCollectors ()

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

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

获取SandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

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

退货
ISandboxFactory

获取分片策略

public abstract IShardHelper getShardingStrategy ()

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

退货
IShardHelper

获取测试调用管理服务器

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

返回TestInvocationManagementServer或 null（如果未定义）。

退货
TestInvocationManagementServer

获取WtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

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

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

注入选项值

public abstract void injectOptionValue (String optionName, 
                String optionValue)

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

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

参数
optionName String : 选项名称

optionValue String : 选项值

投掷
ConfigurationException如果未能设置选项的值

注入选项值

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

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

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

参数
optionName String : 地图选项名称

optionKey String : 地图选项键

optionValue String : 地图选项值

投掷
ConfigurationException如果未能设置选项的值

设置命令调度器

public abstract void setCommandScheduler (ICommandScheduler scheduler)

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

设置配置工厂

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

为此配置设置IConfigurationFactory 。

参数
configFactory IConfigurationFactory

设置配置对象

public abstract void setConfigurationObject (String name, 
                Object configObject)

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

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

configObject Object ：配置对象

投掷
ConfigurationException如果 configObject 的类型不正确

设置配置对象列表

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

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

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

configList ：配置对象列表

投掷
ConfigurationException如果列表中的任何对象不是正确的类型

设置设备管理服务器

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

设置DeviceManagementGrpcServer 。

参数
server DeviceManagementGrpcServer

设置设备管理器

public abstract void setDeviceManager (IDeviceManager deviceManager)

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

设置设备监视器

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

设置IDeviceMonitor 。

参数
deviceMonitor IDeviceMonitor ：监视器

投掷
ConfigurationException如果已设置IDeviceMonitor 。

设置设备要求

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

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

设置主机监视器

public abstract void setHostMonitors ( hostMonitors)

设置IHostMonitor列表。

参数
hostMonitors ：监视器列表

投掷
ConfigurationException如果已设置IHostMonitor 。

设置主机选项

public abstract void setHostOptions (IHostOptions hostOptions)

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

设置主机资源管理器

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

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

设置调用服务器

public abstract void setInvocationServer (TestInvocationManagementServer server)

设置TestInvocationManagementServer 。

参数
server TestInvocationManagementServer

设置KeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

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

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

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

请参阅ArgsOptionParser了解预期格式

参数
listArgs ：命令行参数

退货
未消耗的参数

投掷
ConfigurationException

设置原始配置

public abstract void setOriginalConfig (String config)

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

参数
config String

设置资源度量收集器

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

设置IResourceMetricCollector 。

参数
collector IResourceMetricCollector

设置SandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

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

设置分片策略

public abstract void setShardingStrategy (IShardHelper sharding)

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

参数
sharding IShardHelper

设置 TradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

设置TradefedFeatureServer 。

参数
server TradefedFeatureServer

设置WtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

设置ITerribleFailureHandler 。

参数
wtfHandler ITerribleFailureHandler ：WTF 处理程序

投掷
ConfigurationException如果已设置ITerribleFailureHandler 。

设置

public abstract void setup ()

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

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

验证选项

public abstract void validateOptions ()

验证选项值。

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

投掷
ConfigurationException如果配置缺少必填字段