IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


מחלקת מידע על הגדרות גלובליות של מופע יחיד של Trade Federation (כולל כל מספר של הפעלות של הגדרות בפועל).

סיכום

‫methods ציבוריים

abstract void cleanup()

ניקוי תקין כשמבצעים כיבוי של tradefed.

abstract File cloneConfigWithFilter(String... allowlistConfigs)

מסננים את GlobalConfiguration על סמך רשימת ההיתרים ומייצאים לקובץ XML.

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

סינון GlobalConfiguration על סמך רשימת היתרים ופלט לקובץ XML.

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

סינון של GlobalConfiguration על סמך רשימת היתרים, תוך מתן אפשרות לשינוי של ערכי האפשרויות ופלט לקובץ XML.

abstract ICommandScheduler getCommandScheduler()

הפונקציה מקבלת את ICommandScheduler לשימוש מההגדרה.

abstract Object getConfigurationObject(String typeName)

מקבל את אובייקט ההגדרה בהתאמה אישית עם השם שצוין.

abstract ICredentialFactory getCredentialFactory()

קבלת ICredentialFactory ליצירת פרטי כניסה.

abstract DeviceManagementGrpcServer getDeviceManagementServer()

הפונקציה מחזירה את הערך DeviceManagementGrpcServer או null אם הוא לא מוגדר.

abstract IDeviceManager getDeviceManager()

הפונקציה מקבלת את IDeviceManager לשימוש מההגדרה.

abstract List<IDeviceMonitor> getDeviceMonitors()

הפונקציה מקבלת את רשימת IDeviceMonitor מההגדרה הגלובלית.

abstract IDeviceSelection getDeviceRequirements()

הפונקציה מקבלת את IDeviceSelection לשימוש מההגדרה.

abstract TradefedFeatureServer getFeatureServer()

הפונקציה מחזירה את הערך TradefedFeatureServer או null אם הוא לא מוגדר.

abstract IConfigurationServer getGlobalConfigServer()

מקבל את שרת ההגדרות הכללי.

abstract List<IHostMonitor> getHostMonitors()

הפונקציה מקבלת את רשימת IHostMonitor מההגדרה הגלובלית.

abstract IHostOptions getHostOptions()

הפונקציה מקבלת את IHostOptions לשימוש מההגדרה.

abstract IHostResourceManager getHostResourceManager()

הפונקציה מקבלת את IHostResourceManager מההגדרה הגלובלית.

abstract IKeyStoreFactory getKeyStoreFactory()

הפונקציה מקבלת את IKeyStoreFactory לשימוש מההגדרה.

abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers()

מקבל את רשימת IMultiDeviceRecovery לשימוש מההגדרה.

abstract List<String> getOptionValues(String optionName)

קבלת רשימה של ערכי אפשרויות.

abstract List<IResourceMetricCollector> getResourceMetricCollectors()

הפונקציה מקבלת את רשימת IResourceMetricCollector מההגדרה הגלובלית.

abstract ISandboxFactory getSandboxFactory()

קבלת ארגז חול של מפעל שאפשר להשתמש בו כדי להריץ קריאה

abstract IShardHelper getShardingStrategy()

מחזירה את IShardHelper שמגדיר את הדרך לפצל הגדרה.

abstract TestInvocationManagementServer getTestInvocationManagementSever()

הפונקציה מחזירה את הערך TestInvocationManagementServer או null אם הוא לא מוגדר.

abstract ITerribleFailureHandler getWtfHandler()

הפונקציה מקבלת את ITerribleFailureHandler לשימוש מההגדרה.

abstract void injectOptionValue(String optionName, String optionValue)

הוספת ערך של אפשרות לקבוצת אובייקטי ההגדרה.

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

הוספת ערך של אפשרות לקבוצת אובייקטי ההגדרה.

abstract void setCommandScheduler(ICommandScheduler scheduler)

מגדירים את ICommandScheduler ומחליפים את הערכים הקיימים.

abstract void setConfigurationFactory(IConfigurationFactory configFactory)

