IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


Una clase que abarca información de configuración global para una sola instancia de la Federación de Comercio (que incluyan cualquier cantidad de invocaciones de configuraciones reales).

Resumen

Métodos públicos

abstract void cleanup()

Se realiza una limpieza adecuada al realizar un intercambio de cierre.

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

Filtra GlobalConfiguration en función de una lista blanca y genera un archivo en formato XML.

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

Filtrar GlobalConfiguration en función de una lista blanca y, al mismo tiempo, permitir la manipulación de los valores de opción y el resultado en un archivo en formato XML.

abstract File cloneConfigWithFilter(String... allowlistConfigs)

Filtra GlobalConfiguration según una lista permitida y da como resultado un archivo en formato XML.

abstract ICommandScheduler getCommandScheduler()

Obtiene el ICommandScheduler que se usará de la configuración.

abstract Object getConfigurationObject(String typeName)

Obtiene el objeto de configuración personalizado con un nombre determinado.

abstract ICredentialFactory getCredentialFactory()

Obtiene el ICredentialFactory para crear credenciales.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

Muestra el objeto DeviceManagementGrpcServer o el valor nulo si no está definido.

abstract IDeviceManager getDeviceManager()

Obtiene el IDeviceManager que se usará de la configuración.

abstract getDeviceMonitors()

Obtiene la lista de IDeviceMonitor de la configuración global.

abstract IDeviceSelection getDeviceRequirements()

Obtiene el IDeviceSelection que se usará de la configuración.

abstract TradefedFeatureServer getFeatureServer()

Muestra el objeto TradefedFeatureServer o el valor nulo si no está definido.

abstract IConfigurationServer getGlobalConfigServer()

Obtiene el servidor de configuración global.

abstract getHostMonitors()

Obtiene la lista de IHostMonitor de la configuración global.

abstract IHostOptions getHostOptions()

Obtiene el IHostOptions que se usará de la configuración.

abstract IHostResourceManager getHostResourceManager()

Obtiene el IHostResourceManager de la configuración global.

abstract IKeyStoreFactory getKeyStoreFactory()

Obtiene el IKeyStoreFactory que se usará de la configuración.

abstract getMultiDeviceRecoveryHandlers()

Obtiene la lista de IMultiDeviceRecovery para usar de la configuración.

abstract getOptionValues(String optionName)

Obtén una lista de los valores de la opción.

abstract getResourceMetricCollectors()

Obtiene la lista de IResourceMetricCollector de la configuración global.

abstract ISandboxFactory getSandboxFactory()

Obtener una fábrica de zona de pruebas que se pueda usar para ejecutar una invocación

abstract IShardHelper getShardingStrategy()

Muestra el IShardHelper que define la forma de fragmentar una configuración.

abstract TestInvocationManagementServer getTestInvocationManagementSever()

Muestra el objeto TestInvocationManagementServer o el valor nulo si no está definido.

abstract ITerribleFailureHandler getWtfHandler()

Obtiene el ITerribleFailureHandler que se usará de la configuración.

abstract void injectOptionValue(String optionName, String optionValue)

Incorpora un valor de opción en el conjunto de objetos de configuración.

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

Incorpora un valor de opción en el conjunto de objetos de configuración.

abstract void setCommandScheduler(ICommandScheduler scheduler)

Establece el ICommandScheduler y reemplaza los valores existentes.

abstract void setConfigurationFactory(IConfigurationFactory configFactory)

Establece el IConfigurationFactory para esta configuración.

abstract void setConfigurationObject(String name, Object configObject)

Es un método genérico para establecer el objeto de configuración con el nombre dado y reemplazar cualquier valor existente.

abstract void setConfigurationObjectList(String typeName, configList)

Método genérico para establecer la lista de objetos de configuración para el nombre dado y reemplazar cualquier objeto existente valor.

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

Establece el DeviceManagementGrpcServer.

