IConfiguration globale

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


Une classe pour englober les informations de configuration globales pour une seule instance de Trade Federation (englobant un nombre quelconque d'appels de configurations réelles).

Résumé

Méthodes publiques

abstract void cleanup ()

Nettoyage approprié lors de l'arrêt du tradefed.

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

Filtrez la configuration globale en fonction d'une liste blanche et affichez-la dans un fichier XML.

abstract 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 vers un fichier XML.

abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste autorisée et affichez-la dans un fichier XML.

abstract ICommandScheduler getCommandScheduler ()

Obtient le ICommandScheduler à utiliser à partir de la configuration.

abstract Object getConfigurationObject (String typeName)

Obtient l'objet de configuration personnalisé avec le nom donné.

abstract ICredentialFactory getCredentialFactory ()

Obtient ICredentialFactory pour créer des informations d’identification.

abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Renvoie le DeviceManagementGrpcServer ou null s'il n'est pas défini.

abstract IDeviceManager getDeviceManager ()

Obtient le IDeviceManager à utiliser à partir de la configuration.

abstract getDeviceMonitors ()

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

abstract IDeviceSelection getDeviceRequirements ()

Obtient l' IDeviceSelection à utiliser à partir de la configuration.

abstract TradefedFeatureServer getFeatureServer ()

Renvoie le TradefedFeatureServer ou null s'il n'est pas défini.

abstract IConfigurationServer getGlobalConfigServer ()

Obtient le serveur de configuration global.

abstract getHostMonitors ()

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

abstract IHostOptions getHostOptions ()

Obtient les IHostOptions à utiliser à partir de la configuration.

abstract IHostResourceManager getHostResourceManager ()

Obtient le IHostResourceManager de la configuration globale.

abstract IKeyStoreFactory getKeyStoreFactory ()

Obtient le IKeyStoreFactory à utiliser à partir de la configuration.

abstract getMultiDeviceRecoveryHandlers ()

Obtient la liste des IMultiDeviceRecovery à utiliser à partir de la configuration.

abstract getOptionValues (String optionName)

Obtenez une liste des valeurs des options.

abstract getResourceMetricCollectors ()

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

abstract ISandboxFactory getSandboxFactory ()

Obtenez une usine sandbox qui peut être utilisée pour exécuter une invocation

abstract IShardHelper getShardingStrategy ()

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

abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Renvoie le TestInvocationManagementServer ou null s'il n'est pas défini.

abstract ITerribleFailureHandler getWtfHandler ()

Obtient le ITerribleFailureHandler à utiliser à partir de la configuration.

abstract void injectOptionValue (String optionName, String optionValue)

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

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

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

abstract void setCommandScheduler ( ICommandScheduler scheduler)

Définissez le 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 pour définir l'objet de configuration avec le nom donné, en remplaçant toute valeur existante.

abstract 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é, en remplaçant toute valeur existante.

abstract void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Définit le DeviceManagementGrpcServer .

abstract void setDeviceManager ( IDeviceManager deviceManager)

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

abstract void setDeviceMonitor ( IDeviceMonitor deviceMonitor)

Définissez le IDeviceMonitor .

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

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

abstract void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

Définissez la liste IHostMonitor .

abstract void setHostOptions ( IHostOptions hostOptions)

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

abstract void setHostResourceManager ( IHostResourceManager hostResourceManager)

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

abstract void setInvocationServer ( TestInvocationManagementServer server)

Définit le TestInvocationManagementServer .

abstract void setKeyStoreFactory ( IKeyStoreFactory factory)

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

abstract setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

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

Voir ArgsOptionParser pour 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 le IResourceMetricCollector .

abstract void setSandboxFactory ( ISandboxFactory factory)

Définissez ISandboxFactory , en remplaçant toutes 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 le TradefedFeatureServer .

abstract void setWtfHandler ( ITerribleFailureHandler wtfHandler)

Définissez le ITerribleFailureHandler .

abstract void setup ()

Configuration appropriée au début de tradefed.

abstract void validateOptions ()

Validez les valeurs des options.

Méthodes publiques

nettoyer

public abstract void cleanup ()

Nettoyage approprié lors de l'arrêt du tradefed.

cloneConfigWithFilter

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

Filtrez la configuration globale en fonction d'une liste blanche et affichez-la dans un fichier XML.

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

allowlistConfigs String : un tableau String de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null , a default list should be used.
Retour
File le fichier contenant la nouvelle configuration globale filtrée.

Jetés
IOException

cloneConfigWithFilter

public abstract 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 vers un fichier XML.

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

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String : un tableau String de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null , a default list should be used.
Retour
File le fichier contenant la nouvelle configuration globale filtrée.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste autorisée et affichez-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 sauf "key_store" seront filtrées et donneront 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 String de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null , a default list should be used.
Retour
File le fichier contenant la nouvelle configuration globale filtrée.

Jetés
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

Obtient le ICommandScheduler à utiliser à partir de la configuration.

Retour
ICommandScheduler le ICommandScheduler . Ne retournera jamais null.

getConfigurationObject

public abstract 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 abstract ICredentialFactory getCredentialFactory ()

Obtient ICredentialFactory pour créer des informations d’identification.

Retour
ICredentialFactory ICredentialFactory ou null si aucun n’a été spécifié.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Renvoie le DeviceManagementGrpcServer ou null s'il n'est pas défini.

Retour
DeviceManagementGrpcServer

obtenirDeviceManager

public abstract IDeviceManager getDeviceManager ()

Obtient le IDeviceManager à utiliser à partir de la configuration. Gère l’ensemble des appareils disponibles pour les tests

Retour
IDeviceManager le IDeviceManager fourni dans la configuration.

getDeviceMonitors

public abstract  getDeviceMonitors ()

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

Retour
la liste des IDeviceMonitor de la configuration globale, ou null si aucun n'a été spécifié.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

Obtient l' IDeviceSelection à utiliser à partir de la configuration. Représente un filtre global sur quels appareils le DeviceManager peut voir.

Retour
IDeviceSelection le IDeviceSelection fourni dans la configuration.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

Renvoie le TradefedFeatureServer ou null s'il n'est pas défini.

Retour
TradefedFeatureServer

getGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

Obtient le serveur de configuration global. Le serveur de configuration global est utilisé pour obtenir les configurations d'hôte d'un serveur au lieu de les obtenir à partir de fichiers locaux.

Retour
IConfigurationServer

getHostMonitors

public abstract  getHostMonitors ()

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

Retour
la liste des IHostMonitor de la configuration globale, ou null si aucun n'a été spécifié.

getHostOptions

public abstract IHostOptions getHostOptions ()

Obtient les IHostOptions à utiliser à partir de la configuration.

Retour
IHostOptions le IDeviceManager fourni dans la configuration.

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

Obtient le IHostResourceManager de la configuration globale.

Retour
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 ()

Obtient le IKeyStoreFactory à utiliser à partir de la configuration.

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

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

Obtient la liste des IMultiDeviceRecovery à utiliser à partir de la configuration.

Retour
la liste des IMultiDeviceRecovery , ou null s'il n'est pas défini.

obtenirOptionValues

public abstract  getOptionValues (String optionName)

Obtenez une liste des valeurs des options.

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

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

getResourceMetricCollectors

public abstract  getResourceMetricCollectors ()

Obtient la liste des 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 abstract ISandboxFactory getSandboxFactory ()

Obtenez une usine sandbox qui peut être utilisée pour exécuter une invocation

Retour
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

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

Retour
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Renvoie le TestInvocationManagementServer ou null s'il n'est pas défini.

Retour
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

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

Retour
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 des objets de configuration.

Utile pour fournir des valeurs pour les options générées dynamiquement.

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

optionValue String : la ou les valeurs de l'option

Jetés
ConfigurationException si vous n'avez pas réussi à définir la valeur de l'option

injectOptionValue

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

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

Utile pour fournir des valeurs pour les options générées dynamiquement.

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

optionKey String : la clé d'option de la carte

optionValue String : la valeur de l'option de carte

Jetés
ConfigurationException si vous n'avez pas réussi à définir la valeur de l'option

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

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

setConfigurationFactory

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 pour définir l'objet de configuration avec le nom donné, en remplaçant toute valeur existante.

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

configObject Object : l'objet de configuration

Jetés
ConfigurationException si le configObject n'était pas du bon type

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

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

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

configList : la liste des objets de configuration

Jetés
ConfigurationException si des objets dans la liste ne sont pas du type correct

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Définit le DeviceManagementGrpcServer .

Paramètres
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Définissez le IDeviceManager , en remplaçant toutes les valeurs existantes. Ceci définit le gestionnaire des appareils de test

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Définissez le IDeviceMonitor .

Paramètres
deviceMonitor IDeviceMonitor : Le moniteur

Jetés
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. Cela définit un filtre de périphérique global sur lequel les périphériques que le DeviceManager peut voir.

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

Définissez la liste IHostMonitor .

Paramètres
hostMonitors : La liste des moniteurs

Jetés
ConfigurationException si un IHostMonitor a déjà été défini.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

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

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

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

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Définit le TestInvocationManagementServer .

Paramètres
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

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

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

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

Voir ArgsOptionParser pour le format attendu

Paramètres
listArgs : les arguments de la ligne de commande

Retour
les arguments non consommés

Jetés
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 le 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 le IShardHelper à utiliser lors du partitionnement d’une configuration.

Paramètres
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Définit le TradefedFeatureServer .

Paramètres
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Définissez le ITerribleFailureHandler .

Paramètres
wtfHandler ITerribleFailureHandler : le gestionnaire WTF

Jetés
ConfigurationException si un ITerribleFailureHandler a déjà été défini.

installation

public abstract void setup ()

Configuration appropriée au début de tradefed.

Jetés
com.android.tradefed.config.ConfigurationException
ConfigurationException

validerOptions

public abstract void validateOptions ()

Validez les valeurs des options.

Actuellement, cela validera simplement que toutes les options obligatoires ont été définies

Jetés
ConfigurationException s'il manque des champs obligatoires dans la configuration