Configuração global

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

Subclasses indiretas conhecidas GlobalConfiguration (em inglês) GlobalConfiguration Uma implementação IGlobalConfiguration que armazena os objetos de configuração carregados em um mapa

---

Uma classe para abranger informações de configuração globais para uma única instância da Trade Federation (incluindo qualquer número de invocações de configurações reais).

Resumo

Métodos públicos
abstract void	cleanup() Limpeza adequada ao encerrar o tradefed.
abstract File	cloneConfigWithFilter( exclusionPatterns, String... allowlistConfigs) Filtre a GlobalConfiguration com base em uma lista branca e gere um arquivo XML.
abstract File	cloneConfigWithFilter( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) Filtre a GlobalConfiguration com base em uma lista branca, permitindo a manipulação de valores de opções e a saída para um arquivo XML.
abstract File	cloneConfigWithFilter(String... allowlistConfigs) Filtra a GlobalConfiguration com base em uma lista de permissões e saída para um arquivo XML.
abstract ICommandScheduler	getCommandScheduler() Recebe o ICommandScheduler a ser usado na configuração.
abstract Object	getConfigurationObject(String typeName) Recebe o objeto de configuração personalizada com o nome fornecido.
abstract ICredentialFactory	getCredentialFactory() Recebe o ICredentialFactory para criar credenciais.
abstract DeviceManagementGrpcServer	getDeviceManagementServer() Retorna DeviceManagementGrpcServer ou nulo se indefinido.
abstract IDeviceManager	getDeviceManager() Recebe o IDeviceManager a ser usado na configuração.
abstract	getDeviceMonitors() Recebe a lista de IDeviceMonitor da configuração global.
abstract IDeviceSelection	getDeviceRequirements() Recebe o IDeviceSelection a ser usado na configuração.
abstract TradefedFeatureServer	getFeatureServer() Retorna TradefedFeatureServer ou nulo se indefinido.
abstract IConfigurationServer	getGlobalConfigServer() Recebe o servidor de configuração global.
abstract	getHostMonitors() Recebe a lista de IHostMonitor da configuração global.
abstract IHostOptions	getHostOptions() Recebe o IHostOptions a ser usado na configuração.
abstract IHostResourceManager	getHostResourceManager() Recebe o IHostResourceManager da configuração global.
abstract IKeyStoreFactory	getKeyStoreFactory() Recebe o IKeyStoreFactory a ser usado na configuração.
abstract	getMultiDeviceRecoveryHandlers() Extrai a lista de IMultiDeviceRecovery a serem usados na configuração.
abstract	getOptionValues(String optionName) Recebe uma lista de valores da opção.
abstract	getResourceMetricCollectors() Recebe a lista de IResourceMetricCollector da configuração global.
abstract ISandboxFactory	getSandboxFactory() Receber uma fábrica de sandbox que pode ser usada para executar uma invocação
abstract IShardHelper	getShardingStrategy() Retorna o IShardHelper que define a forma de dividir uma configuração.
abstract TestInvocationManagementServer	getTestInvocationManagementSever() Retorna TestInvocationManagementServer ou nulo se indefinido.
abstract ITerribleFailureHandler	getWtfHandler() Recebe o ITerribleFailureHandler a ser usado na configuração.
abstract void	injectOptionValue(String optionName, String optionValue) Injete um valor de opção no conjunto de objetos de configuração.
abstract void	injectOptionValue(String optionName, String optionKey, String optionValue) Injete um valor de opção no conjunto de objetos de configuração.
abstract void	setCommandScheduler(ICommandScheduler scheduler) Defina ICommandScheduler, substituindo todos os valores atuais.
abstract void	setConfigurationFactory(IConfigurationFactory configFactory) Defina o IConfigurationFactory para essa configuração.
abstract void	setConfigurationObject(String name, Object configObject) Método genérico para definir o objeto de configuração com o nome determinado, substituindo qualquer valor atual.
abstract void	setConfigurationObjectList(String typeName, configList) Método genérico para definir a lista de objetos de configuração para o nome fornecido, substituindo qualquer valor atual.
abstract void	setDeviceManagementServer(DeviceManagementGrpcServer server) Define o DeviceManagementGrpcServer.
abstract void	setDeviceManager(IDeviceManager deviceManager) Defina IDeviceManager, substituindo todos os valores atuais.
abstract void	setDeviceMonitor(IDeviceMonitor deviceMonitor) Defina o IDeviceMonitor.
abstract void	setDeviceRequirements(IDeviceSelection deviceSelection) Defina IDeviceSelection, substituindo todos os valores atuais.
abstract void	setHostMonitors( hostMonitors) Defina a lista IHostMonitor.
abstract void	setHostOptions(IHostOptions hostOptions) Defina IHostOptions, substituindo todos os valores atuais.
abstract void	setHostResourceManager(IHostResourceManager hostResourceManager) Defina o IHostResourceManager, substituindo os valores atuais.
abstract void	setInvocationServer(TestInvocationManagementServer server) Define o TestInvocationManagementServer.
abstract void	setKeyStoreFactory(IKeyStoreFactory factory) Defina IKeyStoreFactory, substituindo todos os valores atuais.
abstract	setOptionsFromCommandLineArgs( listArgs) Definir os campos de configuração global Option com um conjunto específico de argumentos de linha de comando Consulte ArgsOptionParser para saber o formato esperado
abstract void	setOriginalConfig(String config) Define a configuração original usada para criar a configuração global.
abstract void	setResourceMetricCollector(IResourceMetricCollector collector) Define o IResourceMetricCollector.
abstract void	setSandboxFactory(ISandboxFactory factory) Defina ISandboxFactory, substituindo todos os valores atuais.
abstract void	setShardingStrategy(IShardHelper sharding) Define a IShardHelper a ser usada ao dividir uma configuração.
abstract void	setTradefedFeatureServer(TradefedFeatureServer server) Define o TradefedFeatureServer.
abstract void	setWtfHandler(ITerribleFailureHandler wtfHandler) Defina o ITerribleFailureHandler.
abstract void	setup() Configuração adequada no início da tradefed.
abstract void	validateOptions() Valide os valores de opção.

