IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

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

Zusammenfassung

Öffentliche Methoden

abstract void cleanup()

Ordnungsgemäße Bereinigung beim Herunterfahren von Tradefed.

abstract File cloneConfigWithFilter(String... allowlistConfigs)

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

abstract File cloneConfigWithFilter(Set<String> exclusionPatterns, String... allowlistConfigs)

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

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

Filtern der GlobalConfiguration anhand einer Zulassungsliste, wobei die Bearbeitung von Optionswerten und die Ausgabe in eine XML-Datei zulässig sind.

abstract ICommandScheduler getCommandScheduler()

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

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

abstract IDeviceManager getDeviceManager()

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

abstract List<IDeviceMonitor> getDeviceMonitors()

Ruft die Liste der IDeviceMonitor aus der globalen Konfiguration ab.

abstract IDeviceSelection getDeviceRequirements()

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

abstract TradefedFeatureServer getFeatureServer()

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

abstract IConfigurationServer getGlobalConfigServer()

Ruft den globalen Konfigurationsserver ab.

abstract List<IHostMonitor> getHostMonitors()

Ruft die Liste der IHostMonitor aus der globalen Konfiguration ab.

abstract IHostOptions getHostOptions()

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

abstract IHostResourceManager getHostResourceManager()

Ruft die IHostResourceManager aus der globalen Konfiguration ab.

abstract IKeyStoreFactory getKeyStoreFactory()

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

abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers()

Ruft die Liste der IMultiDeviceRecovery ab, die aus der Konfiguration verwendet werden sollen.

abstract List<String> getOptionValues(String optionName)

Eine Liste der Werte einer Option abrufen.

abstract List<IResourceMetricCollector> getResourceMetricCollectors()

Ruft die Liste der IResourceMetricCollector aus der globalen Konfiguration ab.

abstract ISandboxFactory getSandboxFactory()

Eine Sandbox-Factory abrufen, mit der ein Aufruf ausgeführt werden kann

abstract IShardHelper getShardingStrategy()

Gibt das IShardHelper zurück, das die Art und Weise definiert, wie eine Konfiguration aufgeteilt wird.

abstract TestInvocationManagementServer getTestInvocationManagementSever()

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

abstract ITerribleFailureHandler getWtfHandler()

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

abstract void injectOptionValue(String optionName, String optionValue)

Fügen Sie einen Optionswert in die Gruppe der Konfigurationsobjekte ein.

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

Fügen Sie einen Optionswert in die Gruppe der Konfigurationsobjekte ein.

abstract void setCommandScheduler(ICommandScheduler scheduler)

Legen Sie ICommandScheduler fest. Alle vorhandenen Werte werden ersetzt.

abstract void setConfigurationFactory(IConfigurationFactory configFactory)

Legen Sie IConfigurationFactory für diese Konfiguration fest.

abstract void setConfigurationObject(String name, Object configObject)

Generische Methode zum Festlegen des Konfigurationsobjekts mit dem angegebenen Namen. Alle vorhandenen Werte werden ersetzt.

abstract void setConfigurationObjectList(String typeName, List<?> configList)

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

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

Legt DeviceManagementGrpcServer fest.

abstract void setDeviceManager(IDeviceManager deviceManager)

Legen Sie IDeviceManager fest. Alle vorhandenen Werte werden ersetzt.

abstract void setDeviceMonitor(IDeviceMonitor deviceMonitor)

Legen Sie IDeviceMonitor fest.

abstract void setDeviceRequirements(IDeviceSelection deviceSelection)

Legen Sie IDeviceSelection fest. Alle vorhandenen Werte werden ersetzt.

abstract void setHostMonitors(List<IHostMonitor> hostMonitors)

Legen Sie die Liste IHostMonitor fest.

abstract void setHostOptions(IHostOptions hostOptions)

Legen Sie IHostOptions fest. Alle vorhandenen Werte werden ersetzt.

abstract void setHostResourceManager(IHostResourceManager hostResourceManager)

Legen Sie IHostResourceManager fest. Alle vorhandenen Werte werden ersetzt.

abstract void setInvocationServer(TestInvocationManagementServer server)

Legt TestInvocationManagementServer fest.

abstract void setKeyStoreFactory(IKeyStoreFactory factory)

Legen Sie IKeyStoreFactory fest. Alle vorhandenen Werte werden ersetzt.

abstract List<String> setOptionsFromCommandLineArgs(List<String> listArgs)

Globale Konfigurationsfelder Option mit einer bestimmten Gruppe von 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 IResourceMetricCollector fest.

abstract void setSandboxFactory(ISandboxFactory factory)

Legen Sie ISandboxFactory fest. Alle vorhandenen Werte werden ersetzt.

