IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

Класс, предназначенный для хранения глобальной информации о конфигурации отдельного экземпляра Торговой федерации (включая любое количество вызовов фактических конфигураций).

Краткое содержание

Общедоступные методы

abstract void cleanup ()

Надлежащая очистка после отключения TradeFed.

abstract File cloneConfigWithFilter (String... allowlistConfigs)

Отфильтруйте GlobalConfiguration на основе списка разрешенных параметров и выведите результат в XML-файл.

abstract File cloneConfigWithFilter (Set<String> exclusionPatterns, String... allowlistConfigs)

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

abstract File cloneConfigWithFilter (Set<String> exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)

Фильтрация глобальной конфигурации на основе белого списка с возможностью изменения значений параметров и выводом результатов в XML-файл.

abstract ICommandScheduler getCommandScheduler ()

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

abstract Object getConfigurationObject (String typeName)

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

abstract ICredentialFactory getCredentialFactory ()

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

abstract DeviceManagementGrpcServer getDeviceManagementServer ()

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

abstract IDeviceManager getDeviceManager ()

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

abstract List< IDeviceMonitor > getDeviceMonitors ()

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

abstract IDeviceSelection getDeviceRequirements ()

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

abstract TradefedFeatureServer getFeatureServer ()

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

abstract IConfigurationServer getGlobalConfigServer ()

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

abstract List< IHostMonitor > getHostMonitors ()

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

abstract IHostOptions getHostOptions ()

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

abstract IHostResourceManager getHostResourceManager ()

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

abstract IKeyStoreFactory getKeyStoreFactory ()

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

abstract List< IMultiDeviceRecovery > getMultiDeviceRecoveryHandlers ()

Получает список используемых IMultiDeviceRecovery из конфигурации.

abstract List<String> getOptionValues (String optionName)

Получите список значений параметров.

abstract List< IResourceMetricCollector > getResourceMetricCollectors ()

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

abstract ISandboxFactory getSandboxFactory ()

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

abstract IShardHelper getShardingStrategy ()

Возвращает объект IShardHelper , определяющий способ сегментирования конфигурации.

abstract TestInvocationManagementServer getTestInvocationManagementSever ()

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

abstract ITerribleFailureHandler getWtfHandler ()

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

abstract void injectOptionValue (String optionName, String optionValue)

Внедрить значение параметра в набор объектов конфигурации.

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

Внедрить значение параметра в набор объектов конфигурации.

abstract void setCommandScheduler ( ICommandScheduler scheduler)

Установите значение параметра ICommandScheduler , заменив все существующие значения.

abstract void setConfigurationFactory ( IConfigurationFactory configFactory)

Установите IConfigurationFactory для этой конфигурации.

abstract void setConfigurationObject (String name, Object configObject)

Универсальный метод для установки объекта конфигурации с заданным именем, заменяя любое существующее значение.

abstract void setConfigurationObjectList (String typeName, List<?> configList)

Универсальный метод для установки списка объектов конфигурации для заданного имени, заменяющий любое существующее значение.

abstract void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Задает значение параметра DeviceManagementGrpcServer .

abstract void setDeviceManager ( IDeviceManager deviceManager)

Установите значение IDeviceManager , заменив все существующие значения.

abstract void setDeviceMonitor ( IDeviceMonitor deviceMonitor)

Настройте IDeviceMonitor .

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

Установите значение параметра IDeviceSelection , заменив все существующие значения.

abstract void setHostMonitors (List< IHostMonitor > hostMonitors)

Настройте список IHostMonitor .

abstract void setHostOptions ( IHostOptions hostOptions)

Установите значение параметра IHostOptions , заменив все существующие значения.

abstract void setHostResourceManager ( IHostResourceManager hostResourceManager)

Установите значение параметра IHostResourceManager , заменив все существующие значения.

abstract void setInvocationServer ( TestInvocationManagementServer server)

Устанавливает значение параметра TestInvocationManagementServer .

abstract void setKeyStoreFactory ( IKeyStoreFactory factory)

Установите значение параметра IKeyStoreFactory , заменив все существующие значения.

abstract List<String> setOptionsFromCommandLineArgs (List<String> listArgs)

Задайте поля глобальных Option конфигурации с помощью заданного набора аргументов командной строки.

См. ArgsOptionParser для получения информации об ожидаемом формате.

abstract void setOriginalConfig (String config)

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

abstract void setResourceMetricCollector ( IResourceMetricCollector collector)

Устанавливает значение IResourceMetricCollector .

abstract void setSandboxFactory ( ISandboxFactory factory)

Установите значение параметра ISandboxFactory , заменив все существующие значения.

