IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


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

Zusammenfassung

Öffentliche Methoden

abstract void cleanup()

Ordnungsgemäße Bereinigung nach dem Tradefed-Shutdown

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

Filtern Sie die GlobalConfiguration anhand einer Zulassungsliste und geben Sie die Ausgabe in eine XML-Datei aus.

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

Filtern Sie die GlobalConfiguration anhand einer Zulassungsliste, während Optionswerte manipuliert und in eine XML-Datei ausgegeben werden können.

abstract File cloneConfigWithFilter(String... allowlistConfigs)

Filtern Sie die GlobalConfiguration anhand einer Zulassungsliste und geben Sie die Ausgabe in eine XML-Datei aus.

abstract ICommandScheduler getCommandScheduler()

Ruft die zu verwendende 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 Anmeldedaten ab.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

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

abstract IDeviceManager getDeviceManager()

Ruft die IDeviceManager ab, die aus der Konfiguration verwendet werden soll.

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 TradefedFeatureServer zurück oder null, wenn nicht definiert.

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 verwendende IHostOptions aus der Konfiguration ab.

abstract IHostResourceManager getHostResourceManager()

Ruft den IHostResourceManager aus der globalen Konfiguration ab.

abstract IKeyStoreFactory getKeyStoreFactory()

Ruft die IKeyStoreFactory ab, die aus der Konfiguration verwendet werden soll.

abstract getMultiDeviceRecoveryHandlers()

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

abstract getOptionValues(String optionName)

Liste der Werte der Option abrufen

abstract getResourceMetricCollectors()

Ruft die Liste von IResourceMetricCollector aus der globalen Konfiguration ab.

abstract ISandboxFactory getSandboxFactory()

Sandbox-Factory abrufen, mit der eine Aufrufanfrage ausgeführt werden kann

abstract IShardHelper getShardingStrategy()

Gibt das IShardHelper zurück, das die Sharding-Methode für eine Konfiguration definiert.

abstract TestInvocationManagementServer getTestInvocationManagementSever()

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

abstract ITerribleFailureHandler getWtfHandler()

Ruft die zu verwendende ITerribleFailureHandler aus der Konfiguration ab.

abstract void injectOptionValue(String optionName, String optionValue)

Einen Optionswert in die Konfigurationsobjekte einfügen

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

Fügen Sie einen Optionswert in die Gruppe von Konfigurationsobjekten ein.

abstract void setCommandScheduler(ICommandScheduler scheduler)

Legen Sie ICommandScheduler fest 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)

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

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

Legt die DeviceManagementGrpcServer fest.

abstract void setDeviceManager(IDeviceManager deviceManager)

Legen Sie IDeviceManager fest und ersetzen Sie alle vorhandenen Werte.

abstract void setDeviceMonitor(IDeviceMonitor deviceMonitor)

Legen Sie IDeviceMonitor fest.

abstract void setDeviceRequirements(IDeviceSelection deviceSelection)

Legen Sie IDeviceSelection fest und ersetzen Sie alle vorhandenen Werte.

abstract void setHostMonitors( hostMonitors)

Legen Sie die Liste IHostMonitor fest.

abstract void setHostOptions(IHostOptions hostOptions)

Legen Sie IHostOptions fest und ersetzen Sie alle vorhandenen Werte.

abstract void setHostResourceManager(IHostResourceManager hostResourceManager)

Legen Sie IHostResourceManager fest und ersetzen Sie alle vorhandenen Werte.

abstract void setInvocationServer(TestInvocationManagementServer server)

Legt TestInvocationManagementServer fest.

abstract void setKeyStoreFactory(IKeyStoreFactory factory)

Legen Sie IKeyStoreFactory fest und ersetzen Sie alle vorhandenen Werte.

abstract setOptionsFromCommandLineArgs( listArgs)

Globale Option-Konfigurationsfelder mit bestimmten Befehlszeilenargumenten festlegen

Informationen zum erwarteten Format finden Sie unter ArgsOptionParser.

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 die IResourceMetricCollector fest.

abstract void setSandboxFactory(ISandboxFactory factory)

Legen Sie ISandboxFactory fest und ersetzen Sie alle vorhandenen Werte.

abstract void setShardingStrategy(IShardHelper sharding)

Legt den IShardHelper fest, der beim Sharding einer Konfiguration verwendet werden soll.

abstract void setTradefedFeatureServer(TradefedFeatureServer server)