abstract void setShardingStrategy(IShardHelper sharding)

Legt die IShardHelper fest, die 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()

Ordnungsgemäße Einrichtung zu Beginn von Tradefed.

abstract void validateOptions()

Validiert Optionswerte.

Öffentliche Methoden

cleanup

public abstract void cleanup ()

Ordnungsgemäße Bereinigung beim Herunterfahren von Tradefed.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

Filtern Sie die GlobalConfiguration anhand einer Zulassungsliste und geben Sie sie in einer 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 Konfigurationen außer „key_store“ werden herausgefiltert. Die resultierende Konfigurationsdatei hat folgenden Inhalt: <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

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

 festgelegt ist
Gibt Folgendes zurück:
File Die Datei mit der neuen gefilterten globalen Konfiguration.
Löst aus
java.io.IOException
IOException

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (Set<String> exclusionPatterns, 
                String... allowlistConfigs)

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

Parameter
exclusionPatterns Set: Das Muster des Klassennamens, der aus dem Dump ausgeschlossen werden soll.
allowlistConfigs String: Ein String-Array mit Konfigurationen, die in die neue XML-Datei aufgenommen werden sollen. Wenn es auf null, a default list should be used.

 festgelegt ist
Gibt Folgendes zurück:
File Die Datei mit der neuen gefilterten globalen Konfiguration.
Löst aus
java.io.IOException
IOException

Weitere Informationen

cloneConfigWithFilter

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

Filtern der GlobalConfiguration anhand einer Zulassungsliste, wobei die Bearbeitung von Optionswerten und die Ausgabe in eine XML-Datei zulässig sind.

Parameter
exclusionPatterns Set: Das Muster des Klassennamens, der aus dem Dump ausgeschlossen werden soll.
transformer IConfigOptionValueTransformer

deepCopy boolean

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

 festgelegt ist
Gibt Folgendes zurück:
File Die Datei mit der neuen gefilterten globalen Konfiguration.
Löst aus
IOException

Weitere Informationen

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

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

Gibt Folgendes zurück:
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
Gibt Folgendes zurück:
Object Das Objekt oder „null“, wenn kein Objekt mit diesem Namen gefunden wird.

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

Ruft die ICredentialFactory zum Erstellen von Anmeldedaten ab.

Gibt Folgendes zurück:
ICredentialFactory ICredentialFactory oder null, wenn kein Wert angegeben wurde.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

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

Gibt Folgendes zurück:
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

Ruft die IDeviceManager ab, die aus der Konfiguration verwendet werden soll. Verwaltet die verfügbaren Geräte für Tests

Gibt Folgendes zurück:
IDeviceManager die in der Konfiguration angegebene IDeviceManager.

getDeviceMonitors

public abstract List<IDeviceMonitor> getDeviceMonitors ()

Ruft die Liste der IDeviceMonitor aus der globalen Konfiguration ab.

Gibt Folgendes zurück:
List<IDeviceMonitor> Die Liste der IDeviceMonitor aus der globalen Konfiguration oder null, wenn keine angegeben wurde.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

Ruft die IDeviceSelection ab, die aus der Konfiguration verwendet werden soll. Stellt einen globalen Filter für die Geräte dar, die DeviceManager sehen kann.

Gibt Folgendes zurück:
IDeviceSelection die in der Konfiguration angegebene IDeviceSelection.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

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

Gibt Folgendes 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 zu beziehen.

Gibt Folgendes zurück:
IConfigurationServer

getHostMonitors

public abstract List<IHostMonitor> getHostMonitors ()

Ruft die Liste der IHostMonitor aus der globalen Konfiguration ab.

Gibt Folgendes zurück:
List<IHostMonitor> Die Liste der IHostMonitor aus der globalen Konfiguration oder null, wenn keine angegeben wurde.

getHostOptions

public abstract IHostOptions getHostOptions ()

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

Gibt Folgendes zurück:
IHostOptions die in der Konfiguration angegebene IDeviceManager.

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

Ruft die IHostResourceManager aus der globalen Konfiguration ab.

Gibt Folgendes zurück:
IHostResourceManager IHostResourceManager aus der globalen Konfiguration oder die Standardimplementierung LocalHostResourceManager, falls keine in der Hostkonfiguration angegeben ist.

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

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

Gibt Folgendes zurück:
IKeyStoreFactory IKeyStoreFactory oder null, wenn keine Schlüsselspeicher-Factory festgelegt ist.

getMultiDeviceRecoveryHandlers

public abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers ()

Ruft die Liste der IMultiDeviceRecovery ab, die aus der Konfiguration verwendet werden sollen.

Gibt Folgendes zurück:
List<IMultiDeviceRecovery> Die Liste der IMultiDeviceRecovery oder null, wenn sie nicht festgelegt ist.

