IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

Es una clase que abarca la información de configuración global de una sola instancia de Trade Federation (que abarca cualquier cantidad de invocaciones de configuraciones reales).

Resumen

Métodos públicos

abstract void cleanup()

Se realiza una limpieza adecuada cuando se cierra tradefed.

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

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

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

Filtra GlobalConfiguration en función de una lista blanca y, al mismo tiempo, permite manipular los valores de opción y los resultados a 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 personalizada con el nombre determinado.

abstract ICredentialFactory getCredentialFactory()

Obtiene el ICredentialFactory para crear credenciales.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

Muestra DeviceManagementGrpcServer o un 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 TradefedFeatureServer o un 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 que se usará desde 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()

Obtén 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 dividir una configuración.

abstract TestInvocationManagementServer getTestInvocationManagementSever()

Muestra TestInvocationManagementServer o un 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)

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

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

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

abstract void setCommandScheduler(ICommandScheduler scheduler)

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

Es un método genérico para establecer la lista de objetos de configuración para el nombre determinado y reemplazar cualquier valor existente.

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

Establece el DeviceManagementGrpcServer.

abstract void setDeviceManager(IDeviceManager deviceManager)

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

Consulta ArgsOptionParser para conocer 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 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 del 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 está configurado en null, a default list should be used.
Muestra
File el archivo que contiene la nueva configuración global filtrada.
Arroja
IOException

cloneConfigWithFilter

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

Filtra GlobalConfiguration en función de una lista de entidades permitidas y, al mismo tiempo, permite la manipulación de los valores de las opciones y la salida a un archivo en formato XML.

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

deepCopy boolean

allowlistConfigs String: Es un array String de configuraciones que se incluirán en el nuevo archivo en formato XML. Si está configurado 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>

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

Parámetros
allowlistConfigs String: Es un array String de configuraciones que se incluirán en el nuevo archivo en formato XML. Si está configurado 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 el ICommandScheduler. Nunca mostrará 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 el 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 DeviceManagementGrpcServer o un 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 dispositivos disponibles 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ó ninguna.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

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

Muestra
IDeviceSelection el IDeviceSelection proporcionado en la configuración.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

Muestra TradefedFeatureServer o un 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 del host de un servidor, en lugar de obtenerlos de los archivos locales.

Muestra
IConfigurationServer

getHostMonitors

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 se especificó ninguna.

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 predeterminada 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 el IKeyStoreFactory o nulo si no se configuró ninguna fábrica de almacenes de claves

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

Obtiene la lista de IMultiDeviceRecovery que se usará desde 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 de mapa.
Muestra
una lista de los valores de la opción determinada. null si el nombre de la opción no existe.

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ó ninguna.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Obtén 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 dividir una configuración.

Muestra
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Muestra TestInvocationManagementServer o un 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 error WTF (What a Terrible Failure).

Muestra
ITerribleFailureHandler el ITerribleFailureHandler proporcionado en la configuración, o nulo si no se configuró ningún controlador

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Inyecta 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: Los valores de las opciones
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)

Inyecta 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: La clave de opción de mapa
optionValue String: Es el valor de la opción del mapa.
Arroja
ConfigurationException si no se pudo establecer el valor de la opción

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Establece 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: El objeto de configuración
Arroja
ConfigurationException si el configObject no era del tipo correcto

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

Es un método genérico para establecer la lista de objetos de configuración del nombre determinado y reemplaza cualquier valor existente.

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 alguno de los objetos 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 IDeviceManager y reemplaza los valores existentes. Esto configura el administrador de los dispositivos de prueba.

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Establece el IDeviceMonitor.

Parámetros
deviceMonitor IDeviceMonitor: El monitor
Arroja
ConfigurationException si ya se configuró un IDeviceMonitor.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Establece IDeviceSelection y reemplaza los valores existentes. Esto establece un filtro de dispositivos global en los que DeviceManager puede ver los dispositivos.

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

Establece la lista IHostMonitor.

Parámetros
hostMonitors : Es la lista de monitores.
Arroja
ConfigurationException si ya se configuró un IHostMonitor.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Establece 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 IKeyStoreFactory y reemplaza los valores existentes.

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

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

Consulta ArgsOptionParser para conocer el formato esperado

Parámetros
listArgs : 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 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: el controlador de WTF
Arroja
ConfigurationException si ya se configuró un ITerribleFailureHandler.

configuración

public abstract void setup ()

Configuración adecuada al comienzo de tradefed.

Arroja
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

Valida los valores de las opciones.

Actualmente, solo se validará que se hayan establecido todas las opciones obligatorias.

Arroja
ConfigurationException si faltan campos obligatorios en la configuración