Legt TradefedFeatureServer fest.

abstract void setWtfHandler(ITerribleFailureHandler wtfHandler)

Legen Sie ITerribleFailureHandler fest.

abstract void setup()

Korrekte Einrichtung zu Beginn von tradefed.

abstract void validateOptions()

Optionswerte prüfen

Öffentliche Methoden

cleanup

public abstract void cleanup ()

Ordnungsgemäße Bereinigung beim Herunterfahren von Tradef

cloneConfigWithFilter

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

Filtern Sie die GlobalConfiguration anhand einer Zulassungsliste und geben Sie die Ausgabe in eine XML-Datei aus.

Parameter
exclusionPatterns : Das Muster des Klassennamens, der aus dem 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.

festgelegt ist
Returns
File Die Datei mit der neuen gefilterten globalen Konfiguration.

Ausgabe
IOException

Weitere Informationen

KlonConfigWithFilter

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

Filtern Sie die GlobalConfiguration anhand einer Zulassungsliste, während Optionswerte manipuliert und in eine XML-Datei ausgegeben werden können.

Parameter
exclusionPatterns : Das Muster des Klassennamens, der aus dem 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.

gesetzt ist
Returns
File Die Datei mit der neuen gefilterten globalen Konfiguration.

Weitere Informationen

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

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

Beispiel: Für die 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 Konfigurationselemente mit Ausnahme von „key_store“ werden herausgefiltert. Die resultierende Konfigurationsdatei enthält dann den folgenden 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.

festgelegt ist
Returns
File Die Datei mit der neuen gefilterten globalen Konfiguration.

Ausgabe
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

Ruft die zu verwendende ICommandScheduler aus der Konfiguration ab.

Returns
ICommandScheduler die ICommandScheduler. Gibt niemals null zurück.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

Ruft das benutzerdefinierte Konfigurationsobjekt mit dem angegebenen Namen ab.

Parameter
typeName String: der eindeutige Typ des Konfigurationsobjekts

Returns
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 Anmeldedaten ab.

Returns
ICredentialFactory ICredentialFactory oder null, wenn kein Wert angegeben wurde.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

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

Returns
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

Ruft die zu verwendende IDeviceManager aus der Konfiguration ab. Verwaltet die verfügbaren Geräte für Tests

Returns
IDeviceManager der in der Konfiguration angegebene IDeviceManager.

getDeviceMonitors

public abstract  getDeviceMonitors ()

Ruft die Liste von IDeviceMonitor aus der globalen Konfiguration ab.

Returns
die Liste der 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, der festlegt, auf welchen Geräten die DeviceManager angezeigt werden kann.

Returns
IDeviceSelection der in der Konfiguration angegebene IDeviceSelection.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

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

Returns
TradefedFeatureServer

getGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

Ruft den globalen Konfigurationsserver ab. Über den globalen Konfigurationsserver werden Hostkonfigurationen von einem Server abgerufen, anstatt von lokalen Dateien.

Returns
IConfigurationServer

getHostMonitors

public abstract  getHostMonitors ()

Ruft die Liste der IHostMonitor aus der globalen Konfiguration ab.

Returns
die Liste der IHostMonitor aus der globalen Konfiguration oder null, wenn keine angegeben wurde.

getHostOptions

public abstract IHostOptions getHostOptions ()

Ruft die zu verwendende IHostOptions aus der Konfiguration ab.

Returns
IHostOptions Das in der Konfiguration angegebene IDeviceManager.

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

Ruft den IHostResourceManager aus der globalen Konfiguration ab.

Returns
IHostResourceManager IHostResourceManager aus der globalen Konfiguration oder die Standardimplementierung LocalHostResourceManager, falls in der Hostkonfiguration keine angegeben ist.

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

Ruft die zu verwendende IKeyStoreFactory aus der Konfiguration ab.

Returns
IKeyStoreFactory die IKeyStoreFactory oder „null“, wenn keine Schlüsselspeicher-Fabrik festgelegt ist.

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

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

Returns
die Liste von IMultiDeviceRecovery oder null, wenn sie nicht festgelegt ist.

getOptionValues

public abstract  getOptionValues (String optionName)

Rufen Sie eine Liste mit den Werten der Option ab.

Parameter
optionName String: der Name der Kartenoption

Returns
eine Liste der Werte der angegebenen Option. null, wenn der Optionsname nicht vorhanden ist.

