Configurazione globale
public class GlobalConfiguration
extends Object
implements IGlobalConfiguration
java.lang.Object | |
↳ | com.android.tradefed.config.GlobalConfiguration |
Un'implementazione IGlobalConfiguration
che archivia gli oggetti di configurazione caricati in una mappa
Riepilogo
Campi | |
---|---|
public static final String | CREDENTIAL_FACTORY_TYPE_NAME |
public static final String | DEVICE_MANAGER_TYPE_NAME |
public static final String | DEVICE_MONITOR_TYPE_NAME |
public static final String | DEVICE_REQUIREMENTS_TYPE_NAME |
public static final String | GLOBAL_CONFIG_SERVER |
public static final String | GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE |
public static final String | GLOBAL_CONFIG_VARIABLE |
public static final String | HOST_MONITOR_TYPE_NAME |
public static final String | HOST_OPTIONS_TYPE_NAME |
public static final String | HOST_RESOURCE_MANAGER_TYPE_NAME |
public static final String | KEY_STORE_TYPE_NAME |
public static final String | MULTI_DEVICE_RECOVERY_TYPE_NAME |
public static final String | RESOURCE_METRIC_COLLECTOR_TYPE_NAME |
public static final String | SANDBOX_FACTORY_TYPE_NAME |
public static final String | SCHEDULER_TYPE_NAME |
public static final String | SHARDING_STRATEGY_TYPE_NAME |
public static final String | TF_DEVICE_MANAGEMENT_SERVER_NAME |
public static final String | TF_FEATURE_SERVER_NAME |
public static final String | TF_INVOCATION_SERVER_NAME |
public static final String | WTF_HANDLER_TYPE_NAME
|
Metodi pubblici | |
---|---|
void | cleanup () Pulizia adeguata quando si chiude il tradefed. |
File | cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) Filtra la GlobalConfiguration in base a una white list e genera un output in un file XML. |
File | cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) Filtra la GlobalConfiguration in base a una white list consentendo la manipolazione dei valori delle opzioni e l'output in un file XML. |
File | cloneConfigWithFilter (String... allowlistConfigs) Filtra GlobalConfiguration in base a un elenco consentito e genera un output in un file XML. |
static | createGlobalConfiguration (String[] args) Imposta il singleton |
ICommandScheduler | getCommandScheduler () Ottiene l' |
Object | getConfigurationObject (String typeName) Ottiene l'oggetto di configurazione personalizzato con il nome specificato. |
ICredentialFactory | getCredentialFactory () Ottiene |
String | getDescription () |
DeviceManagementGrpcServer | getDeviceManagementServer () Restituisce |
IDeviceManager | getDeviceManager () Ottiene l' |
static IDeviceManager | getDeviceManagerInstance () Restituisce un riferimento all'istanza |
getDeviceMonitors () Ottiene l'elenco di | |
IDeviceSelection | getDeviceRequirements () Ottiene l' |
TradefedFeatureServer | getFeatureServer () Restituisce |
IConfigurationServer | getGlobalConfigServer () Ottiene il server di configurazione globale. |
static | getHostMonitorInstances () |
getHostMonitors () Ottiene l'elenco di | |
IHostOptions | getHostOptions () Ottiene |
IHostResourceManager | getHostResourceManager () Ottiene |
static IGlobalConfiguration | getInstance () Restituisce un riferimento all'istanza |
IKeyStoreFactory | getKeyStoreFactory () Ottiene l' |
getMultiDeviceRecoveryHandlers () Ottiene l'elenco di | |
String | getName () |
getOptionValues (String optionName) Ottieni un elenco di valori dell'opzione. | |
getResourceMetricCollectors () Ottiene l'elenco di | |
ISandboxFactory | getSandboxFactory () Ottieni una sandbox factory che può essere utilizzata per eseguire un'invocazione |
IShardHelper | getShardingStrategy () Restituisce |
TestInvocationManagementServer | getTestInvocationManagementSever () Restituisce |
ITerribleFailureHandler | getWtfHandler () Ottiene l' |
void | injectOptionValue (String optionName, String optionValue) Iniettare un valore di opzione nell'insieme di oggetti di configurazione. |
void | injectOptionValue (String optionName, String optionKey, String optionValue) Iniettare un valore di opzione nell'insieme di oggetti di configurazione. |
void | printCommandUsage (boolean importantOnly, PrintStream out) Emette un testo della guida sull'utilizzo della riga di comando per questa configurazione in un determinato printStream. |
void | setCommandScheduler ( ICommandScheduler scheduler) Impostare |
void | setConfigurationFactory ( IConfigurationFactory configFactory) Impostare |
void | setConfigurationObject (String typeName, Object configObject) Metodo generico per impostare l'oggetto di configurazione con il nome specificato, sostituendo qualsiasi valore esistente. |
void | setConfigurationObjectList (String typeName, configList) setConfigurationObjectList (String typeName, configList) Metodo generico per impostare l'elenco degli oggetti di configurazione per il nome specificato, sostituendo qualsiasi valore esistente. |
void | setDeviceManagementServer ( DeviceManagementGrpcServer server) Imposta il |
void | setDeviceManager ( IDeviceManager manager) Imposta l' |
void | setDeviceMonitor ( IDeviceMonitor monitor) Imposta |
void | setDeviceRequirements ( IDeviceSelection devRequirements) Imposta |
void | setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors) Imposta l'elenco |
void | setHostOptions ( IHostOptions hostOptions) Imposta |
void | setHostResourceManager ( IHostResourceManager hostResourceManager) Imposta |
void | setInvocationServer ( TestInvocationManagementServer server) Imposta il |
void | setKeyStoreFactory ( IKeyStoreFactory factory) Imposta |
setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs) Imposta i campi ArgsOptionParser per il formato previsto | |
void | setOriginalConfig (String config) Imposta la configurazione originale utilizzata per creare la configurazione globale. |
void | setResourceMetricCollector ( IResourceMetricCollector collector) Imposta |
void | setSandboxFactory ( ISandboxFactory factory) Imposta |
void | setShardingStrategy ( IShardHelper sharding) Imposta |
void | setTradefedFeatureServer ( TradefedFeatureServer server) Imposta |
void | setWtfHandler ( ITerribleFailureHandler wtfHandler) Impostare l' |
void | setup () Configurazione corretta all'inizio di tradefed. |
void | validateOptions () Convalida i valori delle opzioni. |
Metodi protetti | |
---|---|
IConfigurationFactory | getConfigurationFactory () |
Campi
CREDENZIAL_FACTORY_TYPE_NAME
public static final String CREDENTIAL_FACTORY_TYPE_NAME
DEVICE_MANAGER_TYPE_NAME
public static final String DEVICE_MANAGER_TYPE_NAME
DEVICE_MONITOR_TYPE_NAME
public static final String DEVICE_MONITOR_TYPE_NAME
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
SERVER_CONFIGURAZIONE_GLOBALE
public static final String GLOBAL_CONFIG_SERVER
GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE
public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE
GLOBAL_CONFIG_VARIABLE
public static final String GLOBAL_CONFIG_VARIABLE
HOST_MONITOR_TYPE_NAME
public static final String HOST_MONITOR_TYPE_NAME
HOST_OPTIONS_TYPE_NAME
public static final String HOST_OPTIONS_TYPE_NAME
HOST_RESOURCE_MANAGER_TYPE_NAME
public static final String HOST_RESOURCE_MANAGER_TYPE_NAME
KEY_STORE_TYPE_NAME
public static final String KEY_STORE_TYPE_NAME
MULTI_DEVICE_RECOVERY_TYPE_NAME
public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME
RESOURCE_METRIC_COLLECTOR_TYPE_NAME
public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME
SANDBOX_FACTORY_TYPE_NAME
public static final String SANDBOX_FACTORY_TYPE_NAME
SCHEDULER_TYPE_NAME
public static final String SCHEDULER_TYPE_NAME
SARDING_STRATEGY_TYPE_NAME
public static final String SHARDING_STRATEGY_TYPE_NAME
TF_DEVICE_MANAGEMENT_SERVER_NAME
public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME
TF_FEATURE_SERVER_NAME
public static final String TF_FEATURE_SERVER_NAME
TF_INVOCATION_SERVER_NAME
public static final String TF_INVOCATION_SERVER_NAME
WTF_HANDLER_TYPE_NAME
public static final String WTF_HANDLER_TYPE_NAME
Metodi pubblici
pulire
public void cleanup ()
Pulizia adeguata quando si chiude il tradefed.
cloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, String... allowlistConfigs)
Filtra la GlobalConfiguration in base a una white list e genera un output in un file XML.
Parametri | |
---|---|
exclusionPatterns | |
allowlistConfigs | String : un array String di configurazioni da includere nel nuovo file XML. Se è impostato su null |
ritorna | |
---|---|
File | il File contenente la nuova configurazione globale filtrata. |
cloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)
Filtra la GlobalConfiguration in base a una white list consentendo la manipolazione dei valori delle opzioni e l'output in un file XML.
Parametri | |
---|---|
exclusionPatterns | |
transformer | IConfigOptionValueTransformer |
deepCopy | boolean |
allowlistConfigs | String : un array String di configurazioni da includere nel nuovo file XML. Se è impostato su null |
ritorna | |
---|---|
File | il File contenente la nuova configurazione globale filtrata. |
cloneConfigWithFilter
public File cloneConfigWithFilter (String... allowlistConfigs)
Filtra GlobalConfiguration in base a un elenco consentito e genera un output in un file XML.
Ad esempio, per la configurazione seguente: <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>
tutta la configurazione tranne "key_store" verrà filtrata e risulterà un file di configurazione con il seguente contenuto: <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>
Parametri | |
---|---|
allowlistConfigs | String : un array String di configurazioni da includere nel nuovo file XML. Se è impostato su null |
ritorna | |
---|---|
File | il File contenente la nuova configurazione globale filtrata. |
createGlobalConfiguration
public staticcreateGlobalConfiguration (String[] args)
Imposta il singleton GlobalConfiguration
per questa istanza TF. Deve essere chiamato una volta e solo una volta, prima che qualcosa tenti di chiamare getInstance()
Parametri | |
---|---|
args | String |
ritorna | |
---|---|
Tiri | |
---|---|
IllegalStateException | se chiamato più di una volta |
ConfigurationException |
getCommandScheduler
public ICommandScheduler getCommandScheduler ()
Ottiene l' ICommandScheduler
da usare dalla configurazione.
ritorna | |
---|---|
ICommandScheduler | l' ICommandScheduler . Non tornerà mai nullo. |
getConfigurationObject
public Object getConfigurationObject (String typeName)
Ottiene l'oggetto di configurazione personalizzato con il nome specificato.
Parametri | |
---|---|
typeName | String : il tipo univoco dell'oggetto di configurazione |
ritorna | |
---|---|
Object | l'oggetto o null se l'oggetto con quel nome non viene trovato |
getCredentialFactory
public ICredentialFactory getCredentialFactory ()
Ottiene ICredentialFactory
per la creazione delle credenziali.
ritorna | |
---|---|
ICredentialFactory | ICredentialFactory o null se non ne è stato specificato nessuno. |
getDescription
public String getDescription ()
ritorna | |
---|---|
String | una breve descrizione leggibile dall'utente questa Configuration |
getDeviceManagementServer
public DeviceManagementGrpcServer getDeviceManagementServer ()
Restituisce DeviceManagementGrpcServer
o null se non definito.
ritorna | |
---|---|
DeviceManagementGrpcServer |
getDevice Manager
public IDeviceManager getDeviceManager ()
Ottiene l' IDeviceManager
da utilizzare dalla configurazione. Gestisce l'insieme dei dispositivi disponibili per il test
ritorna | |
---|---|
IDeviceManager | l' IDeviceManager fornito nella configurazione. |
getDeviceManagerInstance
public static IDeviceManager getDeviceManagerInstance ()
Restituisce un riferimento all'istanza DeviceManager
singleton per questa istanza TF.
ritorna | |
---|---|
IDeviceManager |
Tiri | |
---|---|
IllegalStateException | se createGlobalConfiguration(String[]) non è già stato chiamato. |
getDeviceMonitors
publicgetDeviceMonitors ()
Ottiene l'elenco di IDeviceMonitor
dalla configurazione globale.
ritorna | |
---|---|
l'elenco di IDeviceMonitor dalla configurazione globale o null se non ne è stato specificato nessuno. |
getDeviceRequirements
public IDeviceSelection getDeviceRequirements ()
Ottiene l' IDeviceSelection
da usare dalla configurazione. Rappresenta un filtro globale su cui i dispositivi possono essere visualizzati DeviceManager
.
ritorna | |
---|---|
IDeviceSelection | l' IDeviceSelection fornito nella configurazione. |
getFeatureServer
public TradefedFeatureServer getFeatureServer ()
Restituisce TradefedFeatureServer
o null se non definito.
ritorna | |
---|---|
TradefedFeatureServer |
getGlobalConfigServer
public IConfigurationServer getGlobalConfigServer ()
Ottiene il server di configurazione globale. Il server di configurazione globale viene utilizzato per ottenere le configurazioni dell'host da un server invece di ottenerle dai file locali.
ritorna | |
---|---|
IConfigurationServer |
getHostMonitorInstances
public staticgetHostMonitorInstances ()
ritorna | |
---|---|
getHostMonitors
publicgetHostMonitors ()
Ottiene l'elenco di IHostMonitor
dalla configurazione globale.
ritorna | |
---|---|
l'elenco di IHostMonitor dalla configurazione globale o null se non ne è stato specificato nessuno. |
getHostOptions
public IHostOptions getHostOptions ()
Ottiene IHostOptions
da usare dalla configurazione.
ritorna | |
---|---|
IHostOptions | l' IDeviceManager fornito nella configurazione. |
getHostResourceManager
public IHostResourceManager getHostResourceManager ()
Ottiene IHostResourceManager
dalla configurazione globale.
ritorna | |
---|---|
IHostResourceManager | l' IHostResourceManager dalla configurazione globale o l'implementazione predefinita LocalHostResourceManager se nessuno è specificato nella configurazione dell'host. |
getInstance
public static IGlobalConfiguration getInstance ()
Restituisce un riferimento all'istanza GlobalConfiguration
singleton per questa istanza TF.
ritorna | |
---|---|
IGlobalConfiguration |
Tiri | |
---|---|
IllegalStateException | se createGlobalConfiguration(String[]) non è già stato chiamato. |
getKeyStoreFactory
public IKeyStoreFactory getKeyStoreFactory ()
Ottiene l' IKeyStoreFactory
da usare dalla configurazione.
ritorna | |
---|---|
IKeyStoreFactory | l' IKeyStoreFactory o null se non è impostato alcun key store factory. |
getMultiDeviceRecoveryHandlers
publicgetMultiDeviceRecoveryHandlers ()
Ottiene l'elenco di IMultiDeviceRecovery
da usare dalla configurazione.
ritorna | |
---|---|
l'elenco di IMultiDeviceRecovery o null se non impostato. |
getOptionValues
publicgetOptionValues (String optionName)
Ottieni un elenco di valori dell'opzione.
Parametri | |
---|---|
optionName | String : il nome dell'opzione della mappa |
ritorna | |
---|---|
un elenco dei valori dell'opzione data. null se il nome dell'opzione non esiste. |
getResourceMetricCollectors
publicgetResourceMetricCollectors ()
Ottiene l'elenco di IResourceMetricCollector
dalla configurazione globale.
ritorna | |
---|---|
l'elenco di IResourceMetricCollector dalla configurazione globale o null se non ne è stato specificato nessuno. |
getSandboxFactory
public ISandboxFactory getSandboxFactory ()
Ottieni una sandbox factory che può essere utilizzata per eseguire un'invocazione
ritorna | |
---|---|
ISandboxFactory |
getShardingStrategy
public IShardHelper getShardingStrategy ()
Restituisce IShardHelper
che definisce il modo per partizionare una configurazione.
ritorna | |
---|---|
IShardHelper |
getTestInvocationManagementSever
public TestInvocationManagementServer getTestInvocationManagementSever ()
Restituisce TestInvocationManagementServer
o null se non definito.
ritorna | |
---|---|
TestInvocationManagementServer |
getWtfHandler
public ITerribleFailureHandler getWtfHandler ()
Ottiene l' ITerribleFailureHandler
da usare dalla configurazione. Gestisce cosa fare nel caso in cui si verifichi un WTF (What a Terrible Failure).
ritorna | |
---|---|
ITerribleFailureHandler | l' ITerribleFailureHandler fornito nella configurazione o null se non è impostato alcun gestore |
injectOptionValue
public void injectOptionValue (String optionName, String optionValue)
Iniettare un valore di opzione nell'insieme di oggetti di configurazione.
Utile per fornire valori per le opzioni generate dinamicamente.Parametri | |
---|---|
optionName | String : il nome dell'opzione |
optionValue | String : i valori dell'opzione |
Tiri | |
---|---|
ConfigurationException |
injectOptionValue
public void injectOptionValue (String optionName, String optionKey, String optionValue)
Iniettare un valore di opzione nell'insieme di oggetti di configurazione.
Utile per fornire valori per le opzioni generate dinamicamente.Parametri | |
---|---|
optionName | String : il nome dell'opzione della mappa |
optionKey | String : la chiave di opzione della mappa |
optionValue | String : il valore dell'opzione della mappa |
Tiri | |
---|---|
ConfigurationException |
printCommandUsage
public void printCommandUsage (boolean importantOnly, PrintStream out)
Emette un testo della guida sull'utilizzo della riga di comando per questa configurazione in un determinato printStream.
Parametri | |
---|---|
importantOnly | boolean |
out | PrintStream : ERROR(/PrintStream) da utilizzare. |
Tiri | |
---|---|
ConfigurationException |
setCommandScheduler
public void setCommandScheduler (ICommandScheduler scheduler)
Impostare ICommandScheduler
, sostituendo eventuali valori esistenti.
setConfigurationFactory
public void setConfigurationFactory (IConfigurationFactory configFactory)
Impostare IConfigurationFactory
per questa configurazione.
Parametri | |
---|---|
configFactory | IConfigurationFactory |
setConfigurationObject
public void setConfigurationObject (String typeName, Object configObject)
Metodo generico per impostare l'oggetto di configurazione con il nome specificato, sostituendo qualsiasi valore esistente.
Parametri | |
---|---|
typeName | String : il nome univoco del tipo di oggetto di configurazione. |
configObject | Object : l'oggetto di configurazione |
Tiri | |
---|---|
ConfigurationException |
setConfigurationObjectList
public void setConfigurationObjectList (String typeName,configList)
Metodo generico per impostare l'elenco degli oggetti di configurazione per il nome specificato, sostituendo qualsiasi valore esistente.
Parametri | |
---|---|
typeName | String : il nome univoco del tipo di oggetto di configurazione. |
configList |
Tiri | |
---|---|
ConfigurationException |
setDeviceManagementServer
public void setDeviceManagementServer (DeviceManagementGrpcServer server)
Imposta il DeviceManagementGrpcServer
.
Parametri | |
---|---|
server | DeviceManagementGrpcServer |
setDeviceManager
public void setDeviceManager (IDeviceManager manager)
Imposta l' IDeviceManager
, sostituendo tutti i valori esistenti. Questo imposta il manager per i dispositivi di test
setDeviceMonitor
public void setDeviceMonitor (IDeviceMonitor monitor)
Imposta IDeviceMonitor
.
Parametri | |
---|---|
monitor | IDeviceMonitor : Il monitor |
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
Imposta IDeviceSelection
, sostituendo tutti i valori esistenti. In questo modo viene impostato un filtro dispositivo globale su cui i dispositivi possono essere visualizzati DeviceManager
.
setHostMonitors
public void setHostMonitors (hostMonitors)
Imposta l'elenco IHostMonitor
.
Parametri | |
---|---|
hostMonitors |
setHostOptions
public void setHostOptions (IHostOptions hostOptions)
Imposta IHostOptions
, sostituendo tutti i valori esistenti.
setHostResourceManager
public void setHostResourceManager (IHostResourceManager hostResourceManager)
Imposta IHostResourceManager
, sostituendo tutti i valori esistenti.
setInvocationServer
public void setInvocationServer (TestInvocationManagementServer server)
Imposta il TestInvocationManagementServer
.
Parametri | |
---|---|
server | TestInvocationManagementServer |
setKeyStoreFactory
public void setKeyStoreFactory (IKeyStoreFactory factory)
Imposta IKeyStoreFactory
, sostituendo tutti i valori esistenti.
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
Imposta i campi Option
di configurazione globale con un determinato set di argomenti della riga di comando
ArgsOptionParser
per il formato previstoParametri | |
---|---|
listArgs |
ritorna | |
---|---|
gli argomenti non consumati |
Tiri | |
---|---|
ConfigurationException |
setOriginalConfig
public void setOriginalConfig (String config)
Imposta la configurazione originale utilizzata per creare la configurazione globale.
Parametri | |
---|---|
config | String |
setResourceMetricCollector
public void setResourceMetricCollector (IResourceMetricCollector collector)
Imposta IResourceMetricCollector
.
Parametri | |
---|---|
collector | IResourceMetricCollector |
setSandboxFactory
public void setSandboxFactory (ISandboxFactory factory)
Imposta ISandboxFactory
, sostituendo tutti i valori esistenti.
setShardingStrategy
public void setShardingStrategy (IShardHelper sharding)
Imposta IShardHelper
da utilizzare durante il partizionamento orizzontale di una configurazione.
Parametri | |
---|---|
sharding | IShardHelper |
setTradefedFeatureServer
public void setTradefedFeatureServer (TradefedFeatureServer server)
Imposta TradefedFeatureServer
.
Parametri | |
---|---|
server | TradefedFeatureServer |
setWtfHandler
public void setWtfHandler (ITerribleFailureHandler wtfHandler)
Impostare l' ITerribleFailureHandler
.
Parametri | |
---|---|
wtfHandler | ITerribleFailureHandler : il gestore WTF |
impostare
public void setup ()
Configurazione corretta all'inizio di tradefed.
Tiri | |
---|---|
ConfigurationException |
validateOptions
public void validateOptions ()
Convalida i valori delle opzioni.
Attualmente questo convaliderà solo che tutte le opzioni obbligatorie sono state impostate
Tiri | |
---|---|
ConfigurationException |
Metodi protetti
getConfigurationFactory
protected IConfigurationFactory getConfigurationFactory ()
ritorna | |
---|---|
IConfigurationFactory |