GlobalConfiguration

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Object
   ↳ com.android.tradefed.config.GlobalConfiguration


Implémentation IGlobalConfiguration qui stocke les objets de configuration chargés dans une carte

Résumé

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 de Tradefed.

File cloneConfigWithFilter( exclusionPatterns, String... allowlistConfigs)

Filtrez la GlobalConfiguration en fonction d'une liste blanche et exportez-la dans un fichier XML.

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

Filtrez la GlobalConfiguration en fonction d'une liste blanche, tout en permettant de manipuler les valeurs d'option et de générer une sortie dans un fichier XML.

File cloneConfigWithFilter(String... allowlistConfigs)

Filtrez la GlobalConfiguration en fonction d'une liste d'autorisations et exportez-la dans un fichier XML.

static createGlobalConfiguration(String[] args)

Configure le singleton GlobalConfiguration pour cette instance TF.

ICommandScheduler getCommandScheduler()

Récupère le ICommandScheduler à utiliser à partir de la configuration.

Object getConfigurationObject(String typeName)

Récupère l'objet de configuration personnalisé portant le nom donné.

ICredentialFactory getCredentialFactory()

Récupère ICredentialFactory pour créer des identifiants.

String getDescription()
DeviceManagementGrpcServer getDeviceManagementServer()

Renvoie DeviceManagementGrpcServer ou la valeur "null" si elle n'est pas définie.

IDeviceManager getDeviceManager()

Récupère le IDeviceManager à utiliser à partir de la configuration.

static IDeviceManager getDeviceManagerInstance()

Renvoie une référence à l'instance DeviceManager singleton pour cette instance TF.

getDeviceMonitors()

Récupère la liste des IDeviceMonitor à partir de la configuration globale.

IDeviceSelection getDeviceRequirements()

Récupère le IDeviceSelection à utiliser à partir de la configuration.

TradefedFeatureServer getFeatureServer()

Renvoie TradefedFeatureServer ou la valeur "null" si elle n'est pas définie.

IConfigurationServer getGlobalConfigServer()

Récupère le serveur de configuration global.

static getHostMonitorInstances()
getHostMonitors()

Récupère la liste des IHostMonitor à partir de la configuration globale.

IHostOptions getHostOptions()

Récupère les IHostOptions à utiliser à partir de la configuration.

IHostResourceManager getHostResourceManager()

Récupère la IHostResourceManager à partir de la configuration globale.

static IGlobalConfiguration getInstance()

Renvoie une référence à l'instance singleton GlobalConfiguration pour cette instance TF.

IKeyStoreFactory getKeyStoreFactory()

Récupère le IKeyStoreFactory à utiliser à partir de la configuration.

getMultiDeviceRecoveryHandlers()

Récupère la liste des IMultiDeviceRecovery à utiliser à partir de la configuration.

String getName()
getOptionValues(String optionName)

Obtenez la liste des valeurs de l'option.

getResourceMetricCollectors()

Récupère la liste des IResourceMetricCollector à partir de la configuration globale.

ISandboxFactory getSandboxFactory()

Obtenir une fabrique de bac à sable pouvant être utilisée pour exécuter un appel

IShardHelper getShardingStrategy()

Renvoie la valeur IShardHelper qui définit la manière de segmenter une configuration.

TestInvocationManagementServer getTestInvocationManagementSever()

Renvoie TestInvocationManagementServer ou la valeur "null" si la valeur n'est pas définie.

ITerribleFailureHandler getWtfHandler()

Récupère le ITerribleFailureHandler à utiliser à partir de la configuration.

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)

Affiche un texte d'aide sur l'utilisation de la ligne de commande pour cette configuration dans le flux d'impression donné.

void setCommandScheduler(ICommandScheduler scheduler)

Définissez ICommandScheduler, en remplaçant toutes les valeurs existantes.

void setConfigurationFactory(IConfigurationFactory configFactory)

Définissez le paramètre IConfigurationFactory pour cette configuration.

void setConfigurationObject(String typeName, Object configObject)

Méthode générique permettant de définir l'objet de configuration avec le nom donné, en remplaçant toute valeur existante.

void setConfigurationObjectList(String typeName, configList)

Méthode générique permettant de définir la liste des objets de configuration pour le nom donné, en remplaçant toute valeur existante.

void setDeviceManagementServer(DeviceManagementGrpcServer server)

Définit DeviceManagementGrpcServer.

