IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

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

摘要

公共方法

abstract void cleanup()

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

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

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

abstract File 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)

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

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)

设置 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)

使用指定的一组命令行参数设置全局配置 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 时进行适当的清理。

cloneConfigWithFilter

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

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

参数
exclusionPatterns ：要从转储中排除的类名称的模式。
allowlistConfigs String：要包含在新 XML 文件中的配置的 String 数组。 如果设置为 null, a default list should be used.
返回
File 包含经过过滤的新全局配置的文件。
抛出
IOException

cloneConfigWithFilter

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

cloneConfigWithFilter

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

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

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

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

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

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

参数
typeName String：配置对象的唯一类型
返回
Object 对象；如果未找到具有该名称的对象，则返回 null

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

获取用于创建凭据的 ICredentialFactory。

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

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

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

返回
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

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

返回
IDeviceManager 配置中提供的 IDeviceManager。

getDeviceMonitors

public abstract  getDeviceMonitors ()

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

返回
来自全局配置的 IDeviceMonitor 列表，或者 null 未指定任何项目。

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

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

返回
IDeviceSelection 配置中提供的 IDeviceSelection。

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

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

返回
TradefedFeatureServer

getGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

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

返回
IConfigurationServer

getHostMonitors

public abstract  getHostMonitors ()

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

返回
来自全局配置的 IHostMonitor 列表，如果没有，则返回 null 。

getHostOptions

public abstract IHostOptions getHostOptions ()

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

返回
IHostOptions 配置中提供的 IDeviceManager。

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

从全局配置中获取 IHostResourceManager。

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

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

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

返回
IKeyStoreFactory IKeyStoreFactory 或 null（如果未设置密钥库工厂）。

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

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

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

getOptionValues

public abstract  getOptionValues (String optionName)

获取选项值的列表。

参数
optionName String：地图选项名称
返回
指定选项的值的列表。如果选项名称没有指定，则为 null 存在。

getResourceMetricCollector

public abstract  getResourceMetricCollectors ()

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

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

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

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

返回
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

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

返回
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

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

返回
TestInvocationManagementServer

getWtfHandler

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 如果未能设置选项的值

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

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

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

为此配置设置 IConfigurationFactory。

参数
configFactory IConfigurationFactory

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                Object configObject)

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

参数
name String：配置对象类型的唯一名称。
configObject Object：配置对象
抛出
ConfigurationException 如果 configObject 类型不正确

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

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

参数
typeName String：配置对象类型的唯一名称。
configList ：配置对象列表
抛出
ConfigurationException 如果列表中有任何对象的类型不正确

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

设置 DeviceManagementGrpcServer。

参数
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

设置 IDeviceManager，替换任何现有值。这样可设置 测试设备

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

设置 IDeviceMonitor。

参数
deviceMonitor IDeviceMonitor：监控器
抛出
ConfigurationException 如果已设置 IDeviceMonitor，则会发生此错误。

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

设置 IDeviceSelection，替换任何现有值。这会设置一个全局设备 过滤出DeviceManager可以看到哪些设备。

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

设置 IHostMonitor 列表。

参数
hostMonitors ：监控器列表
抛出
ConfigurationException 如果已设置 IHostMonitor，则会发生此错误。

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

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

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

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

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

设置 TestInvocationManagementServer。

参数
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

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

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

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

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

参数
listArgs ：命令行参数
返回
不使用的参数
抛出
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

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

参数
config String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

设置 IResourceMetricCollector。

参数
collector IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

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

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

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

参数
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

设置 TradefedFeatureServer。

参数
server TradefedFeatureServer

setWtfHandler

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 如果配置缺少必填字段