מגדירים את IConfigurationFactory להגדרה הזו.

abstract void setConfigurationObject(String name, Object configObject)

שיטה כללית להגדרת אובייקט ההגדרה עם השם הנתון, והחלפת כל ערך קיים.

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

שיטה כללית להגדרת רשימת אובייקטים של הגדרות עבור השם הנתון, שמחליפה כל ערך קיים.

abstract void setDeviceManagementServer(DeviceManagementGrpcServer server)

מגדיר את DeviceManagementGrpcServer.

abstract void setDeviceManager(IDeviceManager deviceManager)

מגדירים את IDeviceManager ומחליפים את הערכים הקיימים.

abstract void setDeviceMonitor(IDeviceMonitor deviceMonitor)

מגדירים את IDeviceMonitor.

abstract void setDeviceRequirements(IDeviceSelection deviceSelection)

מגדירים את IDeviceSelection ומחליפים את הערכים הקיימים.

abstract void setHostMonitors(List<IHostMonitor> hostMonitors)

מגדירים את הרשימה IHostMonitor.

abstract void setHostOptions(IHostOptions hostOptions)

מגדירים את IHostOptions ומחליפים את הערכים הקיימים.

abstract void setHostResourceManager(IHostResourceManager hostResourceManager)

מגדירים את IHostResourceManager ומחליפים את הערכים הקיימים.

abstract void setInvocationServer(TestInvocationManagementServer server)

מגדיר את TestInvocationManagementServer.

abstract void setKeyStoreFactory(IKeyStoreFactory factory)

מגדירים את IKeyStoreFactory ומחליפים את הערכים הקיימים.

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

הגדרת השדות של ההגדרה הגלובלית Option באמצעות קבוצה נתונה של ארגומנטים של שורת הפקודה

הפורמט הרצוי מפורט במאמר ArgsOptionParser

abstract void setOriginalConfig(String config)

מגדיר את התצורה המקורית ששימשה ליצירת התצורה הגלובלית.

abstract void setResourceMetricCollector(IResourceMetricCollector collector)

הגדרת IResourceMetricCollector.

abstract void setSandboxFactory(ISandboxFactory factory)

מגדירים את ISandboxFactory ומחליפים את הערכים הקיימים.

abstract void setShardingStrategy(IShardHelper sharding)

מגדירה את ה-IShardHelper שייעשה בו שימוש כשמפצלים הגדרה.

abstract void setTradefedFeatureServer(TradefedFeatureServer server)

מגדיר את TradefedFeatureServer.

abstract void setWtfHandler(ITerribleFailureHandler wtfHandler)

מגדירים את ITerribleFailureHandler.

abstract void setup()

הגדרה נכונה בתחילת השימוש ב-Tradefed.

abstract void validateOptions()

מאמתים את הערכים של האפשרויות.

‫methods ציבוריים

ניקוי נתונים

public abstract void cleanup ()

ניקוי תקין כשמבצעים כיבוי של tradefed.

cloneConfigWithFilter

public abstract File cloneConfigWithFilter (String... allowlistConfigs)

מסננים את GlobalConfiguration על סמך רשימת ההיתרים ומייצאים לקובץ XML.

לדוגמה, עבור ההגדרה הבאה: <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>

כל ההגדרות חוץ מ-key_store יסוננו, וקובץ ההגדרות יכיל את התוכן הבא: <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

פרמטרים
allowlistConfigs String: String מערך של הגדרות שייכללו בקובץ ה-XML החדש. אם ההגדרה היא null, a default list should be used.

החזרות
File הקובץ שמכיל את ההגדרה הגלובלית החדשה שסוננה.

הקפצת הודעות שגיאה (throw)
java.io.IOException
IOException

cloneConfigWithFilter

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

סינון GlobalConfiguration על סמך רשימת היתרים ופלט לקובץ XML.

פרמטרים
exclusionPatterns Set: התבנית של שם המחלקה שרוצים להחריג מהדאמפ.

allowlistConfigs String: String מערך של הגדרות שייכללו בקובץ ה-XML החדש. אם ההגדרה היא null, a default list should be used.

