IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


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

Resumo

Métodos públicos

abstract void cleanup()

Limpeza adequada quando o tradefed é encerrado.

abstract File cloneConfigWithFilter(String... allowlistConfigs)

Filtre o GlobalConfiguration com base em uma lista permitida e gere um arquivo XML.

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

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

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

Filtra o GlobalConfiguration com base em uma lista de permissões, permitindo a manipulação de valores de opção e a 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 especificado.

abstract ICredentialFactory getCredentialFactory()

Recebe o ICredentialFactory para criar credenciais.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

Retorna o DeviceManagementGrpcServer ou nulo se não estiver definido.

abstract IDeviceManager getDeviceManager()

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

abstract List<IDeviceMonitor> 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 o TradefedFeatureServer ou nulo se não estiver definido.

abstract IConfigurationServer getGlobalConfigServer()

Recebe o servidor de configuração global.

abstract List<IHostMonitor> 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 List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers()

Recebe a lista de IMultiDeviceRecovery a serem usadas na configuração.

abstract List<String> getOptionValues(String optionName)

Recebe uma lista de valores de opção.

abstract List<IResourceMetricCollector> 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 maneira de fragmentar uma configuração.

abstract TestInvocationManagementServer getTestInvocationManagementSever()

Retorna o TestInvocationManagementServer ou nulo se não estiver definido.

abstract ITerribleFailureHandler getWtfHandler()

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

abstract void injectOptionValue(String optionName, String optionValue)

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

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

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

abstract void setCommandScheduler(ICommandScheduler scheduler)

Defina o ICommandScheduler, substituindo 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 especificado, substituindo qualquer valor existente.

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

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

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

Define o DeviceManagementGrpcServer.

abstract void setDeviceManager(IDeviceManager deviceManager)

Defina o IDeviceManager, substituindo os valores atuais.

abstract void setDeviceMonitor(IDeviceMonitor deviceMonitor)

Defina o IDeviceMonitor.

abstract void setDeviceRequirements(IDeviceSelection deviceSelection)

Defina o IDeviceSelection, substituindo os valores atuais.

abstract void setHostMonitors(List<IHostMonitor> hostMonitors)

Defina a lista IHostMonitor.

abstract void setHostOptions(IHostOptions hostOptions)

Defina o IHostOptions, substituindo 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 o IKeyStoreFactory, substituindo os valores atuais.

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

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

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 o ISandboxFactory, substituindo os valores atuais.

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

cleanup

public abstract void cleanup ()

Limpeza adequada quando o tradefed é encerrado.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtre o GlobalConfiguration com base em uma lista permitida 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, resultando 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.

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

Gera
java.io.IOException
IOException

cloneConfigWithFilter

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

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

Parâmetros
exclusionPatterns Set: o padrão de nome de classe a ser excluído do despejo.

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.

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

Gera
java.io.IOException
IOException

cloneConfigWithFilter

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

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

Parâmetros
exclusionPatterns Set: o padrão de nome de 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 estiver 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 vai retornar nulo.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

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

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 nenhum for especificado.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Retorna o DeviceManagementGrpcServer ou nulo se não estiver definido.

Retorna
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

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

Retorna
IDeviceManager o IDeviceManager fornecido na configuração.

getDeviceMonitors

public abstract List<IDeviceMonitor> getDeviceMonitors ()

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

Retorna
List<IDeviceMonitor> a lista de IDeviceMonitor da configuração global ou null se nenhuma foi especificada.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

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

Retorna
IDeviceSelection o IDeviceSelection fornecido na configuração.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

Retorna o TradefedFeatureServer ou nulo se não estiver definido.

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 List<IHostMonitor> getHostMonitors ()

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

Retorna
List<IHostMonitor> 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 o IKeyStoreFactory ou nulo se nenhuma fábrica de keystore estiver definida.

getMultiDeviceRecoveryHandlers

public abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers ()

Recebe a lista de IMultiDeviceRecovery a serem usadas na configuração.

Retorna
List<IMultiDeviceRecovery> a lista de IMultiDeviceRecovery ou null se não estiver definida.

getOptionValues

public abstract List<String> getOptionValues (String optionName)

Recebe uma lista de valores de opção.

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

Retorna
List<String> uma lista dos valores da opção especificada. null se o nome da opção não existir.

getResourceMetricCollectors

public abstract List<IResourceMetricCollector> getResourceMetricCollectors ()

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

Retorna
List<IResourceMetricCollector> 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 o TestInvocationManagementServer ou nulo se não estiver definido.

Retorna
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Recebe o ITerribleFailureHandler a ser usado na configuração. Processa o que fazer caso ocorra um 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)

Injeta 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 das opções.

Gera
ConfigurationException se não for possível definir o valor da opção

injectOptionValue

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

Injeta 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 de mapa

optionKey String: a chave da opção de mapa

optionValue String: o valor da opção de mapa

Gera
ConfigurationException se não for possível definir o valor da opção

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Defina o ICommandScheduler, substituindo 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 especificado, 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, 
                List<?> configList)

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

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

configList List: 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 o IDeviceManager, substituindo os valores atuais. 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

Gera
ConfigurationException se um IDeviceMonitor já tiver sido definido.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Defina o IDeviceSelection, substituindo os valores atuais. Isso define um filtro global de dispositivos para determinar quais dispositivos o DeviceManager pode ver.

setHostMonitors

public abstract void setHostMonitors (List<IHostMonitor> hostMonitors)

Defina a lista IHostMonitor.

Parâmetros
hostMonitors List: a lista de monitores

Gera
ConfigurationException se um IHostMonitor já tiver sido definido.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Defina o IHostOptions, substituindo 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 o IKeyStoreFactory, substituindo os valores atuais.

setOptionsFromCommandLineArgs

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

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

Consulte ArgsOptionParser para saber o formato esperado.

Parâmetros
listArgs List: os argumentos da linha de comando

Retorna
List<String> 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 o ISandboxFactory, substituindo 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 gerenciador WTF

Gera
ConfigurationException se um ITerribleFailureHandler já tiver sido definido.

configuração

public abstract void setup ()

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

Gera
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

Valide os valores das opções.

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

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