全域配置

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Object
com.android.tradefed.config.GlobalConfiguration


將載入的設定物件儲存在映射中的IGlobalConfiguration實現

概括

領域

public static final String CREDENTIAL_FACTORY_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MONITOR_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

public static final String GLOBAL_CONFIG_SERVER

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_VARIABLE

public static final String HOST_MONITOR_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String KEY_STORE_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

public static final String SCHEDULER_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

public static final String WTF_HANDLER_TYPE_NAME

公共方法

void cleanup ()

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

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

根據白名單過濾全域配置並輸出到 XML 檔案。

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

根據白名單過濾 GlobalConfiguration,同時允許操作選項值並輸出到 XML 檔案。

File cloneConfigWithFilter (String... allowlistConfigs)

根據允許的清單過濾 GlobalConfiguration 並輸出到 XML 檔案。

static createGlobalConfiguration (String[] args)

為此 TF 實例設定GlobalConfiguration單例。

ICommandScheduler getCommandScheduler ()

從配置中取得要使用的ICommandScheduler

Object getConfigurationObject (String typeName)

取得具有給定名稱的自訂配置物件。

ICredentialFactory getCredentialFactory ()

取得用於建立憑證的ICredentialFactory

String getDescription ()
DeviceManagementGrpcServer getDeviceManagementServer ()

返回DeviceManagementGrpcServer或 null(如果未定義)。

IDeviceManager getDeviceManager ()

從設定中取得要使用的IDeviceManager

static IDeviceManager getDeviceManagerInstance ()

傳回對此 TF 實例的單例DeviceManager實例的參考。

getDeviceMonitors ()

從全域配置中取得IDeviceMonitor清單。

IDeviceSelection getDeviceRequirements ()

從配置中取得要使用的IDeviceSelection

TradefedFeatureServer getFeatureServer ()

返回TradefedFeatureServer或 null(如果未定義)。

IConfigurationServer getGlobalConfigServer ()

取得全域配置伺服器。

static getHostMonitorInstances ()
getHostMonitors ()

從全域配置中取得IHostMonitor清單。

IHostOptions getHostOptions ()

從設定中取得要使用的IHostOptions

IHostResourceManager getHostResourceManager ()

從全域設定中取得IHostResourceManager

static IGlobalConfiguration getInstance ()

傳回對此 TF 實例的單例GlobalConfiguration實例的參考。

IKeyStoreFactory getKeyStoreFactory ()

從配置中取得要使用的IKeyStoreFactory

getMultiDeviceRecoveryHandlers ()

從組態中取得要使用的IMultiDeviceRecovery清單。

String getName ()
getOptionValues (String optionName)

取得選項值的清單。

getResourceMetricCollectors ()

從全域配置中取得IResourceMetricCollector清單。

ISandboxFactory getSandboxFactory ()

取得可用於運作呼叫的沙箱工廠

IShardHelper getShardingStrategy ()

傳回定義分片配置方式的IShardHelper

TestInvocationManagementServer getTestInvocationManagementSever ()

傳回TestInvocationManagementServer或 null(如果未定義)。

ITerribleFailureHandler getWtfHandler ()

從設定中取得要使用的ITerribleFailureHandler

void injectOptionValue (String optionName, String optionValue)

將選項值注入到配置物件集中。

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

將選項值注入到配置物件集中。

void printCommandUsage (boolean importantOnly, PrintStream out)

將此配置的命令列使用幫助文字輸出到給定的 printStream。

void setCommandScheduler ( ICommandScheduler scheduler)

設定ICommandScheduler ,取代任何現有值。

void setConfigurationFactory ( IConfigurationFactory configFactory)

為此配置設定IConfigurationFactory

void setConfigurationObject (String typeName, Object configObject)

使用給定名稱設定配置物件的通用方法,替換任何現有值。

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

設定給定名稱的配置物件清單的通用方法,替換任何現有值。

void setDeviceManagementServer ( DeviceManagementGrpcServer server)

設定DeviceManagementGrpcServer

void setDeviceManager ( IDeviceManager manager)

設定IDeviceManager ,取代任何現有值。

void setDeviceMonitor ( IDeviceMonitor monitor)

