Configuración global

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Objeto
com.android.tradefed.config.GlobalConfiguration


Una implementación IGlobalConfiguration que almacena los objetos de configuración cargados en un mapa

Resumen

Campos

public static final String CREDENTIAL_FACTORY_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MONITOR_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

public static final String GLOBAL_CONFIG_SERVER

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_VARIABLE

public static final String HOST_MONITOR_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String KEY_STORE_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

public static final String SCHEDULER_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

public static final String WTF_HANDLER_TYPE_NAME

Métodos públicos

void cleanup ()

Limpieza adecuada cuando se apaga tradefed.

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

Filtre la configuración global en función de una lista blanca y envíela a un archivo XML.

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

Filtre la configuración global en función de una lista blanca mientras permite la manipulación de los valores de las opciones y la salida a un archivo XML.

File cloneConfigWithFilter (String... allowlistConfigs)

Filtre la configuración global en función de una lista permitida y envíela a un archivo XML.

static createGlobalConfiguration (String[] args)

Configura el singleton GlobalConfiguration para esta instancia de TF.

ICommandScheduler getCommandScheduler ()

Obtiene el ICommandScheduler para usar desde la configuración.

Object getConfigurationObject (String typeName)

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

ICredentialFactory getCredentialFactory ()

Obtiene ICredentialFactory para crear credenciales.

String getDescription ()
DeviceManagementGrpcServer getDeviceManagementServer ()

Devuelve DeviceManagementGrpcServer o nulo si no está definido.

IDeviceManager getDeviceManager ()

Obtiene el IDeviceManager para usar desde la configuración.

static IDeviceManager getDeviceManagerInstance ()

Devuelve una referencia a la instancia DeviceManager singleton para esta instancia de TF.

getDeviceMonitors ()

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

IDeviceSelection getDeviceRequirements ()

Obtiene IDeviceSelection para usar desde la configuración.

TradefedFeatureServer getFeatureServer ()

Devuelve TradefedFeatureServer o nulo si no está definido.

IConfigurationServer getGlobalConfigServer ()

Obtiene el servidor de configuración global.

static getHostMonitorInstances ()
getHostMonitors ()

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

IHostOptions getHostOptions ()

Obtiene IHostOptions para usar desde la configuración.

IHostResourceManager getHostResourceManager ()

Obtiene el IHostResourceManager de la configuración global.

static IGlobalConfiguration getInstance ()

Devuelve una referencia a la instancia GlobalConfiguration singleton para esta instancia de TF.

IKeyStoreFactory getKeyStoreFactory ()

Obtiene IKeyStoreFactory para usar desde la configuración.

getMultiDeviceRecoveryHandlers ()

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

String getName ()
getOptionValues (String optionName)

Obtenga una lista de los valores de las opciones.

getResourceMetricCollectors ()

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

ISandboxFactory getSandboxFactory ()

Obtenga una fábrica de sandbox que se puede usar para ejecutar una invocación

IShardHelper getShardingStrategy ()

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

TestInvocationManagementServer getTestInvocationManagementSever ()

Devuelve TestInvocationManagementServer o nulo si no está definido.

ITerribleFailureHandler getWtfHandler ()

Obtiene el ITerribleFailureHandler para usar desde la configuración.

void injectOptionValue (String optionName, String optionValue)

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

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

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

void printCommandUsage (boolean importantOnly, PrintStream out)

Envía un texto de ayuda de uso de la línea de comandos para esta configuración a printStream dado.

void setCommandScheduler ( ICommandScheduler scheduler)

Configure el ICommandScheduler , reemplazando cualquier valor existente.

void setConfigurationFactory ( IConfigurationFactory configFactory)

Establezca IConfigurationFactory para esta configuración.

void setConfigurationObject (String typeName, Object configObject)

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

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.

void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Establece DeviceManagementGrpcServer .

void setDeviceManager ( IDeviceManager manager)

Configure el IDeviceManager , reemplazando cualquier valor existente.

void setDeviceMonitor ( IDeviceMonitor monitor)

Configure el IDeviceMonitor .

void setDeviceRequirements ( IDeviceSelection devRequirements)

Establezca IDeviceSelection , reemplazando cualquier valor existente.

void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

Configure la lista IHostMonitor .

void setHostOptions ( IHostOptions hostOptions)

Establezca IHostOptions , reemplazando cualquier valor existente.

void setHostResourceManager ( IHostResourceManager hostResourceManager)

Configure el IHostResourceManager , reemplazando cualquier valor existente.

void setInvocationServer ( TestInvocationManagementServer server)

Establece TestInvocationManagementServer .

void setKeyStoreFactory ( IKeyStoreFactory factory)

Configure IKeyStoreFactory , reemplazando cualquier valor existente.

setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

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

Ver ArgsOptionParser para el formato esperado

