IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


Eine Klasse, die globale Konfigurationsinformationen für eine einzelne Trade Federation-Instanz umfasst (die eine beliebige Anzahl von Aufrufen tatsächlicher Konfigurationen umfasst).

Zusammenfassung

Öffentliche Methoden

abstract void cleanup ()

Korrekte Bereinigung bei Tradefed-Shutdown.

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

Filtern Sie die GlobalConfiguration basierend auf einer Whitelist und geben Sie sie in eine XML-Datei aus.

abstract File cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)

Filtern Sie die GlobalConfiguration basierend auf einer weißen Liste, während Sie die Manipulation von Optionswerten und die Ausgabe in eine XML-Datei zulassen.

abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtern Sie die GlobalConfiguration basierend auf einer zulässigen Liste und geben Sie sie in eine XML-Datei aus.

abstract ICommandScheduler getCommandScheduler ()

Ruft den zu verwendenden ICommandScheduler aus der Konfiguration ab.

abstract Object getConfigurationObject (String typeName)

Ruft das benutzerdefinierte Konfigurationsobjekt mit dem angegebenen Namen ab.

abstract ICredentialFactory getCredentialFactory ()

Ruft die ICredentialFactory zum Erstellen von Anmeldeinformationen ab.

abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Gibt den DeviceManagementGrpcServer oder null zurück, wenn er nicht definiert ist.

abstract IDeviceManager getDeviceManager ()

Ruft den zu verwendenden IDeviceManager aus der Konfiguration ab.

abstract getDeviceMonitors ()

Ruft die Liste von IDeviceMonitor aus der globalen Konfiguration ab.

abstract IDeviceSelection getDeviceRequirements ()

Ruft die zu verwendende IDeviceSelection aus der Konfiguration ab.

abstract TradefedFeatureServer getFeatureServer ()

Gibt den TradefedFeatureServer oder null zurück, wenn er nicht definiert ist.

abstract IConfigurationServer getGlobalConfigServer ()

Ruft den globalen Konfigurationsserver ab.

abstract getHostMonitors ()

Ruft die Liste von IHostMonitor aus der globalen Konfiguration ab.

abstract IHostOptions getHostOptions ()

Ruft die zu verwendenden IHostOptions aus der Konfiguration ab.

abstract IHostResourceManager getHostResourceManager ()

Ruft den IHostResourceManager aus der globalen Konfiguration ab.

abstract IKeyStoreFactory getKeyStoreFactory ()

Ruft die zu verwendende IKeyStoreFactory aus der Konfiguration ab.

abstract getMultiDeviceRecoveryHandlers ()

Ruft die Liste der zu verwendenden IMultiDeviceRecovery aus der Konfiguration ab.

abstract getOptionValues (String optionName)

Holen Sie sich eine Liste der Werte der Option.

abstract getResourceMetricCollectors ()

Ruft die Liste von IResourceMetricCollector aus der globalen Konfiguration ab.

abstract ISandboxFactory getSandboxFactory ()

Rufen Sie eine Sandbox-Factory ab, die zum Ausführen eines Aufrufs verwendet werden kann

abstract IShardHelper getShardingStrategy ()

Gibt den IShardHelper zurück, der definiert, wie eine Konfiguration fragmentiert wird.

abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Gibt den TestInvocationManagementServer oder null zurück, wenn nicht definiert.

abstract ITerribleFailureHandler getWtfHandler ()

Ruft den zu verwendenden ITerribleFailureHandler aus der Konfiguration ab.

abstract void injectOptionValue (String optionName, String optionValue)

Fügen Sie einen Optionswert in den Satz von Konfigurationsobjekten ein.

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

Fügen Sie einen Optionswert in den Satz von Konfigurationsobjekten ein.

abstract void setCommandScheduler ( ICommandScheduler scheduler)

Legen Sie den ICommandScheduler und ersetzen Sie alle vorhandenen Werte.

abstract void setConfigurationFactory ( IConfigurationFactory configFactory)

Legen Sie die IConfigurationFactory für diese Konfiguration fest.

abstract void setConfigurationObject (String name, Object configObject)

Generische Methode zum Festlegen des Konfigurationsobjekts mit dem angegebenen Namen, wobei alle vorhandenen Werte ersetzt werden.

abstract void setConfigurationObjectList (String typeName, configList) setConfigurationObjectList (String typeName, configList)

Generische Methode zum Festlegen der Konfigurationsobjektliste für den angegebenen Namen, wobei alle vorhandenen Werte ersetzt werden.

