Configuração IGlobal

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


Uma classe para abranger informações de configuração global para uma única instância da Federação de Comércio (abrangendo qualquer número de invocações de configurações reais).

Resumo

Métodos públicos

abstract void cleanup ()

Limpeza adequada quando o desligamento do tradefed.

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

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

abstract File cloneConfigWithFilter (String... allowlistConfigs)

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

abstract ICommandScheduler getCommandScheduler ()

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

abstract Object getConfigurationObject (String typeName)

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

abstract ICredentialFactory getCredentialFactory ()

Obtém o ICredentialFactory para criar credenciais.

abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Retorna DeviceManagementGrpcServer ou null se indefinido.

abstract IDeviceManager getDeviceManager ()

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

abstract getDeviceMonitors ()

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

abstract IDeviceSelection getDeviceRequirements ()

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

abstract TradefedFeatureServer getFeatureServer ()

Retorna TradefedFeatureServer ou null se indefinido.

abstract IConfigurationServer getGlobalConfigServer ()

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

abstract getHostMonitors ()

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

abstract IHostOptions getHostOptions ()

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

abstract IHostResourceManager getHostResourceManager ()

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

abstract IKeyStoreFactory getKeyStoreFactory ()

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

abstract getMultiDeviceRecoveryHandlers ()

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

abstract getOptionValues (String optionName)

Obtenha uma lista de valores de opções.

abstract getResourceMetricCollectors ()

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

abstract ISandboxFactory getSandboxFactory ()

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

abstract IShardHelper getShardingStrategy ()

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

abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Retorna TestInvocationManagementServer ou null se indefinido.

abstract ITerribleFailureHandler getWtfHandler ()

Obtém 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 o ICommandScheduler , substituindo quaisquer valores existentes.

abstract void setConfigurationFactory ( IConfigurationFactory configFactory)

Defina o IConfigurationFactory para esta configuração.

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.

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

abstract void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Define o DeviceManagementGrpcServer .

abstract void setDeviceManager ( IDeviceManager deviceManager)

Defina o IDeviceManager , substituindo quaisquer valores existentes.

abstract void setDeviceMonitor ( IDeviceMonitor deviceMonitor)

Defina o IDeviceMonitor .

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

Defina o IDeviceSelection , substituindo quaisquer valores existentes.

abstract void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

Defina a lista IHostMonitor .

abstract void setHostOptions ( IHostOptions hostOptions)

Defina IHostOptions , substituindo quaisquer valores existentes.

abstract void setHostResourceManager ( IHostResourceManager hostResourceManager)

Defina o IHostResourceManager , substituindo quaisquer valores existentes.

abstract void setInvocationServer ( TestInvocationManagementServer server)

Define o TestInvocationManagementServer .

abstract void setKeyStoreFactory ( IKeyStoreFactory factory)

Defina IKeyStoreFactory , substituindo quaisquer valores existentes.

abstract 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

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

abstract void setShardingStrategy ( IShardHelper sharding)

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

abstract void validateOptions ()

Valide os valores das opções.

Métodos públicos

limpar

public abstract void cleanup ()

Limpeza adequada quando o desligamento do tradefed.

cloneConfigWithFilter

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

Lança
IOException

cloneConfigWithFilter

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

Lança
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

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

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

getConfigurationObject

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

Obtém o ICredentialFactory para criar credenciais.

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

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Retorna DeviceManagementGrpcServer ou null se indefinido.

Devoluções
DeviceManagementGrpcServer

getDeviceManager

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

getDeviceMonitores

public abstract  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 abstract 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 abstract TradefedFeatureServer getFeatureServer ()

Retorna TradefedFeatureServer ou null se indefinido.

Devoluções
TradefedFeatureServer

getGlobalConfigServer

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

getHostMonitores

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

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

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

getHostResourceManager

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

getKeyStoreFactory

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

getOptionValues

public abstract  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 abstract  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 abstract ISandboxFactory getSandboxFactory ()

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

Devoluções
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

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

Devoluções
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Retorna TestInvocationManagementServer ou null se indefinido.

Devoluções
TestInvocationManagementServer

getWtfHandler

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

Lança
ConfigurationException se não foi possível definir o valor da opção

injetarOptionValue

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

Lança
ConfigurationException se não foi possível definir o valor da opção

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Defina o ICommandScheduler , substituindo quaisquer valores existentes.

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

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

Lança
ConfigurationException se o configObject não fosse 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 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 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 o IDeviceManager , substituindo quaisquer valores existentes. Isso define o gerenciador para os dispositivos de teste

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Defina o IDeviceMonitor .

Parâmetros
deviceMonitor IDeviceMonitor : O monitor

Lança
ConfigurationException se um IDeviceMonitor já tiver sido definido.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Defina o IDeviceSelection , substituindo quaisquer valores existentes. Isso define um filtro global de dispositivos nos quais o DeviceManager pode ver.

setHostMonitores

public abstract void setHostMonitors ( hostMonitors)

Defina a lista IHostMonitor .

Parâmetros
hostMonitors : A lista de monitores

Lança
ConfigurationException se um IHostMonitor já tiver sido definido.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Defina IHostOptions , substituindo quaisquer valores existentes.

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Defina o IHostResourceManager , substituindo quaisquer valores existentes.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Define o TestInvocationManagementServer .

Parâmetros
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Defina IKeyStoreFactory , substituindo quaisquer valores existentes.

setOptionsFromCommandLineArgs

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

definirSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

Defina ISandboxFactory , substituindo quaisquer valores existentes.

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 WTF

Lança
ConfigurationException se um ITerribleFailureHandler já tiver sido definido.

configurar

public abstract void setup ()

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

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

validarOpções

public abstract void validateOptions ()

Valide os valores das opções.

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

Lança
ConfigurationException se a configuração estiver faltando campos obrigatórios