void setDeviceManager(IDeviceManager manager)

Définissez IDeviceManager, en remplaçant toutes les valeurs existantes.

void setDeviceMonitor(IDeviceMonitor monitor)

Définissez IDeviceMonitor.

void setDeviceRequirements(IDeviceSelection devRequirements)

Définissez IDeviceSelection en remplaçant les valeurs existantes.

void setHostMonitors( hostMonitors)

Définissez la liste IHostMonitor.

void setHostOptions(IHostOptions hostOptions)

Définissez IHostOptions, en remplaçant toutes les valeurs existantes.

void setHostResourceManager(IHostResourceManager hostResourceManager)

Définissez IHostResourceManager, en remplaçant toutes les valeurs existantes.

void setInvocationServer(TestInvocationManagementServer server)

Définit TestInvocationManagementServer.

void setKeyStoreFactory(IKeyStoreFactory factory)

Définissez IKeyStoreFactory, en remplaçant toutes les valeurs existantes.

setOptionsFromCommandLineArgs( listArgs)

Définir les champs de configuration globale Option avec un ensemble donné d'arguments de ligne de commande

Consultez ArgsOptionParser pour connaître 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 IResourceMetricCollector.

void setSandboxFactory(ISandboxFactory factory)

Définissez ISandboxFactory, en remplaçant toutes les valeurs existantes.

void setShardingStrategy(IShardHelper sharding)

Définit l'IShardHelper à utiliser lors du fractionnement d'une configuration.

void setTradefedFeatureServer(TradefedFeatureServer server)

Définit TradefedFeatureServer.

void setWtfHandler(ITerribleFailureHandler wtfHandler)

Définissez ITerribleFailureHandler.

void setup()

Configuration correcte au début de la diffusion.

void validateOptions()

Validez les valeurs des options.

Méthodes protégées

IConfigurationFactory getConfigurationFactory()

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

SERVEUR_CONFIGURATION_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

NOM_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

nettoyage

public void cleanup ()

Nettoyage correct en cas d'arrêt échangé.

cloneConfigWithFilter

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

Filtrez la GlobalConfiguration en fonction d'une liste blanche et exportez-la dans un fichier XML.

Paramètres
exclusionPatterns : modèle de nom de classe à exclure du vidage.

allowlistConfigs String: tableau String de configurations à inclure dans le nouveau fichier XML. Si elle est définie sur null, a default list should be used.

Renvoie
File Fichier contenant la nouvelle configuration globale filtrée.

cloneConfigWithFilter

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

Filtrez la GlobalConfiguration en fonction d'une liste blanche, tout en permettant de manipuler les valeurs d'option et de générer une sortie dans un fichier XML.

Paramètres
exclusionPatterns : format du nom de classe à exclure du vidage.

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String: tableau String de configurations à inclure dans le nouveau fichier XML. Si elle est définie sur null, a default list should be used.

Renvoie
File Fichier contenant la nouvelle configuration globale filtrée.

cloneConfigWithFilter

public File cloneConfigWithFilter (String... allowlistConfigs)

Permet de filtrer la GlobalConfiguration en fonction d'une liste d'autorisation et de générer 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, à l'exception de "key_store", seront filtrées, et un fichier de configuration contenant le contenu suivant sera généré : <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

Paramètres
allowlistConfigs String: tableau String de configurations à inclure dans le nouveau fichier XML. Si elle est définie sur null, a default list should be used.

Renvoie
File Fichier contenant la nouvelle configuration globale filtrée.

createGlobalConfiguration

public static  createGlobalConfiguration (String[] args)

Configure le singleton GlobalConfiguration pour cette instance TF. Doit être appelé une seule fois avant toute tentative d'appel de getInstance().

Paramètres
args String

Renvoie

Génère
IllegalStateException si elle est appelée plusieurs fois
ConfigurationException

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

Récupère les ICommandScheduler à utiliser à partir de la configuration.

Renvoie
ICommandScheduler ICommandScheduler. Ne renvoie jamais la valeur "null".

getConfigurationObject

public Object getConfigurationObject (String typeName)

Récupère l'objet de configuration personnalisée avec le nom donné.

Paramètres
typeName String: type unique de l'objet de configuration

Renvoie
Object l'objet ou la valeur "null" si l'objet portant ce nom est introuvable

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

Récupère les ICredentialFactory pour créer des identifiants.

