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，如果未定義則傳回空值。
abstract IDeviceManager getDeviceManager()

從設定中取得要使用的 IDeviceManager。
abstract getDeviceMonitors()

從全域設定取得 IDeviceMonitor 清單。
abstract IDeviceSelection getDeviceRequirements()

從設定中取得要使用的 IDeviceSelection。
abstract TradefedFeatureServer getFeatureServer()

傳回 TradefedFeatureServer，如果未定義則傳回空值。
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，如果未定義則傳回空值。
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。永遠不會傳回空值。

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

取得具有指定名稱的自訂設定物件。

參數
typeName String：設定物件的專屬類型
傳回
Object 物件或空值 (如果找不到該名稱的物件)

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

取得用於建立憑證的 ICredentialFactory。

傳回
ICredentialFactory ICredentialFactory 或 null (如果未指定任何值)。

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

傳回 DeviceManagementGrpcServer，如果未定義則傳回空值。

傳回
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，如果未定義則傳回空值。

傳回
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，如果選項名稱不存在。

getResourceMetricCollectors

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，如果未定義則傳回空值。

傳回
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

從設定中取得要使用的 ITerribleFailureHandler。處理發生 WTF (What a Terrible Failure) 時的處理方式。

傳回
ITerribleFailureHandler 設定中提供的 ITerribleFailureHandler，如果未設定處理程序，則為空值

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

將選項值插入設定物件集。

可用於為動態產生的選項提供值。

參數
optionName String：選項名稱
optionValue String：選項值
擲回
ConfigurationException 如果無法設定選項的值

injectOptionValue

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

validateOptions

public abstract void validateOptions ()

驗證選項值。

目前這項驗證只會確認所有必填選項都已設定

擲回
ConfigurationException 設定中缺少必填欄位