Métodos públicos

limpeza

public abstract void cleanup ()

Limpeza adequada ao encerrar o tradefed.

cloneConfigWithFilter

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

Filtre a GlobalConfiguration com base em uma lista de permissões e envie a saída para um arquivo XML.

Parâmetros
exclusionPatterns	: o padrão do nome da classe a ser excluído do despejo.
allowlistConfigs	String: uma matriz String de configurações a serem incluídas no novo arquivo XML. Se definido como null, a default list should be used.

Retorna
File	O arquivo que contém a nova configuração global filtrada.

Gera
	IOException

Confira também:

• cloneConfigWithFilter(String)

cloneConfigWithFilter

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

Filtra a GlobalConfiguration com base em uma lista de permissões, permitindo a manipulação de valores de opções e a saída para um arquivo XML.

Parâmetros
exclusionPatterns	: o padrão do nome da classe a ser excluído do despejo.
transformer	IConfigOptionValueTransformer
deepCopy	boolean
allowlistConfigs	String: uma matriz String de configurações a serem incluídas no novo arquivo XML. Se definido como null, a default list should be used.

Retorna
File	O arquivo que contém a nova configuração global filtrada.

Confira também:

• cloneConfigWithFilter(String)

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtre a GlobalConfiguration com base em uma lista de permissões e gere um arquivo XML.

Por exemplo, para a seguinte configuração: <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>

Todas as configurações, exceto "key_store", serão filtradas e resultarão em um arquivo de configuração com o seguinte conteúdo: <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

Parâmetros
allowlistConfigs	String: uma matriz String de configurações a serem incluídas no novo arquivo XML. Se definido como null, a default list should be used.

Retorna
File	O arquivo que contém a nova configuração global filtrada.

Gera
	IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

Recebe o ICommandScheduler a ser usado na configuração.

Retorna
ICommandScheduler	o ICommandScheduler. Nunca retorna um valor nulo.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

Recebe o objeto de configuração personalizada com o nome fornecido.

Parâmetros
typeName	String: o tipo exclusivo do objeto de configuração

Retorna
Object	o objeto ou nulo se o objeto com esse nome não for encontrado

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

Recebe o ICredentialFactory para criar credenciais.

Retorna
ICredentialFactory	ICredentialFactory ou null se nenhuma tiver sido especificada.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Retorna DeviceManagementGrpcServer ou nulo se indefinido.

Retorna
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

Recebe o IDeviceManager a ser usado na configuração. Gerencia o conjunto de dispositivos disponíveis para testes

Retorna
IDeviceManager	o IDeviceManager fornecido na configuração.

getDeviceMonitors

public abstract  getDeviceMonitors ()

Recebe a lista de IDeviceMonitor da configuração global.

Retorna
	a lista de IDeviceMonitor da configuração global ou null se nenhum tiver sido especificado.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

Recebe o IDeviceSelection a ser usado na configuração. Representa um filtro global em que os dispositivos DeviceManager podem ser vistos.

Retorna
IDeviceSelection	o IDeviceSelection fornecido na configuração.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

Retorna o TradefedFeatureServer ou nulo, se indefinido.

Retorna
TradefedFeatureServer

getGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

Recebe o servidor de configuração global. O servidor de configuração global é usado para receber configurações de host de um servidor em vez de arquivos locais.

Retorna
IConfigurationServer

getHostMonitors

public abstract  getHostMonitors ()

Recebe a lista de IHostMonitor da configuração global.

Retorna
	a lista de IHostMonitor da configuração global ou null se nenhuma foi especificada.

getHostOptions

public abstract IHostOptions getHostOptions ()

Recebe o IHostOptions a ser usado na configuração.

Retorna
IHostOptions	o IDeviceManager fornecido na configuração.

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

Recebe o IHostResourceManager da configuração global.

Retorna
IHostResourceManager	o IHostResourceManager da configuração global ou a implementação padrão LocalHostResourceManager, se nenhuma for especificada na configuração do host.

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

