本頁面由 Cloud Translation API 翻譯而成。

全局配置

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)` 根據白名單過濾 GlobalConfiguration 並輸出到 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

GLOBAL_CONFIG_SERVER

public static final String GLOBAL_CONFIG_SERVER

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

GLOBAL_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 關閉時進行適當的清理。

cloneConfigWithFilter

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

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

參數
`exclusionPatterns`	：要從轉儲中排除的類名模式。
`allowlistConfigs`	`String` ：要包含在新 XML 文件中的`ERROR(/String)`配置數組。如果它設置為`null , a default list should be used.`

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

cloneConfigWithFilter

public 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 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`	包含新過濾的全局配置的文件。

創建全局配置

public static  createGlobalConfiguration (String[] args)

為此 TF 實例設置GlobalConfiguration單例。必須在任何嘗試調用getInstance()之前調用一次且僅調用一次

參數
`args`	`String`

退貨

投擲
	如果調用不止一次
`ConfigurationException`

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

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

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

獲取配置對象

public Object getConfigurationObject (String typeName)

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

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

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

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

獲取用於創建憑據的ICredentialFactory 。

退貨
`ICredentialFactory`	`ICredentialFactory`或`null` （如果未指定）。

獲取描述

public String getDescription ()

退貨
`String`	此`Configuration`的簡短用戶可讀描述

獲取設備管理服務器

public DeviceManagementGrpcServer getDeviceManagementServer ()

如果未定義，則返回DeviceManagementGrpcServer或 null。

退貨
`DeviceManagementGrpcServer`

獲取設備管理器

public IDeviceManager getDeviceManager ()

從配置中獲取要使用的IDeviceManager 。管理一組可用的測試設備

退貨
`IDeviceManager`	配置中提供的`IDeviceManager` 。

獲取設備管理器實例

public static IDeviceManager getDeviceManagerInstance ()

返回對此 TF 實例的單例DeviceManager實例的引用。

退貨
`IDeviceManager`

投擲
	如果`createGlobalConfiguration(String[])`尚未被調用。

獲取設備監視器

public  getDeviceMonitors ()

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

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

獲取設備要求

public IDeviceSelection getDeviceRequirements ()

從配置中獲取要使用的IDeviceSelection 。表示DeviceManager可以在哪些設備上看到的全局過濾器。

退貨
`IDeviceSelection`	配置中提供的`IDeviceSelection` 。

獲取要素服務器

public TradefedFeatureServer getFeatureServer ()

如果未定義，則返回TradefedFeatureServer或 null。

退貨
`TradefedFeatureServer`

獲取全局配置服務器

public IConfigurationServer getGlobalConfigServer ()

獲取全局配置服務器。全局配置服務器用於從服務器獲取主機配置，而不是從本地文件獲取。

退貨
`IConfigurationServer`

getHostMonitorInstances

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`

投擲
	如果`createGlobalConfiguration(String[])`尚未被調用。

獲取KeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

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

退貨
`IKeyStoreFactory`	`IKeyStoreFactory`或 null（如果未設置密鑰存儲工廠）。

獲取多設備恢復處理程序

public  getMultiDeviceRecoveryHandlers ()

從配置中獲取要使用的IMultiDeviceRecovery列表。

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

獲取名稱

public String getName ()

退貨
`String`	此`Configuration`的名稱

獲取選項值

public  getOptionValues (String optionName)

獲取選項值列表。

參數
`optionName`	`String` : 地圖選項名稱

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

getResourceMetricCollectors

public  getResourceMetricCollectors ()

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

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

獲取沙盒工廠

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`

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

設置IResourceMetricCollector 。

參數
`collector`	`IResourceMetricCollector`

設置沙盒工廠

public void setSandboxFactory (ISandboxFactory factory)

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

設置分片策略

public void setShardingStrategy (IShardHelper sharding)

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

參數
`sharding`	`IShardHelper`

setTradefedFeatureServer

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`