IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

Clase que abarca la información de configuración global para 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(String... allowlistConfigs)

Filtra GlobalConfiguration según una lista de elementos permitidos y genera un archivo XML.

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

Filtra GlobalConfiguration según una lista de entidades permitidas y genera un archivo XML.

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

Filtra la GlobalConfiguration según una lista de entidades permitidas y permite la manipulación de los valores de las opciones y la salida a un archivo XML.

abstract ICommandScheduler getCommandScheduler()

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

abstract Object getConfigurationObject(String typeName)

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

abstract ICredentialFactory getCredentialFactory()

Obtiene el ICredentialFactory para crear credenciales.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

Devuelve DeviceManagementGrpcServer o null si no está definido.

abstract IDeviceManager getDeviceManager()

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

abstract List<IDeviceMonitor> getDeviceMonitors()

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

abstract IDeviceSelection getDeviceRequirements()

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

abstract TradefedFeatureServer getFeatureServer()

Devuelve TradefedFeatureServer o null si no está definido.

abstract IConfigurationServer getGlobalConfigServer()

Obtiene el servidor de configuración global.

abstract List<IHostMonitor> getHostMonitors()

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

abstract IHostOptions getHostOptions()

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

abstract IHostResourceManager getHostResourceManager()

Obtiene el IHostResourceManager de la configuración global.

abstract IKeyStoreFactory getKeyStoreFactory()

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

abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers()

Obtiene la lista de IMultiDeviceRecovery que se usarán de la configuración.

abstract List<String> getOptionValues(String optionName)

Obtiene una lista de los valores de la opción.

abstract List<IResourceMetricCollector> 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()

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

abstract TestInvocationManagementServer getTestInvocationManagementSever()

Devuelve TestInvocationManagementServer o null si no está definido.

abstract ITerribleFailureHandler getWtfHandler()

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

abstract void injectOptionValue(String optionName, String optionValue)

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

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

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

Método genérico para establecer el objeto de configuración con el nombre determinado, reemplazando cualquier valor existente.

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

Método genérico para establecer la lista de objetos de configuración para el nombre determinado, reemplazando 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 IDeviceSelection y reemplaza los valores existentes.

abstract void setHostMonitors(List<IHostMonitor> hostMonitors)

Establece la lista IHostMonitor.

abstract void setHostOptions(IHostOptions hostOptions)

Establece IHostOptions y reemplaza los valores existentes.

abstract void setHostResourceManager(IHostResourceManager hostResourceManager)

Establece 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 List<String> setOptionsFromCommandLineArgs(List<String> listArgs)

Establece los campos de configuración global Option con el conjunto de argumentos de la línea de comandos proporcionado

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 particione 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 inicio de tradefed.

abstract void validateOptions()

Valida los valores de las opciones.

Métodos públicos

cleanup

public abstract void cleanup ()

Se realiza una limpieza adecuada cuando se cierra tradefed.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtra GlobalConfiguration según una lista de elementos permitidos y genera un archivo 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 parámetros de configuración que se incluirán en el nuevo archivo en formato XML. Si está configurado como null, a default list should be used.
Muestra
File Es el archivo que contiene la nueva configuración global filtrada.
Arroja
java.io.IOException
IOException

cloneConfigWithFilter

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

Filtra GlobalConfiguration según una lista de entidades permitidas y genera un archivo XML.

Parámetros
exclusionPatterns Set: Es el patrón del nombre de la clase que se excluirá del volcado.
allowlistConfigs String: Es un array String de parámetros de configuración que se incluirán en el nuevo archivo en formato XML. Si está configurado como null, a default list should be used.
Muestra
File Es el archivo que contiene la nueva configuración global filtrada.
Arroja
java.io.IOException
IOException

cloneConfigWithFilter

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

Filtra la GlobalConfiguration según una lista de entidades permitidas y permite la manipulación de los valores de las opciones y la salida a un archivo XML.