Recebe o IKeyStoreFactory a ser usado na configuração.

Retorna
IKeyStoreFactory	IKeyStoreFactory ou nulo se nenhuma fábrica de keystore estiver definida.

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

Recebe a lista de IMultiDeviceRecovery a ser usado na configuração.

Retorna
	a lista de IMultiDeviceRecovery ou null, se não estiver definido.

getOptionValues

public abstract  getOptionValues (String optionName)

Receba uma lista de valores de opções.

Parâmetros
optionName	String: o nome da opção do mapa

Retorna
	uma lista dos valores da opção indicada. null se o nome da opção não existir.

getResourceMetricCollectors

public abstract  getResourceMetricCollectors ()

Recebe a lista de IResourceMetricCollector da configuração global.

Retorna
	a lista de IResourceMetricCollector da configuração global ou null se nenhuma foi especificada.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Receber uma fábrica de sandbox que pode ser usada para executar uma invocação

Retorna
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

Retorna o IShardHelper que define a maneira de fragmentar uma configuração.

Retorna
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Retorna TestInvocationManagementServer ou nulo se indefinido.

Retorna
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Recebe o ITerribleFailureHandler a ser usado na configuração. Processa o que fazer caso ocorra uma falha WTF (What a Terrible Failure).

Retorna
ITerribleFailureHandler	o ITerribleFailureHandler fornecido na configuração ou nulo se nenhum gerenciador estiver definido

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Injete um valor de opção no conjunto de objetos de configuração.

Útil para fornecer valores para opções geradas dinamicamente.

Parâmetros
optionName	String: o nome da opção.
optionValue	String: os valores de opção

Gera
ConfigurationException	se houver falha ao definir o valor da opção

injectOptionValue

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

Injete um valor de opção no conjunto de objetos de configuração.

Útil para fornecer valores para opções geradas dinamicamente.

Parâmetros
optionName	String: o nome da opção do mapa
optionKey	String: a chave de opção do mapa
optionValue	String: o valor da opção de mapa

Gera
ConfigurationException	se houver falha ao definir o valor da opção

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Defina ICommandScheduler, substituindo todos os valores atuais.

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Defina o IConfigurationFactory para essa configuração.

Parâmetros
configFactory	IConfigurationFactory

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                Object configObject)

Método genérico para definir o objeto de configuração com o nome fornecido, substituindo qualquer valor existente.

Parâmetros
name	String: o nome exclusivo do tipo de objeto de configuração.
configObject	Object: o objeto de configuração.

Gera
ConfigurationException	se o configObject não for do tipo correto

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

Método genérico para definir a lista de objetos de configuração para o nome fornecido, substituindo qualquer valor atual.

Parâmetros
typeName	String: o nome exclusivo do tipo de objeto de configuração.
configList	: a lista de objetos de configuração.

Gera
ConfigurationException	se algum objeto na lista não for do tipo correto

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Define o DeviceManagementGrpcServer.

Parâmetros
server	DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Defina IDeviceManager, substituindo todos os valores atuais. Isso define o gerenciador dos dispositivos de teste

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Defina o IDeviceMonitor.

Parâmetros
deviceMonitor	IDeviceMonitor: o monitor

Gera
ConfigurationException	se um IDeviceMonitor já tiver sido definido.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Defina IDeviceSelection, substituindo todos os valores atuais. Isso define um filtro global de dispositivos em que o DeviceManager pode ser visto.

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

Defina a lista IHostMonitor.

Parâmetros
hostMonitors	: a lista de monitores

Gera
ConfigurationException	se um IHostMonitor já tiver sido definido.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Defina IHostOptions, substituindo todos os valores atuais.

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Defina o IHostResourceManager, substituindo os valores atuais.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Define o TestInvocationManagementServer.

Parâmetros
server	TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Defina IKeyStoreFactory, substituindo todos os valores atuais.

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

Definir os campos de configuração global Option com um conjunto específico de argumentos de linha de comando

Consulte ArgsOptionParser para saber o formato esperado

Parâmetros
listArgs	: os argumentos da linha de comando

Retorna
	os argumentos não consumidos

Gera
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

Define a configuração original usada para criar a configuração global.

Parâmetros
config	String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

Define o IResourceMetricCollector.

Parâmetros
collector	IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

Defina ISandboxFactory, substituindo todos os valores atuais.

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

Define o IShardHelper a ser usado ao fragmentar uma configuração.

Parâmetros
sharding	IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Define o TradefedFeatureServer.

Parâmetros
server	TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Defina o ITerribleFailureHandler.

Parâmetros
wtfHandler	ITerribleFailureHandler: o manipulador de WTF

Gera
ConfigurationException	se um ITerribleFailureHandler já tiver sido definido.

Configuração

public abstract void setup ()

Configuração adequada no início da tradefed.

Gera
	com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

Valide os valores de opção.

No momento, isso apenas valida que todas as opções obrigatórias foram definidas.

Gera
ConfigurationException	se a configuração não tiver campos obrigatórios.