À partir de 2026, pour nous aligner sur notre modèle de développement stable et garantir la stabilité de la plate-forme pour l'écosystème, nous publierons le code source sur AOSP au deuxième et au quatrième trimestre. Pour créer et contribuer dans AOSP, utilisez android-latest-release. La branche de fichier manifeste android-latest-release fera toujours référence à la version la plus récente envoyée à AOSP. Pour en savoir plus, consultez Modifications apportées à AOSP.

Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Sous-classes directes connues

GCSConfigurationFactory, RetryConfigurationFactory, SandboxConfigurationFactory

GCSConfigurationFactory	Un `ConfigurationFactory` charge les configurations depuis Google Cloud Storage.
RetryConfigurationFactory	Fabrique qui gère la nouvelle tentative d'exécution d'une commande.
SandboxConfigurationFactory	Fabrique de configuration spéciale pour gérer la création de configurations à des fins de bac à sable.

Fabrique permettant de créer IConfiguration.

Résumé

Classes imbriquées
`class`	`ConfigurationFactory.ConfigLoader` Implémentation d'IConfigDefLoader qui suit les configurations incluses à partir d'une configuration racine et génère une exception en cas d'inclusions circulaires.
`class`	`ConfigurationFactory.ExceptionLoader`

Constructeurs protégés
`ConfigurationFactory()`

Méthodes publiques
`void`	`clearMapConfig()` Dans certains cas particuliers, nous devons effacer la carte.
`IConfiguration`	`createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient)` Créez le `IConfiguration` à partir d'arguments de ligne de commande avec un keystore.
`IConfiguration`	`createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs)` Créez le `IConfiguration` à partir des arguments de ligne de commande.
`IConfiguration`	`createConfigurationFromArgs(String[] arrayArgs)` Méthode pratique qui appelle `createConfigurationFromArgs(String[],List)` avec un deuxième argument `null`.
`IGlobalConfiguration`	`createGlobalConfigurationFromArgs(String[] arrayArgs, List<String> remainingArgs)` Créez un `IGlobalConfiguration` à partir des arguments de ligne de commande.
`IConfiguration`	`createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator)` Créez une configuration qui ne contient qu'un ensemble d'objets sélectionnés.
`void`	`dumpConfig(String configName, PrintStream out)` Dumps the contents of the configuration to the given `PrintStream`
`List<String>`	`getConfigList(String subPath, boolean loadFromEnv)` Variation de `getConfigList()` où vous pouvez spécifier si vous souhaitez également charger la configuration à partir de l'environnement.
`List<String>`	`getConfigList()` Renvoie la liste des noms de toutes les configurations trouvées dans les fichiers JAR du chemin de classe.
`static IConfigurationFactory`	`getInstance()` Obtenez l'instance singleton `IConfigurationFactory`.
`void`	`loadAllConfigs(boolean discardExceptions)` Charge toutes les configurations trouvées dans les répertoires classpath et de scénarios de test.
`void`	`loadAndPrintAllConfigs()` Méthode utilitaire qui vérifie que toutes les configurations peuvent être chargées et analysées, et que toutes les valeurs d'option sont définies.
`void`	`printHelp(PrintStream out)` Affiche l'aide pour cette usine.
`void`	`printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)` Affiche l'aide pour le `IConfiguration` spécifié dans les arguments de ligne de commande. Si "args" fait référence à une configuration connue, un objet `IConfiguration` sera créé à partir du fichier XML et l'aide pour ce `IConfiguration` sera affichée.

Méthodes protégées
`InputStream`	`getBundledConfigStream(String name)`
`String`	`getConfigPrefix()` Renvoie le préfixe de chemin d'accès des fichiers XML de configuration sur le chemin de classe. Exposé pour que les tests unitaires puissent simuler.
`BufferedInputStream`	`getConfigStream(String name)` Charge un InputStream pour le nom de configuration donné
`ConfigurationDef`	`getConfigurationDef(String name, boolean isGlobal, Map<String, String> templateMap)` Récupérer le `ConfigurationDef` pour le nom donné
`Map<ConfigurationFactory.ConfigId, ConfigurationDef>`	`getMapConfig()` Exposé pour les tests.
`boolean`	`isDirectConfiguration(String configName)`
`String[]`	`reorderArgs(String[] args)` Réorganisez les arguments pour que tous les arguments template:map soient déplacés au début.
`IRemoteFileResolver.ResolvedFile`	`resolveRemoteFile(URI configURI, URI destDir)`

Constructeurs protégés

ConfigurationFactory

protected ConfigurationFactory ()