החזרות
File הקובץ שמכיל את ההגדרה הגלובלית החדשה שסוננה.

הקפצת הודעות שגיאה (throw)
java.io.IOException
IOException

cloneConfigWithFilter

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

סינון של GlobalConfiguration על סמך רשימת היתרים, תוך מתן אפשרות לשינוי של ערכי האפשרויות ופלט לקובץ XML.

פרמטרים
exclusionPatterns Set: התבנית של שם המחלקה שרוצים להחריג מהדאמפ.

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String: מערך String של הגדרות שייכללו בקובץ ה-XML החדש. אם ההגדרה היא null, a default list should be used.

החזרות
File הקובץ שמכיל את ההגדרה הגלובלית החדשה שסוננה.

הקפצת הודעות שגיאה (throw)
IOException

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

הפונקציה מקבלת את ICommandScheduler לשימוש מההגדרה.

החזרות
ICommandScheduler ה-ICommandScheduler. לעולם לא תחזיר ערך null.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

מקבל את אובייקט ההגדרה בהתאמה אישית עם השם שצוין.

פרמטרים
typeName String: הסוג הייחודי של אובייקט ההגדרה

החזרות
Object האובייקט או null אם לא נמצא אובייקט עם השם הזה

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

קבלת ICredentialFactory ליצירת פרטי כניסה.

החזרות
ICredentialFactory ICredentialFactory או null אם לא צוין אף אחד מהם.

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

הפונקציה מחזירה את הערך DeviceManagementGrpcServer או null אם הוא לא מוגדר.

החזרות
DeviceManagementGrpcServer

getDeviceManager

public abstract IDeviceManager getDeviceManager ()

הפונקציה מקבלת את IDeviceManager לשימוש מההגדרה. ניהול קבוצת המכשירים הזמינים לבדיקה

החזרות
IDeviceManager הערך של IDeviceManager שצוין בהגדרה.

getDeviceMonitors

public abstract List<IDeviceMonitor> getDeviceMonitors ()

הפונקציה מקבלת את רשימת IDeviceMonitor מההגדרה הגלובלית.

החזרות
List<IDeviceMonitor> רשימת IDeviceMonitor מההגדרה הגלובלית, או null אם לא צוין אף אחד.

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

הפונקציה מקבלת את IDeviceSelection לשימוש מההגדרה. מייצג מסנן גלובלי שקובע באילו מכשירים אפשר לראות את DeviceManager.

החזרות
IDeviceSelection הערך של IDeviceSelection שצוין בהגדרה.

getFeatureServer

public abstract TradefedFeatureServer getFeatureServer ()

הפונקציה מחזירה את הערך TradefedFeatureServer או null אם הוא לא מוגדר.

החזרות
TradefedFeatureServer

getGlobalConfigServer

public abstract IConfigurationServer getGlobalConfigServer ()

מקבל את שרת ההגדרות הכללי. שרת התצורה הגלובלי משמש לקבלת הגדרות מארח משרת במקום מקבצים מקומיים.

החזרות
IConfigurationServer

getHostMonitors

public abstract List<IHostMonitor> getHostMonitors ()

הפונקציה מקבלת את רשימת IHostMonitor מההגדרה הגלובלית.

החזרות
List<IHostMonitor> רשימת IHostMonitor מההגדרה הגלובלית, או null אם לא צוין אף אחד.

getHostOptions

public abstract IHostOptions getHostOptions ()

הפונקציה מקבלת את IHostOptions לשימוש מההגדרה.

החזרות
IHostOptions הערך של IDeviceManager שצוין בהגדרה.

getHostResourceManager

public abstract IHostResourceManager getHostResourceManager ()

הפונקציה מקבלת את IHostResourceManager מההגדרה הגלובלית.

החזרות
IHostResourceManager הערך IHostResourceManager מההגדרה הגלובלית, או הטמעה של ברירת מחדל LocalHostResourceManager אם לא צוין ערך בהגדרת המארח.

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

הפונקציה מקבלת את IKeyStoreFactory לשימוש מההגדרה.

