Configuration globale
public class GlobalConfiguration
extends Object
implements IGlobalConfiguration
java.lang.Object | |
↳ | com.android.tradefed.config.GlobalConfiguration |
Une implémentation IGlobalConfiguration
qui stocke les objets de configuration chargés dans une carte
Résumé
Des champs | |
---|---|
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éthodes publiques | |
---|---|
void | cleanup () Nettoyage approprié lors de l'arrêt du tradefed. |
File | cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) Filtrez la configuration globale en fonction d'une liste blanche et de la sortie dans un fichier XML. |
File | cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) Filtrez la configuration globale en fonction d'une liste blanche tout en permettant la manipulation des valeurs d'option et la sortie dans un fichier XML. |
File | cloneConfigWithFilter (String... allowlistConfigs) Filtrez la configuration globale en fonction d'une liste autorisée et de la sortie dans un fichier XML. |
static | createGlobalConfiguration (String[] args) Configure le singleton |
ICommandScheduler | getCommandScheduler () Obtient le |
Object | getConfigurationObject (String typeName) Obtient l'objet de configuration personnalisé avec le nom donné. |
ICredentialFactory | getCredentialFactory () Obtient |
String | getDescription () |
DeviceManagementGrpcServer | getDeviceManagementServer () Renvoie le |
IDeviceManager | getDeviceManager () Obtient le |
static IDeviceManager | getDeviceManagerInstance () Renvoie une référence à l'instance singleton |
getDeviceMonitors () Obtient la liste de | |
IDeviceSelection | getDeviceRequirements () Obtient le |
TradefedFeatureServer | getFeatureServer () Renvoie le |
IConfigurationServer | getGlobalConfigServer () Obtient le serveur de configuration global. |
static | getHostMonitorInstances () |
getHostMonitors () Obtient la liste de | |
IHostOptions | getHostOptions () Obtient les |
IHostResourceManager | getHostResourceManager () Obtient |
static IGlobalConfiguration | getInstance () Renvoie une référence à l'instance singleton |
IKeyStoreFactory | getKeyStoreFactory () Obtient le |
getMultiDeviceRecoveryHandlers () Obtient la liste des | |
String | getName () |
getOptionValues (String optionName) Obtenez une liste des valeurs d'option. | |
getResourceMetricCollectors () Obtient la liste de | |
ISandboxFactory | getSandboxFactory () Obtenez une fabrique de sandbox qui peut être utilisée pour exécuter une invocation |
IShardHelper | getShardingStrategy () Renvoie le |
TestInvocationManagementServer | getTestInvocationManagementSever () Renvoie le |
ITerribleFailureHandler | getWtfHandler () Obtient le |
void | injectOptionValue (String optionName, String optionValue) Injectez une valeur d'option dans l'ensemble d'objets de configuration. |
void | injectOptionValue (String optionName, String optionKey, String optionValue) Injectez une valeur d'option dans l'ensemble d'objets de configuration. |
void | printCommandUsage (boolean importantOnly, PrintStream out) Génère un texte d'aide à l'utilisation de la ligne de commande pour cette configuration vers printStream donné. |
void | setCommandScheduler ( ICommandScheduler scheduler) Définissez le |
void | setConfigurationFactory ( IConfigurationFactory configFactory) Définissez |
void | setConfigurationObject (String typeName, Object configObject) Méthode générique pour définir l'objet de configuration avec le nom donné, en remplaçant toute valeur existante. |
void | setConfigurationObjectList (String typeName, configList) setConfigurationObjectList (String typeName, configList) Méthode générique pour définir la liste d'objets de configuration pour le nom donné, remplaçant toute valeur existante. |
void | setDeviceManagementServer ( DeviceManagementGrpcServer server) Définit le |
void | setDeviceManager ( IDeviceManager manager) Définissez le |
void | setDeviceMonitor ( IDeviceMonitor monitor) Définissez |
void | setDeviceRequirements ( IDeviceSelection devRequirements) Définissez |
void | setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors) Définissez la liste |
void | setHostOptions ( IHostOptions hostOptions) Définissez |
void | setHostResourceManager ( IHostResourceManager hostResourceManager) Définissez le |
void | setInvocationServer ( TestInvocationManagementServer server) Définit le |
void | setKeyStoreFactory ( IKeyStoreFactory factory) Définissez |
setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs) Définissez les champs ArgsOptionParser pour le format attendu | |
void | setOriginalConfig (String config) Définit la configuration d'origine utilisée pour créer la configuration globale. |
void | setResourceMetricCollector ( IResourceMetricCollector collector) Définit le |
void | setSandboxFactory ( ISandboxFactory factory) Définissez |
void | setShardingStrategy ( IShardHelper sharding) Définit |
void | setTradefedFeatureServer ( TradefedFeatureServer server) Définit le |
void | setWtfHandler ( ITerribleFailureHandler wtfHandler) Définissez le |
void | setup () Configuration correcte au début de tradefed. |
void | validateOptions () Validez les valeurs des options. |
Méthodes protégées | |
---|---|
IConfigurationFactory | getConfigurationFactory () |
Des champs
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éthodes publiques
nettoyer
public void cleanup ()
Nettoyage approprié lors de l'arrêt du tradefed.
cloneConfigWithFiltercloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, String... allowlistConfigs)
Filtrez la configuration globale en fonction d'une liste blanche et de la sortie dans un fichier XML.
Paramètres | |
---|---|
exclusionPatterns | |
allowlistConfigs | String : un tableau ERROR(/String) de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null |
Retour | |
---|---|
File | le fichier contenant la nouvelle configuration globale filtrée. |
cloneConfigWithFiltercloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)
Filtrez la configuration globale en fonction d'une liste blanche tout en permettant la manipulation des valeurs d'option et la sortie dans un fichier XML.
Paramètres | |
---|---|
exclusionPatterns | |
transformer | IConfigOptionValueTransformer |
deepCopy | boolean |
allowlistConfigs | String : un tableau ERROR(/String) de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null |
Retour | |
---|---|
File | le fichier contenant la nouvelle configuration globale filtrée. |
cloneConfigWithFiltercloneConfigWithFilter
public File cloneConfigWithFilter (String... allowlistConfigs)
Filtrez la configuration globale en fonction d'une liste autorisée et de la sortie dans un fichier XML.
Par exemple, pour la configuration suivante : <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>
toutes les configurations sauf "key_store" seront filtrées et le résultat sera un fichier de configuration avec le contenu suivant : <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>
Paramètres | |
---|---|
allowlistConfigs | String : un tableau ERROR(/String) de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null |
Retour | |
---|---|
File | le fichier contenant la nouvelle configuration globale filtrée. |
createGlobalConfiguration
public staticcreateGlobalConfiguration (String[] args)
Configure le singleton GlobalConfiguration
pour cette instance TF. Doit être appelé une et une seule fois, avant que quoi que ce soit ne tente d'appeler getInstance()
Paramètres | |
---|---|
args | String |
Retour | |
---|---|
Lance | |
---|---|
| si appelé plus d'une fois |
ConfigurationException |
getCommandScheduler
public ICommandScheduler getCommandScheduler ()
Obtient le ICommandScheduler
à utiliser à partir de la configuration.
Retour | |
---|---|
ICommandScheduler | le ICommandScheduler . Ne retournera jamais null. |
getConfigurationObject
public Object getConfigurationObject (String typeName)
Obtient l'objet de configuration personnalisé avec le nom donné.
Paramètres | |
---|---|
typeName | String : le type unique de l'objet de configuration |
Retour | |
---|---|
Object | l'objet ou null si l'objet portant ce nom n'est pas trouvé |
getCredentialFactory
public ICredentialFactory getCredentialFactory ()
Obtient ICredentialFactory
pour créer des informations d'identification.
Retour | |
---|---|
ICredentialFactory | ICredentialFactory ou null si aucun n'a été spécifié. |
getDescription
public String getDescription ()
Retour | |
---|---|
String | une courte description lisible par l'utilisateur de cette Configuration |
getDeviceManagementServer
public DeviceManagementGrpcServer getDeviceManagementServer ()
Renvoie le DeviceManagementGrpcServer
ou null si non défini.
Retour | |
---|---|
DeviceManagementGrpcServer |
getDeviceManager
public IDeviceManager getDeviceManager ()
Obtient le IDeviceManager
à utiliser à partir de la configuration. Gère l'ensemble des appareils disponibles pour les tests
Retour | |
---|---|
IDeviceManager | l' IDeviceManager fourni dans la configuration. |
getDeviceManagerInstance
public static IDeviceManager getDeviceManagerInstance ()
Renvoie une référence à l'instance singleton DeviceManager
pour cette instance TF.
Retour | |
---|---|
IDeviceManager |
Lance | |
---|---|
| si createGlobalConfiguration(String[]) n'a pas déjà été appelé. |
getDeviceMonitors
publicgetDeviceMonitors ()
Obtient la liste de IDeviceMonitor
à partir de la configuration globale.
Retour | |
---|---|
la liste de IDeviceMonitor de la configuration globale, ou null si aucun n'a été spécifié. |
getDeviceRequirements
public IDeviceSelection getDeviceRequirements ()
Obtient le IDeviceSelection
à utiliser à partir de la configuration. Représente un filtre global sur lequel les périphériques que le DeviceManager
peut voir.
Retour | |
---|---|
IDeviceSelection | IDeviceSelection fourni dans la configuration. |
getFeatureServer
public TradefedFeatureServer getFeatureServer ()
Renvoie le TradefedFeatureServer
ou null si non défini.
Retour | |
---|---|
TradefedFeatureServer |
getGlobalConfigServer
public IConfigurationServer getGlobalConfigServer ()
Obtient le serveur de configuration global. Le serveur de configuration global est utilisé pour obtenir les configurations d'hôte à partir d'un serveur au lieu de les obtenir à partir de fichiers locaux.
Retour | |
---|---|
IConfigurationServer |
getHostMonitorInstances
public staticgetHostMonitorInstances ()
Retour | |
---|---|
getHostMonitors
publicgetHostMonitors ()
Obtient la liste de IHostMonitor
à partir de la configuration globale.
Retour | |
---|---|
la liste de IHostMonitor de la configuration globale, ou null si aucun n'a été spécifié. |
getHostOptions
public IHostOptions getHostOptions ()
Obtient les IHostOptions
à utiliser à partir de la configuration.
Retour | |
---|---|
IHostOptions | l' IDeviceManager fourni dans la configuration. |
getHostResourceManager
public IHostResourceManager getHostResourceManager ()
Obtient IHostResourceManager
à partir de la configuration globale.
Retour | |
---|---|
IHostResourceManager | le IHostResourceManager de la configuration globale, ou l'implémentation par défaut LocalHostResourceManager si aucune n'est spécifiée dans la configuration de l'hôte. |
getInstance
public static IGlobalConfiguration getInstance ()
Renvoie une référence à l'instance singleton GlobalConfiguration
pour cette instance TF.
Retour | |
---|---|
IGlobalConfiguration |
Lance | |
---|---|
| si createGlobalConfiguration(String[]) n'a pas déjà été appelé. |
getKeyStoreFactory
public IKeyStoreFactory getKeyStoreFactory ()
Obtient le IKeyStoreFactory
à utiliser à partir de la configuration.
Retour | |
---|---|
IKeyStoreFactory | IKeyStoreFactory ou null si aucune fabrique de magasin de clés n'est définie. |
getMultiDeviceRecoveryHandlers
publicgetMultiDeviceRecoveryHandlers ()
Obtient la liste des IMultiDeviceRecovery
à utiliser à partir de la configuration.
Retour | |
---|---|
la liste de IMultiDeviceRecovery , ou null si non défini. |
getOptionValues
publicgetOptionValues (String optionName)
Obtenez une liste des valeurs d'option.
Paramètres | |
---|---|
optionName | String : le nom de l'option de carte |
Retour | |
---|---|
une liste des valeurs de l'option donnée. null si le nom de l'option n'existe pas. |
getResourceMetricCollectors
publicgetResourceMetricCollectors ()
Obtient la liste de IResourceMetricCollector
à partir de la configuration globale.
Retour | |
---|---|
la liste des IResourceMetricCollector de la configuration globale ou null si aucun n'a été spécifié. |
getSandboxFactory
public ISandboxFactory getSandboxFactory ()
Obtenez une fabrique de sandbox qui peut être utilisée pour exécuter une invocation
Retour | |
---|---|
ISandboxFactory |
getShardingStrategy
public IShardHelper getShardingStrategy ()
Renvoie le IShardHelper
qui définit la manière de partitionner une configuration.
Retour | |
---|---|
IShardHelper |
getTestInvocationManagementSever
public TestInvocationManagementServer getTestInvocationManagementSever ()
Renvoie le TestInvocationManagementServer
ou null si non défini.
Retour | |
---|---|
TestInvocationManagementServer |
getWtfHandler
public ITerribleFailureHandler getWtfHandler ()
Obtient le ITerribleFailureHandler
à utiliser à partir de la configuration. Gère ce qu'il faut faire dans le cas où un WTF (What a Terrible Failure) se produit.
Retour | |
---|---|
ITerribleFailureHandler | le ITerribleFailureHandler fourni dans la configuration, ou null si aucun gestionnaire n'est défini |
injectOptionValue
public void injectOptionValue (String optionName, String optionValue)
Injectez une valeur d'option dans l'ensemble d'objets de configuration.
Utile pour fournir des valeurs aux options générées dynamiquement.Paramètres | |
---|---|
optionName | String : le nom de l'option |
optionValue | String : la ou les valeurs de l'option |
Lance | |
---|---|
ConfigurationException |
injectOptionValue
public void injectOptionValue (String optionName, String optionKey, String optionValue)
Injectez une valeur d'option dans l'ensemble d'objets de configuration.
Utile pour fournir des valeurs aux options générées dynamiquement.Paramètres | |
---|---|
optionName | String : le nom de l'option de carte |
optionKey | String : la clé d'option de la carte |
optionValue | String : la valeur de l'option de carte |
Lance | |
---|---|
ConfigurationException |
printCommandUsageprintCommandUsage
public void printCommandUsage (boolean importantOnly, PrintStream out)
Génère un texte d'aide à l'utilisation de la ligne de commande pour cette configuration vers printStream donné.
Paramètres | |
---|---|
importantOnly | boolean |
out | PrintStream : l' ERROR(/PrintStream) à utiliser. |
Lance | |
---|---|
| com.android.tradefed.config.ConfigurationException |
ConfigurationException |
setCommandScheduler
public void setCommandScheduler (ICommandScheduler scheduler)
Définissez le ICommandScheduler
, en remplaçant toutes les valeurs existantes.
setConfigurationFactorysetConfigurationFactory
public void setConfigurationFactory (IConfigurationFactory configFactory)
Définissez IConfigurationFactory
pour cette configuration.
Paramètres | |
---|---|
configFactory | IConfigurationFactory |
setConfigurationObjectsetConfigurationObject
public void setConfigurationObject (String typeName, Object configObject)
Méthode générique pour définir l'objet de configuration avec le nom donné, en remplaçant toute valeur existante.
Paramètres | |
---|---|
typeName | String : le nom unique du type d'objet de configuration. |
configObject | Object : l'objet de configuration |
Lance | |
---|---|
ConfigurationException |
setConfigurationObjectListsetConfigurationObjectList
public void setConfigurationObjectList (String typeName,configList)
Méthode générique pour définir la liste d'objets de configuration pour le nom donné, remplaçant toute valeur existante.
Paramètres | |
---|---|
typeName | String : le nom unique du type d'objet de configuration. |
configList |
Lance | |
---|---|
ConfigurationException |
setDeviceManagementServersetDeviceManagementServer
public void setDeviceManagementServer (DeviceManagementGrpcServer server)
Définit le DeviceManagementGrpcServer
.
Paramètres | |
---|---|
server | DeviceManagementGrpcServer |
setDeviceManager
public void setDeviceManager (IDeviceManager manager)
Définissez le IDeviceManager
, en remplaçant toutes les valeurs existantes. Cela définit le gestionnaire pour les appareils de test
setDeviceMonitor
public void setDeviceMonitor (IDeviceMonitor monitor)
Définissez IDeviceMonitor
.
Paramètres | |
---|---|
monitor | IDeviceMonitor : Le moniteur |
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
Définissez IDeviceSelection
en remplaçant toutes les valeurs existantes. Cela définit un filtre de périphérique global sur lequel les périphériques que le DeviceManager
peut voir.
setHostMonitorssetHostMonitors
public void setHostMonitors (hostMonitors)
Définissez la liste IHostMonitor
.
Paramètres | |
---|---|
hostMonitors |
setHostOptions
public void setHostOptions (IHostOptions hostOptions)
Définissez IHostOptions
en remplaçant toutes les valeurs existantes.
setHostResourceManager
public void setHostResourceManager (IHostResourceManager hostResourceManager)
Définissez le IHostResourceManager
, en remplaçant toutes les valeurs existantes.
setInvocationServersetInvocationServer
public void setInvocationServer (TestInvocationManagementServer server)
Définit le TestInvocationManagementServer
.
Paramètres | |
---|---|
server | TestInvocationManagementServer |
setKeyStoreFactorysetKeyStoreFactory
public void setKeyStoreFactory (IKeyStoreFactory factory)
Définissez IKeyStoreFactory
en remplaçant toutes les valeurs existantes.
setOptionsFromCommandLineArgssetOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
Définissez les champs Option
de configuration globale avec un ensemble donné d'arguments de ligne de commande
ArgsOptionParser
pour le format attenduParamètres | |
---|---|
listArgs |
Retour | |
---|---|
les arguments non consommés |
Lance | |
---|---|
ConfigurationException |
setOriginalConfig
public void setOriginalConfig (String config)
Définit la configuration d'origine utilisée pour créer la configuration globale.
Paramètres | |
---|---|
config | String |
setResourceMetricCollectorsetResourceMetricCollector
public void setResourceMetricCollector (IResourceMetricCollector collector)
Définit le IResourceMetricCollector
.
Paramètres | |
---|---|
collector | IResourceMetricCollector |
setSandboxFactory
public void setSandboxFactory (ISandboxFactory factory)
Définissez ISandboxFactory
, en remplaçant toutes les valeurs existantes.
setShardingStrategy
public void setShardingStrategy (IShardHelper sharding)
Définit IShardHelper
à utiliser lors du partitionnement d'une configuration.
Paramètres | |
---|---|
sharding | IShardHelper |
setTradefedFeatureServer
public void setTradefedFeatureServer (TradefedFeatureServer server)
Définit le TradefedFeatureServer
.
Paramètres | |
---|---|
server | TradefedFeatureServer |
setWtfHandler
public void setWtfHandler (ITerribleFailureHandler wtfHandler)
Définissez le ITerribleFailureHandler
.
Paramètres | |
---|---|
wtfHandler | ITerribleFailureHandler : le gestionnaire WTF |
installation
public void setup ()
Configuration correcte au début de tradefed.
Lance | |
---|---|
ConfigurationException |
validerOptions
public void validateOptions ()
Validez les valeurs des options.
Actuellement, cela ne fera que valider que toutes les options obligatoires ont été définies
Lance | |
---|---|
ConfigurationException |
Méthodes protégées
getConfigurationFactory
protected IConfigurationFactory getConfigurationFactory ()
Retour | |
---|---|
IConfigurationFactory |