Renvoie
ICredentialFactory ICredentialFactory ou null si aucun élément n'a été spécifié.

getDescription

public String getDescription ()

Renvoie
String une brève description lisible par l'utilisateur de cet Configuration

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

Renvoie DeviceManagementGrpcServer ou la valeur "null" si la valeur n'est pas définie.

Renvoie
DeviceManagementGrpcServer

getDeviceManager

public IDeviceManager getDeviceManager ()

Récupère le IDeviceManager à utiliser à partir de la configuration. Gère l'ensemble des appareils disponibles pour les tests

Renvoie
IDeviceManager le IDeviceManager fourni dans la configuration.

Instance getDeviceManager

public static IDeviceManager getDeviceManagerInstance ()

Renvoie une référence à l'instance singleton DeviceManager pour cette instance TF.

Renvoie
IDeviceManager

Génère
IllegalStateException si createGlobalConfiguration(String[]) n'a pas déjà été appelé.

getDeviceMonitors

public  getDeviceMonitors ()

Récupère la liste des IDeviceMonitor à partir de la configuration globale.

Renvoie
la liste des IDeviceMonitor de la configuration globale, ou null si aucune n'a été spécifiée.

getDeviceRequirements

public IDeviceSelection getDeviceRequirements ()

Récupère le IDeviceSelection à utiliser à partir de la configuration. Représente un filtre global sur les appareils que DeviceManager peut voir.

Renvoie
IDeviceSelection le IDeviceSelection fourni dans la configuration.

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

Renvoie TradefedFeatureServer ou la valeur "null" si la valeur n'est pas définie.

Renvoie
TradefedFeatureServer

getGlobalConfigServer

public IConfigurationServer getGlobalConfigServer ()

Récupère le serveur de configuration global. Le serveur de configuration global est utilisé pour obtenir les configurations d'hôte auprès d'un serveur au lieu de les obtenir à partir de fichiers locaux.

Renvoie
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

Renvoie

getHostMonitors

public  getHostMonitors ()

Récupère la liste des IHostMonitor à partir de la configuration globale.

Renvoie
la liste des IHostMonitor de la configuration globale ou null si aucune n'a été spécifiée.

getHostOptions

public IHostOptions getHostOptions ()

Récupère le IHostOptions à utiliser à partir de la configuration.

Renvoie
IHostOptions le IDeviceManager fourni dans la configuration.

getHostResourceManager

public IHostResourceManager getHostResourceManager ()

Récupère la IHostResourceManager à partir de la configuration globale.

Renvoie
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 GlobalConfiguration du singleton pour cette instance TF.

Renvoie
IGlobalConfiguration

Génère
IllegalStateException si createGlobalConfiguration(String[]) n'a pas déjà été appelé.

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

Récupère le IKeyStoreFactory à utiliser à partir de la configuration.

Renvoie
IKeyStoreFactory IKeyStoreFactory ou valeur nulle si aucune usine de magasin de clés n'est définie.

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

Récupère la liste des IMultiDeviceRecovery à utiliser à partir de la configuration.

Renvoie
la liste de IMultiDeviceRecovery, ou null si elle n'est pas définie.

getName

public String getName ()

Renvoie
String nom de cet objet Configuration

getOptionValues

public  getOptionValues (String optionName)

Permet d'obtenir la liste des valeurs d'une option.

Paramètres
optionName String: nom de l'option de carte

Renvoie
une liste des valeurs de l'option donnée. null si le nom de l'option n'existe pas.

getResourceMetricCollectors

public  getResourceMetricCollectors ()

Récupère la liste des IResourceMetricCollector à partir de la configuration globale.

Renvoie
la liste des IResourceMetricCollector de la configuration globale ou de null si aucune n'a été spécifiée.

getSandboxFactory

public ISandboxFactory getSandboxFactory ()

Obtenir une fabrique de bac à sable pouvant être utilisée pour exécuter une invocation

Renvoie
ISandboxFactory

getShardingStrategy

public IShardHelper getShardingStrategy ()

Renvoie l'IShardHelper qui définit la méthode de fractionnement d'une configuration.

Renvoie
IShardHelper

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

Renvoie TestInvocationManagementServer ou la valeur "null" si elle n'est pas définie.

Renvoie
TestInvocationManagementServer

getWtfHandler

public ITerribleFailureHandler getWtfHandler ()

