GlobalConfiguration

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Object
↳	com.android.tradefed.config.GlobalConfiguration

---

Uma implementação IGlobalConfiguration que armazena os objetos de configuração carregados em um mapa

Resumo

Campos
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

Métodos públicos
void	cleanup() Limpeza adequada ao encerrar o tradefed.
File	cloneConfigWithFilter( exclusionPatterns, String... allowlistConfigs) Filtre a GlobalConfiguration com base em uma lista branca e gere um arquivo XML.
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.
File	cloneConfigWithFilter(String... allowlistConfigs) Filtre a GlobalConfiguration com base em uma lista de permissões e gere um arquivo XML.
static	createGlobalConfiguration(String[] args) Configura o singleton GlobalConfiguration para essa instância do TF.
ICommandScheduler	getCommandScheduler() Recebe o ICommandScheduler a ser usado na configuração.
Object	getConfigurationObject(String typeName) Recebe o objeto de configuração personalizada com o nome fornecido.
ICredentialFactory	getCredentialFactory() Recebe o ICredentialFactory para criar credenciais.
String	getDescription()
DeviceManagementGrpcServer	getDeviceManagementServer() Retorna DeviceManagementGrpcServer ou nulo se indefinido.
IDeviceManager	getDeviceManager() Recebe a IDeviceManager a ser usada na configuração.
static IDeviceManager	getDeviceManagerInstance() Retorna uma referência à instância DeviceManager singleton para essa instância de TF.
	getDeviceMonitors() Recebe a lista de IDeviceMonitor da configuração global.
IDeviceSelection	getDeviceRequirements() Recebe o IDeviceSelection a ser usado na configuração.
TradefedFeatureServer	getFeatureServer() Retorna TradefedFeatureServer ou nulo se indefinido.
IConfigurationServer	getGlobalConfigServer() Recebe o servidor de configuração global.
static	getHostMonitorInstances()
	getHostMonitors() Recebe a lista de IHostMonitor da configuração global.
IHostOptions	getHostOptions() Recebe o IHostOptions a ser usado na configuração.
IHostResourceManager	getHostResourceManager() Recebe o IHostResourceManager da configuração global.
static IGlobalConfiguration	getInstance() Retorna uma referência à instância GlobalConfiguration de singleton para esta instância do TF.
IKeyStoreFactory	getKeyStoreFactory() Recebe o IKeyStoreFactory a ser usado na configuração.
	getMultiDeviceRecoveryHandlers() Recebe a lista de IMultiDeviceRecovery a ser usado na configuração.
String	getName()
	getOptionValues(String optionName) Recebe uma lista de valores da opção.
	getResourceMetricCollectors() Recebe a lista de IResourceMetricCollector da configuração global.
ISandboxFactory	getSandboxFactory() Receber uma fábrica de sandbox que pode ser usada para executar uma invocação
IShardHelper	getShardingStrategy() Retorna o IShardHelper que define a forma de dividir uma configuração.
TestInvocationManagementServer	getTestInvocationManagementSever() Retorna TestInvocationManagementServer ou nulo se indefinido.
ITerribleFailureHandler	getWtfHandler() Recebe o ITerribleFailureHandler a ser usado na configuração.
void	injectOptionValue(String optionName, String optionValue) Injetar um valor de opção no conjunto de objetos de configuração.
void	injectOptionValue(String optionName, String optionKey, String optionValue) Injetar um valor de opção no conjunto de objetos de configuração.
void	printCommandUsage(boolean importantOnly, PrintStream out) Mostra um texto de ajuda de uso da linha de comando para essa configuração na stream de impressão especificada.
void	setCommandScheduler(ICommandScheduler scheduler) Defina o ICommandScheduler, substituindo os valores atuais.
void	setConfigurationFactory(IConfigurationFactory configFactory) Defina o IConfigurationFactory para essa configuração.
void	setConfigurationObject(String typeName, Object configObject) Método genérico para definir o objeto de configuração com o nome fornecido, substituindo qualquer valor existente.
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.
void	setDeviceManagementServer(DeviceManagementGrpcServer server) Define o DeviceManagementGrpcServer.
void	setDeviceManager(IDeviceManager manager) Defina IDeviceManager, substituindo todos os valores atuais.
void	setDeviceMonitor(IDeviceMonitor monitor) Defina o IDeviceMonitor.
void	setDeviceRequirements(IDeviceSelection devRequirements) Defina IDeviceSelection, substituindo todos os valores atuais.
void	setHostMonitors( hostMonitors) Defina a lista IHostMonitor.
void	setHostOptions(IHostOptions hostOptions) Defina IHostOptions, substituindo todos os valores atuais.
void	setHostResourceManager(IHostResourceManager hostResourceManager) Defina IHostResourceManager, substituindo todos os valores atuais.
void	setInvocationServer(TestInvocationManagementServer server) Define o TestInvocationManagementServer.
void	setKeyStoreFactory(IKeyStoreFactory factory) Defina IKeyStoreFactory, substituindo todos os valores atuais.
	setOptionsFromCommandLineArgs( listArgs) Definir os campos de configuração global Option com um conjunto específico de argumentos de linha de comando Consulte ArgsOptionParser para conferir o formato esperado
