IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

Classe regroupant les informations de configuration globale pour une seule instance Trade Federation (englobant un nombre quelconque d'invocations de configurations réelles).

Résumé

Méthodes publiques

abstract void cleanup()

Nettoyage approprié lors de l'arrêt de Tradefed.

abstract File cloneConfigWithFilter(String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste autorisée et générez un fichier XML.

abstract File cloneConfigWithFilter(Set<String> exclusionPatterns, String... allowlistConfigs)

Filtrez la GlobalConfiguration en fonction d'une liste blanche et générez un fichier XML.

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

Filtrer la GlobalConfiguration en fonction d'une liste blanche tout en permettant la manipulation des valeurs d'option et la sortie vers un fichier XML.

abstract ICommandScheduler getCommandScheduler()

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

abstract Object getConfigurationObject(String typeName)

Récupère l'objet de configuration personnalisée portant le nom spécifié.

abstract ICredentialFactory getCredentialFactory()

Obtient le ICredentialFactory pour la création d'identifiants.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

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

abstract IDeviceManager getDeviceManager()

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

abstract List<IDeviceMonitor> getDeviceMonitors()

Obtient la liste des IDeviceMonitor à partir de la configuration globale.

abstract IDeviceSelection getDeviceRequirements()

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

abstract TradefedFeatureServer getFeatureServer()

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

abstract IConfigurationServer getGlobalConfigServer()

Récupère le serveur de configuration globale.

abstract List<IHostMonitor> getHostMonitors()

Obtient la liste des IHostMonitor à partir de la configuration globale.

abstract IHostOptions getHostOptions()

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

abstract IHostResourceManager getHostResourceManager()

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

abstract IKeyStoreFactory getKeyStoreFactory()

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

abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers()

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

abstract List<String> getOptionValues(String optionName)

Obtenez la liste des valeurs d'une option.

abstract List<IResourceMetricCollector> getResourceMetricCollectors()

Obtient la liste des IResourceMetricCollector à partir de la configuration globale.

abstract ISandboxFactory getSandboxFactory()

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

abstract IShardHelper getShardingStrategy()

Renvoie le IShardHelper qui définit la manière de partitionner une configuration.

abstract TestInvocationManagementServer getTestInvocationManagementSever()

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

abstract ITerribleFailureHandler getWtfHandler()

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

abstract void injectOptionValue(String optionName, String optionValue)

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

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

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

abstract void setCommandScheduler(ICommandScheduler scheduler)

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

abstract void setConfigurationFactory(IConfigurationFactory configFactory)

Définissez le IConfigurationFactory pour cette configuration.

abstract void setConfigurationObject(String name, 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.

abstract void setConfigurationObjectList(String typeName, List<?> 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.

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

Définit DeviceManagementGrpcServer.

abstract void setDeviceManager(IDeviceManager deviceManager)

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

abstract void setDeviceMonitor(IDeviceMonitor deviceMonitor)

Définissez IDeviceMonitor.

abstract void setDeviceRequirements(IDeviceSelection deviceSelection)

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

abstract void setHostMonitors(List<IHostMonitor> hostMonitors)

Définissez la liste IHostMonitor.

abstract void setHostOptions(IHostOptions hostOptions)

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

abstract void setHostResourceManager(IHostResourceManager hostResourceManager)

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

abstract void setInvocationServer(TestInvocationManagementServer server)

Définit TestInvocationManagementServer.

abstract void setKeyStoreFactory(IKeyStoreFactory factory)

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

abstract List<String> setOptionsFromCommandLineArgs(List<String> listArgs)

Définissez les champs de configuration globale Option avec l'ensemble d'arguments de ligne de commande donné.

Consultez ArgsOptionParser pour connaître le format attendu.

abstract void setOriginalConfig(String config)

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

abstract void setResourceMetricCollector(IResourceMetricCollector collector)

Définit IResourceMetricCollector.

abstract void setSandboxFactory(ISandboxFactory factory)

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

abstract void setShardingStrategy(IShardHelper sharding)

Définit le IShardHelper à utiliser lors du partitionnement d'une configuration.

abstract void setTradefedFeatureServer(TradefedFeatureServer server)

Définit TradefedFeatureServer.

abstract void setWtfHandler(ITerribleFailureHandler wtfHandler)

Définissez ITerribleFailureHandler.

abstract void setup()

Configuration appropriée au début de Tradefed.

abstract void validateOptions()

Validez les valeurs des options.

Méthodes publiques

cleanup

public abstract void cleanup ()

Nettoyage approprié lors de l'arrêt de Tradefed.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste autorisée et générez 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 le fichier de configuration obtenu aura le contenu suivant : <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 la valeur est définie sur null, a default list should be used.
Renvoie
File Fichier contenant la nouvelle configuration globale filtrée.
Génère
java.io.IOException
IOException

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (Set<String> exclusionPatterns, 
                String... allowlistConfigs)

Filtrez la GlobalConfiguration en fonction d'une liste blanche et générez un fichier XML.

Paramètres
exclusionPatterns Set : modèle de nom de classe à exclure du dump.
allowlistConfigs String : tableau String de configurations à inclure dans le nouveau fichier XML. Si la valeur est définie sur null, a default list should be used.
Renvoie
File Fichier contenant la nouvelle configuration globale filtrée.
Génère
java.io.IOException
IOException

cloneConfigWithFilter

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

Filtrer la GlobalConfiguration en fonction d'une liste blanche tout en permettant la manipulation des valeurs d'option et la sortie vers un fichier XML.

Paramètres
exclusionPatterns Set : modèle de nom de classe à exclure du dump.
transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String : tableau String de configurations à inclure dans le nouveau fichier XML. Si la valeur est définie sur null, a default list should be used.
Renvoie
File Fichier contenant la nouvelle configuration globale filtrée.
Génère
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

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

Renvoie
ICommandScheduler le ICommandScheduler. Ne renverra jamais la valeur "null".

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

Récupère l'objet de configuration personnalisée portant le nom spécifié.

Paramètres
typeName String : type unique de l'objet de configuration
Renvoie
Object l'objet ou null si l'objet portant ce nom est introuvable.

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

Obtient le ICredentialFactory pour la création d'identifiants.

Renvoie
ICredentialFactory ICredentialFactory ou null si aucune valeur n'a été spécifiée.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

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

Renvoie
DeviceManagementGrpcServer

getDeviceManager

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

getDeviceMonitors

public abstract List<IDeviceMonitor> getDeviceMonitors ()

Obtient la liste des IDeviceMonitor à partir de la configuration globale.

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

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

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

Renvoie
IDeviceSelection le IDeviceSelection fourni dans la configuration.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

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

Renvoie
TradefedFeatureServer

getGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

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

Renvoie
IConfigurationServer

getHostMonitors

public abstract List<IHostMonitor> getHostMonitors ()

Obtient la liste des IHostMonitor à partir de la configuration globale.

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

getHostOptions

public abstract IHostOptions getHostOptions ()

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

Renvoie
IHostOptions le IDeviceManager fourni dans la configuration.

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

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

Renvoie
IHostResourceManager IHostResourceManager de la configuration globale ou de l'implémentation par défaut LocalHostResourceManager si aucune n'est spécifiée dans la configuration de l'hôte.

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

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

Renvoie
IKeyStoreFactory IKeyStoreFactory ou null si aucune fabrique de magasin de clés n'est définie.

getMultiDeviceRecoveryHandlers

public abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers ()

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

Renvoie
List<IMultiDeviceRecovery> Liste des IMultiDeviceRecovery, ou null si elle n'est pas définie.

getOptionValues

public abstract List<String> getOptionValues (String optionName)

Obtenez la liste des valeurs d'une option.

Paramètres
optionName String : nom de l'option de carte
Renvoie
List<String> une liste des valeurs de l'option donnée. null si le nom de l'option n'existe pas.

getResourceMetricCollectors

public abstract List<IResourceMetricCollector> getResourceMetricCollectors ()

Obtient la liste des IResourceMetricCollector à partir de la configuration globale.

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

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

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

Renvoie
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

Renvoie le IShardHelper qui définit la manière de partitionner une configuration.

Renvoie
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

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

Renvoie
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Récupère le ITerribleFailureHandler à utiliser à partir de la configuration. Gère ce qu'il faut faire en cas d'erreur WTF (What a Terrible Failure).

Renvoie
ITerribleFailureHandler ITerribleFailureHandler fourni dans la configuration, ou null si aucun gestionnaire n'est défini

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

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

Utile pour fournir des valeurs pour les options générées de manière dynamique.

Paramètres
optionName String : nom de l'option
optionValue String : valeur(s) de l'option
Génère
ConfigurationException Échec de la définition de la valeur de l'option

injectOptionValue

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

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

Utile pour fournir des valeurs pour les options générées de manière dynamique.

Paramètres
optionName String : nom de l'option de carte
optionKey String : clé de l'option de carte
optionValue String : valeur de l'option de carte
Génère
ConfigurationException Échec de la définition de la valeur de l'option

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

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

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Définissez le IConfigurationFactory pour cette configuration.

Paramètres
configFactory IConfigurationFactory

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                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.

Paramètres
name String : nom unique du type d'objet de configuration.
configObject Object : objet de configuration
Génère
ConfigurationException si configObject n'était pas du bon type.

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                List<?> 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.

Paramètres
typeName String : nom unique du type d'objet de configuration.
configList List : liste des objets de configuration
Génère
ConfigurationException Si des objets de la liste ne sont pas du bon type

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Définit DeviceManagementGrpcServer.

Paramètres
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Définissez IDeviceManager en remplaçant les valeurs existantes. Cela définit le gestionnaire pour les appareils de test.

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Définissez IDeviceMonitor.

Paramètres
deviceMonitor IDeviceMonitor : écran
Génère
ConfigurationException si un IDeviceMonitor a déjà été défini.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

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

setHostMonitors

public abstract void setHostMonitors (List<IHostMonitor> hostMonitors)

Définissez la liste IHostMonitor.

Paramètres
hostMonitors List : liste des moniteurs.
Génère
ConfigurationException si un IHostMonitor a déjà été défini.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

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

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

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

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Définit TestInvocationManagementServer.

Paramètres
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

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

setOptionsFromCommandLineArgs

public abstract List<String> setOptionsFromCommandLineArgs (List<String> listArgs)

Définissez les champs de configuration globale Option avec l'ensemble d'arguments de ligne de commande donné.

Consultez ArgsOptionParser pour connaître le format attendu.

Paramètres
listArgs List : arguments de ligne de commande
Renvoie
List<String> les arguments non utilisés.
Génère
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

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

Paramètres
config String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

Définit IResourceMetricCollector.

Paramètres
collector IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

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

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

Définit le IShardHelper à utiliser lors du partitionnement d'une configuration.

Paramètres
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Définit TradefedFeatureServer.

Paramètres
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Définissez ITerribleFailureHandler.

Paramètres
wtfHandler ITerribleFailureHandler : gestionnaire WTF
Génère
ConfigurationException si un ITerribleFailureHandler a déjà été défini.

configurer

public abstract void setup ()

Configuration appropriée au début de Tradefed.

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

validateOptions

public abstract void validateOptions ()

Validez les valeurs des options.

Pour le moment, cette fonction se contente de vérifier que toutes les options obligatoires ont été définies.

Génère
ConfigurationException si la configuration comporte des champs obligatoires manquants.