ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Sottoclassi dirette note GCSConfigurationFactory, RetryConfigurationFactory, SandboxConfigurationFactory GCSConfigurationFactory Un ConfigurationFactory carica le configurazioni da Google Cloud Storage.  RetryConfigurationFactory Factory che gestisce i tentativi di ripetizione di un comando.  SandboxConfigurationFactory Fabbrica di configurazioni speciali per gestire la creazione di configurazioni a scopo di sandboxing.

---

Factory per la creazione di IConfiguration.

Riepilogo

Classi nidificate
class	ConfigurationFactory.ConfigLoader Implementazione di IConfigDefLoader che tiene traccia delle configurazioni incluse da una configurazione radice e genera un'eccezione per le inclusioni circolari.
class	ConfigurationFactory.ExceptionLoader

Scuderie protette
ConfigurationFactory()

Metodi pubblici
void	clearMapConfig() In alcuni casi particolari, dobbiamo cancellare la mappa.
IConfiguration	createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient) Crea IConfiguration dagli argomenti della riga di comando con un keystore.
IConfiguration	createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs) Crea IConfiguration dagli argomenti della riga di comando.
IConfiguration	createConfigurationFromArgs(String[] arrayArgs) Un metodo pratico che chiama createConfigurationFromArgs(String[],List) con un secondo argomento null.
IGlobalConfiguration	createGlobalConfigurationFromArgs(String[] arrayArgs, List<String> remainingArgs) Crea un IGlobalConfiguration dagli argomenti della riga di comando.
IConfiguration	createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator) Crea una configurazione che contenga solo un insieme di oggetti selezionati.
void	dumpConfig(String configName, PrintStream out) Scarica i contenuti della configurazione nel file PrintStream specificato
List<String>	getConfigList(String subPath, boolean loadFromEnv) Variante di getConfigList() in cui è possibile specificare se caricare o meno la configurazione dall'ambiente.
List<String>	getConfigList() Restituisce l'elenco dei nomi di tutte le configurazioni trovate nei file JAR nel classpath.
static IConfigurationFactory	getInstance() Ottieni l'istanza singleton IConfigurationFactory.
void	loadAllConfigs(boolean discardExceptions) Carica tutte le configurazioni trovate nelle directory classpath e scenari di test.
void	loadAndPrintAllConfigs() Metodo di utilità che verifica che tutte le configurazioni possano essere caricate, analizzate e che tutti i valori delle opzioni siano impostati.
void	printHelp(PrintStream out) Stampa l'output di assistenza per questa fabbrica.
void	printHelpForConfig(String[] args, boolean importantOnly, PrintStream out) Stampa l'output della guida per IConfiguration specificato negli argomenti della riga di comando. Se "args" si riferisce a una configurazione nota, verrà creato un oggetto IConfiguration da XML e verrà visualizzata la guida per IConfiguration.

Metodi protetti
InputStream	getBundledConfigStream(String name)
String	getConfigPrefix() Restituisce il prefisso del percorso dei file XML di configurazione nel classpath Esposto in modo che i test delle unità possano simulare.
BufferedInputStream	getConfigStream(String name) Carica un InputStream per il nome della configurazione specificato
ConfigurationDef	getConfigurationDef(String name, boolean isGlobal, Map<String, String> templateMap) Recupera ConfigurationDef per il nome specificato.
Map<ConfigurationFactory.ConfigId, ConfigurationDef>	getMapConfig() Esposto per i test.
boolean	isDirectConfiguration(String configName)
String[]	reorderArgs(String[] args) Riordina gli argomenti in modo che gli argomenti template:map vengano spostati tutti all'inizio.
IRemoteFileResolver.ResolvedFile	resolveRemoteFile(URI configURI, URI destDir)

Costruttori protetti

ConfigurationFactory

protected ConfigurationFactory ()

Metodi pubblici

clearMapConfig

public void clearMapConfig ()

In alcuni casi particolari, dobbiamo cancellare la mappa.

createConfigurationFromArgs

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

Crea IConfiguration dagli argomenti della riga di comando con un keystore.

Il formato previsto è "CONFIG [options]", dove CONFIG è il nome della configurazione integrata o un percorso file a un file XML di configurazione.

Parametri
arrayArgs	String: gli argomenti della riga di comando
unconsumedArgs	List: un elenco che verrà compilato con gli argomenti non utilizzati dagli oggetti associati alla configurazione specificata. Se questo è null, l'implementazione genererà ConfigurationException se rimangono argomenti non elaborati.
keyStoreClient	IKeyStoreClient: un IKeyStoreClient utilizzato per ottenere informazioni sensibili negli argomenti.

Resi
IConfiguration	il IConfiguration caricato. I campi dell'oggetto delegato Option sono stati compilati con i valori in args.

Genera
ConfigurationException

createConfigurationFromArgs

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

Crea IConfiguration dagli argomenti della riga di comando.

Il formato previsto è "CONFIG [options]", dove CONFIG è il nome della configurazione integrata o un percorso file a un file XML di configurazione.

Parametri
arrayArgs	String: gli argomenti della riga di comando
unconsumedArgs	List: un elenco che verrà compilato con gli argomenti non utilizzati dagli oggetti associati alla configurazione specificata. Se questo è null, l'implementazione genererà ConfigurationException se rimangono argomenti non elaborati.

Resi
IConfiguration	il IConfiguration caricato. I campi dell'oggetto delegato Option sono stati compilati con i valori in args.