abstract void setDeviceManager(IDeviceManager deviceManager)

Establece el IDeviceManager y reemplaza los valores existentes.

abstract void setDeviceMonitor(IDeviceMonitor deviceMonitor)

Establece el IDeviceMonitor.

abstract void setDeviceRequirements(IDeviceSelection deviceSelection)

Establece el IDeviceSelection y reemplaza los valores existentes.

abstract void setHostMonitors( hostMonitors)

Establece la lista IHostMonitor.

abstract void setHostOptions(IHostOptions hostOptions)

Establece el IHostOptions y reemplaza los valores existentes.

abstract void setHostResourceManager(IHostResourceManager hostResourceManager)

Establece el IHostResourceManager y reemplaza los valores existentes.

abstract void setInvocationServer(TestInvocationManagementServer server)

Establece el TestInvocationManagementServer.

abstract void setKeyStoreFactory(IKeyStoreFactory factory)

Establece el IKeyStoreFactory y reemplaza los valores existentes.

abstract setOptionsFromCommandLineArgs( listArgs)

Establece los campos de configuración global Option con un conjunto determinado de argumentos de línea de comandos.

Consultar ArgsOptionParser para ver el formato esperado

abstract void setOriginalConfig(String config)

Establece la configuración original que se usó para crear la configuración global.

abstract void setResourceMetricCollector(IResourceMetricCollector collector)

Establece el IResourceMetricCollector.

abstract void setSandboxFactory(ISandboxFactory factory)

Establece el ISandboxFactory y reemplaza los valores existentes.

abstract void setShardingStrategy(IShardHelper sharding)

Establece el IShardHelper que se usará cuando se fragmente una configuración.

abstract void setTradefedFeatureServer(TradefedFeatureServer server)

Establece el TradefedFeatureServer.

abstract void setWtfHandler(ITerribleFailureHandler wtfHandler)

Establece el ITerribleFailureHandler.

abstract void setup()

Configuración adecuada al comienzo del intercambio.

abstract void validateOptions()

Valida los valores de las opciones.

Métodos públicos

limpieza

public abstract void cleanup ()

Se realiza una limpieza adecuada al realizar un intercambio de cierre.

clonConfigWithFilter

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

Filtra GlobalConfiguration en función de una lista blanca y genera un archivo en formato XML.

Parámetros
exclusionPatterns : Es el patrón de nombre de clase que se excluirá del volcado.

allowlistConfigs String: Es un array de configuraciones String que se incluirá en el archivo en formato XML nuevo. Si se estableció en null, a default list should be used.

Muestra
File el archivo que contiene la nueva configuración global filtrada.

Arroja
IOException

clonConfigWithFilter

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

Filtrar GlobalConfiguration en función de una lista blanca y, al mismo tiempo, permitir la manipulación de los valores de opción y el resultado en un archivo en formato XML.

Parámetros
exclusionPatterns : Es el patrón de nombre de clase que se excluirá del volcado.

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String: Es un array de configuraciones String que se incluirá en el nuevo XML. . Si se estableció en null, a default list should be used.

Muestra
File el archivo que contiene la nueva configuración global filtrada.

clonConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtra GlobalConfiguration según una lista permitida y da como resultado un archivo en formato XML.

Por ejemplo, para la siguiente configuración: <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>

toda la configuración, excepto “key_store” se filtrará y generará un archivo de configuración con siguiente contenido: <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

Parámetros
allowlistConfigs String: Es un array de configuraciones String que se incluirá en el archivo en formato XML nuevo. Si se estableció en null, a default list should be used.

Muestra
File el archivo que contiene la nueva configuración global filtrada.

Arroja
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

Obtiene el ICommandScheduler que se usará de la configuración.

Muestra
ICommandScheduler ICommandScheduler Nunca devolverá un valor nulo.

getConfigurationObject.

public abstract Object getConfigurationObject (String typeName)