設定IDeviceMonitor

void setDeviceRequirements ( IDeviceSelection devRequirements)

設定IDeviceSelection ,替換任何現有值。

void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

設定IHostMonitor列表。

void setHostOptions ( IHostOptions hostOptions)

設定IHostOptions ,替換任何現有值。

void setHostResourceManager ( IHostResourceManager hostResourceManager)

設定IHostResourceManager ,取代任何現有值。

void setInvocationServer ( TestInvocationManagementServer server)

設定TestInvocationManagementServer

void setKeyStoreFactory ( IKeyStoreFactory factory)

設定IKeyStoreFactory ,取代任何現有值。

setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

使用給定的一組命令列參數設定全域配置Option字段

請參閱ArgsOptionParser以了解預期格式

void setOriginalConfig (String config)

設定用於建立全域配置的原始配置。

void setResourceMetricCollector ( IResourceMetricCollector collector)

設定IResourceMetricCollector

void setSandboxFactory ( ISandboxFactory factory)

設定ISandboxFactory ,替換任何現有值。

void setShardingStrategy ( IShardHelper sharding)

設定分片配置時要使用的IShardHelper

void setTradefedFeatureServer ( TradefedFeatureServer server)

設定TradefedFeatureServer

void setWtfHandler ( ITerribleFailureHandler wtfHandler)

設定ITerribleFailureHandler

void setup ()

在 tradefed 開始時進行正確的設定。

void validateOptions ()

驗證選項值。

受保護的方法

IConfigurationFactory getConfigurationFactory ()

領域

CREDENTIAL_FACTORY_TYPE_NAME

public static final String CREDENTIAL_FACTORY_TYPE_NAME

DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

DEVICE_MONITOR_TYPE_NAME

public static final String DEVICE_MONITOR_TYPE_NAME

DEVICE_REQUIREMENTS_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

全域設定伺服器

public static final String GLOBAL_CONFIG_SERVER

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

全域配置變數

public static final String GLOBAL_CONFIG_VARIABLE

HOST_MONITOR_TYPE_NAME

public static final String HOST_MONITOR_TYPE_NAME

HOST_OPTIONS_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

KEY_STORE_TYPE_NAME

public static final String KEY_STORE_TYPE_NAME

MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

RESOURCE_METRIC_COLLECTOR_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

SANDBOX_FACTORY_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

SCHEDULER_TYPE_NAME

public static final String SCHEDULER_TYPE_NAME

SHARDING_STRATEGY_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

TF_FEATURE_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

TF_INVOCATION_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

WTF_HANDLER_TYPE_NAME

public static final String WTF_HANDLER_TYPE_NAME

公共方法

清理

public void cleanup ()

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

帶過濾器的克隆配置

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

根據白名單過濾全域配置並輸出到 XML 檔案。

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

allowlistConfigs String :要包含在新 XML 檔案中的配置的String陣列。如果它設定為null , a default list should be used.
退貨
File包含新過濾的全域配置的檔案。

帶過濾器的克隆配置

public 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 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包含新過濾的全域配置的檔案。

建立全域配置

public static  createGlobalConfiguration (String[] args)

為此 TF 實例設定GlobalConfiguration單例。在嘗試呼叫getInstance()之前必須呼叫一次且僅呼叫一次

參數
args String

退貨

投擲
IllegalStateException如果多次調用
ConfigurationException

取得命令調度程序

public ICommandScheduler getCommandScheduler ()

從配置中取得要使用的ICommandScheduler

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

取得配置對象

public Object getConfigurationObject (String typeName)

取得具有給定名稱的自訂配置物件。

參數
typeName String : 配置物件的唯一類型

退貨
Object物件或 null 如果未找到具有該名稱的對象

取得憑證工廠

public ICredentialFactory getCredentialFactory ()

取得用於建立憑證的ICredentialFactory

退貨
ICredentialFactory ICredentialFactorynull (如果未指定)。

取得描述

public String getDescription ()

退貨
StringConfiguration的簡短使用者可讀描述

取得設備管理伺服器

public DeviceManagementGrpcServer getDeviceManagementServer ()

