Глобальная конфигурация

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Объект
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)

Настраивает синглтон GlobalConfiguration для этого экземпляра TF.

ICommandScheduler getCommandScheduler ()

Получает ICommandScheduler для использования из конфигурации.

Object getConfigurationObject (String typeName)

Получает настраиваемый объект конфигурации с заданным именем.

ICredentialFactory getCredentialFactory ()

Получает ICredentialFactory для создания учетных данных.

String getDescription ()
DeviceManagementGrpcServer getDeviceManagementServer ()

Возвращает DeviceManagementGrpcServer или значение null, если оно не определено.

IDeviceManager getDeviceManager ()

Получает IDeviceManager для использования из конфигурации.

static IDeviceManager getDeviceManagerInstance ()

Возвращает ссылку на одноэлементный экземпляр DeviceManager для этого экземпляра TF.

getDeviceMonitors ()

Получает список IDeviceMonitor из глобальной конфигурации.

IDeviceSelection getDeviceRequirements ()

Получает IDeviceSelection для использования из конфигурации.

TradefedFeatureServer getFeatureServer ()

Возвращает TradefedFeatureServer или null, если он не определен.

IConfigurationServer getGlobalConfigServer ()

Получает сервер глобальной конфигурации.

static getHostMonitorInstances ()
getHostMonitors ()

Получает список IHostMonitor из глобальной конфигурации.

IHostOptions getHostOptions ()

Получает IHostOptions для использования из конфигурации.

IHostResourceManager getHostResourceManager ()

Получает IHostResourceManager из глобальной конфигурации.

static IGlobalConfiguration getInstance ()

Возвращает ссылку на единственный экземпляр GlobalConfiguration для этого экземпляра TF.

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

УСТРОЙСТВО_MANAGER_TYPE_NAME

public static final String DEVICE_MANAGER_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.

клонконфигвисфилтер

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

Отфильтруйте GlobalConfiguration на основе белого списка и выведите в файл XML.

Параметры
exclusionPatterns : Шаблон имени класса, который следует исключить из дампа.

allowlistConfigs String : массив String конфигураций для включения в новый XML-файл. Если установлено значение 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 : массив String конфигураций для включения в новый XML-файл. Если установлено значение 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 : массив String конфигураций для включения в новый XML-файл. Если установлено значение null , a default list should be used.
Возвращает
File Файл, содержащий новый отфильтрованный глобальный конфиг.

создать глобальную конфигурацию

public static  createGlobalConfiguration (String[] args)

Настраивает синглтон GlobalConfiguration для этого экземпляра TF. Должен быть вызван один и только один раз, прежде чем что-либо попытается вызвать 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 , если ничего не указано.

получить описание

public String getDescription ()

Возвращает
String краткое удобочитаемое описание этой Configuration

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

Возвращает DeviceManagementGrpcServer или значение null, если оно не определено.

Возвращает
DeviceManagementGrpcServer

getDeviceManager

public IDeviceManager getDeviceManager ()

Получает IDeviceManager для использования из конфигурации. Управляет набором доступных устройств для тестирования

Возвращает
IDeviceManager IDeviceManager , указанный в конфигурации.

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

Возвращает ссылку на одноэлементный экземпляр DeviceManager для этого экземпляра TF.

Возвращает
IDeviceManager

Броски
IllegalStateException если createGlobalConfiguration(String[]) еще не был вызван.

getDeviceMonitors

public  getDeviceMonitors ()

Получает список IDeviceMonitor из глобальной конфигурации.

Возвращает
список IDeviceMonitor из глобальной конфигурации или null , если ничего не было указано.

получитьтребования к устройству

public IDeviceSelection getDeviceRequirements ()

Получает IDeviceSelection для использования из конфигурации. Представляет глобальный фильтр, который может видеть DeviceManager .

Возвращает
IDeviceSelection IDeviceSelection предоставленный в конфигурации.

получитьFeatureServer

public TradefedFeatureServer getFeatureServer ()

Возвращает TradefedFeatureServer или null, если он не определен.

Возвращает
TradefedFeatureServer

получить глобалконфигсервер

public IConfigurationServer getGlobalConfigServer ()

Получает сервер глобальной конфигурации. Сервер глобальной конфигурации используется для получения конфигураций хоста с сервера, а не из локальных файлов.

Возвращает
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

Возвращает

getHostMonitors

public  getHostMonitors ()

Получает список IHostMonitor из глобальной конфигурации.

Возвращает
список IHostMonitor из глобальной конфигурации или null , если ничего не было указано.

getHostOptions

public IHostOptions getHostOptions ()

Получает IHostOptions для использования из конфигурации.

Возвращает
IHostOptions IDeviceManager , указанный в конфигурации.

получитьHostResourceManager

public IHostResourceManager getHostResourceManager ()

Получает IHostResourceManager из глобальной конфигурации.

Возвращает
IHostResourceManager IHostResourceManager из глобальной конфигурации или реализация по умолчанию LocalHostResourceManager если ни один из них не указан в конфигурации хоста.

получить экземпляр

public static IGlobalConfiguration getInstance ()

Возвращает ссылку на единственный экземпляр GlobalConfiguration для этого экземпляра TF.

Возвращает
IGlobalConfiguration

Броски
IllegalStateException если createGlobalConfiguration(String[]) еще не был вызван.

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

Получает IKeyStoreFactory для использования из конфигурации.

Возвращает
IKeyStoreFactory IKeyStoreFactory или null, если фабрика хранилища ключей не задана.

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

Получает список IMultiDeviceRecovery для использования из конфигурации.

Возвращает
список IMultiDeviceRecovery или null , если оно не установлено.

получить имя

public String getName ()

Возвращает
String имя этой Configuration

получитьOptionValues

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 или значение null, если оно не определено.

Возвращает
TestInvocationManagementServer

getWtfHandler

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

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

валидатеоптионс

public void validateOptions ()

Подтвердите значения параметров.

В настоящее время это просто подтвердит, что все обязательные параметры установлены.

Броски
ConfigurationException

Защищенные методы

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

Возвращает
IConfigurationFactory