abstract void setShardingStrategy ( IShardHelper sharding)

Задает компонент IShardHelper , который будет использоваться при сегментировании конфигурации.

abstract void setTradefedFeatureServer ( TradefedFeatureServer server)

Устанавливает значение параметра TradefedFeatureServer .

abstract void setWtfHandler ( ITerribleFailureHandler wtfHandler)

Установите обработчик ITerribleFailureHandler .

abstract void setup ()

Правильная настройка в начале работы с TradeFed.

abstract void validateOptions ()

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

Общедоступные методы

уборка 

public abstract void cleanup ()

Надлежащая очистка после отключения TradeFed.

cloneConfigWithFilter 

public abstract 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 Файл, содержащий новую отфильтрованную глобальную конфигурацию.

Броски
java.io.IOException
IOException

cloneConfigWithFilter 

public abstract File cloneConfigWithFilter (Set<String> exclusionPatterns, 
                String... allowlistConfigs)

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

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

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

Броски
java.io.IOException
IOException

cloneConfigWithFilter 

public abstract File cloneConfigWithFilter (Set<String> exclusionPatterns, 
                IConfigOptionValueTransformer transformer, 
                boolean deepCopy, 
                String... allowlistConfigs)

Фильтрация глобальной конфигурации на основе белого списка с возможностью изменения значений параметров и выводом результатов в XML-файл.

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

transformer IConfigOptionValueTransformer

deepCopy boolean

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

Броски
IOException

getCommandScheduler 

public abstract ICommandScheduler getCommandScheduler ()

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

Возвраты
ICommandScheduler Класс ICommandScheduler никогда не вернет null.

getConfigurationObject 

public abstract Object getConfigurationObject (String typeName)

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

Параметры
typeName String : уникальный тип объекта конфигурации.

Возвраты
Object Если объект с таким именем не найден, он принимает значение null.

getCredentialFactory 

public abstract ICredentialFactory getCredentialFactory ()

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

Возвраты
ICredentialFactory ICredentialFactory или null , если не был указан.

getDeviceManagementServer 

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

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

Возвраты
DeviceManagementGrpcServer

getDeviceManager 

public abstract IDeviceManager getDeviceManager ()

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

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

getDeviceMonitors 

public abstract List<IDeviceMonitor> getDeviceMonitors ()

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

Возвраты
List< IDeviceMonitor > Список IDeviceMonitor из глобальной конфигурации или null , если ни одно из них не было указано.

getDeviceRequirements 

public abstract IDeviceSelection getDeviceRequirements ()

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

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

getFeatureServer 

public abstract TradefedFeatureServer getFeatureServer ()

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

Возвраты
TradefedFeatureServer

getGlobalConfigServer 

public abstract IConfigurationServer getGlobalConfigServer ()

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

Возвраты
IConfigurationServer

getHostMonitors 

public abstract List<IHostMonitor> getHostMonitors ()

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

Возвраты
List< IHostMonitor > Список объектов IHostMonitor из глобальной конфигурации или null , если ни один из них не был указан.

getHostOptions 

public abstract IHostOptions getHostOptions ()

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

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

getHostResourceManager 

public abstract IHostResourceManager getHostResourceManager ()

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

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

getKeyStoreFactory 

public abstract IKeyStoreFactory getKeyStoreFactory ()

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

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

getMultiDeviceRecoveryHandlers 

public abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers ()

Получает список используемых IMultiDeviceRecovery из конфигурации.

Возвраты
List< IMultiDeviceRecovery > Список объектов IMultiDeviceRecovery или null , если он не задан.

getOptionValues 

public abstract List<String> getOptionValues (String optionName)

Получите список значений параметров.

Параметры
optionName String : название параметра карты

Возвраты
List<String> Список значений заданного параметра. Если параметр с таким именем не существует, null .

getResourceMetricCollectors 

public abstract List<IResourceMetricCollector> getResourceMetricCollectors ()

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

Возвраты
List< IResourceMetricCollector > Список объектов IResourceMetricCollector из глобальной конфигурации или null , если ни один из них не был указан.

getSandboxFactory 

public abstract ISandboxFactory getSandboxFactory ()

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

Возвраты
ISandboxFactory

getShardingStrategy 

public abstract IShardHelper getShardingStrategy ()

Возвращает объект IShardHelper , определяющий способ сегментирования конфигурации.

Возвраты
IShardHelper

getTestInvocationManagementServer 

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

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

Возвраты
TestInvocationManagementServer

getWtfHandler 

public abstract ITerribleFailureHandler getWtfHandler ()

Получает обработчик ITerribleFailureHandler из конфигурации. Определяет, что делать в случае возникновения ошибки WTF (What a Terrible Failure — «Какая ужасная ошибка»).

