IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


Classe permettant de regrouper les informations de configuration globales d'une seule instance de Trade Federation (comprenant un nombre illimité d'appels de configurations réelles).

Résumé

Méthodes publiques

abstract void cleanup()

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

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

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

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

abstract File cloneConfigWithFilter(String... allowlistConfigs)

Filtrez la GlobalConfiguration en fonction d'une liste d'autorisations et exportez-la dans 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 avec le nom donné.

abstract ICredentialFactory getCredentialFactory()

Récupère ICredentialFactory pour créer des 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 getDeviceMonitors()

Récupère 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 la valeur n'est pas définie.

abstract IConfigurationServer getGlobalConfigServer()

Récupère le serveur de configuration global.

abstract getHostMonitors()

Récupère la liste de 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 la IHostResourceManager à partir de la configuration globale.

abstract IKeyStoreFactory getKeyStoreFactory()

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

abstract getMultiDeviceRecoveryHandlers()

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

abstract getOptionValues(String optionName)

Obtenez la liste des valeurs de l'option.

abstract getResourceMetricCollectors()

Récupère 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 une invocation

abstract IShardHelper getShardingStrategy()

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

abstract TestInvocationManagementServer getTestInvocationManagementSever()

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

abstract ITerribleFailureHandler getWtfHandler()

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

abstract void injectOptionValue(String optionName, String optionValue)

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

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

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

abstract void setCommandScheduler(ICommandScheduler scheduler)

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

abstract void setConfigurationFactory(IConfigurationFactory configFactory)

Définissez 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, 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.

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

Définit DeviceManagementGrpcServer.

abstract void setDeviceManager(IDeviceManager deviceManager)

Définissez IDeviceManager, en remplaçant toutes 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( 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 toutes 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 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

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 toutes les valeurs existantes.

abstract void setShardingStrategy(IShardHelper sharding)

Définit les IShardHelper à utiliser lors de la segmentation d'une configuration.

abstract void setTradefedFeatureServer(TradefedFeatureServer server)

Définit TradefedFeatureServer.

abstract void setWtfHandler(ITerribleFailureHandler wtfHandler)

Définissez ITerribleFailureHandler.

abstract void setup()

Configuration correcte au début de la diffusion.

abstract void validateOptions()

Validez les valeurs des options.

Méthodes publiques

nettoyage

public abstract void cleanup ()

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

cloneConfigWithFilter

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

Génère
IOException

cloneConfigWithFilter

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

Filtrez la GlobalConfiguration 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 : modèle de 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 abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtrez la GlobalConfiguration en fonction d'une liste d'autorisations et exportez-la 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.

Génère
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

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

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

getConfigurationObject

public abstract 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 nulle si aucun objet ne correspond à ce nom

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

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

Renvoie
ICredentialFactory ICredentialFactory ou null si aucune 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  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.

getDeviceExigences

public abstract IDeviceSelection getDeviceRequirements ()

Récupère les 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 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 global. Le serveur de configuration global permet d'obtenir les configurations d'hôte à partir d'un serveur plutôt que de fichiers locaux.

Renvoie
IConfigurationServer

getHostMonitors

public abstract  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 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 la IHostResourceManager à partir de la configuration globale.

Renvoie
IHostResourceManager le IHostResourceManager de la configuration globale ou l'implémentation par défaut LocalHostResourceManager si aucun n'est spécifié 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 valeur nulle si aucune usine de magasin de clés n'est définie.

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

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

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

getOptionValues

public abstract  getOptionValues (String optionName)

Obtenez la liste des valeurs de l'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 abstract  getResourceMetricCollectors ()

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

Renvoie
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 l'IShardHelper qui définit la méthode de fractionnement d'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 la procédure à suivre en cas de défaillance grave.

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

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

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

Utile pour 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 si l'échec de la définition de la valeur de l'option

injectOptionValue

public abstract 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 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 en cas d'échec de la définition de la valeur de l'option

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

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

Définir une fabrique de configuration

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Définissez 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 "config" 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 le type de configObject n'était pas correct

setConfigurationObjectList

public abstract 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 Si le type d'un objet de la liste est incorrect

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 toutes les valeurs existantes. Le gestionnaire des appareils de test est alors défini

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Définissez IDeviceMonitor.

Paramètres
deviceMonitor IDeviceMonitor: l'é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 toutes les valeurs existantes. Cette action définit un filtre d'appareil global sur les appareils que DeviceManager peut voir.

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

Définissez la liste IHostMonitor.

Paramètres
hostMonitors : 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 toutes 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 toutes les valeurs existantes.

setOptionsFromCommandLineArgs

public abstract  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 ligne de commande

Renvoie
les arguments non consommés

Génère
ConfigurationException

Configurer la configuration d'origine

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 toutes les valeurs existantes.

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

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

configuration

public abstract void setup ()

Configuration appropriée au début du tradefed.

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

ValidOptions

public abstract 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 si des champs obligatoires sont manquants dans la configuration.