abstract void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Legt den DeviceManagementGrpcServer .

abstract void setDeviceManager ( IDeviceManager deviceManager)

Legen Sie den IDeviceManager und ersetzen Sie alle vorhandenen Werte.

abstract void setDeviceMonitor ( IDeviceMonitor deviceMonitor)

Stellen Sie den IDeviceMonitor .

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

Legen Sie die IDeviceSelection und ersetzen Sie alle vorhandenen Werte.

abstract void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

Legen Sie die IHostMonitor Liste fest.

abstract void setHostOptions ( IHostOptions hostOptions)

Legen Sie die IHostOptions und ersetzen Sie alle vorhandenen Werte.

abstract void setHostResourceManager ( IHostResourceManager hostResourceManager)

Legen Sie den IHostResourceManager und ersetzen Sie alle vorhandenen Werte.

abstract void setInvocationServer ( TestInvocationManagementServer server)

Legt den TestInvocationManagementServer .

abstract void setKeyStoreFactory ( IKeyStoreFactory factory)

Legen Sie die IKeyStoreFactory und ersetzen Sie alle vorhandenen Werte.

abstract setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

Legen Sie die Option Konfigurationsoptionsfelder mit dem angegebenen Satz von Befehlszeilenargumenten fest

Siehe ArgsOptionParser für das erwartete Format

abstract void setOriginalConfig (String config)

Legt die ursprüngliche Konfiguration fest, die zum Erstellen der globalen Konfiguration verwendet wurde.

abstract void setResourceMetricCollector ( IResourceMetricCollector collector)

Legt den IResourceMetricCollector .

abstract void setSandboxFactory ( ISandboxFactory factory)

Legen Sie die ISandboxFactory und ersetzen Sie alle vorhandenen Werte.

abstract void setShardingStrategy ( IShardHelper sharding)

Legt den beim IShardHelper einer Konfiguration zu verwendenden IShardHelper fest.

abstract void setTradefedFeatureServer ( TradefedFeatureServer server)

Legt den TradefedFeatureServer .

abstract void setWtfHandler ( ITerribleFailureHandler wtfHandler)

Legen Sie den ITerribleFailureHandler .

abstract void setup ()

Korrektes Setup zu Beginn des Tradefed.

abstract void validateOptions ()

Optionswerte validieren.

Öffentliche Methoden

Aufräumen

public abstract void cleanup ()

Korrekte Bereinigung bei Tradefed-Shutdown.

cloneConfigWithFilter

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

Filtern Sie die GlobalConfiguration basierend auf einer Whitelist und geben Sie sie in eine XML-Datei aus.

Parameter
exclusionPatterns : Das Muster des Klassennamens, das vom Dump ausgeschlossen werden soll.

allowlistConfigs String : ein String -Array von Konfigurationen, die in die neue XML-Datei aufgenommen werden sollen. Wenn es auf null , a default list should be used.

Kehrt zurück
File die Datei, die die neue gefilterte globale Konfiguration enthält.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter ( exclusionPatterns, 
                IConfigOptionValueTransformer transformer, 
                boolean deepCopy, 
                String... allowlistConfigs)

Filtern Sie die GlobalConfiguration basierend auf einer weißen Liste, während Sie die Manipulation von Optionswerten und die Ausgabe in eine XML-Datei zulassen.

Parameter
exclusionPatterns : Das Muster des Klassennamens, das vom Dump ausgeschlossen werden soll.

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String : ein String -Array von Konfigurationen, die in die neue XML-Datei aufgenommen werden sollen. Wenn es auf null , a default list should be used.

Kehrt zurück
File die Datei, die die neue gefilterte globale Konfiguration enthält.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtern Sie die GlobalConfiguration basierend auf einer zulässigen Liste und geben Sie sie in eine XML-Datei aus.

Beispiel für folgende Konfiguration: <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>

Alle Konfigurationen außer „key_store“ werden herausgefiltert und ergeben eine Konfigurationsdatei mit folgendem Inhalt: <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

Parameter
allowlistConfigs String : ein String -Array von Konfigurationen, die in die neue XML-Datei aufgenommen werden sollen. Wenn es auf null , a default list should be used.

Kehrt zurück
File die Datei, die die neue gefilterte globale Konfiguration enthält.

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

Ruft den zu verwendenden ICommandScheduler aus der Konfiguration ab.