返回DeviceManagementGrpcServer或 null(如果未定義)。

退貨
DeviceManagementGrpcServer

取得裝置管理員

public IDeviceManager getDeviceManager ()

從設定中取得要使用的IDeviceManager 。管理一組可用的測試設備

退貨
IDeviceManager配置中提供的IDeviceManager

取得裝置管理員實例

public static IDeviceManager getDeviceManagerInstance ()

傳回對此 TF 實例的單例DeviceManager實例的參考。

退貨
IDeviceManager

投擲
IllegalStateException如果尚未呼叫createGlobalConfiguration(String[])

取得設備監視器

public  getDeviceMonitors ()

從全域配置中取得IDeviceMonitor清單。

退貨
全域配置中的IDeviceMonitor列表,如果未指定,則為null

取得設備需求

public IDeviceSelection getDeviceRequirements ()

從配置中取得要使用的IDeviceSelection 。表示DeviceManager可以查看的設備的全域過濾器。

退貨
IDeviceSelection配置中提供的IDeviceSelection

取得特徵伺服器

public TradefedFeatureServer getFeatureServer ()

返回TradefedFeatureServer或 null(如果未定義)。

退貨
TradefedFeatureServer

取得全域設定伺服器

public IConfigurationServer getGlobalConfigServer ()

取得全域配置伺服器。全域配置伺服器用於從伺服器取得主機配置,而不是從本機檔案取得。

退貨
IConfigurationServer

取得主機監視器實例

public static  getHostMonitorInstances ()

退貨

取得主機監視器

public  getHostMonitors ()

從全域配置中取得IHostMonitor清單。

退貨
全域配置中的IHostMonitor列表,如果未指定,則為null

取得主機選項

public IHostOptions getHostOptions ()

從設定中取得要使用的IHostOptions

退貨
IHostOptions配置中提供的IDeviceManager

取得主機資源管理器

public IHostResourceManager getHostResourceManager ()

從全域設定中取得IHostResourceManager

退貨
IHostResourceManager全域配置中的IHostResourceManager ,如果主機配置中未指定,則預設實作LocalHostResourceManager

取得實例

public static IGlobalConfiguration getInstance ()

傳回對此 TF 實例的單例GlobalConfiguration實例的參考。

退貨
IGlobalConfiguration

投擲
IllegalStateException如果尚未呼叫createGlobalConfiguration(String[])

取得KeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

從配置中取得要使用的IKeyStoreFactory

退貨
IKeyStoreFactory如果未設定密鑰儲存工廠,則為IKeyStoreFactory或 null。

取得多設備恢復處理程序

public  getMultiDeviceRecoveryHandlers ()

從組態中取得要使用的IMultiDeviceRecovery清單。

退貨
IMultiDeviceRecovery列表,如果未設定則為null

取得名稱

public String getName ()

退貨
StringConfiguration的名稱

取得選項值

public  getOptionValues (String optionName)

取得選項值的清單。

參數
optionName String : 地圖選項名稱

退貨
給定選項值的清單。如果選項名稱不存在,則為null

取得資源度量收集器

public  getResourceMetricCollectors ()

從全域配置中取得IResourceMetricCollector清單。

退貨
全域配置中的IResourceMetricCollector列表,如果未指定,則為null

獲取SandboxFactory

public ISandboxFactory getSandboxFactory ()

取得可用於運作呼叫的沙箱工廠

退貨
ISandboxFactory

取得分片策略

public IShardHelper getShardingStrategy ()

傳回定義分片配置方式的IShardHelper

退貨
IShardHelper

取得測試調用管理伺服器

public TestInvocationManagementServer getTestInvocationManagementSever ()

傳回TestInvocationManagementServer或 null(如果未定義)。

退貨
TestInvocationManagementServer

取得WtfHandler

public ITerribleFailureHandler getWtfHandler ()

從設定中取得要使用的ITerribleFailureHandler 。處理發生 WTF(多麼可怕的故障)時該怎麼做。

退貨
ITerribleFailureHandler配置中提供的ITerribleFailureHandler ,如果未設定處理程序則為 null

注入選項值

public void injectOptionValue (String optionName, 
                String optionValue)

