全局配置

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

包含單個 Trade Federation 實例的全局配置信息的類（包含任意數量的實際配置調用）。

概括

公共方法

abstract void cleanup ()

tradefed 關閉時進行適當的清理。

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

根據白名單過濾 GlobalConfiguration 並輸出到 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 關閉時進行適當的清理。

cloneConfigWithFilter

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

根據白名單過濾 GlobalConfiguration 並輸出到 XML 文件。

參數
exclusionPatterns ：要從轉儲中排除的類名模式。

allowlistConfigs String ：要包含在新 XML 文件中的ERROR(/String)配置數組。如果它設置為null , a default list should be used.

退貨
File包含新過濾的全局配置的文件。

投擲
異常

也可以看看：

cloneConfigWithFilter

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

基於白名單過濾 GlobalConfiguration，同時允許操作選項值和輸出到 XML 文件。

參數
exclusionPatterns ：要從轉儲中排除的類名模式。

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String ：要包含在新 XML 文件中的ERROR(/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 文件中的ERROR(/String)配置數組。如果它設置為null , a default list should be used.

退貨
File包含新過濾的全局配置的文件。

投擲
異常

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

從配置中獲取要使用的ICommandScheduler 。

退貨
ICommandScheduler ICommandScheduler 。永遠不會返回 null。

獲取配置對象

public abstract Object getConfigurationObject (String typeName)

獲取具有給定名稱的自定義配置對象。

參數
typeName String : 配置對象的唯一類型

退貨
Object對像或 null 如果找不到具有該名稱的對象

getCredentialFactory

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列表。

退貨
IMultiDeviceRecovery的列表，如果未設置則為null 。

獲取選項值

public abstract  getOptionValues (String optionName)

獲取選項值列表。

參數
optionName String : 地圖選項名稱

退貨
給定選項值的列表。如果選項名稱不存在， null 。

getResourceMetricCollectors

public abstract  getResourceMetricCollectors ()

從全局配置中獲取IResourceMetricCollector列表。

退貨
來自全局配置的IResourceMetricCollector列表，如果未指定則為null 。

獲取沙盒工廠

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

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

設置IResourceMetricCollector 。

參數
collector IResourceMetricCollector

設置沙盒工廠

public abstract void setSandboxFactory (ISandboxFactory factory)

設置ISandboxFactory ，替換任何現有值。

設置分片策略

public abstract void setShardingStrategy (IShardHelper sharding)

設置在分片配置時要使用的IShardHelper 。

參數
sharding IShardHelper

setTradefedFeatureServer

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