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

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 ()

Возвращает ссылку на экземпляр Singleton 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

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

ГЛОБАЛ_CONFIG_СЕРВЕР 

public static final String GLOBAL_CONFIG_SERVER

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE 

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

ГЛОБАЛЬНАЯ_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

ПЛАНИРОВЩИК_ТИП_ИМЯ 

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 : String массив конфигураций, которые будут включены в новый XML-файл. Если для него установлено значение 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 : String массив конфигураций, которые будут включены в новый XML-файл. Если для него установлено значение 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 : 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 , если ничего не указано.

getDeviceRequirements 

public IDeviceSelection getDeviceRequirements ()

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

Возврат
IDeviceSelection IDeviceSelection указанный в конфигурации.

GetFeatureServer 

public TradefedFeatureServer getFeatureServer ()

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

Возврат
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 по умолчанию, если в конфигурации хоста ничего не указано.

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

public static IGlobalConfiguration getInstance ()

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

Возврат
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

getTestInvoctionManagementSever 

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 , заменив все существующие значения.

setInvoctionServer 

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