החזרות
IKeyStoreFactory IKeyStoreFactory או null אם לא מוגדר מפעל של מאגר מפתחות.

getMultiDeviceRecoveryHandlers

public abstract List<IMultiDeviceRecovery> getMultiDeviceRecoveryHandlers ()

מקבל את רשימת IMultiDeviceRecovery לשימוש מההגדרה.

החזרות
List<IMultiDeviceRecovery> רשימת IMultiDeviceRecovery, או null אם לא הוגדר.

getOptionValues

public abstract List<String> getOptionValues (String optionName)

קבלת רשימה של ערכי אפשרויות.

פרמטרים
optionName String: השם של אפשרות המפה

החזרות
List<String> רשימה של הערכים של האפשרות שצוינה. null אם שם האפשרות לא קיים.

getResourceMetricCollectors

public abstract List<IResourceMetricCollector> getResourceMetricCollectors ()

הפונקציה מקבלת את רשימת IResourceMetricCollector מההגדרה הגלובלית.

החזרות
List<IResourceMetricCollector> רשימת IResourceMetricCollector מההגדרה הגלובלית או null אם לא צוין אף אחד.

getSandboxFactory

public abstract ISandboxFactory getSandboxFactory ()

קבלת ארגז חול של מפעל שאפשר להשתמש בו כדי להריץ קריאה

החזרות
ISandboxFactory

getShardingStrategy

public abstract IShardHelper getShardingStrategy ()

מחזירה את IShardHelper שמגדיר את הדרך לפצל הגדרה.

החזרות
IShardHelper

getTestInvocationManagementSever

public abstract TestInvocationManagementServer getTestInvocationManagementSever ()

הפונקציה מחזירה את הערך TestInvocationManagementServer או null אם הוא לא מוגדר.

החזרות
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

הפונקציה מקבלת את ITerribleFailureHandler לשימוש מההגדרה. הפונקציה הזו מטפלת במקרים שבהם מתרחשת שגיאה חמורה (WTF,‏ What a Terrible Failure).

החזרות
ITerribleFailureHandler ה-ITerribleFailureHandler שסופק בהגדרה, או null אם לא הוגדר handler

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

הוספת ערך של אפשרות לקבוצת אובייקטי ההגדרה.

המאפיין הזה שימושי כשרוצים לספק ערכים לאפשרויות שנוצרות באופן דינמי.

פרמטרים
optionName String: שם האפשרות

optionValue String: ערכי האפשרויות

הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא הצלחנו להגדיר את הערך של האפשרות

injectOptionValue

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

הוספת ערך של אפשרות לקבוצת אובייקטי ההגדרה.

המאפיין הזה שימושי כשרוצים לספק ערכים לאפשרויות שנוצרות באופן דינמי.

פרמטרים
optionName String: השם של אפשרות המפה

optionKey String: מפתח האפשרות של המפה

optionValue String: הערך של אפשרות המיפוי

הקפצת הודעות שגיאה (throw)
ConfigurationException אם לא הצלחנו להגדיר את הערך של האפשרות

setCommandScheduler

public abstract void setCommandScheduler (ICommandScheduler scheduler)

מגדירים את ICommandScheduler ומחליפים את הערכים הקיימים.

setConfigurationFactory

public abstract void setConfigurationFactory (IConfigurationFactory configFactory)

מגדירים את IConfigurationFactory להגדרה הזו.

פרמטרים
configFactory IConfigurationFactory

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                Object configObject)

שיטה כללית להגדרת אובייקט ההגדרה עם השם הנתון, והחלפת כל ערך קיים.

פרמטרים
name String: השם הייחודי של סוג אובייקט ההגדרה.

configObject Object: אובייקט ההגדרות

הקפצת הודעות שגיאה (throw)
ConfigurationException אם configObject לא היה מהסוג הנכון

setConfigurationObjectList

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

שיטה כללית להגדרת רשימת אובייקטים של הגדרות עבור השם הנתון, שמחליפה כל ערך קיים.

