ГлобальнаяКонфигурация
public class GlobalConfiguration
extends Object implements IGlobalConfiguration
| java.lang.Object | |
| ↳ | com.android.tradefed.config.GlobalConfiguration |
Реализация IGlobalConfiguration , которая сохраняет загруженные объекты конфигурации на карте.
Краткое содержание
Константы | |
|---|---|
String | CREDENTIAL_FACTORY_TYPE_NAME |
String | DEVICE_MANAGER_TYPE_NAME |
String | DEVICE_MONITOR_TYPE_NAME |
String | DEVICE_REQUIREMENTS_TYPE_NAME |
String | GLOBAL_CONFIG_SERVER |
String | GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE |
String | GLOBAL_CONFIG_VARIABLE |
String | HOST_MONITOR_TYPE_NAME |
String | HOST_OPTIONS_TYPE_NAME |
String | HOST_RESOURCE_MANAGER_TYPE_NAME |
String | KEY_STORE_TYPE_NAME |
String | MULTI_DEVICE_RECOVERY_TYPE_NAME |
String | RESOURCE_METRIC_COLLECTOR_TYPE_NAME |
String | SANDBOX_FACTORY_TYPE_NAME |
String | SCHEDULER_TYPE_NAME |
String | SHARDING_STRATEGY_TYPE_NAME |
String | TF_DEVICE_MANAGEMENT_SERVER_NAME |
String | TF_FEATURE_SERVER_NAME |
String | TF_INVOCATION_SERVER_NAME |
String | WTF_HANDLER_TYPE_NAME |
Публичные методы | |
|---|---|
void | cleanup ()Правильная очистка при отключении Tradefed. |
File | cloneConfigWithFilter (Фильтрация GlobalConfiguration на основе белого списка и вывод в XML-файл. |
File | cloneConfigWithFilter (Фильтрация GlobalConfiguration на основе белого списка с возможностью манипулирования значениями параметров и вывода в XML-файл. |
File | cloneConfigWithFilter (String... allowlistConfigs)Фильтрация GlobalConfiguration на основе разрешенного списка и вывод в XML-файл. |
static | createGlobalConfiguration (String[] args) Настраивает синглтон |
ICommandScheduler | getCommandScheduler () Получает |
Object | getConfigurationObject (String typeName)Получает пользовательский объект конфигурации с заданным именем. |
ICredentialFactory | getCredentialFactory () Получает |
String | getDescription () |
DeviceManagementGrpcServer | getDeviceManagementServer () Возвращает |
IDeviceManager | getDeviceManager () Получает |
static IDeviceManager | getDeviceManagerInstance () Возвращает ссылку на единичный экземпляр |
| getDeviceMonitors () Получает список |
IDeviceSelection | getDeviceRequirements () Получает |
TradefedFeatureServer | getFeatureServer () Возвращает |
IConfigurationServer | getGlobalConfigServer ()Получает глобальный сервер конфигураций. |
static | getHostMonitorInstances () |
| getHostMonitors () Получает список |
IHostOptions | getHostOptions () Получает |
IHostResourceManager | getHostResourceManager () Получает |
static IGlobalConfiguration | getInstance () Возвращает ссылку на единичный экземпляр |
IKeyStoreFactory | getKeyStoreFactory () Получает |
| getMultiDeviceRecoveryHandlers () Получает список |
String | getName () |
| getOptionValues (String optionName)Получить список значений опций. |
| getResourceMetricCollectors () Получает список |
ISandboxFactory | getSandboxFactory ()Получите фабрику-песочницу, которую можно использовать для запуска вызова |
IShardHelper | getShardingStrategy () Возвращает |
TestInvocationManagementServer | getTestInvocationManagementSever () Возвращает |
ITerribleFailureHandler | getWtfHandler () Получает |
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) Установите |
void | setConfigurationFactory ( IConfigurationFactory configFactory) Настройте |
void | setConfigurationObject (String typeName, Object configObject)Универсальный метод для установки объекта конфигурации с заданным именем, заменяя любое существующее значение. |
void | setConfigurationObjectList (String typeName,Универсальный метод для установки списка объектов конфигурации для заданного имени, заменяющий любое существующее значение. |
void | setDeviceManagementServer ( DeviceManagementGrpcServer server) Устанавливает |
void | setDeviceManager ( IDeviceManager manager) Установите |
void | setDeviceMonitor ( IDeviceMonitor monitor) Установите |
void | setDeviceRequirements ( IDeviceSelection devRequirements) Установите |
void | setHostMonitors ( Настройте список |
void | setHostOptions ( IHostOptions hostOptions) Задайте |
void | setHostResourceManager ( IHostResourceManager hostResourceManager) Установите |
void | setInvocationServer ( TestInvocationManagementServer server) Устанавливает |
void | setKeyStoreFactory ( IKeyStoreFactory factory) Установите |
| setOptionsFromCommandLineArgs ( Установите глобальные поля ArgsOptionParser |
void | setOriginalConfig (String config)Устанавливает исходную конфигурацию, используемую для создания глобальной конфигурации. |
void | setResourceMetricCollector ( IResourceMetricCollector collector) Устанавливает |
void | setSandboxFactory ( ISandboxFactory factory) Установите |
void | setShardingStrategy ( IShardHelper sharding) Устанавливает |
void | setTradefedFeatureServer ( TradefedFeatureServer server) Устанавливает |
void | setWtfHandler ( ITerribleFailureHandler wtfHandler) Установите |
void | setup ()Правильная настройка при запуске tradefed. |
void | validateOptions ()Проверьте значения параметров. |
Защищенные методы | |
|---|---|
IConfigurationFactory | getConfigurationFactory () |
Константы
CREDENTIAL_FACTORY_TYPE_NAME
public static final String CREDENTIAL_FACTORY_TYPE_NAME
Постоянное значение: «credential_factory»
Имя_типа_менеджера_устройства
public static final String DEVICE_MANAGER_TYPE_NAME
Постоянное значение: «device_manager»
Имя_типа_монитора_устройства
public static final String DEVICE_MONITOR_TYPE_NAME
Постоянное значение: «device_monitor»
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
Постоянное значение: «device_requirements»
GLOBAL_CONFIG_SERVER
public static final String GLOBAL_CONFIG_SERVER
Постоянное значение: «global_config_server»
GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE
public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE
Постоянное значение: «TF_GLOBAL_CONFIG_SERVER_CONFIG»
GLOBAL_CONFIG_VARIABLE
public static final String GLOBAL_CONFIG_VARIABLE
Постоянное значение: «TF_GLOBAL_CONFIG»
HOST_MONITOR_TYPE_NAME
public static final String HOST_MONITOR_TYPE_NAME
Постоянное значение: «host_monitor»
HOST_OPTIONS_TYPE_NAME
public static final String HOST_OPTIONS_TYPE_NAME
Постоянное значение: «host_options»
HOST_RESOURCE_MANAGER_TYPE_NAME
public static final String HOST_RESOURCE_MANAGER_TYPE_NAME
Постоянное значение: «host_resource_manager»
ИМЯ_ТИПА_ХРАНИЛИЩА_КЛЮЧА
public static final String KEY_STORE_TYPE_NAME
Постоянное значение: «key_store»
MULTI_DEVICE_RECOVERY_TYPE_NAME
public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME
Постоянное значение: «multi_device_recovery»
RESOURCE_METRIC_COLLECTOR_TYPE_NAME
public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME
Постоянное значение: «resource_metric_collector»
SANDBOX_FACTORY_TYPE_NAME
public static final String SANDBOX_FACTORY_TYPE_NAME
Постоянное значение: «sandbox_factory»
SCHEDULER_TYPE_NAME
public static final String SCHEDULER_TYPE_NAME
Постоянное значение: «command_scheduler»
SHARDING_STRATEGY_TYPE_NAME
public static final String SHARDING_STRATEGY_TYPE_NAME
Постоянное значение: «sharding_strategy»
TF_DEVICE_MANAGEMENT_SERVER_NAME
public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME
Постоянное значение: «tf_device_management_server»
TF_FEATURE_SERVER_NAME
public static final String TF_FEATURE_SERVER_NAME
Постоянное значение: «tf_feature_server»
TF_INVOCATION_SERVER_NAME
public static final String TF_INVOCATION_SERVER_NAME
Постоянное значение: «tf_invocation_server»
WTF_HANDLER_TYPE_NAME
public static final String WTF_HANDLER_TYPE_NAME
Постоянное значение: "wtf_handler"
Публичные методы
уборка
public void cleanup ()
Правильная очистка при отключении Tradefed.
cloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, String... allowlistConfigs)
Фильтрация GlobalConfiguration на основе белого списка и вывод в XML-файл.
| Параметры | |
|---|---|
exclusionPatterns | : Шаблон имени класса, исключаемого из дампа. |
allowlistConfigs | String : массив String с конфигурациями, которые будут включены в новый XML-файл. Если значение равно null |
| Возврат | |
|---|---|
File | Файл, содержащий новую отфильтрованную глобальную конфигурацию. |
cloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)
Фильтрация GlobalConfiguration на основе белого списка с возможностью манипулирования значениями параметров и вывода в XML-файл.
| Параметры | |
|---|---|
exclusionPatterns | : Шаблон имени класса, исключаемого из дампа. |
transformer | IConfigOptionValueTransformer |
deepCopy | boolean |
allowlistConfigs | String : массив String с конфигурациями, которые будут включены в новый XML-файл. Если значение равно null |
| Возврат | |
|---|---|
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 : массив String с конфигурациями, которые будут включены в новый XML-файл. Если значение равно null |
| Возврат | |
|---|---|
File | Файл, содержащий новую отфильтрованную глобальную конфигурацию. |
createGlobalConfiguration
public staticcreateGlobalConfiguration (String[] args)
Устанавливает синглтон GlobalConfiguration для данного экземпляра TF. Должен быть вызван только один раз, до того, как кто-либо попытается вызвать getInstance()
| Параметры | |
|---|---|
args | String |
| Возврат | |
|---|---|
| |
| Броски | |
|---|---|
IllegalStateException | если вызывается более одного раза |
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 , доступное для чтения пользователем |
getDeviceManagementServer
public DeviceManagementGrpcServer getDeviceManagementServer ()
Возвращает DeviceManagementGrpcServer или null, если не определено.
| Возврат | |
|---|---|
DeviceManagementGrpcServer | |
получитьDeviceManager
public IDeviceManager getDeviceManager ()
Получает IDeviceManager для использования из конфигурации. Управляет набором доступных устройств для тестирования.
| Возврат | |
|---|---|
IDeviceManager | IDeviceManager предоставленный в конфигурации. |
получитьDeviceManagerInstance
public static IDeviceManager getDeviceManagerInstance ()
Возвращает ссылку на единичный экземпляр DeviceManager для данного экземпляра TF.
| Возврат | |
|---|---|
IDeviceManager | |
| Броски | |
|---|---|
IllegalStateException | если createGlobalConfiguration(String[]) еще не был вызван. |
getDeviceMonitors
publicgetDeviceMonitors ()
Получает список IDeviceMonitor из глобальной конфигурации.
| Возврат | |
|---|---|
| список IDeviceMonitor из глобальной конфигурации или null , если ничего не указано. |
getDeviceRequirements
public IDeviceSelection getDeviceRequirements ()
Получает IDeviceSelection для использования из конфигурации. Представляет собой глобальный фильтр, на котором DeviceManager может видеть устройства.
| Возврат | |
|---|---|
IDeviceSelection | IDeviceSelection указанный в конфигурации. |
получитьFeatureServer
public TradefedFeatureServer getFeatureServer ()
Возвращает TradefedFeatureServer или null, если не определено.
| Возврат | |
|---|---|
TradefedFeatureServer | |
получитьGlobalConfigServer
public IConfigurationServer getGlobalConfigServer ()
Получает глобальный сервер конфигурации. Глобальный сервер конфигурации используется для получения конфигураций хоста с сервера, а не из локальных файлов.
| Возврат | |
|---|---|
IConfigurationServer | |
getHostMonitorInstances
public staticgetHostMonitorInstances ()
| Возврат | |
|---|---|
| |
getHostMonitors
publicgetHostMonitors ()
Получает список IHostMonitor из глобальной конфигурации.
| Возврат | |
|---|---|
| список IHostMonitor из глобальной конфигурации или null , если ничего не указано. |
getHostOptions
public IHostOptions getHostOptions ()
Получает IHostOptions для использования из конфигурации.
| Возврат | |
|---|---|
IHostOptions | IDeviceManager предоставленный в конфигурации. |
getHostResourceManager
public IHostResourceManager getHostResourceManager ()
Получает IHostResourceManager из глобальной конфигурации.
| Возврат | |
|---|---|
IHostResourceManager | IHostResourceManager из глобальной конфигурации или реализация LocalHostResourceManager по умолчанию, если в конфигурации хоста ничего не указано. |
получитьInstance
public static IGlobalConfiguration getInstance ()
Возвращает ссылку на единичный экземпляр GlobalConfiguration для данного экземпляра TF.
| Возврат | |
|---|---|
IGlobalConfiguration | |
| Броски | |
|---|---|
IllegalStateException | если createGlobalConfiguration(String[]) еще не был вызван. |
getKeyStoreFactory
public IKeyStoreFactory getKeyStoreFactory ()
Получает IKeyStoreFactory для использования из конфигурации.
| Возврат | |
|---|---|
IKeyStoreFactory | IKeyStoreFactory или null, если фабрика хранилища ключей не установлена. |
getMultiDeviceRecoveryHandlers
publicgetMultiDeviceRecoveryHandlers ()
Получает список IMultiDeviceRecovery для использования из конфигурации.
| Возврат | |
|---|---|
| список IMultiDeviceRecovery или null , если не установлен. |
получитьOptionValues
publicgetOptionValues (String optionName)
Получить список значений опций.
| Параметры | |
|---|---|
optionName | String : имя параметра карты |
| Возврат | |
|---|---|
| список значений заданной опции. null если имя опции не существует. |
getResourceMetricCollectors
publicgetResourceMetricCollectors ()
Получает список IResourceMetricCollector из глобальной конфигурации.
| Возврат | |
|---|---|
| список IResourceMetricCollector из глобальной конфигурации или null , если ничего не указано. |
getSandboxFactory
public ISandboxFactory getSandboxFactory ()
Получите фабрику-песочницу, которую можно использовать для запуска вызова
| Возврат | |
|---|---|
ISandboxFactory | |
getShardingStrategy
public IShardHelper getShardingStrategy ()
Возвращает IShardHelper , определяющий способ сегментирования конфигурации.
| Возврат | |
|---|---|
IShardHelper | |
getTestInvocationManagementSever
public TestInvocationManagementServer getTestInvocationManagementSever ()
Возвращает TestInvocationManagementServer или null, если не определено.
| Возврат | |
|---|---|
TestInvocationManagementServer | |
getWtfHandler
public ITerribleFailureHandler getWtfHandler ()
Получает ITerribleFailureHandler из конфигурации. Обрабатывает действия, которые необходимо предпринять в случае возникновения ошибки WTF (какая ужасная ошибка).
| Возврат | |
|---|---|
ITerribleFailureHandler | ITerribleFailureHandler указанный в конфигурации, или null, если обработчик не установлен |
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
publicsetOptionsFromCommandLineArgs ( 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 | |