void	setOriginalConfig(String config) Define a configuração original usada para criar a configuração global.
void	setResourceMetricCollector(IResourceMetricCollector collector) Define o IResourceMetricCollector.
void	setSandboxFactory(ISandboxFactory factory) Defina ISandboxFactory, substituindo todos os valores atuais.
void	setShardingStrategy(IShardHelper sharding) Define a IShardHelper a ser usada ao dividir uma configuração.
void	setTradefedFeatureServer(TradefedFeatureServer server) Define o TradefedFeatureServer.
void	setWtfHandler(ITerribleFailureHandler wtfHandler) Defina o ITerribleFailureHandler.
void	setup() Configuração adequada no início da tradefed.
void	validateOptions() Valide os valores das opções.

Métodos protegidos
IConfigurationFactory	getConfigurationFactory()

Campos

NOME_DE_TIPO_DE_CREDENTIAL_FACTORY

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

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

Métodos públicos

limpeza

public void cleanup ()

Limpeza adequada ao encerrar o tradefed.

cloneConfigWithFilter

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

Filtre a GlobalConfiguration com base em uma lista branca e gere 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 ele estiver definido como null, a default list should be used.

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

cloneConfigWithFilter

public 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.

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.

cloneConfigWithFilter

public 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.

createGlobalConfiguration

public static  createGlobalConfiguration (String[] args)

Configura o singleton GlobalConfiguration para essa instância do TF. Precisa ser chamado apenas uma vez, antes que qualquer coisa tente chamar getInstance().

Parâmetros
args	String

Retorna

Gera
IllegalStateException	se for chamado mais de uma vez
ConfigurationException

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

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

Retorna
ICommandScheduler	o ICommandScheduler. Nunca retorna um valor nulo.

getConfigurationObject

public 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 ICredentialFactory getCredentialFactory ()

Recebe o ICredentialFactory para criar credenciais.

Retorna
ICredentialFactory	ICredentialFactory ou null se nenhum for especificado.

getDescription

public String getDescription ()

Retorna
String	uma breve descrição legível para o usuário Configuration

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

Retorna DeviceManagementGrpcServer ou nulo se indefinido.

Retorna
DeviceManagementGrpcServer

getDeviceManager

public 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.

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

Retorna uma referência à instância DeviceManager singleton para essa instância de TF.

Retorna
IDeviceManager

Gera
IllegalStateException	se createGlobalConfiguration(String[]) não tiver sido chamado.

getDeviceMonitors

public  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 IDeviceSelection getDeviceRequirements ()

Recebe o IDeviceSelection a ser usado na configuração. Representa um filtro global nos dispositivos que a DeviceManager pode ver.

Retorna
IDeviceSelection	o IDeviceSelection fornecido na configuração.

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

Retorna TradefedFeatureServer ou nulo se indefinido.

Retorna
TradefedFeatureServer

getGlobalConfigServer

public 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 recebê-las de arquivos locais.

Retorna
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

Retorna

getHostMonitors

public  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 IHostOptions getHostOptions ()

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

