Configuración IGlobal

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


Una clase que abarca información de configuración global para una única instancia de Trade Federation (que abarca cualquier número de invocaciones de configuraciones reales).

Resumen

Métodos públicos

abstract void cleanup ()

Limpieza adecuada cuando se apaga el comercio.

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

Filtre la configuración global según una lista blanca y envíela a un archivo XML.

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

Filtre la configuración global según una lista blanca y al mismo tiempo permita la manipulación de los valores de las opciones y la salida a un archivo XML.

abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtre la configuración global según una lista permitida y envíela a un archivo XML.

abstract ICommandScheduler getCommandScheduler ()

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

abstract Object getConfigurationObject (String typeName)

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

abstract ICredentialFactory getCredentialFactory ()

Obtiene ICredentialFactory para crear credenciales.

abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Devuelve DeviceManagementGrpcServer o nulo si no está definido.

abstract IDeviceManager getDeviceManager ()

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

abstract getDeviceMonitors ()

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

abstract IDeviceSelection getDeviceRequirements ()

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

abstract TradefedFeatureServer getFeatureServer ()

Devuelve TradefedFeatureServer o 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 las IHostOptions que se utilizarán desde la configuración.

abstract IHostResourceManager getHostResourceManager ()

Obtiene IHostResourceManager de la configuración global.

abstract IKeyStoreFactory getKeyStoreFactory ()

Obtiene IKeyStoreFactory para usar desde la configuración.

abstract getMultiDeviceRecoveryHandlers ()

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

abstract getOptionValues (String optionName)

Obtenga una lista de los valores de las opciones.

abstract getResourceMetricCollectors ()

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

abstract ISandboxFactory getSandboxFactory ()

Obtenga una fábrica de espacio aislado que pueda usarse para ejecutar una invocación

abstract IShardHelper getShardingStrategy ()

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

abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Devuelve TestInvocationManagementServer o nulo si no está definido.

abstract ITerribleFailureHandler getWtfHandler ()

Obtiene el ITerribleFailureHandler para usar desde la configuración.

abstract void injectOptionValue (String optionName, String optionValue)

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

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

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

abstract void setCommandScheduler ( ICommandScheduler scheduler)

Configure ICommandScheduler y reemplace los valores existentes.

abstract void setConfigurationFactory ( IConfigurationFactory configFactory)

Establezca IConfigurationFactory para esta configuración.

abstract void setConfigurationObject (String name, Object configObject)

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

abstract void setConfigurationObjectList (String typeName, configList) setConfigurationObjectList (String typeName, configList)

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

abstract void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Establece DeviceManagementGrpcServer .

abstract void setDeviceManager ( IDeviceManager deviceManager)

Configure IDeviceManager y reemplace los valores existentes.

abstract void setDeviceMonitor ( IDeviceMonitor deviceMonitor)

Configure el IDeviceMonitor .

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

Establezca IDeviceSelection y reemplace los valores existentes.

abstract void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

Configure la lista IHostMonitor .

abstract void setHostOptions ( IHostOptions hostOptions)

Configure IHostOptions y reemplace los valores existentes.

abstract void setHostResourceManager ( IHostResourceManager hostResourceManager)

Configure IHostResourceManager y reemplace los valores existentes.

abstract void setInvocationServer ( TestInvocationManagementServer server)

Establece TestInvocationManagementServer .

abstract void setKeyStoreFactory ( IKeyStoreFactory factory)

Configure IKeyStoreFactory y reemplace los valores existentes.

abstract setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

Establezca los campos Option de configuración global con un conjunto dado de argumentos de línea de comando

Consulte ArgsOptionParser para conocer el formato esperado.

abstract void setOriginalConfig (String config)

Establece la configuración original utilizada para crear la configuración global.

abstract void setResourceMetricCollector ( IResourceMetricCollector collector)

Establece IResourceMetricCollector .

abstract void setSandboxFactory ( ISandboxFactory factory)

Establezca ISandboxFactory y reemplace los valores existentes.

abstract void setShardingStrategy ( IShardHelper sharding)

Establece IShardHelper que se utilizará al fragmentar una configuración.

