Configuração Global

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 quando o desligamento do tradefed.

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

Filtre o GlobalConfiguration com base em uma lista branca e envie-o para um arquivo XML.

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

Filtre o GlobalConfiguration com base em uma lista branca enquanto permite a manipulação de valores de opções e saída para um arquivo XML.

File cloneConfigWithFilter (String... allowlistConfigs)

Filtre o GlobalConfiguration com base em uma lista permitida e envie-a para um arquivo XML.

static createGlobalConfiguration (String[] args)

Configura o singleton GlobalConfiguration para esta instância do TF.

ICommandScheduler getCommandScheduler ()

Obtém o ICommandScheduler a ser usado na configuração.

Object getConfigurationObject (String typeName)

Obtém o objeto de configuração personalizado com o nome fornecido.

ICredentialFactory getCredentialFactory ()

Obtém o ICredentialFactory para criar credenciais.

String getDescription ()
DeviceManagementGrpcServer getDeviceManagementServer ()

Retorna DeviceManagementGrpcServer ou null se indefinido.

IDeviceManager getDeviceManager ()

Obtém o IDeviceManager a ser usado na configuração.

static IDeviceManager getDeviceManagerInstance ()

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

getDeviceMonitors ()

Obtém a lista de IDeviceMonitor da configuração global.

IDeviceSelection getDeviceRequirements ()

Obtém o IDeviceSelection a ser usado na configuração.

TradefedFeatureServer getFeatureServer ()

Retorna TradefedFeatureServer ou null se indefinido.

IConfigurationServer getGlobalConfigServer ()

Obtém o servidor de configuração global.

static getHostMonitorInstances ()
getHostMonitors ()

Obtém a lista de IHostMonitor da configuração global.

IHostOptions getHostOptions ()

Obtém o IHostOptions a ser usado na configuração.

IHostResourceManager getHostResourceManager ()

Obtém o IHostResourceManager da configuração global.

static IGlobalConfiguration getInstance ()

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

IKeyStoreFactory getKeyStoreFactory ()

Obtém o IKeyStoreFactory a ser usado na configuração.

getMultiDeviceRecoveryHandlers ()

Obtém a lista de IMultiDeviceRecovery a ser usada na configuração.

String getName ()
getOptionValues (String optionName)

Obtenha uma lista de valores de opções.

getResourceMetricCollectors ()

Obtém a lista de IResourceMetricCollector da configuração global.

ISandboxFactory getSandboxFactory ()

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

IShardHelper getShardingStrategy ()

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

TestInvocationManagementServer getTestInvocationManagementSever ()

Retorna TestInvocationManagementServer ou null se indefinido.

ITerribleFailureHandler getWtfHandler ()

Obtém o ITerribleFailureHandler a ser usado na configuração.

void injectOptionValue (String optionName, String optionValue)

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

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

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

void printCommandUsage (boolean importantOnly, PrintStream out)

Produz um texto de ajuda de uso de linha de comando para esta configuração para determinado printStream.

void setCommandScheduler ( ICommandScheduler scheduler)

Defina o ICommandScheduler , substituindo quaisquer valores existentes.

void setConfigurationFactory ( IConfigurationFactory configFactory)

Defina o IConfigurationFactory para esta 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) setConfigurationObjectList (String typeName, configList)

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

void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Define o DeviceManagementGrpcServer .

void setDeviceManager ( IDeviceManager manager)

Defina o IDeviceManager , substituindo quaisquer valores existentes.

void setDeviceMonitor ( IDeviceMonitor monitor)

Defina o IDeviceMonitor .

void setDeviceRequirements ( IDeviceSelection devRequirements)

Defina o IDeviceSelection , substituindo quaisquer valores existentes.

void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

Defina a lista IHostMonitor .

void setHostOptions ( IHostOptions hostOptions)

Defina IHostOptions , substituindo quaisquer valores existentes.

void setHostResourceManager ( IHostResourceManager hostResourceManager)

Defina o IHostResourceManager , substituindo quaisquer valores existentes.

void setInvocationServer ( TestInvocationManagementServer server)

Define o TestInvocationManagementServer .

void setKeyStoreFactory ( IKeyStoreFactory factory)

Defina IKeyStoreFactory , substituindo quaisquer valores existentes.

setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

Defina os campos Option de configuração global com determinado conjunto de argumentos de linha de comando

Consulte ArgsOptionParser para 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 quaisquer valores existentes.

void setShardingStrategy ( IShardHelper sharding)