Возвраты
ITerribleFailureHandler Обработчик ITerribleFailureHandler указанный в конфигурации, или null, если обработчик не задан.

injectOptionValue 

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Внедрить значение параметра в набор объектов конфигурации.

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

Параметры
optionName String : название параметра

optionValue String : значение(я) опции

Броски
ConfigurationException если не удалось установить значение параметра

injectOptionValue 

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

Внедрить значение параметра в набор объектов конфигурации.

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

Параметры
optionName String : название параметра карты

optionKey String : ключ параметра карты

optionValue String : значение параметра карты

Броски
ConfigurationException если не удалось установить значение параметра

setCommandScheduler 

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Установите значение параметра ICommandScheduler , заменив все существующие значения.

setConfigurationFactory 

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Установите IConfigurationFactory для этой конфигурации.

Параметры
configFactory IConfigurationFactory

setConfigurationObject 

public abstract void setConfigurationObject (String name, 
                Object configObject)

Универсальный метод для установки объекта конфигурации с заданным именем, заменяя любое существующее значение.

Параметры
name String : уникальное имя типа объекта конфигурации.

configObject Object : объект конфигурации

Броски
ConfigurationException если тип configObject был неверным

setConfigurationObjectList 

public abstract void setConfigurationObjectList (String typeName, 
                List<?> configList)

Универсальный метод для установки списка объектов конфигурации для заданного имени, заменяющий любое существующее значение.

Параметры
typeName String : уникальное имя типа объекта конфигурации.

configList List : список объектов конфигурации

Броски
ConfigurationException если какие-либо объекты в списке не соответствуют нужному типу

setDeviceManagementServer 

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Задает значение параметра DeviceManagementGrpcServer .

Параметры
server DeviceManagementGrpcServer

setDeviceManager 

public abstract void setDeviceManager (IDeviceManager deviceManager)

Установите IDeviceManager , заменив все существующие значения. Это задаст менеджер для тестовых устройств.

setDeviceMonitor 

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Настройте IDeviceMonitor .

Параметры
deviceMonitor IDeviceMonitor : Монитор

Броски
ConfigurationException если IDeviceMonitor уже был настроен.

setDeviceRequirements 

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

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

setHostMonitors 

public abstract void setHostMonitors (List<IHostMonitor> hostMonitors)

Настройте список IHostMonitor .

Параметры
hostMonitors List : Список мониторов

Броски
ConfigurationException если IHostMonitor уже настроен.

setHostOptions 

public abstract void setHostOptions (IHostOptions hostOptions)

Установите значение параметра IHostOptions , заменив все существующие значения.

setHostResourceManager 

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Установите значение параметра IHostResourceManager , заменив все существующие значения.

setInvocationServer 

public abstract void setInvocationServer (TestInvocationManagementServer server)

Устанавливает значение параметра TestInvocationManagementServer .

Параметры
server TestInvocationManagementServer

setKeyStoreFactory 

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Установите значение параметра IKeyStoreFactory , заменив все существующие значения.

setOptionsFromCommandLineArgs 

public abstract List<String> setOptionsFromCommandLineArgs (List<String> listArgs)

Задайте поля глобальных Option конфигурации с помощью заданного набора аргументов командной строки.

См. ArgsOptionParser для получения информации об ожидаемом формате.

Параметры
listArgs List : аргументы командной строки

Возвраты
List<String> неиспользованные аргументы

Броски
ConfigurationException

setOriginalConfig 

public abstract void setOriginalConfig (String config)

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

Параметры
config String

setResourceMetricCollector 

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

Устанавливает значение IResourceMetricCollector .

Параметры
collector IResourceMetricCollector

setSandboxFactory 

public abstract void setSandboxFactory (ISandboxFactory factory)

Установите значение параметра ISandboxFactory , заменив все существующие значения.

setShardingStrategy 

public abstract void setShardingStrategy (IShardHelper sharding)

Задает компонент IShardHelper , который будет использоваться при сегментировании конфигурации.

Параметры
sharding IShardHelper

setTradefedFeatureServer 

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Устанавливает значение параметра TradefedFeatureServer .

Параметры
server TradefedFeatureServer

setWtfHandler 

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Установите обработчик ITerribleFailureHandler .

Параметры
wtfHandler ITerribleFailureHandler : обработчик WTF

Броски
ConfigurationException если обработчик ITerribleFailureHandler уже установлен.

настраивать 

public abstract void setup ()

Правильная настройка в начале работы с TradeFed.

Броски
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions 

public abstract void validateOptions ()

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

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

Броски
ConfigurationException если в конфигурации отсутствуют обязательные поля