Kehrt zurück
ICommandScheduler der ICommandScheduler . Wird niemals null zurückgeben.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

Ruft das benutzerdefinierte Konfigurationsobjekt mit dem angegebenen Namen ab.

Parameter
typeName String : der eindeutige Typ des Konfigurationsobjekts

Kehrt zurück
Object das Objekt oder null, wenn das Objekt mit diesem Namen nicht gefunden wird

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

Ruft die ICredentialFactory zum Erstellen von Anmeldeinformationen ab.

Kehrt zurück
ICredentialFactory ICredentialFactory oder null , wenn nichts angegeben wurde.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

Gibt den DeviceManagementGrpcServer oder null zurück, wenn er nicht definiert ist.

Kehrt zurück
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

Ruft den zu verwendenden IDeviceManager aus der Konfiguration ab. Verwaltet den Satz verfügbarer Geräte zum Testen

Kehrt zurück
IDeviceManager der in der Konfiguration bereitgestellte IDeviceManager .

getDeviceMonitors

public abstract  getDeviceMonitors ()

Ruft die Liste von IDeviceMonitor aus der globalen Konfiguration ab.

Kehrt zurück
die Liste von IDeviceMonitor aus der globalen Konfiguration oder null , wenn keine angegeben wurde.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

Ruft die zu verwendende IDeviceSelection aus der Konfiguration ab. Stellt einen globalen Filter dar, welche Geräte der DeviceManager sehen kann.

Kehrt zurück
IDeviceSelection die in der Konfiguration bereitgestellte IDeviceSelection .

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

Gibt den TradefedFeatureServer oder null zurück, wenn er nicht definiert ist.

Kehrt zurück
TradefedFeatureServer

getGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

Ruft den globalen Konfigurationsserver ab. Der globale Konfigurationsserver wird verwendet, um Hostkonfigurationen von einem Server abzurufen, anstatt sie aus lokalen Dateien abzurufen.

Kehrt zurück
IConfigurationServer

getHostMonitors

public abstract  getHostMonitors ()

Ruft die Liste von IHostMonitor aus der globalen Konfiguration ab.

Kehrt zurück
die Liste von IHostMonitor aus der globalen Konfiguration oder null , wenn keine angegeben wurde.

getHostOptions

public abstract IHostOptions getHostOptions ()

Ruft die zu verwendenden IHostOptions aus der Konfiguration ab.

Kehrt zurück
IHostOptions der in der Konfiguration bereitgestellte IDeviceManager .

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

Ruft den IHostResourceManager aus der globalen Konfiguration ab.

Kehrt zurück
IHostResourceManager der IHostResourceManager aus der globalen Konfiguration oder die Standardimplementierung LocalHostResourceManager , wenn in der Hostkonfiguration keine angegeben ist.

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

Ruft die zu verwendende IKeyStoreFactory aus der Konfiguration ab.

Kehrt zurück
IKeyStoreFactory die IKeyStoreFactory oder null, wenn keine Keystore-Factory festgelegt ist.

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

Ruft die Liste der zu verwendenden IMultiDeviceRecovery aus der Konfiguration ab.

Kehrt zurück
die Liste von IMultiDeviceRecovery oder null , wenn nicht festgelegt.

getOptionValues

public abstract  getOptionValues (String optionName)

Holen Sie sich eine Liste der Werte der Option.

Parameter
optionName String : der Kartenoptionsname

Kehrt zurück
eine Liste der Werte der gegebenen Option. null , wenn der Optionsname nicht existiert.

getResourceMetricCollectors

public abstract  getResourceMetricCollectors ()

Ruft die Liste von IResourceMetricCollector aus der globalen Konfiguration ab.

Kehrt zurück
die Liste von IResourceMetricCollector aus der globalen Konfiguration oder null , wenn keine angegeben wurde.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Rufen Sie eine Sandbox-Factory ab, die zum Ausführen eines Aufrufs verwendet werden kann

Kehrt zurück
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

Gibt den IShardHelper zurück, der definiert, wie eine Konfiguration fragmentiert wird.

Kehrt zurück
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

Gibt den TestInvocationManagementServer oder null zurück, wenn nicht definiert.

Kehrt zurück
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Ruft den zu verwendenden ITerribleFailureHandler aus der Konfiguration ab. Behandelt, was zu tun ist, falls ein WTF (What a Terrible Failure) auftritt.