void setOriginalConfig (String config)

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

void setResourceMetricCollector ( IResourceMetricCollector collector)

Establece el IResourceMetricCollector .

void setSandboxFactory ( ISandboxFactory factory)

Configure ISandboxFactory , reemplazando cualquier valor existente.

void setShardingStrategy ( IShardHelper sharding)

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

void setTradefedFeatureServer ( TradefedFeatureServer server)

Establece TradefedFeatureServer .

void setWtfHandler ( ITerribleFailureHandler wtfHandler)

Configure el ITerribleFailureHandler .

void setup ()

Configuración adecuada al comienzo de tradefed.

void validateOptions ()

Validar valores de opciones.

Métodos protegidos

IConfigurationFactory getConfigurationFactory ()

Campos

CREDENCIAL_FÁBRICA_TIPO_NOMBRE

public static final String CREDENTIAL_FACTORY_TYPE_NAME

DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

DEVICE_MONITOR_TYPE_NAME

public static final String DEVICE_MONITOR_TYPE_NAME

DEVICE_REQUIREMENTS_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

SERVIDOR_CONFIG_GLOBAL

public static final String GLOBAL_CONFIG_SERVER

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

GLOBAL_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_VARIABLE

HOST_MONITOR_TYPE_NAME

public static final String HOST_MONITOR_TYPE_NAME

HOST_OPTIONS_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

CLAVE_TIENDA_TIPO_NOMBRE

public static final String KEY_STORE_TYPE_NAME

MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

RECURSO_METRIC_COLLECTOR_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

SANDBOX_FACTORY_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

PROGRAMADOR_TIPO_NOMBRE

public static final String SCHEDULER_TYPE_NAME

SHARDING_STRATEGY_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

TF_FEATURE_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

TF_INVOCATION_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

WTF_HANDLER_TYPE_NAME

public static final String WTF_HANDLER_TYPE_NAME

Métodos públicos

limpiar

public void cleanup ()

Limpieza adecuada cuando se apaga tradefed.

clonConfigConFiltro

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

Filtre la configuración global en función de una lista blanca y envíela a un archivo XML.

Parámetros
exclusionPatterns : El patrón de nombre de clase para 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.

clonConfigConFiltro

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

Filtre la configuración global en función de una lista blanca mientras permite la manipulación de los valores de las opciones y la salida a un archivo XML.

Parámetros
exclusionPatterns : El patrón de nombre de clase para 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.

clonConfigConFiltro

public File cloneConfigWithFilter (String... allowlistConfigs)

Filtre la configuración global en función de 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>

toda la configuración, excepto "key_store", se filtrará y dará como resultado 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.

crearConfiguraciónGlobal

public static  createGlobalConfiguration (String[] args)

Configura el singleton GlobalConfiguration para esta instancia de TF. Debe llamarse una vez y solo una vez, antes de que algo intente llamar getInstance()

Parámetros
args String

Devoluciones

Lanza
IllegalStateException si se llama más de una vez
ConfigurationException

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

Obtiene el ICommandScheduler para usar desde la configuración.

Devoluciones
ICommandScheduler el ICommandScheduler . Nunca devolverá nulo.

getConfigurationObject

public Object getConfigurationObject (String typeName)

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

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

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

Obtiene ICredentialFactory para crear credenciales.

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

obtenerDescripción

public String getDescription ()

Devoluciones
String una breve descripción legible por el usuario esta Configuration

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

Devuelve DeviceManagementGrpcServer o nulo si no está definido.

Devoluciones
DeviceManagementGrpcServer

getDeviceManager

public IDeviceManager getDeviceManager ()

Obtiene el IDeviceManager para usar desde la configuración. Administra el conjunto de dispositivos disponibles para la prueba

Devoluciones
IDeviceManager el IDeviceManager proporcionado en la configuración.

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

Devuelve una referencia a la instancia DeviceManager singleton para esta instancia de TF.

Devoluciones
IDeviceManager

Lanza
IllegalStateException si todavía no se ha llamado createGlobalConfiguration(String[]) .

getDeviceMonitores

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

getDeviceRequirements

public IDeviceSelection getDeviceRequirements ()

Obtiene IDeviceSelection para usar desde la configuración. Representa un filtro global en qué dispositivos puede ver DeviceManager .

Devoluciones
IDeviceSelection la IDeviceSelection proporcionada en la configuración.

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

Devuelve TradefedFeatureServer o nulo si no está definido.

Devoluciones
TradefedFeatureServer

getGlobalConfigServer

public IConfigurationServer getGlobalConfigServer ()

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

Devoluciones
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

Devoluciones

getHostMonitores

public  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 IHostOptions getHostOptions ()

Obtiene IHostOptions para usar desde la configuración.

Devoluciones
IHostOptions el IDeviceManager proporcionado en la configuración.