Récupère le ITerribleFailureHandler à utiliser à partir de la configuration. Gère les actions à entreprendre en cas d'erreur de type WTF (What a Terrible Failure).

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

Il est utile de fournir des valeurs pour les options générées dynamiquement.

Paramètres
optionName String: nom de l'option

optionValue String: valeur(s) de l'option

Génère
ConfigurationException

injectOptionValue

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

Injectez une valeur d'option dans l'ensemble d'objets de configuration.

Il est utile de fournir des valeurs pour les options générées dynamiquement.

Paramètres
optionName String: nom de l'option de carte

optionKey String: clé d'option de carte

optionValue String: valeur de l'option de carte

Génère
ConfigurationException

printCommandUsage

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

Affiche un texte d'aide sur l'utilisation de la ligne de commande pour cette configuration dans le flux d'impression donné.

Paramètres
importantOnly boolean

out PrintStream: ERROR(/PrintStream) à utiliser.

Génère
com.android.tradefed.config.ConfigurationException
ConfigurationException

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

Définissez ICommandScheduler, en remplaçant toutes les valeurs existantes.

Définir une fabrique de configuration

public void setConfigurationFactory (IConfigurationFactory configFactory)

Définissez IConfigurationFactory pour cette configuration.

Paramètres
configFactory IConfigurationFactory

objet de configuration

public void setConfigurationObject (String typeName, 
                Object configObject)

Méthode générique permettant de définir l'objet "config" avec le nom donné en remplaçant toute valeur existante.

Paramètres
typeName String: nom unique du type d'objet de configuration.

configObject Object: objet de configuration

Génère
ConfigurationException

setConfigurationObjectList

public void setConfigurationObjectList (String typeName, 
                 configList)

Méthode générique permettant de définir la liste d'objets de configuration pour le nom donné, en remplaçant toute valeur existante.

Paramètres
typeName String: nom unique du type d'objet de configuration.

configList : liste des objets de configuration

Génère
ConfigurationException

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

Définit DeviceManagementGrpcServer.

Paramètres
server DeviceManagementGrpcServer

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

Définissez IDeviceManager, en remplaçant toutes les valeurs existantes. Le gestionnaire des appareils de test est alors défini

setDeviceMonitor

public void setDeviceMonitor (IDeviceMonitor monitor)

Définissez IDeviceMonitor.

Paramètres
monitor IDeviceMonitor: moniteur

setDeviceRequirements

public void setDeviceRequirements (IDeviceSelection devRequirements)

Définissez IDeviceSelection, en remplaçant toutes les valeurs existantes. Cette action définit un filtre d'appareil global sur les appareils que DeviceManager peut voir.

setHostMonitors

public void setHostMonitors ( hostMonitors)

Définissez la liste IHostMonitor.

Paramètres
hostMonitors : liste des moniteurs

setHostOptions

public void setHostOptions (IHostOptions hostOptions)

Définissez IHostOptions en remplaçant les valeurs existantes.

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

Définissez IHostResourceManager, en remplaçant toutes les valeurs existantes.

setInvocationServer

public void setInvocationServer (TestInvocationManagementServer server)

Définit TestInvocationManagementServer.

Paramètres
server TestInvocationManagementServer

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

Définissez IKeyStoreFactory, en remplaçant toutes les valeurs existantes.

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

Définir les champs de configuration globale Option avec un ensemble d'arguments de ligne de commande donné

Consultez ArgsOptionParser pour connaître le format attendu

Paramètres
listArgs : arguments de la ligne de commande

Renvoie
les arguments non utilisés

Génère
ConfigurationException

Configurer la configuration d'origine

public void setOriginalConfig (String config)

Définit la configuration d'origine utilisée pour créer la configuration globale.

Paramètres
config String

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

Définit 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 l'IShardHelper à utiliser lors du fractionnement d'une configuration.

Paramètres
sharding IShardHelper

setTradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

Définit TradefedFeatureServer.

Paramètres
server TradefedFeatureServer

setWtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

Définissez ITerribleFailureHandler.

Paramètres
wtfHandler ITerribleFailureHandler: gestionnaire WTF

configuration

public void setup ()

Configuration correcte au début de la diffusion.

Génère
ConfigurationException

validateOptions

public void validateOptions ()

Validez les valeurs des options.

Pour le moment, cette opération ne permet que de vérifier que toutes les options obligatoires ont été définies.

Génère
ConfigurationException

Méthodes protégées

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

Renvoie
IConfigurationFactory