ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Factory zum Erstellen von IConfiguration.

Zusammenfassung

Verschachtelte Klassen

class ConfigurationFactory.ConfigLoader

Implementierung von IConfigDefLoader, die die eingeschlossenen Konfigurationen aus einer Stammkonfiguration verfolgt und bei zirkulären Includes eine Ausnahme auslöst. 

class ConfigurationFactory.ExceptionLoader

 

Geschützte Konstruktoren

ConfigurationFactory()

Öffentliche Methoden

void clearMapConfig()

In einigen Fällen müssen wir die Karte leeren.

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

Erstellen Sie das IConfiguration aus Befehlszeilenargumenten mit einem Keystore.

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

Erstellen Sie die IConfiguration aus Befehlszeilenargumenten.

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

Eine praktische Methode, die createConfigurationFromArgs(String[],List) mit einem zweiten Argument von null aufruft.

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

Erstellen Sie ein IGlobalConfiguration aus Befehlszeilenargumenten.

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

Erstellen Sie eine Konfiguration, die nur eine Reihe ausgewählter Objekte enthält.

void dumpConfig(String configName, PrintStream out)

Gibt den Inhalt der Konfiguration in die angegebene PrintStream aus.

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

Variante von getConfigList(), mit der Sie angeben können, ob die Konfiguration auch aus der Umgebung geladen werden soll.

List<String> getConfigList()

Gibt die Liste der Namen aller Konfigurationen zurück, die in den JARs im Klassenpfad gefunden wurden.

static IConfigurationFactory getInstance()

Rufen Sie die Singleton-Instanz IConfigurationFactory ab.

void loadAllConfigs(boolean discardExceptions)

Lädt alle Konfigurationen, die im Klassenpfad und in den Testfallverzeichnissen gefunden werden.

void loadAndPrintAllConfigs()

Hilfsmethode, die prüft, ob alle Konfigurationen geladen und geparst werden können und alle Optionswerte festgelegt sind.

void printHelp(PrintStream out)

Gibt die Hilfeausgabe für diese Factory aus.

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

Gibt die Hilfeausgabe für das in den Befehlszeilenargumenten angegebene IConfiguration aus.

Wenn sich „args“ auf eine bekannte Konfiguration bezieht, wird ein IConfiguration-Objekt aus XML erstellt und Hilfe für dieses IConfiguration ausgegeben.

Geschützte Methoden

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Gibt das Pfadpräfix von XML-Konfigurationsdateien im Klassenpfad zurück.

Wird bereitgestellt, damit Einheitentests simuliert werden können.

BufferedInputStream getConfigStream(String name)

Lädt einen InputStream für den angegebenen Konfigurationsnamen.

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

ConfigurationDef für den angegebenen Namen abrufen

Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig()

Für Tests verfügbar gemacht.

boolean isDirectConfiguration(String configName)
String[] reorderArgs(String[] args)

Ordnen Sie die Argumente neu an, sodass alle Argumente vom Typ „template:map“ an den Anfang verschoben werden.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

Geschützte Konstruktoren

ConfigurationFactory

protected ConfigurationFactory ()

Öffentliche Methoden

clearMapConfig

public void clearMapConfig ()

In einigen Fällen müssen wir die Karte leeren.

createConfigurationFromArgs

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

Erstellen Sie das IConfiguration aus Befehlszeilenargumenten mit einem Keystore.

Das erwartete Format ist „CONFIG [options]“, wobei CONFIG der Name der integrierten Konfiguration oder ein Dateipfad zu einer XML-Konfigurationsdatei ist.

Parameter
arrayArgs String: die Befehlszeilenargumente
unconsumedArgs List: Eine Liste, die mit den Argumenten gefüllt wird, die nicht von den Objekten verwendet wurden, die mit der angegebenen Konfiguration verknüpft sind. Wenn dies null ist, wird in der Implementierung ConfigurationException ausgelöst, wenn nicht verarbeitete Argumente vorhanden sind.
keyStoreClient IKeyStoreClient: ein IKeyStoreClient, der verwendet wird, um vertrauliche Informationen in den Argumenten abzurufen.
Gibt Folgendes zurück:
IConfiguration die geladene IConfiguration. Die Felder des Delegatobjekts Option wurden mit Werten in „args“ gefüllt.
Löst aus
ConfigurationException

