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 ( 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 Whitelist und ermöglichen Sie gleichzeitig die Manipulation von Optionswerten und die Ausgabe in eine XML-Datei.

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 nicht definiert.

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 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 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)

Rufen Sie eine Liste der Optionswerte ab.

abstract getResourceMetricCollectors ()

Ruft die Liste von IResourceMetricCollector aus der globalen Konfiguration ab.

abstract ISandboxFactory getSandboxFactory ()

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

abstract IShardHelper getShardingStrategy ()

Gibt den IShardHelper zurück, der die Art und Weise zum Shardieren einer Konfiguration definiert.

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 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) 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 fest.

abstract void setDeviceManager ( IDeviceManager deviceManager)

Legen Sie den IDeviceManager fest und ersetzen Sie alle vorhandenen Werte.

abstract void setDeviceMonitor ( IDeviceMonitor deviceMonitor)

Legen Sie den IDeviceMonitor fest.

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

Legen Sie IDeviceSelection fest 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 IHostOptions fest und ersetzen Sie alle vorhandenen Werte.

abstract void setHostResourceManager ( IHostResourceManager hostResourceManager)

Legen Sie den IHostResourceManager fest und ersetzen Sie alle vorhandenen Werte.

abstract void setInvocationServer ( TestInvocationManagementServer server)

Legt den TestInvocationManagementServer fest.

abstract void setKeyStoreFactory ( IKeyStoreFactory factory)

Legen Sie IKeyStoreFactory fest und ersetzen Sie alle vorhandenen Werte.

abstract setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

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

Das erwartete 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 den 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 den TradefedFeatureServer fest.

abstract void setWtfHandler ( ITerribleFailureHandler wtfHandler)

Legen Sie den ITerribleFailureHandler fest.

abstract void setup ()

Richtiges Setup zu Beginn von Tradefed.

abstract void validateOptions ()

Optionswerte validieren.

Öffentliche Methoden

Aufräumen

public abstract void cleanup ()

Ordnungsgemäße Bereinigung beim Herunterfahren von Tradefed.

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, 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.
Kehrt zurück
File die Datei, die die neue gefilterte globale Konfiguration enthält.

Würfe
IOException

cloneConfigWithFilter

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

Filtern Sie die GlobalConfiguration basierend auf einer Whitelist und ermöglichen Sie gleichzeitig die Manipulation von Optionswerten und die Ausgabe in eine XML-Datei.

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.
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.

Zum 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 und es entsteht 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.

Würfe
IOException

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 keine angegeben wurde.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

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

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, auf welchen Geräten 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 nicht definiert.

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 keiner 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 Schlüsselspeicherfabrik 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)

Rufen Sie eine Liste der Optionswerte ab.

Parameter
optionName String : der Name der Kartenoption

Kehrt zurück
eine Liste der Werte der angegebenen Option. null , wenn der Optionsname nicht vorhanden ist.

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 ()

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

Kehrt zurück
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

Gibt den IShardHelper zurück, der die Art und Weise zum Shardieren einer Konfiguration definiert.

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, wenn 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)

Würfe
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 Name der Kartenoption

optionKey String : der Kartenoptionsschlüssel

optionValue String : der Kartenoptionswert

Würfe
ConfigurationException wenn der Wert der Option nicht festgelegt werden konnte

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

Legen Sie den 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

Würfe
ConfigurationException wenn das configObject nicht den richtigen Typ hatte

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

Würfe
ConfigurationException wenn Objekte in der Liste nicht den richtigen Typ haben

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

Legt den DeviceManagementGrpcServer fest.

Parameter
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

Legen Sie den 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 den IDeviceMonitor fest.

Parameter
deviceMonitor IDeviceMonitor : Der Monitor

Würfe
ConfigurationException wenn bereits ein 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, 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

Würfe
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 den IHostResourceManager fest und ersetzen Sie alle vorhandenen Werte.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

Legt den 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 mit dem angegebenen Satz von Befehlszeilenargumenten fest

Das erwartete Format finden Sie unter ArgsOptionParser

Parameter
listArgs : die Befehlszeilenargumente

Kehrt zurück
die unverbrauchten Argumente

Würfe
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 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 den TradefedFeatureServer fest.

Parameter
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

Legen Sie den ITerribleFailureHandler fest.

Parameter
wtfHandler ITerribleFailureHandler : der WTF-Handler

Würfe
ConfigurationException wenn bereits ein ITerribleFailureHandler festgelegt wurde.

aufstellen

public abstract void setup ()

Richtiges Setup zu Beginn von Tradefed.

Würfe
com.android.tradefed.config.ConfigurationException
ConfigurationException

validierungsoptionen

public abstract void validateOptions ()

Optionswerte validieren.

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

Würfe
ConfigurationException wenn in der Konfiguration Pflichtfelder fehlen