Define o IShardHelper a ser usado ao fragmentar 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 do tradefed.

void validateOptions ()

Valide os valores das opções.

Métodos protegidos

IConfigurationFactory getConfigurationFactory ()

Campos

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

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

limpar

public void cleanup ()

Limpeza adequada quando o desligamento do tradefed.

cloneConfigWithFilter

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

Filtre o GlobalConfiguration com base em uma lista branca e envie-o para um arquivo XML.

Parâmetros
exclusionPatterns : o padrão do nome da classe a ser excluído do dump.

allowlistConfigs String : uma matriz String de configurações a serem incluídas no novo arquivo XML. Se estiver definido como null , a default list should be used.
Devoluções
File o arquivo que contém a nova configuração global filtrada.

cloneConfigWithFilter

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

Filtre o GlobalConfiguration com base em uma lista branca enquanto permite a manipulação de valores de opções e saída para um arquivo XML.

Parâmetros
exclusionPatterns : o padrão do nome da classe a ser excluído do dump.

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String : uma matriz String de configurações a serem incluídas no novo arquivo XML. Se estiver definido como null , a default list should be used.
Devoluções
File o arquivo que contém a nova configuração global filtrada.

cloneConfigWithFilter

public File cloneConfigWithFilter (String... allowlistConfigs)

Filtre o GlobalConfiguration com base em uma lista permitida e envie-a para 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 estiver definido como null , a default list should be used.
Devoluções
File o arquivo que contém a nova configuração global filtrada.

createGlobalConfiguração

public static  createGlobalConfiguration (String[] args)

Configura o singleton GlobalConfiguration para esta instância do TF. Deve ser chamado uma e apenas uma vez, antes de qualquer tentativa de chamar getInstance()

Parâmetros
args String

Devoluções

Lança
IllegalStateException se for chamado mais de uma vez
ConfigurationException

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

Obtém o ICommandScheduler a ser usado na configuração.

Devoluções
ICommandScheduler o ICommandScheduler . Nunca retornará nulo.

getConfigurationObject

public Object getConfigurationObject (String typeName)

Obtém o objeto de configuração personalizado com o nome fornecido.

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

Devoluções
Object o objeto ou nulo se o objeto com esse nome não for encontrado

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

Obtém o ICredentialFactory para criar credenciais.

Devoluções
ICredentialFactory ICredentialFactory ou null se nenhum tiver sido especificado.

getDescrição

public String getDescription ()

Devoluções
String uma breve descrição legível pelo usuário desta Configuration

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

Retorna DeviceManagementGrpcServer ou null se indefinido.

Devoluções
DeviceManagementGrpcServer

getDeviceManager

public IDeviceManager getDeviceManager ()

Obtém o IDeviceManager a ser usado na configuração. Gerencia o conjunto de dispositivos disponíveis para teste

Devoluções
IDeviceManager o IDeviceManager fornecido na configuração.

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

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

Devoluções
IDeviceManager

Lança
IllegalStateException se createGlobalConfiguration(String[]) ainda não tiver sido chamado.

getDeviceMonitores

public  getDeviceMonitors ()

Obtém a lista de IDeviceMonitor da configuração global.

Devoluções
a lista de IDeviceMonitor da configuração global ou null se nenhum foi especificado.

getDeviceRequirements

public IDeviceSelection getDeviceRequirements ()

Obtém o IDeviceSelection a ser usado na configuração. Representa um filtro global em quais dispositivos o DeviceManager pode ver.

Devoluções
IDeviceSelection o IDeviceSelection fornecido na configuração.

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

Retorna TradefedFeatureServer ou null se indefinido.

Devoluções
TradefedFeatureServer

getGlobalConfigServer

public IConfigurationServer getGlobalConfigServer ()

Obtém o servidor de configuração global. O servidor de configuração global é usado para obter configurações de host de um servidor em vez de obtê-las de arquivos locais.

Devoluções
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

Devoluções

getHostMonitores

public  getHostMonitors ()

Obtém a lista de IHostMonitor da configuração global.

Devoluções
a lista de IHostMonitor da configuração global ou null se nenhum foi especificado.

getHostOptions

public IHostOptions getHostOptions ()

Obtém o IHostOptions a ser usado na configuração.

Devoluções
IHostOptions o IDeviceManager fornecido na configuração.

getHostResourceManager

public IHostResourceManager getHostResourceManager ()

Obtém o IHostResourceManager da configuração global.