createConfigurationFromArgs

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

Erstellen Sie die IConfiguration aus Befehlszeilenargumenten.

Das erwartete Format ist „CONFIG [options]“, wobei CONFIG der Name der integrierten Konfiguration oder ein Dateipfad zu einer XML-Konfigurationsdatei ist.

Parameter
arrayArgs String: die Befehlszeilenargumente
unconsumedArgs List: Eine Liste, die mit den Argumenten gefüllt wird, die nicht von den Objekten verwendet wurden, die mit der angegebenen Konfiguration verknüpft sind. Wenn dies null ist, wird in der Implementierung ConfigurationException ausgelöst, wenn nicht verarbeitete Argumente vorhanden sind.
Gibt Folgendes zurück:
IConfiguration die geladene IConfiguration. Die Felder des Delegatobjekts Option wurden mit Werten in „args“ gefüllt.
Löst aus
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Eine praktische Methode, die createConfigurationFromArgs(String[],List) mit einem zweiten Argument von null aufruft. Daher wird ConfigurationException ausgegeben, wenn nicht alle Argumente verarbeitet wurden.

Parameter
arrayArgs String

Gibt Folgendes zurück:
IConfiguration

Löst aus
ConfigurationException

createGlobalConfigurationFromArgs

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

Erstellen Sie ein IGlobalConfiguration aus Befehlszeilenargumenten.

Das erwartete Format ist „CONFIG [options]“, wobei CONFIG der Name der integrierten Konfiguration oder ein Dateipfad zu einer XML-Konfigurationsdatei ist.

Parameter
arrayArgs String: die Befehlszeilenargumente
remainingArgs List: Eine Liste, die mit den Argumenten gefüllt wird, die nicht als globale Argumente verarbeitet wurden.
Gibt Folgendes zurück:
IGlobalConfiguration die geladene IGlobalConfiguration. Die Felder des Delegatobjekts Option wurden mit Werten in „args“ gefüllt.
Löst aus
ConfigurationException

createPartialConfigurationFromArgs

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

Erstellen Sie eine Konfiguration, die nur eine Reihe ausgewählter Objekte enthält.

Parameter
arrayArgs String: Die Befehlszeilenargumente
keyStoreClient IKeyStoreClient: Ein IKeyStoreClient, mit dem vertrauliche Informationen in den Argumenten abgerufen werden.
allowedObjects Set: Die Menge der zulässigen Objekte, die erstellt werden können.
delegator TradefedDelegator

Gibt Folgendes zurück:
IConfiguration Die geladenen IConfiguration.
Löst aus
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Gibt den Inhalt der Konfiguration in die angegebene PrintStream aus.

Parameter
configName String: Der Name der Konfiguration
out PrintStream: die PrintStream, in die die Ausgabe geschrieben werden soll

getConfigList

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

Variante von getConfigList(), mit der Sie angeben können, ob die Konfiguration auch aus der Umgebung geladen werden soll.

Parameter
subPath String: Name der Unterverzeichnisse, in denen nach Konfigurationen gesucht werden soll. Bei „null“ entspricht das Verhalten dem von getConfigList().
loadFromEnv boolean: „True“, wenn die Konfiguration in der Umgebungsvariablen geladen werden soll.
Gibt Folgendes zurück:
List<String>

getConfigList

public List<String> getConfigList ()

Gibt die Liste der Namen aller Konfigurationen zurück, die in den JARs im Klassenpfad gefunden wurden. Es wird nicht versucht, eine der Konfigurationen zu laden. Daher kann es sein, dass sich in dieser Liste nicht funktionierende Konfigurationen befinden.