將選項值注入到配置物件集中。

對於為動態產生的選項提供值很有用。

參數
optionName String : 選項名稱

optionValue String : 選項值

投擲
ConfigurationException

注入選項值

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

將選項值注入到配置物件集中。

對於為動態產生的選項提供值很有用。

參數
optionName String : 地圖選項名稱

optionKey String : 地圖選項鍵

optionValue String : 地圖選項值

投擲
ConfigurationException

列印命令用法

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

將此配置的命令列使用幫助文字輸出到給定的 printStream。

參數
importantOnly boolean

out PrintStream :要使用的ERROR(/PrintStream)

投擲
com.android.tradefed.config.ConfigurationException
ConfigurationException

設定命令調度器

public void setCommandScheduler (ICommandScheduler scheduler)

設定ICommandScheduler ,取代任何現有值。

設定配置工廠

public void setConfigurationFactory (IConfigurationFactory configFactory)

為此配置設定IConfigurationFactory

參數
configFactory IConfigurationFactory

設定配置對象

public void setConfigurationObject (String typeName, 
                Object configObject)

使用給定名稱設定配置物件的通用方法,替換任何現有值。

參數
typeName String :配置物件類型的唯一名稱。

configObject Object :配置對象

投擲
ConfigurationException

設定配置對象列表

public void setConfigurationObjectList (String typeName, 
                 configList)

設定給定名稱的配置物件清單的通用方法,替換任何現有值。

參數
typeName String :配置物件類型的唯一名稱。

configList :配置物件列表

投擲
ConfigurationException

設定設備管理伺服器

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

設定DeviceManagementGrpcServer

參數
server DeviceManagementGrpcServer

設定裝置管理員

public void setDeviceManager (IDeviceManager manager)

設定IDeviceManager ,取代任何現有值。這設定了測試設備的管理器

設定設備監視器

public void setDeviceMonitor (IDeviceMonitor monitor)

設定IDeviceMonitor

參數
monitor IDeviceMonitor :監視器

設定設備要求

public void setDeviceRequirements (IDeviceSelection devRequirements)

設定IDeviceSelection ,替換任何現有值。這將設定全域設備過濾器, DeviceManager可以查看哪些設備。

設定主機監視器

public void setHostMonitors ( hostMonitors)

設定IHostMonitor列表。

參數
hostMonitors :監視器列表

設定主機選項

public void setHostOptions (IHostOptions hostOptions)

設定IHostOptions ,替換任何現有值。

設定主機資源管理器

public void setHostResourceManager (IHostResourceManager hostResourceManager)

設定IHostResourceManager ,取代任何現有值。

設定調用伺服器

public void setInvocationServer (TestInvocationManagementServer server)

設定TestInvocationManagementServer

參數
server TestInvocationManagementServer

設定KeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

設定IKeyStoreFactory ,取代任何現有值。

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

使用給定的一組命令列參數設定全域配置Option字段

請參閱ArgsOptionParser以了解預期格式

參數
listArgs :命令列參數

退貨
未消耗的參數

投擲
ConfigurationException

設定原始配置

public void setOriginalConfig (String config)

設定用於建立全域配置的原始配置。

參數
config String

設定資源度量收集器

public void setResourceMetricCollector (IResourceMetricCollector collector)

設定IResourceMetricCollector

參數
collector IResourceMetricCollector

設定SandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

設定ISandboxFactory ,替換任何現有值。

設定分片策略

public void setShardingStrategy (IShardHelper sharding)

設定分片配置時要使用的IShardHelper

參數
sharding IShardHelper

設定 TradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

設定TradefedFeatureServer

參數
server TradefedFeatureServer

設定WtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

設定ITerribleFailureHandler

參數
wtfHandler ITerribleFailureHandler :WTF 處理程序

設定

public void setup ()

在 tradefed 開始時進行正確的設定。

投擲
ConfigurationException

驗證選項

public void validateOptions ()

驗證選項值。

目前,這只會驗證所有強制選項是否已設置

投擲
ConfigurationException

受保護的方法

取得配置工廠

protected IConfigurationFactory getConfigurationFactory ()

退貨
IConfigurationFactory