IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


فئة لتضمين معلومات الإعدادات العامة لمثيل واحد من Trade Federation (يشمل أي عدد من عمليات استدعاء الإعدادات الفعلية).

ملخّص

الإجراءات العامة

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 أو قيمة فارغة إذا كانت غير محدّدة.

abstract IDeviceManager getDeviceManager()

تعرض هذه السمة IDeviceManager المطلوب استخدامه من الإعداد.

abstract List<IDeviceMonitor> getDeviceMonitors()

تعرض هذه السمة قائمة IDeviceMonitor من الإعدادات العامة.

abstract IDeviceSelection getDeviceRequirements()

تعرض هذه السمة IDeviceSelection المطلوب استخدامه من الإعداد.

abstract TradefedFeatureServer getFeatureServer()

تعرِض هذه السمة القيمة TradefedFeatureServer أو قيمة فارغة إذا كانت غير محدّدة.

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 أو قيمة فارغة إذا كانت غير محدّدة.

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

التحقّق من صحة قيم الخيار

الإجراءات العامة

تنظيف

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 الملف الذي يحتوي على الإعدادات العامة الجديدة التي تمّت فلترتها

عمليات الطرح
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 الملف الذي يحتوي على الإعدادات العامة الجديدة التي تمّت فلترتها

عمليات الطرح
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 الملف الذي يحتوي على الإعدادات العامة الجديدة التي تمّت فلترتها

عمليات الطرح
IOException

يُرجى الاطّلاع أيضًا على:

getCommandScheduler

public abstract ICommandScheduler getCommandScheduler ()

تعرض هذه السمة ICommandScheduler المطلوب استخدامه من الإعداد.

المرتجعات
ICommandScheduler ICommandScheduler لن تعرض القيمة الخالية أبدًا.

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

تعرض هذه الطريقة عنصر الإعدادات المخصّصة بالاسم المحدّد.

المعلَمات
typeName String: النوع الفريد لعنصر الإعداد

المرتجعات
Object الكائن أو قيمة فارغة إذا لم يتم العثور على كائن بهذا الاسم

getCredentialFactory

public abstract ICredentialFactory getCredentialFactory ()

يحصل على ICredentialFactory لإنشاء بيانات الاعتماد.

المرتجعات
ICredentialFactory ICredentialFactory أو null إذا لم يتم تحديد أي منهما

getDeviceManagementServer

public abstract DeviceManagementGrpcServer getDeviceManagementServer ()

تعرِض هذه السمة القيمة DeviceManagementGrpcServer أو قيمة فارغة إذا كانت غير محدّدة.

المرتجعات
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 أو قيمة فارغة إذا كانت غير محدّدة.

المرتجعات
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 أو قيمة فارغة إذا كانت غير محدّدة.

المرتجعات
TestInvocationManagementServer

getWtfHandler

public abstract ITerribleFailureHandler getWtfHandler ()

تعرض هذه السمة ITerribleFailureHandler المطلوب استخدامه من الإعداد. يتعامل هذا الحقل مع الإجراءات التي يجب اتّخاذها في حال حدوث خطأ WTF (What a Terrible Failure).

المرتجعات
ITerribleFailureHandler ITerribleFailureHandler المقدَّم في الإعدادات، أو قيمة فارغة إذا لم يتم ضبط أي معالج

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

إدخال قيمة خيار في مجموعة عناصر الإعداد.

مفيد لتقديم قيم للخيارات التي يتم إنشاؤها بشكل ديناميكي.

المعلَمات
optionName String: اسم الخيار

optionValue String: قيم الخيار

عمليات الطرح
ConfigurationException في حال تعذّر ضبط قيمة الخيار

injectOptionValue

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

إدخال قيمة خيار في مجموعة عناصر الإعداد.

مفيد لتقديم قيم للخيارات التي يتم إنشاؤها بشكل ديناميكي.

المعلَمات
optionName String: اسم خيار الخريطة

optionKey String: مفتاح خيار الخريطة

optionValue String: قيمة خيار الخريطة

عمليات الطرح
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: عنصر الإعدادات

عمليات الطرح
ConfigurationException إذا لم يكن configObject من النوع الصحيح

setConfigurationObjectList

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

طريقة عامة لضبط قائمة عناصر الإعدادات للاسم المحدّد، مع استبدال أي قيمة حالية.

المعلَمات
typeName String: الاسم الفريد لنوع عنصر الإعدادات.

configList List: قائمة عناصر الإعدادات

عمليات الطرح
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: الشاشة

عمليات الطرح
ConfigurationException إذا سبق أن تم ضبط IDeviceMonitor

setDeviceRequirements

public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)

اضبط IDeviceSelection، مع استبدال أي قيم حالية. يضبط هذا الإعداد فلترًا عامًا للأجهزة يحدّد الأجهزة التي يمكن DeviceManager الاطّلاع عليها.

setHostMonitors

public abstract void setHostMonitors (List<IHostMonitor> hostMonitors)

اضبط قائمة IHostMonitor.

المعلَمات
hostMonitors List: قائمة الشاشات

عمليات الطرح
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> الوسيطات غير المستخدَمة

عمليات الطرح
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

عمليات الطرح
ConfigurationException إذا سبق أن تم ضبط ITerribleFailureHandler.

عملية الإعداد

public abstract void setup ()

الإعداد السليم في بداية Tradefed

عمليات الطرح
com.android.tradefed.config.ConfigurationException
ConfigurationException

validateOptions

public abstract void validateOptions ()

التحقّق من صحة قيم الخيار

في الوقت الحالي، سيتم فقط التحقّق من ضبط جميع الخيارات الإلزامية

عمليات الطرح
ConfigurationException في حال عدم توفّر الحقول الإلزامية في الإعداد