getOptionValues

public abstract List<String> getOptionValues (String optionName)

Eine Liste der Werte einer Option abrufen.

Parameter
optionName String: der Name der Kartenoption
Gibt Folgendes zurück:
List<String> Eine Liste der Werte der angegebenen Option. null, wenn der Optionsname nicht vorhanden ist.

getResourceMetricCollectors

public abstract List<IResourceMetricCollector> getResourceMetricCollectors ()

Ruft die Liste der IResourceMetricCollector aus der globalen Konfiguration ab.

Gibt Folgendes zurück:
List<IResourceMetricCollector> Die Liste der IResourceMetricCollector aus der globalen Konfiguration oder null , wenn keine angegeben wurde.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

Eine Sandbox-Factory abrufen, mit der ein Aufruf ausgeführt werden kann

Gibt Folgendes zurück:
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

Gibt das IShardHelper zurück, das die Art und Weise definiert, wie eine Konfiguration aufgeteilt wird.

Gibt Folgendes zurück:
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

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

Gibt Folgendes zurück:
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

Ruft die ITerribleFailureHandler ab, die aus der Konfiguration verwendet werden soll. Behandelt, was im Falle eines WTF-Fehlers (What a Terrible Failure) zu tun ist.

Gibt Folgendes zurück:
ITerribleFailureHandler die in der Konfiguration angegebene ITerribleFailureHandler oder „null“, wenn kein Handler festgelegt ist

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

Fügen Sie einen Optionswert in die Gruppe der Konfigurationsobjekte ein.

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

Parameter
optionName String: der Name der Option
optionValue String: der/die Optionswert(e)
Löst aus
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 die Gruppe der Konfigurationsobjekte ein.

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 Kartenoption
Löst aus
ConfigurationException wenn der Wert der Option nicht festgelegt werden konnte

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Legen Sie ICommandScheduler fest. Alle vorhandenen Werte werden ersetzt.

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

Legen Sie 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. Alle vorhandenen Werte werden ersetzt.

Parameter
name String: der eindeutige Name des Konfigurationsobjekttyps.
configObject Object: das Konfigurationsobjekt
Löst aus
ConfigurationException wenn das configObject nicht den richtigen Typ hatte

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                List<?> configList)

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

Parameter
typeName String: der eindeutige Name des Konfigurationsobjekttyps.
configList List: die Liste der Konfigurationsobjekte
Löst aus
ConfigurationException wenn Objekte in der Liste nicht den richtigen Typ haben

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Legt DeviceManagementGrpcServer fest.

Parameter
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Legen Sie IDeviceManager fest. Alle vorhandenen Werte werden ersetzt. Damit 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
Löst aus
ConfigurationException wenn bereits ein IDeviceMonitor festgelegt wurde.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

Legen Sie IDeviceSelection fest. Alle vorhandenen Werte werden ersetzt. Damit wird ein globaler Gerätefilter festgelegt, der bestimmt, welche Geräte die DeviceManager sehen kann.

setHostMonitors

public abstract void setHostMonitors (List<IHostMonitor> hostMonitors)

Legen Sie die Liste IHostMonitor fest.

Parameter
hostMonitors List: Die Liste der Monitore
Löst aus
ConfigurationException wenn bereits ein IHostMonitor festgelegt wurde.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

Legen Sie IHostOptions fest. Alle vorhandenen Werte werden ersetzt.

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

Legen Sie IHostResourceManager fest. Alle vorhandenen Werte werden ersetzt.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Legt TestInvocationManagementServer fest.

Parameter
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

Legen Sie IKeyStoreFactory fest. Alle vorhandenen Werte werden ersetzt.

setOptionsFromCommandLineArgs

public abstract List<String> setOptionsFromCommandLineArgs (List<String> listArgs)

Globale Konfigurationsfelder Option mit einer bestimmten Gruppe von Befehlszeilenargumenten festlegen

Informationen zum erwarteten Format finden Sie unter ArgsOptionParser.

Parameter
listArgs List: die Befehlszeilenargumente
Gibt Folgendes zurück:
List<String> die nicht verwendeten Argumente
Löst aus
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 IResourceMetricCollector fest.

Parameter
collector IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

Legen Sie ISandboxFactory fest. Alle vorhandenen Werte werden ersetzt.

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

Legt die IShardHelper fest, die 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
Löst aus
ConfigurationException wenn bereits ein ITerribleFailureHandler festgelegt wurde.

Einrichtung

public abstract void setup ()

Ordnungsgemäße Einrichtung zu Beginn von Tradefed.

Löst aus
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

Validiert Optionswerte.

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

Löst aus
ConfigurationException Ob in der Konfiguration Pflichtfelder fehlen