Obtiene el objeto de configuración personalizado con un nombre determinado.

Parámetros
typeName String: Es el tipo único del objeto de configuración.

Muestra
Object el objeto o nulo si no se encuentra un objeto con ese nombre

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

Obtiene el ICredentialFactory para crear credenciales.

Muestra
ICredentialFactory ICredentialFactory o null si no se especificó ninguno.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Muestra el objeto DeviceManagementGrpcServer o el valor nulo si no está definido.

Muestra
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

Obtiene el IDeviceManager que se usará de la configuración. Administra el conjunto de recursos dispositivos para realizar pruebas

Muestra
IDeviceManager el IDeviceManager proporcionado en la configuración.

getDeviceMonitors

public abstract  getDeviceMonitors ()

Obtiene la lista de IDeviceMonitor de la configuración global.

Muestra
la lista de IDeviceMonitor de la configuración global, o null si no se especificó ninguno.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

Obtiene el IDeviceSelection que se usará de la configuración. Representa un filtro global en qué dispositivos puede ver DeviceManager.

Muestra
IDeviceSelection el IDeviceSelection proporcionado en la configuración.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

Muestra el objeto TradefedFeatureServer o el valor nulo si no está definido.

Muestra
TradefedFeatureServer

getGlobalConfigServer.

public abstract IConfigurationServer getGlobalConfigServer ()

Obtiene el servidor de configuración global. El servidor de configuración global se usa para obtener los parámetros de configuración de host de un servidor en lugar de obtenerlos de archivos locales.

Muestra
IConfigurationServer

getHostMonitor

public abstract  getHostMonitors ()

Obtiene la lista de IHostMonitor de la configuración global.

Muestra
la lista de IHostMonitor de la configuración global o null si no hay ninguno se especificó.

getHostOptions

public abstract IHostOptions getHostOptions ()

Obtiene el IHostOptions que se usará de la configuración.

Muestra
IHostOptions el IDeviceManager proporcionado en la configuración.

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

Obtiene el IHostResourceManager de la configuración global.

Muestra
IHostResourceManager el IHostResourceManager de la configuración global o la implementación Es LocalHostResourceManager si no se especifica ninguno en la configuración del host.

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

Obtiene el IKeyStoreFactory que se usará de la configuración.

Muestra
IKeyStoreFactory IKeyStoreFactory o un valor nulo si no se establece una fábrica de almacén de claves

getMultiDeviceRecoveryHandlers.

public abstract  getMultiDeviceRecoveryHandlers ()

Obtiene la lista de IMultiDeviceRecovery para usar de la configuración.

Muestra
la lista de IMultiDeviceRecovery, o null si no está configurada.

Valores de la opción getOption

public abstract  getOptionValues (String optionName)

Obtén una lista de los valores de la opción.

Parámetros
optionName String: Es el nombre de la opción del mapa.

Muestra
una lista de los valores de la opción determinada. null si el nombre de la opción no existen.

getResourceMetricCollectors.

public abstract  getResourceMetricCollectors ()

Obtiene la lista de IResourceMetricCollector de la configuración global.

Muestra
la lista de IResourceMetricCollector de la configuración global o null si no se especificó ninguno.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Obtener una fábrica de zona de pruebas que se pueda usar para ejecutar una invocación

Muestra
ISandboxFactory

getShardingStrategy.

public abstract IShardHelper getShardingStrategy ()

Muestra el IShardHelper que define la forma de fragmentar una configuración.

Muestra
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Muestra el objeto TestInvocationManagementServer o el valor nulo si no está definido.

Muestra
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Obtiene el ITerribleFailureHandler que se usará de la configuración. Controla qué hacer en caso de que se produzca un WTF (What a Terrible Failure). de que ocurra.

Muestra
ITerribleFailureHandler el ITerribleFailureHandler proporcionado en la o nulo si no se establece ningún controlador