פרמטרים
typeName String: השם הייחודי של סוג אובייקט ההגדרה.

configList List: רשימת אובייקטים של הגדרות

הקפצת הודעות שגיאה (throw)
ConfigurationException אם יש אובייקטים ברשימה שלא מהסוג הנכון

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

מגדיר את DeviceManagementGrpcServer.

פרמטרים
server DeviceManagementGrpcServer

setDeviceManager

public abstract void setDeviceManager (IDeviceManager deviceManager)

מגדירים את IDeviceManager ומחליפים את הערכים הקיימים. כך מגדירים את האדמין למכשירי הבדיקה

setDeviceMonitor

public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)

מגדירים את IDeviceMonitor.

פרמטרים
deviceMonitor IDeviceMonitor: המסך

הקפצת הודעות שגיאה (throw)
ConfigurationException אם כבר הוגדר IDeviceMonitor.

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

מגדירים את IDeviceSelection ומחליפים את הערכים הקיימים. ההגדרה הזו קובעת מסנן גלובלי למכשירים שקובע אילו מכשירים יכולים לראות את DeviceManager.

setHostMonitors

public abstract void setHostMonitors (List<IHostMonitor> hostMonitors)

מגדירים את הרשימה IHostMonitor.

פרמטרים
hostMonitors List: רשימת המוניטורים

הקפצת הודעות שגיאה (throw)
ConfigurationException אם כבר הוגדר IHostMonitor.

setHostOptions

public abstract void setHostOptions (IHostOptions hostOptions)

מגדירים את IHostOptions ומחליפים את הערכים הקיימים.

setHostResourceManager

public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)

מגדירים את IHostResourceManager ומחליפים את הערכים הקיימים.

setInvocationServer

public abstract void setInvocationServer (TestInvocationManagementServer server)

מגדיר את TestInvocationManagementServer.

פרמטרים
server TestInvocationManagementServer

setKeyStoreFactory

public abstract void setKeyStoreFactory (IKeyStoreFactory factory)

מגדירים את IKeyStoreFactory ומחליפים את הערכים הקיימים.

setOptionsFromCommandLineArgs

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

הגדרת השדות של ההגדרה הגלובלית Option באמצעות קבוצה נתונה של ארגומנטים של שורת הפקודה

הפורמט הרצוי מפורט במאמר ArgsOptionParser

פרמטרים
listArgs List: הארגומנטים בשורת הפקודה

החזרות
List<String> הארגומנטים שלא נעשה בהם שימוש

הקפצת הודעות שגיאה (throw)
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

מגדיר את התצורה המקורית ששימשה ליצירת התצורה הגלובלית.

פרמטרים
config String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

מגדיר את IResourceMetricCollector.

פרמטרים
collector IResourceMetricCollector

setSandboxFactory

public abstract void setSandboxFactory (ISandboxFactory factory)

מגדירים את ISandboxFactory ומחליפים את הערכים הקיימים.

setShardingStrategy

public abstract void setShardingStrategy (IShardHelper sharding)

מגדירה את ה-IShardHelper שייעשה בו שימוש כשמפצלים הגדרה.

פרמטרים
sharding IShardHelper

setTradefedFeatureServer

public abstract void setTradefedFeatureServer (TradefedFeatureServer server)

מגדיר את TradefedFeatureServer.

פרמטרים
server TradefedFeatureServer

setWtfHandler

public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)

מגדירים את ITerribleFailureHandler.

פרמטרים
wtfHandler ITerribleFailureHandler: ה-WTF handler

הקפצת הודעות שגיאה (throw)
ConfigurationException אם כבר הוגדר ITerribleFailureHandler.

הגדרה

public abstract void setup ()

הגדרה נכונה בתחילת השימוש ב-Tradefed.

הקפצת הודעות שגיאה (throw)
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

מאמתים את הערכים של האפשרויות.

בשלב הזה, המערכת רק תבדוק שכל אפשרויות החובה הוגדרו

הקפצת הודעות שגיאה (throw)
ConfigurationException אם בהגדרה חסרים שדות חובה