GlobalConfiguration
public
class
GlobalConfiguration
extends Object
implements
IGlobalConfiguration
java.lang.Object | |
↳ | com.android.tradefed.config.GlobalConfiguration |
Una implementación de 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()
Se realiza una limpieza adecuada cuando se cierra tradefed. |
File
|
cloneConfigWithFilter(
Filtra GlobalConfiguration en función de una lista de entidades permitidas y genera un archivo en formato XML. |
File
|
cloneConfigWithFilter(
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. |
File
|
cloneConfigWithFilter(String... allowlistConfigs)
Filtra GlobalConfiguration en función de una lista de entidades permitidas y genera un archivo en formato XML. |
static
|
createGlobalConfiguration(String[] args)
Configura el singleton |
ICommandScheduler
|
getCommandScheduler()
Obtiene el |
Object
|
getConfigurationObject(String typeName)
Obtiene el objeto de configuración personalizada con el nombre determinado. |
ICredentialFactory
|
getCredentialFactory()
Obtiene el |
String
|
getDescription()
|
DeviceManagementGrpcServer
|
getDeviceManagementServer()
Muestra |
IDeviceManager
|
getDeviceManager()
Obtiene el |
static
IDeviceManager
|
getDeviceManagerInstance()
Muestra una referencia a la instancia singleton |
|
getDeviceMonitors()
Obtiene la lista de |
IDeviceSelection
|
getDeviceRequirements()
Obtiene el |
TradefedFeatureServer
|
getFeatureServer()
Muestra |
IConfigurationServer
|
getGlobalConfigServer()
Obtiene el servidor de configuración global. |
static
|
getHostMonitorInstances()
|
|
getHostMonitors()
Obtiene la lista de |
IHostOptions
|
getHostOptions()
Obtiene el |
IHostResourceManager
|
getHostResourceManager()
Obtiene el |
static
IGlobalConfiguration
|
getInstance()
Muestra una referencia a la instancia singleton |
IKeyStoreFactory
|
getKeyStoreFactory()
Obtiene el |
|
getMultiDeviceRecoveryHandlers()
Obtiene la lista de |
String
|
getName()
|
|
getOptionValues(String optionName)
Obtén una lista de los valores de la opción. |
|
getResourceMetricCollectors()
Obtiene la lista de |
ISandboxFactory
|
getSandboxFactory()
Obtén una fábrica de zona de pruebas que se pueda usar para ejecutar una invocación |
IShardHelper
|
getShardingStrategy()
Muestra el |
TestInvocationManagementServer
|
getTestInvocationManagementSever()
Muestra |
ITerribleFailureHandler
|
getWtfHandler()
Obtiene el |
void
|
injectOptionValue(String optionName, String optionValue)
Inyecta un valor de opción en el conjunto de objetos de configuración. |
void
|
injectOptionValue(String optionName, String optionKey, String optionValue)
Inyecta un valor de opción en el conjunto de objetos de configuración. |
void
|
printCommandUsage(boolean importantOnly, PrintStream out)
Muestra un texto de ayuda de uso de la línea de comandos para esta configuración a printStream. |
void
|
setCommandScheduler(ICommandScheduler scheduler)
Establece el |
void
|
setConfigurationFactory(IConfigurationFactory configFactory)
Establece el |
void
|
setConfigurationObject(String typeName, Object configObject)
Es un método genérico para establecer el objeto de configuración con el nombre determinado y reemplazar cualquier valor existente. |
void
|
setConfigurationObjectList(String typeName,
Es un método genérico para establecer la lista de objetos de configuración para el nombre determinado y reemplazar cualquier valor existente. |
void
|
setDeviceManagementServer(DeviceManagementGrpcServer server)
Establece el |
void
|
setDeviceManager(IDeviceManager manager)
Establece |
void
|
setDeviceMonitor(IDeviceMonitor monitor)
Establece el |
void
|
setDeviceRequirements(IDeviceSelection devRequirements)
Establece |
void
|
setHostMonitors(
Establece la lista |
void
|
setHostOptions(IHostOptions hostOptions)
Establece |
void
|
setHostResourceManager(IHostResourceManager hostResourceManager)
Establece |
void
|
setInvocationServer(TestInvocationManagementServer server)
Establece el |
void
|
setKeyStoreFactory(IKeyStoreFactory factory)
Establece |
|
setOptionsFromCommandLineArgs(
Establece los campos
Consulta |
void
|
setOriginalConfig(String config)
Establece la configuración original que se usó para crear la configuración global. |
void
|
setResourceMetricCollector(IResourceMetricCollector collector)
Establece el |
void
|
setSandboxFactory(ISandboxFactory factory)
Establece |
void
|
setShardingStrategy(IShardHelper sharding)
Establece el |
void
|
setTradefedFeatureServer(TradefedFeatureServer server)
Establece el |
void
|
setWtfHandler(ITerribleFailureHandler wtfHandler)
Establece el |
void
|
setup()
Configuración adecuada al comienzo de tradefed. |
void
|
validateOptions()
Valida los valores de las opciones. |
Métodos protegidos | |
---|---|
IConfigurationFactory
|
getConfigurationFactory()
|
Campos
CREDENTIAL_FACTORY_TYPE_NAME
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
GLOBAL_CONFIG_SERVER
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
KEY_STORE_TYPE_NAME
public static final String KEY_STORE_TYPE_NAME
MULTI_DEVICE_RECOVERY_TYPE_NAME
public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME
RESOURCE_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
SCHEDULER_TYPE_NAME
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
limpieza
public void cleanup ()
Se realiza una limpieza adecuada al realizar un intercambio de cierre.
cloneConfigWithFilter
public 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 String de configuraciones que se incluirán en el nuevo archivo en formato XML.
Si se estableció en null |
Muestra | |
---|---|
File |
el archivo que contiene la nueva configuración global filtrada. |
cloneConfigWithFilter
public 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.
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 String de configuraciones que se incluirán en el nuevo archivo en formato XML.
Si se estableció en null |
Muestra | |
---|---|
File |
el archivo que contiene la nueva configuración global filtrada. |
cloneConfigWithFilter
public File cloneConfigWithFilter (String... allowlistConfigs)
Filtra GlobalConfiguration en función de una lista de entidades permitidas y genera 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án todos los parámetros de 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 |
Muestra | |
---|---|
File |
el archivo que contiene la nueva configuración global filtrada. |
createGlobalConfiguration
public staticcreateGlobalConfiguration (String[] args)
Configura el singleton GlobalConfiguration
para esta instancia de TF. Se debe llamar una vez y solo una vez, antes de que se intente llamar a getInstance()
.
Parámetros | |
---|---|
args |
String |
Muestra | |
---|---|
|
Arroja | |
---|---|
IllegalStateException |
si se lo llama más de una vez |
ConfigurationException |
getCommandScheduler
public ICommandScheduler getCommandScheduler ()
Obtiene el ICommandScheduler
que se usará de la configuración.
Muestra | |
---|---|
ICommandScheduler |
el ICommandScheduler . Nunca mostrará un valor nulo. |
getConfigurationObject.
public Object getConfigurationObject (String typeName)
Obtiene el objeto de configuración personalizada con el 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 ICredentialFactory getCredentialFactory ()
Obtiene el ICredentialFactory
para crear credenciales.
Muestra | |
---|---|
ICredentialFactory |
ICredentialFactory o null si no se especificó ninguno. |
getDescription
public String getDescription ()
Muestra | |
---|---|
String |
una breve descripción legible por el usuario de este Configuration |
getDeviceManagementServer
public DeviceManagementGrpcServer getDeviceManagementServer ()
Muestra DeviceManagementGrpcServer
o un valor nulo si no está definido.
Muestra | |
---|---|
DeviceManagementGrpcServer |
getDeviceManager
public 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. |
getDeviceManagerInstance
public static IDeviceManager getDeviceManagerInstance ()
Muestra una referencia a la instancia singleton DeviceManager
de esta instancia de TF.
Muestra | |
---|---|
IDeviceManager |
Arroja | |
---|---|
IllegalStateException |
si aún no se llamó a createGlobalConfiguration(String[]) . |
getDeviceMonitors
publicgetDeviceMonitors ()
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 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 TradefedFeatureServer getFeatureServer ()
Muestra TradefedFeatureServer
o un valor nulo si no está definido.
Muestra | |
---|---|
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 desde un servidor en lugar de obtenerlas de archivos locales.
Muestra | |
---|---|
IConfigurationServer |
getHostMonitorInstances
public staticgetHostMonitorInstances ()
Muestra | |
---|---|
|
getHostMonitor
publicgetHostMonitors ()
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 IHostOptions getHostOptions ()
Obtiene el IHostOptions
que se usará de la configuración.
Muestra | |
---|---|
IHostOptions |
el IDeviceManager proporcionado en la configuración. |
getHostResourceManager
public 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. |
getInstance
public static IGlobalConfiguration getInstance ()
Muestra una referencia a la instancia singleton GlobalConfiguration
de esta instancia de TF.
Muestra | |
---|---|
IGlobalConfiguration |
Arroja | |
---|---|
IllegalStateException |
si aún no se llamó a createGlobalConfiguration(String[]) . |
getKeyStoreFactory
public 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.
publicgetMultiDeviceRecoveryHandlers ()
Obtiene la lista de IMultiDeviceRecovery
para usar de la configuración.
Muestra | |
---|---|
|
la lista de IMultiDeviceRecovery o null si no está configurada. |
getOptionValues
publicgetOptionValues (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
publicgetResourceMetricCollectors ()
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 ISandboxFactory getSandboxFactory ()
Obtén una fábrica de zona de pruebas que se pueda usar para ejecutar una invocación
Muestra | |
---|---|
ISandboxFactory |
getShardingStrategy
public IShardHelper getShardingStrategy ()
Muestra el IShardHelper
que define la forma de dividir una configuración.
Muestra | |
---|---|
IShardHelper |
getTestInvocationManagementSever
public TestInvocationManagementServer getTestInvocationManagementSever ()
Muestra el objeto TestInvocationManagementServer
o el valor nulo si no está definido.
Muestra | |
---|---|
TestInvocationManagementServer |
getWtfHandler
public 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 un valor nulo si no se establece ningún controlador |
Valor de opción de inyección
public 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 : Son los valores de la opción. |
Arroja | |
---|---|
ConfigurationException |
injectOptionValue
public 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 de mapa. |
optionKey |
String : Es la clave de opción del mapa. |
optionValue |
String : Es el valor de la opción del mapa. |
Arroja | |
---|---|
ConfigurationException |
printCommandUsage
public void printCommandUsage (boolean importantOnly, PrintStream out)
Muestra un texto de ayuda de uso de la línea de comandos para esta configuración en el printStream determinado.
Parámetros | |
---|---|
importantOnly |
boolean |
out |
PrintStream : Es el ERROR(/PrintStream) que se usará. |
Arroja | |
---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
setCommandScheduler
public void setCommandScheduler (ICommandScheduler scheduler)
Establece ICommandScheduler
y reemplaza los valores existentes.
setConfigurationFactory
public void setConfigurationFactory (IConfigurationFactory configFactory)
Establece el IConfigurationFactory
para esta configuración.
Parámetros | |
---|---|
configFactory |
IConfigurationFactory |
setConfigurationObject
public void setConfigurationObject (String typeName, 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 | |
---|---|
typeName |
String : Es el nombre único del tipo de objeto de configuración. |
configObject |
Object : El objeto de configuración |
Arroja | |
---|---|
ConfigurationException |
setConfigurationObjectList
public 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.
Parámetros | |
---|---|
typeName |
String : Es el nombre único del tipo de objeto de configuración. |
configList |
: La lista de objetos de configuración |
Arroja | |
---|---|
ConfigurationException |
setDeviceManagementServer
public void setDeviceManagementServer (DeviceManagementGrpcServer server)
Establece el DeviceManagementGrpcServer
.
Parámetros | |
---|---|
server |
DeviceManagementGrpcServer |
setDeviceManager
public void setDeviceManager (IDeviceManager manager)
Establece el IDeviceManager
y reemplaza los valores existentes. Esto configura el administrador de los dispositivos de prueba.
setDeviceMonitor
public void setDeviceMonitor (IDeviceMonitor monitor)
Establece el IDeviceMonitor
.
Parámetros | |
---|---|
monitor |
IDeviceMonitor : El monitor |
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
Establece IDeviceSelection
y reemplaza los valores existentes. Esto establece un filtro de dispositivos global en los que DeviceManager
puede ver los dispositivos.
setHostMonitors
public void setHostMonitors (hostMonitors)
Establece la lista IHostMonitor
.
Parámetros | |
---|---|
hostMonitors |
: Es la lista de monitores. |
setHostOptions
public void setHostOptions (IHostOptions hostOptions)
Establece IHostOptions
y reemplaza los valores existentes.
setHostResourceManager
public void setHostResourceManager (IHostResourceManager hostResourceManager)
Establece IHostResourceManager
y reemplaza los valores existentes.
setInvocationServer
public void setInvocationServer (TestInvocationManagementServer server)
Establece el TestInvocationManagementServer
.
Parámetros | |
---|---|
server |
TestInvocationManagementServer |
setKeyStoreFactory
public void setKeyStoreFactory (IKeyStoreFactory factory)
Establece el IKeyStoreFactory
y reemplaza los valores existentes.
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
Establece los campos Option
de configuración global con un conjunto determinado de argumentos de línea de comandos.
Consultar ArgsOptionParser
para ver el formato esperado
Parámetros | |
---|---|
listArgs |
: Los argumentos de la línea de comandos |
Muestra | |
---|---|
|
los argumentos no consumidos |
Arroja | |
---|---|
ConfigurationException |
setOriginalConfig
public void setOriginalConfig (String config)
Establece la configuración original que se usó 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)
Establece ISandboxFactory
y reemplaza los valores existentes.
setShardingStrategy
public void setShardingStrategy (IShardHelper sharding)
Establece el IShardHelper
que se usará cuando se fragmente una configuración.
Parámetros | |
---|---|
sharding |
IShardHelper |
setTradefedFeatureServer
public void setTradefedFeatureServer (TradefedFeatureServer server)
Establece el TradefedFeatureServer
.
Parámetros | |
---|---|
server |
TradefedFeatureServer |
setWtfHandler
public void setWtfHandler (ITerribleFailureHandler wtfHandler)
Establece el ITerribleFailureHandler
.
Parámetros | |
---|---|
wtfHandler |
ITerribleFailureHandler : Es el controlador de WTF. |
configuración
public void setup ()
Configuración adecuada al comienzo de tradefed.
Arroja | |
---|---|
ConfigurationException |
validateOptions
public void validateOptions ()
Valida los valores de las opciones.
Actualmente, solo se validará que se hayan establecido todas las opciones obligatorias.
Arroja | |
---|---|
ConfigurationException |
Métodos protegidos
getConfigurationFactory
protected IConfigurationFactory getConfigurationFactory ()
Muestra | |
---|---|
IConfigurationFactory |