Kehrt zurück
ITerribleFailureHandler der in der Konfiguration bereitgestellte ITerribleFailureHandler oder null, wenn kein Handler festgelegt ist

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Fügen Sie einen Optionswert in den Satz von Konfigurationsobjekten ein.

Nützlich, um Werte für Optionen bereitzustellen, die dynamisch generiert werden.

Parameter
optionName String : der Optionsname

optionValue String : der/die Optionswert(e)

Wirft
ConfigurationException wenn der Wert der Option nicht festgelegt werden konnte

injectOptionValue

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

Fügen Sie einen Optionswert in den Satz von Konfigurationsobjekten ein.

Nützlich, um Werte für Optionen bereitzustellen, die dynamisch generiert werden.

Parameter
optionName String : der Kartenoptionsname

optionKey String : der Kartenoptionsschlüssel

optionValue String : der Kartenoptionswert

Wirft
ConfigurationException wenn der Wert der Option nicht festgelegt werden konnte

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Legen Sie den ICommandScheduler und ersetzen Sie alle vorhandenen Werte.

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Legen Sie die IConfigurationFactory für diese Konfiguration fest.

Parameter
configFactory IConfigurationFactory

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                Object configObject)

Generische Methode zum Festlegen des Konfigurationsobjekts mit dem angegebenen Namen, wobei alle vorhandenen Werte ersetzt werden.

Parameter
name String : Der eindeutige Name des Konfigurationsobjekttyps.

configObject Object : das Konfigurationsobjekt

Wirft
ConfigurationException wenn das configObject nicht den richtigen Typ hat

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

Generische Methode zum Festlegen der Konfigurationsobjektliste für den angegebenen Namen, wobei alle vorhandenen Werte ersetzt werden.

Parameter
typeName String : Der eindeutige Name des Konfigurationsobjekttyps.

configList : die Konfigurationsobjektliste

Wirft
ConfigurationException wenn Objekte in der Liste nicht den richtigen Typ haben

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Legt den DeviceManagementGrpcServer .

Parameter
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Legen Sie den IDeviceManager und ersetzen Sie alle vorhandenen Werte. Damit wird der Manager für die Testgeräte eingestellt

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Stellen Sie den IDeviceMonitor .

Parameter
deviceMonitor IDeviceMonitor : Der Monitor

Wirft
ConfigurationException wenn bereits ein IDeviceMonitor gesetzt wurde.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Legen Sie die IDeviceSelection und ersetzen Sie alle vorhandenen Werte. Damit wird ein globaler Gerätefilter gesetzt, auf welchen Geräten der DeviceManager sehen kann.

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

Legen Sie die IHostMonitor Liste fest.

Parameter
hostMonitors : Die Liste der Monitore

Wirft
ConfigurationException wenn bereits ein IHostMonitor gesetzt wurde.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Legen Sie die IHostOptions und ersetzen Sie alle vorhandenen Werte.

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Legen Sie den IHostResourceManager und ersetzen Sie alle vorhandenen Werte.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Legt den TestInvocationManagementServer .

Parameter
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Legen Sie die IKeyStoreFactory und ersetzen Sie alle vorhandenen Werte.

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

Legen Sie die Option Konfigurationsoptionsfelder mit dem angegebenen Satz von Befehlszeilenargumenten fest

Siehe ArgsOptionParser für das erwartete Format

Parameter
listArgs : die Kommandozeilenargumente

Kehrt zurück
die unverbrauchten Argumente

Wirft
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

Legt die ursprüngliche Konfiguration fest, die zum Erstellen der globalen Konfiguration verwendet wurde.

Parameter
config String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

Legt den IResourceMetricCollector .

Parameter
collector IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

Legen Sie die ISandboxFactory und ersetzen Sie alle vorhandenen Werte.

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

Legt den beim IShardHelper einer Konfiguration zu verwendenden IShardHelper fest.

Parameter
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Legt den TradefedFeatureServer .

Parameter
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Legen Sie den ITerribleFailureHandler .

Parameter
wtfHandler ITerribleFailureHandler : der WTF-Handler

Wirft
ConfigurationException wenn bereits ein ITerribleFailureHandler gesetzt wurde.

Konfiguration

public abstract void setup ()

Korrektes Setup zu Beginn des Tradefed.

Wirft
ConfigurationException

validateOptions

public abstract void validateOptions ()

Optionswerte validieren.

Derzeit wird dadurch nur überprüft, ob alle obligatorischen Optionen festgelegt wurden

Wirft
ConfigurationException wenn in der Konfiguration Pflichtfelder fehlen