getHostResourceManager

public IHostResourceManager getHostResourceManager ()

Obtiene el 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.

obtener Instancia

public static IGlobalConfiguration getInstance ()

Devuelve una referencia a la instancia GlobalConfiguration singleton para esta instancia de TF.

Devoluciones
IGlobalConfiguration

Lanza
IllegalStateException si todavía no se ha llamado createGlobalConfiguration(String[]) .

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

Obtiene IKeyStoreFactory para usar desde la configuración.

Devoluciones
IKeyStoreFactory IKeyStoreFactory o nulo si no se establece ninguna fábrica de almacenamiento de claves.

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

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

Devoluciones
la lista de IMultiDeviceRecovery , o null si no se establece.

obtenerNombre

public String getName ()

Devoluciones
String el nombre de esta Configuration

getOptionValues

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

getSandboxFactory

public ISandboxFactory getSandboxFactory ()

Obtenga una fábrica de sandbox que se puede usar para ejecutar una invocación

Devoluciones
ISandboxFactory

getShardingStrategy

public IShardHelper getShardingStrategy ()

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

Devoluciones
IShardHelper

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

Devuelve TestInvocationManagementServer o nulo si no está definido.

Devoluciones
TestInvocationManagementServer

obtenerWtfHandler

public ITerribleFailureHandler getWtfHandler ()

Obtiene el ITerribleFailureHandler para usar desde la configuración. Maneja qué hacer en caso de que ocurra un WTF (What a Terrible Failure).

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

inyectarValorOpción

public 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 las 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

inyectarValorOpción

public 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 las 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 de mapa

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

Lanza
ConfigurationException

imprimirComandoUso

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

Envía un texto de ayuda de uso de la línea de comandos para esta configuración a printStream dado.

Parámetros
importantOnly boolean

out PrintStream : el ERROR(/PrintStream) a usar.

Lanza
com.android.tradefed.config.ConfigurationException
ConfigurationException

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

Configure el ICommandScheduler , reemplazando cualquier valor existente.

setConfigurationFactory

public void setConfigurationFactory (IConfigurationFactory configFactory)

Establezca IConfigurationFactory para esta configuración.

Parámetros
configFactory IConfigurationFactory

setConfigurationObject

public void setConfigurationObject (String typeName, 
                Object configObject)

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

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

configObject Object : el objeto de configuración

Lanza
ConfigurationException

setConfigurationObjectListConfigurationObjectList

public 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

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

Establece DeviceManagementGrpcServer .

Parámetros
server DeviceManagementGrpcServer

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

Configure el IDeviceManager , reemplazando cualquier valor existente. Esto establece el administrador de los dispositivos de prueba

configurarDeviceMonitor

public void setDeviceMonitor (IDeviceMonitor monitor)

Configure el IDeviceMonitor .

Parámetros
monitor IDeviceMonitor : El monitor

establecer los requisitos del dispositivo

public void setDeviceRequirements (IDeviceSelection devRequirements)

Establezca IDeviceSelection , reemplazando cualquier valor existente. Esto establece un filtro de dispositivo global en qué dispositivos puede ver DeviceManager .

establecer monitores de host

public void setHostMonitors ( hostMonitors)

Configure la lista IHostMonitor .

Parámetros
hostMonitors : La lista de monitores

establecerHostOptions

public void setHostOptions (IHostOptions hostOptions)

Establezca IHostOptions , reemplazando cualquier valor existente.

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

Configure el IHostResourceManager , reemplazando cualquier valor existente.

establecer servidor de invocación

public void setInvocationServer (TestInvocationManagementServer server)

Establece TestInvocationManagementServer .

Parámetros
server TestInvocationManagementServer

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

Configure IKeyStoreFactory , reemplazando cualquier valor existente.

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

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

Ver ArgsOptionParser para el formato esperado

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

Devoluciones
los argumentos no consumidos

Lanza
ConfigurationException

setOriginalConfig

public void setOriginalConfig (String config)

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

Parámetros
config String

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

Establece el IResourceMetricCollector .

Parámetros
collector IResourceMetricCollector

setSandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

Configure ISandboxFactory , reemplazando cualquier valor existente.

setShardingStrategy

public void setShardingStrategy (IShardHelper sharding)

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

Parámetros
sharding IShardHelper

setTradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

Establece TradefedFeatureServer .

Parámetros
server TradefedFeatureServer

establecerWtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

Configure el ITerribleFailureHandler .

Parámetros
wtfHandler ITerribleFailureHandler : el controlador WTF

configuración

public void setup ()

Configuración adecuada al comienzo de tradefed.

Lanza
ConfigurationException

validarOpciones

public void validateOptions ()

Validar valores de opciones.

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

Lanza
ConfigurationException

Métodos protegidos

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

Devoluciones
IConfigurationFactory