Genera
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Un metodo pratico che chiama createConfigurationFromArgs(String[],List) con un secondo argomento null. Pertanto, genererà ConfigurationException se rimangono argomenti non utilizzati.

Parametri
arrayArgs	String

Resi
IConfiguration

Genera
ConfigurationException

createGlobalConfigurationFromArgs

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

Crea un IGlobalConfiguration dagli argomenti della riga di comando.

Il formato previsto è "CONFIG [options]", dove CONFIG è il nome della configurazione integrata o un percorso file a un file XML di configurazione.

Parametri
arrayArgs	String: gli argomenti della riga di comando
remainingArgs	List: un elenco che verrà compilato con gli argomenti che non sono stati elaborati come argomenti globali

Resi
IGlobalConfiguration	il IGlobalConfiguration caricato. I campi dell'oggetto delegato Option sono stati compilati con i valori in args.

Genera
ConfigurationException

createPartialConfigurationFromArgs

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

Crea una configurazione che contenga solo un insieme di oggetti selezionati.

Parametri
arrayArgs	String: Gli argomenti della riga di comando
keyStoreClient	IKeyStoreClient: un IKeyStoreClient utilizzato per ottenere informazioni sensibili negli argomenti.
allowedObjects	Set: L'insieme di oggetti consentiti da creare
delegator	TradefedDelegator

Resi
IConfiguration	IConfiguration caricato.

Genera
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Scarica i contenuti della configurazione nel file PrintStream specificato

Parametri
configName	String: il nome della configurazione
out	PrintStream: il PrintStream in cui eseguire il dump dell'output

getConfigList

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

Variante di getConfigList() in cui è possibile specificare se caricare o meno la configurazione dall'ambiente.

Parametri
subPath	String: il nome delle sottodirectory in cui cercare la configurazione. Se è nullo, avrà lo stesso comportamento di getConfigList().
loadFromEnv	boolean: True se dobbiamo caricare la configurazione nella variabile di ambiente.

Resi
List<String>

getConfigList

public List<String> getConfigList ()

Restituisce l'elenco dei nomi di tutte le configurazioni trovate nei file JAR nel classpath. Non tenta di caricare nessuna delle configurazioni, quindi è possibile che in questo elenco siano presenti configurazioni non funzionanti.

Resi
List<String>

getInstance

public static IConfigurationFactory getInstance ()

Ottieni l'istanza singleton IConfigurationFactory.

Resi
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Carica tutte le configurazioni trovate nelle directory classpath e scenari di test.

Parametri
discardExceptions	boolean: true se deve essere ignorata qualsiasi ConfigurationException.

Genera
	com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Metodo di utilità che verifica che tutte le configurazioni possano essere caricate, analizzate e che tutti i valori delle opzioni siano impostati. Esposto solo per consentire al progetto dipendente di convalidare le proprie configurazioni. Non deve essere esposto nella console.

Genera
ConfigurationException	se non è stato possibile caricare una o più configurazioni

printHelp

public void printHelp (PrintStream out)

Stampa l'output di assistenza per questa fabbrica.

Stampa informazioni della guida generiche ed elenca tutte le configurazioni disponibili.

Parametri
out	PrintStream: il PrintStream in cui eseguire il dump dell'output

printHelpForConfig

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

Stampa l'output della guida per IConfiguration specificato negli argomenti della riga di comando.

Se "args" si riferisce a una configurazione nota, verrà creato un oggetto IConfiguration da XML e verrà visualizzata la guida per IConfiguration. Tutti gli altri valori "args" verranno ignorati (ovvero il testo della guida descriverà i valori correnti di Option caricati da XML e non rifletterà i valori dell'opzione impostati dagli argomenti della riga di comando.

Se "args" non fa riferimento a un IConfiguration noto, verrà visualizzata la guida generica printHelp(PrintStream).

Parametri
args	String: gli argomenti della riga di comando
importantOnly	boolean: se true, stampa un elenco della guida abbreviato con solo i dettagli importanti
out	PrintStream: il PrintStream in cui eseguire il dump dell'output

Metodi protetti

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parametri
name	String

Resi
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Restituisce il prefisso del percorso dei file XML di configurazione nel classpath

Esposto in modo che i test delle unità possano simulare.

Resi
String	Percorso String con "/" finale

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Carica un InputStream per il nome della configurazione specificato

Parametri
name	String: il nome della configurazione da caricare

Resi
BufferedInputStream	un BufferedInputStream per leggere i contenuti della configurazione

Genera
ConfigurationException	se non è stato possibile trovare la configurazione

getConfigurationDef

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

Recupera ConfigurationDef per il nome specificato.

Parametri
name	String: il nome di una configurazione integrata da caricare o un percorso file del file di configurazione da caricare
isGlobal	boolean
templateMap	Map

Resi
ConfigurationDef	ConfigurationDef

Genera
ConfigurationException	se si è verificato un errore durante il caricamento della configurazione

getMapConfig

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

Esposto per i test. Restituisci una copia della mappa.

Resi
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parametri
configName	String

Resi
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Riordina gli argomenti in modo che gli argomenti template:map vengano spostati tutti all'inizio.

Parametri
args	String

Resi
String[]

resolveRemoteFile

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

Parametri
configURI	URI
destDir	URI

Resi
IRemoteFileResolver.ResolvedFile

Genera
BuildRetrievalError