Devoluções
IHostResourceManager o IHostResourceManager da configuração global ou implementação padrão LocalHostResourceManager se nenhum for especificado na configuração do host.

getInstance

public static IGlobalConfiguration getInstance ()

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

Devoluções
IGlobalConfiguration

Lança
IllegalStateException se createGlobalConfiguration(String[]) ainda não tiver sido chamado.

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

Obtém o IKeyStoreFactory a ser usado na configuração.

Devoluções
IKeyStoreFactory o IKeyStoreFactory ou null se nenhuma fábrica de armazenamento de chaves estiver configurada.

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

Obtém a lista de IMultiDeviceRecovery a ser usada na configuração.

Devoluções
a lista de IMultiDeviceRecovery ou null se não estiver definido.

obterNome

public String getName ()

Devoluções
String O nome dessa Configuration

getOptionValues

public  getOptionValues (String optionName)

Obtenha uma lista de valores de opções.

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

Devoluções
uma lista dos valores da opção fornecida. null se o nome da opção não existir.

getResourceMetricCollectors

public  getResourceMetricCollectors ()

Obtém a lista de IResourceMetricCollector da configuração global.

Devoluções
a lista de IResourceMetricCollector da configuração global ou null se nenhum tiver sido especificado.

obterSandboxFactory

public ISandboxFactory getSandboxFactory ()

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

Devoluções
ISandboxFactory

getShardingStrategy

public IShardHelper getShardingStrategy ()

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

Devoluções
IShardHelper

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

Retorna TestInvocationManagementServer ou null se indefinido.

Devoluções
TestInvocationManagementServer

getWtfHandler

public ITerribleFailureHandler getWtfHandler ()

Obtém o ITerribleFailureHandler a ser usado na configuração. Cuida do que fazer no caso de ocorrer um WTF (What a Terrible Failure).

Devoluções
ITerribleFailureHandler o ITerribleFailureHandler fornecido na configuração ou nulo se nenhum manipulador estiver definido

injetarOptionValue

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 : o(s) valor(es) da opção

Lança
ConfigurationException

injetarOptionValue

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 do mapa

Lança
ConfigurationException

printCommandUsage

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

Produz um texto de ajuda de uso de linha de comando para esta configuração para determinado printStream.

Parâmetros
importantOnly boolean

out PrintStream : o ERROR(/PrintStream) a ser usado.

Lança
com.android.tradefed.config.ConfigurationException
ConfigurationException

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

Defina o ICommandScheduler , substituindo quaisquer valores existentes.

setConfigurationFactory

public void setConfigurationFactory (IConfigurationFactory configFactory)

Defina o IConfigurationFactory para esta 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

Lança
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 existente.

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

configList : a lista de objetos de configuração

Lança
ConfigurationException

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

Define o DeviceManagementGrpcServer .

Parâmetros
server DeviceManagementGrpcServer

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

Defina o IDeviceManager , substituindo quaisquer valores existentes. 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 o IDeviceSelection , substituindo quaisquer valores existentes. Isso define um filtro global de dispositivos nos quais o DeviceManager pode ver.

setHostMonitores

public void setHostMonitors ( hostMonitors)

Defina a lista IHostMonitor .

Parâmetros
hostMonitors : A lista de monitores

setHostOptions

public void setHostOptions (IHostOptions hostOptions)

Defina IHostOptions , substituindo quaisquer valores existentes.

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

Defina o IHostResourceManager , substituindo quaisquer valores existentes.

setInvocationServer

public void setInvocationServer (TestInvocationManagementServer server)

Define o TestInvocationManagementServer .

Parâmetros
server TestInvocationManagementServer

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

Defina IKeyStoreFactory , substituindo quaisquer valores existentes.

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

Defina os campos Option de configuração global com determinado conjunto de argumentos de linha de comando

Consulte ArgsOptionParser para o formato esperado

Parâmetros
listArgs : os argumentos da linha de comando

Devoluções
os argumentos não consumidos

Lança
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

definirSandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

Defina ISandboxFactory , substituindo quaisquer valores existentes.

setShardingStrategy

public void setShardingStrategy (IShardHelper sharding)

Define o IShardHelper a ser usado ao fragmentar 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 WTF

configurar

public void setup ()

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

Lança
ConfigurationException

validarOpções

public void validateOptions ()

Valide os valores das opções.

Atualmente isso apenas validará que todas as opções obrigatórias foram definidas

Lança
ConfigurationException

Métodos protegidos

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

Devoluções
IConfigurationFactory