abstract void setTradefedFeatureServer ( TradefedFeatureServer server)

Establece TradefedFeatureServer .

abstract void setWtfHandler ( ITerribleFailureHandler wtfHandler)

Configure ITerribleFailureHandler .

abstract void setup ()

Configuración adecuada al inicio de tradefed.

abstract void validateOptions ()

Validar los valores de las opciones.

Métodos públicos

limpiar

public abstract void cleanup ()

Limpieza adecuada cuando se apaga el comercio.

cloneConfigWithFilter

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

Filtre la configuración global según una lista blanca y envíela a un archivo XML.

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

allowlistConfigs String : una matriz String de configuraciones que se incluirán en el nuevo archivo XML. Si se establece en null , a default list should be used.
Devoluciones
File el archivo que contiene la nueva configuración global filtrada.

Lanza
IOExcepción

cloneConfigWithFilter

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

Filtre la configuración global según una lista blanca y al mismo tiempo permita la manipulación de los valores de las opciones y la salida a un archivo XML.

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

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String : una matriz String de configuraciones que se incluirán en el nuevo archivo XML. Si se establece en null , a default list should be used.
Devoluciones
File el archivo que contiene la nueva configuración global filtrada.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtre la configuración global según una lista permitida y envíela a 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>

todas las configuraciones excepto "key_store" se filtrarán y el resultado será 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 : una matriz String de configuraciones que se incluirán en el nuevo archivo XML. Si se establece en null , a default list should be used.
Devoluciones
File el archivo que contiene la nueva configuración global filtrada.

Lanza
IOExcepción

obtenerCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

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

Devoluciones
ICommandScheduler el ICommandScheduler . Nunca devolverá nulo.

obtener objeto de configuración

public abstract Object getConfigurationObject (String typeName)

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

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

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

obtenerCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

Obtiene ICredentialFactory para crear credenciales.

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

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Devuelve DeviceManagementGrpcServer o nulo si no está definido.

Devoluciones
DeviceManagementGrpcServer

obtenerAdministrador de dispositivos

public abstract IDeviceManager getDeviceManager ()

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

Devoluciones
IDeviceManager el IDeviceManager proporcionado en la configuración.

getDeviceMonitores

public abstract  getDeviceMonitors ()

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

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

obtener requisitos del dispositivo

public abstract IDeviceSelection getDeviceRequirements ()

Obtiene el IDeviceSelection que se utilizará desde la configuración. Representa un filtro global sobre qué dispositivos puede ver el DeviceManager .

Devoluciones
IDeviceSelection el IDeviceSelection proporcionado en la configuración.

obtener servidor de funciones

public abstract TradefedFeatureServer getFeatureServer ()

Devuelve TradefedFeatureServer o nulo si no está definido.

Devoluciones
TradefedFeatureServer

obtenerGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

Obtiene el servidor de configuración global. El servidor de configuración global se utiliza para obtener configuraciones de host de un servidor en lugar de obtenerlas de archivos locales.

Devoluciones
IConfigurationServer

getHostMonitores

public abstract  getHostMonitors ()

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

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

getHostOptions

public abstract IHostOptions getHostOptions ()

Obtiene las IHostOptions que se utilizarán desde la configuración.

Devoluciones
IHostOptions el IDeviceManager proporcionado en la configuración.

obtenerHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

Obtiene IHostResourceManager de la configuración global.

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

getKeyStoreFábrica

public abstract IKeyStoreFactory getKeyStoreFactory ()

Obtiene IKeyStoreFactory para usar desde la configuración.

Devoluciones
IKeyStoreFactory IKeyStoreFactory o nulo si no se establece ninguna fábrica de almacén de claves.

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

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

Devoluciones
la lista de IMultiDeviceRecovery , o null si no está configurado.

getOptionValues

public abstract  getOptionValues (String optionName)

Obtenga una lista de los valores de las opciones.

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

Devoluciones
una lista de los valores de la opción dada. null si el nombre de la opción no existe.

getResourceMetricCollectors

public abstract  getResourceMetricCollectors ()

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

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

obtenerSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Obtenga una fábrica de espacio aislado que pueda usarse para ejecutar una invocación

Devoluciones
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

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

Devoluciones
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Devuelve TestInvocationManagementServer o nulo si no está definido.

Devoluciones
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Obtiene el ITerribleFailureHandler para usar desde la configuración. Maneja qué hacer en caso de que ocurra un WTF (Qué terrible falla).

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

inyectarValorOpción

public abstract void injectOptionValue (String optionName, 
                String optionValue)

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

Útil para proporcionar valores para opciones que se generan dinámicamente.

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

optionValue String : los valores de la opción

Lanza
ConfigurationException si no se pudo establecer el valor de la opción

inyectarValorOpción

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

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

Útil para proporcionar valores para opciones que se generan dinámicamente.

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

optionKey String : la clave de opción del mapa

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

Lanza
ConfigurationException si no se pudo establecer el valor de la opción

establecerCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Configure ICommandScheduler y reemplace los valores existentes.

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Establezca IConfigurationFactory para esta configuración.

Parámetros
configFactory IConfigurationFactory

establecerConfiguraciónObjeto

public abstract void setConfigurationObject (String name, 
                Object configObject)

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

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

configObject Object : el objeto de configuración

Lanza
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, reemplazando cualquier valor existente.

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

configList : la lista de objetos de configuración

Lanza
ConfigurationException si algún objeto en la lista no es del tipo correcto

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Establece DeviceManagementGrpcServer .

Parámetros
server DeviceManagementGrpcServer

establecerAdministrador de dispositivos

public abstract void setDeviceManager (IDeviceManager deviceManager)

Configure IDeviceManager y reemplace los valores existentes. Esto configura el administrador para los dispositivos de prueba.

establecerDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Configure el IDeviceMonitor .

Parámetros
deviceMonitor IDeviceMonitor : El monitor

Lanza
ConfigurationException si ya se ha configurado un IDeviceMonitor .

establecer requisitos del dispositivo

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Establezca IDeviceSelection y reemplace los valores existentes. Esto establece un filtro de dispositivo global sobre qué dispositivos puede ver el DeviceManager .

setHostMonitores

public abstract void setHostMonitors ( hostMonitors)

Configure la lista IHostMonitor .

Parámetros
hostMonitors : La lista de monitores

Lanza
ConfigurationException si ya se ha configurado un IHostMonitor .

establecer opciones de host

public abstract void setHostOptions (IHostOptions hostOptions)

Configure IHostOptions y reemplace los valores existentes.

establecerHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Configure IHostResourceManager y reemplace los valores existentes.

establecer servidor de invocación

public abstract void setInvocationServer (TestInvocationManagementServer server)

Establece TestInvocationManagementServer .

Parámetros
server TestInvocationManagementServer

setKeyStoreFábrica

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Configure IKeyStoreFactory y reemplace los valores existentes.

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

Establezca los campos Option de configuración global con un conjunto dado de argumentos de línea de comando

Consulte ArgsOptionParser para conocer el formato esperado.

Parámetros
listArgs : los argumentos de la línea de comando

Devoluciones
los argumentos no consumidos

Lanza
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

Establece la configuración original utilizada para crear la configuración global.

Parámetros
config String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

Establece IResourceMetricCollector .

Parámetros
collector IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

Establezca ISandboxFactory y reemplace los valores existentes.

establecer estrategia de fragmentación

public abstract void setShardingStrategy (IShardHelper sharding)

Establece IShardHelper que se utilizará al fragmentar una configuración.

Parámetros
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Establece TradefedFeatureServer .

Parámetros
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Configure ITerribleFailureHandler .

Parámetros
wtfHandler ITerribleFailureHandler : el controlador WTF

Lanza
ConfigurationException si ya se ha configurado un ITerribleFailureHandler .

configuración

public abstract void setup ()

Configuración adecuada al inicio de tradefed.

Lanza
com.android.tradefed.config.ConfigurationException
ConfigurationException

validarOpciones

public abstract void validateOptions ()

Validar los valores de las opciones.

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

Lanza
ConfigurationException si a la configuración le faltan campos obligatorios