Gibt Folgendes zurück:
List<String>

getInstance

public static IConfigurationFactory getInstance ()

Rufen Sie die Singleton-Instanz IConfigurationFactory ab.

Gibt Folgendes zurück:
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Lädt alle Konfigurationen, die im Klassenpfad und in den Testfallverzeichnissen gefunden werden.

Parameter
discardExceptions boolean: „true“, wenn eine ConfigurationException ignoriert werden soll.
Löst aus
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Hilfsmethode, die prüft, ob alle Konfigurationen geladen und geparst werden können und alle Optionswerte festgelegt sind. Nur verfügbar, damit das abhängige Projekt seine Konfigurationen validieren kann. Sollte nicht in der Konsole verfügbar sein.

Löst aus
ConfigurationException wenn mindestens eine Konfiguration nicht geladen werden konnte

printHelp

public void printHelp (PrintStream out)

Gibt die Hilfeausgabe für diese Factory aus.

Gibt allgemeine Hilfeinformationen aus und listet alle verfügbaren Konfigurationen auf.

Parameter
out PrintStream: die PrintStream, in die die Ausgabe geschrieben werden soll

printHelpForConfig

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

Gibt die Hilfeausgabe für das in den Befehlszeilenargumenten angegebene IConfiguration aus.

Wenn sich „args“ auf eine bekannte Konfiguration bezieht, wird ein IConfiguration-Objekt aus XML erstellt und Hilfe für dieses IConfiguration ausgegeben. Alle anderen „args“-Werte werden ignoriert. Das heißt, im Hilfetext werden die aktuellen Werte von Options beschrieben, die aus XML geladen wurden. Die Werte der Optionen, die über die Befehlszeilenargumente festgelegt wurden, werden nicht berücksichtigt.

Wenn „args“ nicht auf eine bekannte IConfiguration verweist, wird die allgemeine printHelp(PrintStream)-Hilfe angezeigt.

Parameter
args String: die Befehlszeilenargumente
importantOnly boolean: Wenn true, wird eine abgekürzte Hilfe mit nur den wichtigen Details ausgegeben.
out PrintStream: die PrintStream, in die die Ausgabe geschrieben werden soll

Geschützte Methoden

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parameter
name String

Gibt Folgendes zurück:
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Gibt das Pfadpräfix von XML-Konfigurationsdateien im Klassenpfad zurück.

Wird bereitgestellt, damit Einheitentests simuliert werden können.

Gibt Folgendes zurück:
String String-Pfad mit abschließendem Schrägstrich

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Lädt einen InputStream für den angegebenen Konfigurationsnamen.

Parameter
name String: Der Name der zu ladenden Konfiguration.
Gibt Folgendes zurück:
BufferedInputStream BufferedInputStream zum Lesen von Konfigurationsinhalten
Löst aus
ConfigurationException wenn die Konfiguration nicht gefunden werden konnte

getConfigurationDef

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

ConfigurationDef für den angegebenen Namen abrufen

Parameter
name String: der Name einer integrierten Konfiguration, die geladen werden soll, oder ein Dateipfad zu einer Konfigurationsdatei, die geladen werden soll
isGlobal boolean

templateMap Map

Gibt Folgendes zurück:
ConfigurationDef ConfigurationDef
Löst aus
ConfigurationException wenn beim Laden der Konfiguration ein Fehler aufgetreten ist

getMapConfig

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

Für Tests verfügbar gemacht. Gibt eine Kopie der Karte zurück.

Gibt Folgendes zurück:
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parameter
configName String

Gibt Folgendes zurück:
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Ordnen Sie die Argumente neu an, sodass alle Argumente vom Typ „template:map“ an den Anfang verschoben werden.

Parameter
args String

Gibt Folgendes zurück:
String[]

resolveRemoteFile

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

Parameter
configURI URI

destDir URI

Gibt Folgendes zurück:
IRemoteFileResolver.ResolvedFile

Löst aus
BuildRetrievalError