getResourceMetricCollectors

public abstract  getResourceMetricCollectors ()

Ruft die Liste der IResourceMetricCollector aus der globalen Konfiguration ab.

Returns
die Liste der IResourceMetricCollector aus der globalen Konfiguration oder null , falls keine angegeben wurde.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Sandbox-Factory abrufen, mit der eine Aufrufanfrage ausgeführt werden kann

Returns
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

Gibt das IShardHelper zurück, das die Fragmentierung der Konfiguration definiert.

Returns
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

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

Returns
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Ruft die zu verwendende ITerribleFailureHandler aus der Konfiguration ab. Gibt an, was zu tun ist, wenn eine WTF-Datei (What a Terrible Failure) auftritt.

Returns
ITerribleFailureHandler der in der Konfiguration angegebene ITerribleFailureHandler oder „null“, wenn kein Handler festgelegt ist

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Einen Optionswert in die Konfigurationsobjekte einfügen

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

Parameter
optionName String: der Name der Option

optionValue String: die Optionswerte

Ausgabe
ConfigurationException if failed to set the option's value

injectOptionValue

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

Einen Optionswert in die Konfigurationsobjekte einfügen

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

Parameter
optionName String: der Name der Kartenoption

optionKey String: der Schlüssel für die Kartenoption

optionValue String: der Wert der Zuordnungsoption

Ausgabe
ConfigurationException if failed to set the option's value

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Legen Sie ICommandScheduler fest 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

Ausgabe
ConfigurationException wenn das configObject nicht vom richtigen Typ war

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

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

Parameter
typeName String: der eindeutige Name des Konfigurationsobjekttyps.

configList : die Liste der Konfigurationsobjekte

Ausgabe
ConfigurationException Objekte in der Liste sind nicht vom richtigen Typ.

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Legt DeviceManagementGrpcServer fest.

Parameter
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Legen Sie IDeviceManager fest und ersetzen Sie alle vorhandenen Werte. Dadurch wird der Manager für die Testgeräte festgelegt

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

Legen Sie IDeviceMonitor fest.

Parameter
deviceMonitor IDeviceMonitor: Der Monitor

Ausgabe
ConfigurationException wenn bereits eine IDeviceMonitor festgelegt wurde.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Legen Sie IDeviceSelection fest und ersetzen Sie alle vorhandenen Werte. Dadurch wird ein globaler Gerätefilter festgelegt, der festlegt, auf welchen Geräten die DeviceManager angezeigt werden kann.

setHostMonitors

public abstract void setHostMonitors ( hostMonitors)

Legen Sie die Liste IHostMonitor fest.

Parameter
hostMonitors : Die Liste der Monitore

Ausgabe
ConfigurationException wenn bereits ein IHostMonitor festgelegt wurde.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Legen Sie IHostOptions fest und ersetzen Sie alle vorhandenen Werte.

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Legen Sie IHostResourceManager fest und ersetzen Sie alle vorhandenen Werte.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Legt TestInvocationManagementServer fest.

Parameter
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Legen Sie IKeyStoreFactory fest und ersetzen Sie alle vorhandenen Werte.

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

Legen Sie die globalen Option-Konfigurationsfelder mit dem angegebenen Satz von Befehlszeilenargumenten fest

Das erwartete Format findest du unter ArgsOptionParser

Parameter
listArgs : Befehlszeilenargumente

Returns
nicht verbrauchten Argumenten

Ausgabe
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 die IResourceMetricCollector fest.

Parameter
collector IResourceMetricCollector

SetSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

Legen Sie ISandboxFactory fest und ersetzen Sie alle vorhandenen Werte.

SetShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

Legt den IShardHelper fest, der beim Sharding einer Konfiguration verwendet werden soll.

Parameter
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

Legt TradefedFeatureServer fest.

Parameter
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Legen Sie ITerribleFailureHandler fest.

Parameter
wtfHandler ITerribleFailureHandler: der WTF-Handler

Ausgabe
ConfigurationException wenn bereits eine ITerribleFailureHandler festgelegt wurde.

einrichten

public abstract void setup ()

Korrekte Einrichtung zu Beginn von tradefed.

Ausgabe
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

Validiert Optionswerte.

Derzeit wird nur geprüft, ob alle Pflichtoptionen festgelegt wurden.

Ausgabe
ConfigurationException ob in der Konfiguration Pflichtfelder fehlen