自 2025 年 3 月 27 日起，我們建議您使用 android-latest-release 而非 aosp-main 建構及貢獻 AOSP。詳情請參閱「Android 開放原始碼計畫變更」。

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

GlobalConfiguration

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)` 根據白名單篩選 GlobalConfiguration，並輸出至 XML 檔案。
`File`	`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`，如果未定義則傳回空值。
`IDeviceManager`	`getDeviceManager()` 從設定中取得要使用的 `IDeviceManager`。
`static IDeviceManager`	`getDeviceManagerInstance()` 傳回此 TF 例項的單例模式 `DeviceManager` 例項參照。
	`getDeviceMonitors()` 從全域設定取得 `IDeviceMonitor` 清單。
`IDeviceSelection`	`getDeviceRequirements()` 從設定中取得要使用的 `IDeviceSelection`。
`TradefedFeatureServer`	`getFeatureServer()` 傳回 `TradefedFeatureServer`，如果未定義則傳回空值。
`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`，如果未定義則傳回空值。
`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)` 通用方法，用於為指定名稱設定設定物件清單，取代任何現有值。
`void`	`setDeviceManagementServer(DeviceManagementGrpcServer server)` 可設定 `DeviceManagementGrpcServer`。
`void`	`setDeviceManager(IDeviceManager manager)` 設定 `IDeviceManager`，取代任何現有值。
`void`	`setDeviceMonitor(IDeviceMonitor monitor)` 設定 `IDeviceMonitor`。
`void`	`setDeviceRequirements(IDeviceSelection devRequirements)` 設定 `IDeviceSelection`，取代任何現有值。
`void`	`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)` 使用指定的指令列引數集合，設定全域設定 `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 檔案的設定 `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 檔案的設定 `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 檔案的設定 `String` 陣列。如果設為 `null, a default list should be used.`

傳回
`File`	包含新篩選全域設定檔的檔案。

createGlobalConfiguration

public static  createGlobalConfiguration (String[] args)

為這個 TF 例項設定 GlobalConfiguration 單例模式。必須在任何嘗試呼叫 getInstance() 之前呼叫一次，且只能呼叫一次

參數
`args`	`String`

傳回

擲回
`IllegalStateException`	如果呼叫多次
`ConfigurationException`

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

從設定中取得要使用的 ICommandScheduler。

傳回
`ICommandScheduler`	`ICommandScheduler`。永遠不會傳回空值。

getConfigurationObject

public Object getConfigurationObject (String typeName)

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

參數
`typeName`	`String`：設定物件的專屬類型

傳回
`Object`	物件或空值 (如果找不到該名稱的物件)

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

取得用於建立憑證的 ICredentialFactory。

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

getDescription

public String getDescription ()

傳回
`String`	使用者可讀的簡短說明 `Configuration`

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

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

傳回
`DeviceManagementGrpcServer`

getDeviceManager

public IDeviceManager getDeviceManager ()

取得要從設定中使用的 IDeviceManager。管理可用於測試的裝置組合

傳回
`IDeviceManager`	設定中提供的 `IDeviceManager`。

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

傳回此 TF 例項的單例模式 DeviceManager 例項參照。

傳回
`IDeviceManager`

擲回
`IllegalStateException`	`createGlobalConfiguration(String[])` 尚未呼叫。

getDeviceMonitors

public  getDeviceMonitors ()

從全域設定取得 IDeviceMonitor 清單。

傳回
	全域設定中的 `IDeviceMonitor` 清單，如果未指定，則為 `null`。

getDeviceRequirements

public IDeviceSelection getDeviceRequirements ()

從設定中取得要使用的 IDeviceSelection。代表 DeviceManager 可查看的裝置上全域篩選器。

傳回
`IDeviceSelection`	設定中提供的 `IDeviceSelection`。

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

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

傳回
`TradefedFeatureServer`

getGlobalConfigServer

public IConfigurationServer getGlobalConfigServer ()

取得全域設定伺服器。全域設定伺服器用於從伺服器取得主機設定，而不是從本機檔案取得。

傳回
`IConfigurationServer`

getHostMonitorInstances

public static  getHostMonitorInstances ()

傳回

getHostMonitors

public  getHostMonitors ()

從全域設定取得 IHostMonitor 清單。

傳回
	全域設定中的 `IHostMonitor` 清單，如果未指定，則為 `null`。

getHostOptions

public IHostOptions getHostOptions ()

從設定中取得要使用的 IHostOptions。

傳回
`IHostOptions`	設定中提供的 `IDeviceManager`。

getHostResourceManager

public IHostResourceManager getHostResourceManager ()

從全域設定取得 IHostResourceManager。

傳回
`IHostResourceManager`	全域設定中的 `IHostResourceManager`，或主機設定中未指定的預設實作 `LocalHostResourceManager`。

getInstance

public static IGlobalConfiguration getInstance ()

傳回此 TF 例項的單例模式 GlobalConfiguration 例項參照。

傳回
`IGlobalConfiguration`

擲回
`IllegalStateException`	`createGlobalConfiguration(String[])` 尚未呼叫。

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