Retorna
IHostOptions	o IDeviceManager fornecido na configuração.

getHostResourceManager

public 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.

getInstance

public static IGlobalConfiguration getInstance ()

Retorna uma referência à instância GlobalConfiguration singleton para essa instância de TF.

Retorna
IGlobalConfiguration

Gera
IllegalStateException	se createGlobalConfiguration(String[]) não tiver sido chamado.

getKeyStoreFactory

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

Extrai a lista de IMultiDeviceRecovery a serem usados na configuração.

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

getName

public String getName ()

Retorna
String	o nome deste Configuration

getOptionValues

public  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. null se o nome da opção não existir.

getResourceMetricCollectors

public  getResourceMetricCollectors ()

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

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

getSandboxFactory

public ISandboxFactory getSandboxFactory ()

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

Retorna
ISandboxFactory

getShardingStrategy

public IShardHelper getShardingStrategy ()

Retorna o IShardHelper que define a forma de dividir uma configuração.

Retorna
IShardHelper

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

Retorna TestInvocationManagementServer ou nulo se indefinido.

Retorna
TestInvocationManagementServer

getWtfHandler

public 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 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

injectOptionValue

public 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

printCommandUsage

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

Gera um texto de ajuda sobre o uso da linha de comando para essa configuração em um determinado printStream.

Parâmetros
importantOnly	boolean
out	PrintStream: o ERROR(/PrintStream) a ser usado.

Gera
	com.android.tradefed.config.ConfigurationException
ConfigurationException

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

Defina ICommandScheduler, substituindo todos os valores atuais.

setConfigurationFactory

public void setConfigurationFactory (IConfigurationFactory configFactory)

Defina o IConfigurationFactory para essa configuração.

Parâmetros
configFactory	IConfigurationFactory

setConfigurationObject

public void setConfigurationObject (String typeName, 
                Object configObject)

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

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

Gera
ConfigurationException

setConfigurationObjectList

public 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

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

Define o DeviceManagementGrpcServer.

Parâmetros
server	DeviceManagementGrpcServer

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

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

setDeviceMonitor

public void setDeviceMonitor (IDeviceMonitor monitor)

Defina o IDeviceMonitor.

Parâmetros
monitor	IDeviceMonitor: o monitor

setDeviceRequirements

public void setDeviceRequirements (IDeviceSelection devRequirements)

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

setHostMonitors

public void setHostMonitors ( hostMonitors)

Defina a lista de IHostMonitor.

Parâmetros
hostMonitors	: a lista de monitores

setHostOptions

public void setHostOptions (IHostOptions hostOptions)

Defina o IHostOptions, substituindo os valores atuais.

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

Defina IHostResourceManager, substituindo todos os valores atuais.

setInvocationServer

public void setInvocationServer (TestInvocationManagementServer server)

Define o TestInvocationManagementServer.

Parâmetros
server	TestInvocationManagementServer

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

Defina IKeyStoreFactory, substituindo todos os valores atuais.

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

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

Consulte ArgsOptionParser para conferir o formato esperado

Parâmetros
listArgs	: os argumentos da linha de comando

Retorna
	os argumentos não consumidos

Gera
ConfigurationException

setOriginalConfig

public void setOriginalConfig (String config)

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

Parâmetros
config	String

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

Define o IResourceMetricCollector.

Parâmetros
collector	IResourceMetricCollector

setSandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

Defina ISandboxFactory, substituindo todos os valores atuais.

setShardingStrategy

public void setShardingStrategy (IShardHelper sharding)

Define a IShardHelper a ser usada ao dividir uma configuração.

Parâmetros
sharding	IShardHelper

setTradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

Define o TradefedFeatureServer.

Parâmetros
server	TradefedFeatureServer

setWtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

Defina o ITerribleFailureHandler.

Parâmetros
wtfHandler	ITerribleFailureHandler: o manipulador de WTF

Configuração

public void setup ()

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

Gera
ConfigurationException

validateOptions

public void validateOptions ()

Valide os valores das opções.

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

Gera
ConfigurationException

Métodos protegidos

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

Retorna
IConfigurationFactory