Méthodes publiques

clearMapConfig

public void clearMapConfig ()

Dans certains cas particuliers, nous devons effacer la carte.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                List<String> unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

Créez le IConfiguration à partir d'arguments de ligne de commande avec un keystore.

Le format attendu est "CONFIG [options]", où CONFIG est le nom de la configuration intégrée ou le chemin d'accès à un fichier XML de configuration.

Paramètres
`arrayArgs`	`String` : arguments de ligne de commande
`unconsumedArgs`	`List` : liste qui sera remplie avec les arguments qui n'ont pas été utilisés par les objets associés à la configuration spécifiée. Si la valeur est `null`, l'implémentation génère `ConfigurationException` si des arguments non traités subsistent.
`keyStoreClient`	`IKeyStoreClient` : `IKeyStoreClient` utilisé pour obtenir des informations sensibles dans les arguments.

Renvoie
`IConfiguration`	le `IConfiguration` chargé. Les champs de l'objet délégué `Option` ont été renseignés avec des valeurs dans les arguments.

Génère
`ConfigurationException`

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                List<String> unconsumedArgs)

Créez le IConfiguration à partir des arguments de ligne de commande.

Le format attendu est "CONFIG [options]", où CONFIG est le nom de la configuration intégrée ou le chemin d'accès à un fichier XML de configuration.

Paramètres
`arrayArgs`	`String` : arguments de ligne de commande
`unconsumedArgs`	`List` : liste qui sera remplie avec les arguments qui n'ont pas été utilisés par les objets associés à la configuration spécifiée. Si la valeur est `null`, l'implémentation génère `ConfigurationException` si des arguments non traités subsistent.

Renvoie
`IConfiguration`	le `IConfiguration` chargé. Les champs de l'objet délégué `Option` ont été renseignés avec des valeurs dans les arguments.

Génère
`ConfigurationException`

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Méthode pratique qui appelle createConfigurationFromArgs(String[],List) avec un deuxième argument null. Par conséquent, il générera ConfigurationException si des arguments non consommés subsistent.

Paramètres
`arrayArgs`	`String`

Renvoie
`IConfiguration`

Génère
`ConfigurationException`

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                List<String> remainingArgs)

Créez un IGlobalConfiguration à partir des arguments de ligne de commande.

Le format attendu est "CONFIG [options]", où CONFIG est le nom de la configuration intégrée ou le chemin d'accès à un fichier XML de configuration.

Paramètres
`arrayArgs`	`String` : arguments de ligne de commande
`remainingArgs`	`List` : liste qui sera remplie avec les arguments qui n'ont pas été traités comme arguments globaux

Renvoie
`IGlobalConfiguration`	le `IGlobalConfiguration` chargé. Les champs de l'objet délégué `Option` ont été renseignés avec des valeurs dans les arguments.

Génère
`ConfigurationException`

createPartialConfigurationFromArgs

public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                Set<String> allowedObjects, 
                TradefedDelegator delegator)

Créez une configuration qui ne contient qu'un ensemble d'objets sélectionnés.

Paramètres
`arrayArgs`	`String` : arguments de ligne de commande
`keyStoreClient`	`IKeyStoreClient` : `IKeyStoreClient` utilisé pour obtenir des informations sensibles dans les arguments.
`allowedObjects`	`Set` : ensemble des objets autorisés à créer.
`delegator`	`TradefedDelegator`

Renvoie
`IConfiguration`	`IConfiguration` chargé.

Génère
`ConfigurationException`

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Dumps the contents of the configuration to the given PrintStream

Paramètres
`configName`	`String` : nom de la configuration
`out`	`PrintStream` : `PrintStream` dans lequel vider le résultat

getConfigList

public List<String> getConfigList (String subPath, 
                boolean loadFromEnv)

Variation de getConfigList() où vous pouvez spécifier si vous souhaitez également charger la configuration à partir de l'environnement.

Paramètres
`subPath`	`String` : nom des sous-répertoires dans lesquels rechercher la configuration. Si la valeur est nulle, le comportement est le même que pour `getConfigList()`.
`loadFromEnv`	`boolean` : "True" si la configuration doit être chargée dans la variable d'environnement.

Renvoie
`List<String>`

getConfigList

public List<String> getConfigList ()

Renvoie la liste des noms de toutes les configurations trouvées dans les fichiers JAR du chemin de classe. N'essaie pas de charger les configurations. Il est donc possible que certaines configurations de cette liste ne fonctionnent pas.

Renvoie
`List<String>`

getInstance

