Configuração global

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


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 quando for encerrado.

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.

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

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

abstract ICredentialFactory getCredentialFactory()

Recebe o ICredentialFactory para criar credenciais.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

Retorna o 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 o 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()

Recebe a lista de IMultiDeviceRecovery a ser usado 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()

Acessar 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 indefinido.

abstract ITerribleFailureHandler getWtfHandler()

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

abstract void injectOptionValue(String optionName, String optionValue)

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

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

Injetar 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 determinado, substituindo qualquer valor atual.

abstract void setConfigurationObjectList(String typeName, configList)

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

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( hostMonitors)

Defina a lista de 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 setOptionsFromCommandLineArgs( listArgs)

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

Consulte ArgsOptionParser para conferir 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 da negociação.

abstract void validateOptions()

Valide os valores de opção.

Métodos públicos

limpeza

public abstract void cleanup ()

Limpeza adequada quando for encerrado.

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ída 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.

Gera
IOException

cloneConfigWithFilter

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

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

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

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String: uma matriz String de configurações a serem incluídas no novo 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 abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtra a GlobalConfiguration com base em uma lista de permissões e saída 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 filtrados, e isso resultará em um arquivo de configuração com 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 ele 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 retorna nulo.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

Recebe o objeto de configuração personalizado com o nome informado.

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

Retorna
Object o objeto ou nulo se um 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 o 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 para teste

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 foi especificado.

getDeviceRequisitos

public abstract IDeviceSelection getDeviceRequirements ()

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

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 obtê-los 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 for especificado.

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 da implementação padrão LocalHostResourceManager se nenhum for especificado 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 armazenamento de chaves 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)

Recebe uma lista de valores da opção.

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

Retorna
uma lista dos valores da opção fornecida. null se o nome da opção não existem.

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 tiver sido especificada.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Acessar 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 indefinido.

Retorna
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Recebe o ITerribleFailureHandler a ser usado na configuração. Lida com o que fazer se um evento "WTF" (What a Terrible Failure) de segurança.

Retorna
ITerribleFailureHandler o ITerribleFailureHandler fornecido no ou nulo se nenhum gerenciador estiver definido

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Injetar 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)

Injetar 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 no 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 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 determinado, substituindo qualquer valor atual.

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 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 do nome determinado, substituindo qualquer .

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 da 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 gerente da 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.

setDeviceRequisitos

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Defina o IDeviceSelection, substituindo os valores atuais. Isso define um dispositivo global filtrar os dispositivos que o DeviceManager pode acessar.

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

Defina a lista de 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 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  setOptionsFromCommandLineArgs ( listArgs)

Definir os campos de configuração global Option com determinado conjunto 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 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 de WTF

Gera
ConfigurationException se um ITerribleFailureHandler tiver já foi definido.

Configuração

public abstract void setup ()

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

Gera
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

Valide os valores de opção.

No momento, isso serve apenas para confirmar que todas as opções obrigatórias foram definidas

Gera
ConfigurationException se faltarem campos obrigatórios na configuração