全域配置

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 ICredentialFactorynull (如果未指定)。

取得設備管理伺服器

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

取得資源度量收集器

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