全局配置
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
|
受保護的方法 | |
---|---|
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 |
退貨 | |
---|---|
File | 包含新過濾的全局配置的文件。 |
帶過濾器的克隆配置
public File cloneConfigWithFilter (exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)
根據白名單過濾 GlobalConfiguration,同時允許操作選項值並輸出到 XML 文件。
參數 | |
---|---|
exclusionPatterns | |
transformer | IConfigOptionValueTransformer |
deepCopy | boolean |
allowlistConfigs | String :要包含在新 XML 文件中的配置的String 數組。如果它設置為null |
退貨 | |
---|---|
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 |
退貨 | |
---|---|
File | 包含新過濾的全局配置的文件。 |
創建全局配置
public staticcreateGlobalConfiguration (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 | ICredentialFactory 或null (如果未指定)。 |
獲取設備管理服務器
public DeviceManagementGrpcServer getDeviceManagementServer ()
返回DeviceManagementGrpcServer
或 null(如果未定義)。
退貨 | |
---|---|
DeviceManagementGrpcServer |
獲取設備管理器
public IDeviceManager getDeviceManager ()
從配置中獲取要使用的IDeviceManager
。管理一組可用的測試設備
退貨 | |
---|---|
IDeviceManager | 配置中提供的IDeviceManager 。 |
獲取設備管理器實例
public static IDeviceManager getDeviceManagerInstance ()
返回對此 TF 實例的單例DeviceManager
實例的引用。
退貨 | |
---|---|
IDeviceManager |
投擲 | |
---|---|
IllegalStateException | 如果尚未調用createGlobalConfiguration(String[]) 。 |
獲取設備需求
public IDeviceSelection getDeviceRequirements ()
從配置中獲取要使用的IDeviceSelection
。表示DeviceManager
可以查看的設備的全局過濾器。
退貨 | |
---|---|
IDeviceSelection | 配置中提供的IDeviceSelection 。 |
獲取特征服務器
public TradefedFeatureServer getFeatureServer ()
返回TradefedFeatureServer
或 null(如果未定義)。
退貨 | |
---|---|
TradefedFeatureServer |
獲取全局配置服務器
public IConfigurationServer getGlobalConfigServer ()
獲取全局配置服務器。全局配置服務器用於從服務器獲取主機配置,而不是從本地文件獲取。
退貨 | |
---|---|
IConfigurationServer |
獲取主機監視器實例
public staticgetHostMonitorInstances ()
退貨 | |
---|---|
獲取主機選項
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。 |
獲取多設備恢復處理程序
publicgetMultiDeviceRecoveryHandlers ()
從配置中獲取要使用的IMultiDeviceRecovery
列表。
退貨 | |
---|---|
IMultiDeviceRecovery 列表,如果未設置則為null 。 |
獲取選項值
publicgetOptionValues (String optionName)
獲取選項值的列表。
參數 | |
---|---|
optionName | String : 地圖選項名稱 |
退貨 | |
---|---|
給定選項值的列表。如果選項名稱不存在, null 。 |
獲取資源度量收集器
publicgetResourceMetricCollectors ()
從全局配置中獲取IResourceMetricCollector
列表。
退貨 | |
---|---|
全局配置中的IResourceMetricCollector 列表,如果未指定,則為null 。 |
獲取測試調用管理服務器
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 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 setDeviceMonitor (IDeviceMonitor monitor)
設置IDeviceMonitor
。
參數 | |
---|---|
monitor | IDeviceMonitor :監視器 |
設置設備要求
public void setDeviceRequirements (IDeviceSelection devRequirements)
設置IDeviceSelection
,替換任何現有值。這將設置全局設備過濾器, DeviceManager
可以查看哪些設備。
設置主機資源管理器
public void setHostResourceManager (IHostResourceManager hostResourceManager)
設置IHostResourceManager
,替換任何現有值。
設置調用服務器
public void setInvocationServer (TestInvocationManagementServer server)
設置TestInvocationManagementServer
。
參數 | |
---|---|
server | TestInvocationManagementServer |
設置KeyStoreFactory
public void setKeyStoreFactory (IKeyStoreFactory factory)
設置IKeyStoreFactory
,替換任何現有值。
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
使用給定的一組命令行參數設置全局配置Option
字段
ArgsOptionParser
了解預期格式參數 | |
---|---|
listArgs |
退貨 | |
---|---|
未消耗的參數 |
投擲 | |
---|---|
ConfigurationException |
設置原始配置
public void setOriginalConfig (String config)
設置用於創建全局配置的原始配置。
參數 | |
---|---|
config | String |
設置資源度量收集器
public void setResourceMetricCollector (IResourceMetricCollector collector)
參數 | |
---|---|
collector | IResourceMetricCollector |
設置分片策略
public void setShardingStrategy (IShardHelper sharding)
設置分片配置時要使用的IShardHelper
。
參數 | |
---|---|
sharding | IShardHelper |
設置 TradefedFeatureServer
public void setTradefedFeatureServer (TradefedFeatureServer server)
參數 | |
---|---|
server | TradefedFeatureServer |
設置WtfHandler
public void setWtfHandler (ITerribleFailureHandler wtfHandler)
參數 | |
---|---|
wtfHandler | ITerribleFailureHandler :WTF 處理程序 |