Parámetros
exclusionPatterns Set: Es el patrón del nombre de la 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 XML. Si está configurado como null, a default list should be used.
Muestra
File Es el archivo que contiene la nueva configuración global filtrada.
Arroja
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

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

Muestra
ICommandScheduler el ICommandScheduler. Nunca devolverá un valor nulo.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

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

Parámetros
typeName String: Es el tipo único del objeto de configuración.
Muestra
Object El objeto o el valor 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 ()

Devuelve DeviceManagementGrpcServer o null si no está definido.

Muestra
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

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

Muestra
IDeviceManager el IDeviceManager proporcionado en la configuración.

getDeviceMonitors

public abstract List<IDeviceMonitor> getDeviceMonitors ()

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

Muestra
List<IDeviceMonitor> 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á desde la configuración. Representa un filtro global sobre los dispositivos que puede ver DeviceManager.

Muestra
IDeviceSelection el IDeviceSelection proporcionado en la configuración.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

Devuelve TradefedFeatureServer o null 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 configuraciones de host desde un servidor en lugar de obtenerlas desde archivos locales.

Muestra
IConfigurationServer

getHostMonitors

public abstract List<IHostMonitor> getHostMonitors ()

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

Muestra
List<IHostMonitor> La lista de IHostMonitor de la configuración global o null si no se especificó ninguno.

getHostOptions

public abstract IHostOptions getHostOptions ()

Obtiene el IHostOptions que se usará desde 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á desde la configuración.

Muestra
IKeyStoreFactory IKeyStoreFactory o null si no se configuró ninguna fábrica de almacén de claves.

getMultiDeviceRecoveryHandlers

public abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers ()

Obtiene la lista de IMultiDeviceRecovery que se usarán de la configuración.

Muestra
List<IMultiDeviceRecovery> La lista de IMultiDeviceRecovery o null si no se configuró.

getOptionValues

public abstract List<String> getOptionValues (String optionName)

Obtiene una lista de los valores de la opción.

Parámetros
optionName String: Es el nombre de la opción del mapa.
Muestra
List<String> Es una lista de los valores de la opción determinada. null si el nombre de la opción no existe.

getResourceMetricCollectors

public abstract List<IResourceMetricCollector> getResourceMetricCollectors ()

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

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

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

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

Muestra
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Devuelve TestInvocationManagementServer o null si no está definido.

Muestra
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Obtiene el ITerribleFailureHandler que se usará desde la configuración. Controla qué hacer en caso de que ocurra un 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)

Inserta 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 la opción
Arroja
ConfigurationException Si no se pudo establecer el valor de la opción

injectOptionValue

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

Inserta 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 la opción del mapa
optionValue String: 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)

Método genérico para establecer el objeto de configuración con el nombre determinado, reemplazando 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 objeto de configuración no era del tipo correcto

setConfigurationObjectList

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

Método genérico para establecer la lista de objetos de configuración para el nombre determinado, reemplazando cualquier valor existente.

Parámetros
typeName String: Es el nombre único del tipo de objeto de configuración.
configList List: 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 IDeviceManager y reemplaza los valores existentes. Establece el administrador para 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. Establece un filtro global de dispositivos en los que el DeviceManager puede ver.

setHostMonitors

public abstract void setHostMonitors (List<IHostMonitor> hostMonitors)

Establece la lista IHostMonitor.

Parámetros
hostMonitors List: 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 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 List<String> setOptionsFromCommandLineArgs (List<String> listArgs)

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

Consulta ArgsOptionParser para conocer el formato esperado.

Parámetros
listArgs List: Los argumentos de la línea de comandos
Muestra
List<String> 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 particione 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.

configurar

public abstract void setup ()

Configuración adecuada al inicio de tradefed.

Arroja
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

Valida los valores de las opciones.

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

Arroja
ConfigurationException Si a la configuración le faltan campos obligatorios