從設定中取得要使用的 IKeyStoreFactory。

傳回
`IKeyStoreFactory`	`IKeyStoreFactory` 或 null (如果未設定金鑰庫工廠)。

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

從設定中取得要使用的 IMultiDeviceRecovery 清單。

傳回
	`IMultiDeviceRecovery` 清單，或未設定時的 `null`。

getName

public String getName ()

傳回
`String`	這個 `Configuration` 的名稱

getOptionValues

public  getOptionValues (String optionName)

取得選項值的清單。

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

傳回
	指定選項值的清單。`null`，如果選項名稱不存在。

getResourceMetricCollectors

public  getResourceMetricCollectors ()

從全域設定取得 IResourceMetricCollector 清單。

傳回
	全域設定中的 `IResourceMetricCollector` 清單，如果未指定，則為 `null`。

getSandboxFactory

public ISandboxFactory getSandboxFactory ()

取得可用於執行叫用作業的沙箱工廠

傳回
`ISandboxFactory`

getShardingStrategy

public IShardHelper getShardingStrategy ()

傳回定義設定分割方式的 IShardHelper。

傳回
`IShardHelper`

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

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

傳回
`TestInvocationManagementServer`

getWtfHandler

public ITerribleFailureHandler getWtfHandler ()

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

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

injectOptionValue

public void injectOptionValue (String optionName, 
                String optionValue)

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

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

參數
`optionName`	`String`：選項名稱
`optionValue`	`String`：選項值

擲回
`ConfigurationException`

injectOptionValue

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

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

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

參數
`optionName`	`String`：地圖選項名稱
`optionKey`	`String`：地圖選項鍵
`optionValue`	`String`：地圖選項值

擲回
`ConfigurationException`

printCommandUsage

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

將此設定的指令列使用說明文字輸出至指定的 printStream。

參數
`importantOnly`	`boolean`
`out`	`PrintStream`：要使用的 `ERROR(/PrintStream)`。

擲回
	com.android.tradefed.config.ConfigurationException
`ConfigurationException`

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

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

setConfigurationFactory

public void setConfigurationFactory (IConfigurationFactory configFactory)

為這項設定設定 IConfigurationFactory。

參數
`configFactory`	`IConfigurationFactory`

setConfigurationObject

public void setConfigurationObject (String typeName, 
                Object configObject)

通用方法，可使用指定名稱設定設定物件，取代任何現有值。

參數
`typeName`	`String`：設定物件類型的專屬名稱。
`configObject`	`Object`：設定物件

擲回
`ConfigurationException`

setConfigurationObjectList

public void setConfigurationObjectList (String typeName, 
                 configList)

通用方法，可為指定名稱設定設定物件清單，取代任何現有值。

參數
`typeName`	`String`：設定物件類型的專屬名稱。
`configList`	：設定物件清單

擲回
`ConfigurationException`

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

可設定 DeviceManagementGrpcServer。

參數
`server`	`DeviceManagementGrpcServer`

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

設定 IDeviceManager，取代任何現有值。這會為測試裝置設定管理員

setDeviceMonitor

public void setDeviceMonitor (IDeviceMonitor monitor)

設定 IDeviceMonitor。

參數
`monitor`	`IDeviceMonitor`：監控

setDeviceRequirements

public void setDeviceRequirements (IDeviceSelection devRequirements)

設定 IDeviceSelection，取代任何現有值。這會設定全域裝置篩選器，決定 DeviceManager 可查看的裝置。

setHostMonitors

public void setHostMonitors ( hostMonitors)

設定 IHostMonitor 清單。

參數
`hostMonitors`	：監控器清單

setHostOptions

public void setHostOptions (IHostOptions hostOptions)

設定 IHostOptions，取代任何現有值。

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

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

setInvocationServer

public void setInvocationServer (TestInvocationManagementServer server)

可設定 TestInvocationManagementServer。

參數
`server`	`TestInvocationManagementServer`

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

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

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

使用指定的指令列引數集合，設定全域設定 Option 欄位

請參閱 ArgsOptionParser，瞭解預期格式

參數
`listArgs`	：指令列引數

傳回
	未使用的引數

擲回
`ConfigurationException`

setOriginalConfig

public void setOriginalConfig (String config)

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

參數
`config`	`String`

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

可設定 IResourceMetricCollector。

參數
`collector`	`IResourceMetricCollector`

setSandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

設定 ISandboxFactory，取代任何現有值。

setShardingStrategy

public void setShardingStrategy (IShardHelper sharding)

設定在分割設定時要使用的 IShardHelper。

參數
`sharding`	`IShardHelper`

setTradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

可設定 TradefedFeatureServer。

參數
`server`	`TradefedFeatureServer`

setWtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

設定 ITerribleFailureHandler。

參數
`wtfHandler`	`ITerribleFailureHandler`：WTF 處理常式

設定

public void setup ()

在 tradefed 開始時正確設定。

擲回
`ConfigurationException`

validateOptions

public void validateOptions ()

驗證選項值。

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

擲回
`ConfigurationException`

受保護的方法

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

傳回
`IConfigurationFactory`