Valor de opción de inyección

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Incorpora un valor de opción en el conjunto de objetos de configuración.

Es útil para proporcionar valores para las opciones que se generan de forma dinámica.

Parámetros
optionName String: Es el nombre de la opción.

optionValue String: Son los valores de la opción.

Arroja
ConfigurationException si no se puede establecer el valor de la opción

Valor de opción de inyección

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

Incorpora un valor de opción en el conjunto de objetos de configuración.

Es útil para proporcionar valores para las opciones que se generan de forma dinámica.

Parámetros
optionName String: Es el nombre de la opción del mapa.

optionKey String: Es la clave de opción del mapa.

optionValue String: Es el valor de la opción del mapa.

Arroja
ConfigurationException si no se puede establecer el valor de la opción

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Establece el ICommandScheduler y reemplaza los valores existentes.

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Establece el IConfigurationFactory para esta configuración.

Parámetros
configFactory IConfigurationFactory

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                Object configObject)

Es un método genérico para establecer el objeto de configuración con el nombre dado y reemplazar cualquier valor existente.

Parámetros
name String: Es el nombre único del tipo de objeto de configuración.

configObject Object: Es el objeto de configuración.

Arroja
ConfigurationException si el configObject no era del tipo correcto

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

Método genérico para establecer la lista de objetos de configuración para el nombre dado y reemplazar cualquier objeto existente valor.

Parámetros
typeName String: Es el nombre único del tipo de objeto de configuración.

configList : Es la lista de objetos de configuración.

Arroja
ConfigurationException si algún objeto de la lista no es del tipo correcto

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Establece el DeviceManagementGrpcServer.

Parámetros
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Establece el IDeviceManager y reemplaza los valores existentes. Esto establece el administrador dispositivos de prueba

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Establece el IDeviceMonitor.

Parámetros
deviceMonitor IDeviceMonitor: El monitor

Arroja
ConfigurationException si ya se estableció un IDeviceMonitor.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Establece el IDeviceSelection y reemplaza los valores existentes. De esta forma, se establece un dispositivo global filtrar según los dispositivos que DeviceManager puede ver.

setHostMonitor

public abstract void setHostMonitors ( hostMonitors)

Establece la lista IHostMonitor.

Parámetros
hostMonitors : La lista de supervisores

Arroja
ConfigurationException si ya se estableció un IHostMonitor.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Establece el IHostOptions y reemplaza los valores existentes.

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Establece el IHostResourceManager y reemplaza los valores existentes.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Establece el TestInvocationManagementServer.

Parámetros
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Establece el IKeyStoreFactory y reemplaza los valores existentes.

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

Establece los campos de configuración global Option con un conjunto determinado de argumentos de línea de comandos.

Consultar ArgsOptionParser para ver el formato esperado

Parámetros
listArgs : Son los argumentos de la línea de comandos.

Muestra
los argumentos no consumidos

Arroja
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

Establece la configuración original que se usó para crear la configuración global.

Parámetros
config String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

Establece el IResourceMetricCollector.

Parámetros
collector IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

Establece el ISandboxFactory y reemplaza los valores existentes.

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

Establece el IShardHelper que se usará cuando se fragmente una configuración.

Parámetros
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Establece el TradefedFeatureServer.

Parámetros
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Establece el ITerribleFailureHandler.

Parámetros
wtfHandler ITerribleFailureHandler: Es el controlador de WTF.

Arroja
ConfigurationException si un elemento ITerribleFailureHandler tiene ya se estableció.

configuración

public abstract void setup ()

Configuración adecuada al comienzo del intercambio.

Arroja
com.android.tradefed.config.ConfigurationException
ConfigurationException

ValidarOpciones

public abstract void validateOptions ()

Valida los valores de las opciones.

Actualmente, esto validará que se hayan configurado todas las opciones obligatorias.

Arroja
ConfigurationException si faltan campos obligatorios en la configuración