public static IConfigurationFactory getInstance ()

Obtenez l'instance singleton IConfigurationFactory.

Renvoie
`IConfigurationFactory`

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Charge toutes les configurations trouvées dans les répertoires classpath et de scénarios de test.

Paramètres
`discardExceptions`	`boolean` : "true" si une exception ConfigurationException doit être ignorée.

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

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Méthode utilitaire qui vérifie que toutes les configurations peuvent être chargées et analysées, et que toutes les valeurs d'option sont définies. Exposé uniquement pour que le projet dépendant puisse valider ses configurations. Ne doit pas être exposé dans la console.

Génère
`ConfigurationException`	si une ou plusieurs configurations n'ont pas pu être chargées.

printHelp

public void printHelp (PrintStream out)

Affiche l'aide pour cette usine.

Affiche des informations d'aide génériques et liste toutes les configurations disponibles.

Paramètres
`out`	`PrintStream` : `PrintStream` dans lequel vider le résultat

printHelpForConfig

public void printHelpForConfig (String[] args, 
                boolean importantOnly, 
                PrintStream out)

Affiche l'aide pour le IConfiguration spécifié dans les arguments de ligne de commande.

Si "args" fait référence à une configuration connue, un objet IConfiguration sera créé à partir du fichier XML et l'aide pour ce IConfiguration sera affichée. Notez que toutes les autres valeurs "args" seront ignorées (c'est-à-dire que le texte d'aide décrira les valeurs actuelles de Options telles qu'elles sont chargées à partir du fichier XML, et ne reflétera pas les valeurs des options définies par les arguments de ligne de commande).

Si "args" ne fait pas référence à un IConfiguration connu, l'aide générique printHelp(PrintStream) s'affiche.

Paramètres
`args`	`String` : arguments de ligne de commande
`importantOnly`	`boolean` : si la valeur est `true`, n'imprime qu'une liste d'aide abrégée contenant les informations importantes.
`out`	`PrintStream` : `PrintStream` dans lequel vider le résultat

Méthodes protégées

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Paramètres
`name`	`String`

Renvoie
`InputStream`

getConfigPrefix

protected String getConfigPrefix ()

Renvoie le préfixe de chemin d'accès des fichiers XML de configuration sur le chemin de classe.

Exposé pour que les tests unitaires puissent simuler.

Renvoie
`String`	Chemin `String` avec une barre oblique à la fin

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Charge un InputStream pour le nom de configuration donné

Paramètres
`name`	`String` : nom de la configuration à charger

Renvoie
`BufferedInputStream`	`BufferedInputStream` pour lire le contenu de la configuration

Génère
`ConfigurationException`	si la configuration est introuvable.

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                Map<String, String> templateMap)

Récupérer le ConfigurationDef pour le nom donné

Paramètres
`name`	`String` : nom d'une configuration intégrée à charger ou chemin d'accès à un fichier de configuration à charger
`isGlobal`	`boolean`
`templateMap`	`Map`

Renvoie
`ConfigurationDef`	`ConfigurationDef`

Génère
`ConfigurationException`	si une erreur s'est produite lors du chargement de la configuration.

getMapConfig

protected Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig ()

Exposé pour les tests. Renvoie une copie de la carte.

Renvoie
`Map<ConfigurationFactory.ConfigId, ConfigurationDef>`

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Paramètres
`configName`	`String`

Renvoie
`boolean`

reorderArgs

protected String[] reorderArgs (String[] args)

Réorganisez les arguments pour que tous les arguments template:map soient déplacés au début.

Paramètres
`args`	`String`

Renvoie
`String[]`

resolveRemoteFile

protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, 
                URI destDir)

Paramètres
`configURI`	`URI`
`destDir`	`URI`

Renvoie
`IRemoteFileResolver.ResolvedFile`

Génère
`BuildRetrievalError`

ConfigurationFactory

Résumé

Classes imbriquées

Constructeurs protégés

Méthodes publiques

Méthodes protégées

Constructeurs protégés

ConfigurationFactory

Méthodes publiques

clearMapConfig

createConfigurationFromArgs

createConfigurationFromArgs

createConfigurationFromArgs

createGlobalConfigurationFromArgs

createPartialConfigurationFromArgs

dumpConfig

getConfigList

getConfigList

getInstance

loadAllConfigs

loadAndPrintAllConfigs

printHelp

printHelpForConfig

Méthodes protégées

getBundledConfigStream

getConfigPrefix

getConfigStream

getConfigurationDef

getMapConfig

isDirectConfiguration

reorderArgs

resolveRemoteFile