Konfigurasi Global
public class GlobalConfiguration
extends Object
implements IGlobalConfiguration
java.lang.Objek | |
↳ | com.android.tradefed.config.GlobalConfiguration |
Implementasi IGlobalConfiguration
yang menyimpan objek konfigurasi yang dimuat di peta
Ringkasan
Bidang | |
---|---|
public static final String | CREDENTIAL_FACTORY_TYPE_NAME |
public static final String | DEVICE_MANAGER_TYPE_NAME |
public static final String | DEVICE_MONITOR_TYPE_NAME |
public static final String | DEVICE_REQUIREMENTS_TYPE_NAME |
public static final String | GLOBAL_CONFIG_SERVER |
public static final String | GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE |
public static final String | GLOBAL_CONFIG_VARIABLE |
public static final String | HOST_MONITOR_TYPE_NAME |
public static final String | HOST_OPTIONS_TYPE_NAME |
public static final String | HOST_RESOURCE_MANAGER_TYPE_NAME |
public static final String | KEY_STORE_TYPE_NAME |
public static final String | MULTI_DEVICE_RECOVERY_TYPE_NAME |
public static final String | RESOURCE_METRIC_COLLECTOR_TYPE_NAME |
public static final String | SANDBOX_FACTORY_TYPE_NAME |
public static final String | SCHEDULER_TYPE_NAME |
public static final String | SHARDING_STRATEGY_TYPE_NAME |
public static final String | TF_DEVICE_MANAGEMENT_SERVER_NAME |
public static final String | TF_FEATURE_SERVER_NAME |
public static final String | TF_INVOCATION_SERVER_NAME |
public static final String | WTF_HANDLER_TYPE_NAME
|
Metode publik | |
---|---|
void | cleanup () Pembersihan yang tepat saat tradefed shutdown. |
File | cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) Filter GlobalConfiguration berdasarkan daftar putih dan keluaran ke file XML. |
File | cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) Filter GlobalConfiguration berdasarkan daftar putih sambil mengizinkan manipulasi nilai opsi dan keluaran ke file XML. |
File | cloneConfigWithFilter (String... allowlistConfigs) Filter GlobalConfiguration berdasarkan daftar yang diizinkan dan keluaran ke file XML. |
static | createGlobalConfiguration (String[] args) Menyiapkan singleton |
ICommandScheduler | getCommandScheduler () Mendapatkan |
Object | getConfigurationObject (String typeName) Mendapat objek konfigurasi khusus dengan nama yang diberikan. |
ICredentialFactory | getCredentialFactory () Mendapatkan |
String | getDescription () |
DeviceManagementGrpcServer | getDeviceManagementServer () Mengembalikan |
IDeviceManager | getDeviceManager () Mendapatkan |
static IDeviceManager | getDeviceManagerInstance () Mengembalikan referensi ke instance |
getDeviceMonitors () Mendapatkan daftar | |
IDeviceSelection | getDeviceRequirements () Mendapatkan |
TradefedFeatureServer | getFeatureServer () Mengembalikan |
IConfigurationServer | getGlobalConfigServer () Mendapat server konfigurasi global. |
static | getHostMonitorInstances () |
getHostMonitors () Mendapat daftar | |
IHostOptions | getHostOptions () Mendapat |
IHostResourceManager | getHostResourceManager () Mendapatkan |
static IGlobalConfiguration | getInstance () Mengembalikan referensi ke instance |
IKeyStoreFactory | getKeyStoreFactory () Mendapatkan |
getMultiDeviceRecoveryHandlers () Mendapatkan daftar | |
String | getName () |
getOptionValues (String optionName) Dapatkan daftar nilai opsi. | |
getResourceMetricCollectors () Mendapatkan daftar | |
ISandboxFactory | getSandboxFactory () Dapatkan pabrik kotak pasir yang dapat digunakan untuk menjalankan pemanggilan |
IShardHelper | getShardingStrategy () Mengembalikan |
TestInvocationManagementServer | getTestInvocationManagementSever () Mengembalikan |
ITerribleFailureHandler | getWtfHandler () Mendapatkan |
void | injectOptionValue (String optionName, String optionValue) Menyuntikkan nilai opsi ke dalam kumpulan objek konfigurasi. |
void | injectOptionValue (String optionName, String optionKey, String optionValue) Menyuntikkan nilai opsi ke dalam kumpulan objek konfigurasi. |
void | printCommandUsage (boolean importantOnly, PrintStream out) Mengeluarkan teks bantuan penggunaan baris perintah untuk konfigurasi ini ke printStream yang diberikan. |
void | setCommandScheduler ( ICommandScheduler scheduler) Setel |
void | setConfigurationFactory ( IConfigurationFactory configFactory) Atur |
void | setConfigurationObject (String typeName, Object configObject) Metode generik untuk menyetel objek konfigurasi dengan nama yang diberikan, menggantikan nilai apa pun yang ada. |
void | setConfigurationObjectList (String typeName, configList) setConfigurationObjectList (String typeName, configList) Metode umum untuk menyetel daftar objek konfigurasi untuk nama yang diberikan, menggantikan nilai apa pun yang ada. |
void | setDeviceManagementServer ( DeviceManagementGrpcServer server) Menyetel |
void | setDeviceManager ( IDeviceManager manager) Setel |
void | setDeviceMonitor ( IDeviceMonitor monitor) Setel |
void | setDeviceRequirements ( IDeviceSelection devRequirements) Setel |
void | setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors) Tetapkan daftar |
void | setHostOptions ( IHostOptions hostOptions) Setel |
void | setHostResourceManager ( IHostResourceManager hostResourceManager) Setel |
void | setInvocationServer ( TestInvocationManagementServer server) Menyetel |
void | setKeyStoreFactory ( IKeyStoreFactory factory) Setel |
setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs) Tetapkan bidang ArgsOptionParser untuk format yang diharapkan | |
void | setOriginalConfig (String config) Menetapkan konfigurasi asli yang digunakan untuk membuat konfigurasi global. |
void | setResourceMetricCollector ( IResourceMetricCollector collector) Menyetel |
void | setSandboxFactory ( ISandboxFactory factory) Setel |
void | setShardingStrategy ( IShardHelper sharding) Menyetel |
void | setTradefedFeatureServer ( TradefedFeatureServer server) Mengatur |
void | setWtfHandler ( ITerribleFailureHandler wtfHandler) Tetapkan |
void | setup () Pengaturan yang tepat di awal tradefed. |
void | validateOptions () Validasi nilai opsi. |
Metode yang dilindungi | |
---|---|
IConfigurationFactory | getConfigurationFactory () |
Bidang
CREDENTIAL_FACTORY_TYPE_NAME
public static final String CREDENTIAL_FACTORY_TYPE_NAME
DEVICE_MANAGER_TYPE_NAME
public static final String DEVICE_MANAGER_TYPE_NAME
DEVICE_MONITOR_TYPE_NAME
public static final String DEVICE_MONITOR_TYPE_NAME
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
GLOBAL_CONFIG_SERVER
public static final String GLOBAL_CONFIG_SERVER
GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE
public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE
GLOBAL_CONFIG_VARIABLE
public static final String GLOBAL_CONFIG_VARIABLE
HOST_MONITOR_TYPE_NAME
public static final String HOST_MONITOR_TYPE_NAME
HOST_OPTIONS_TYPE_NAME
public static final String HOST_OPTIONS_TYPE_NAME
HOST_RESOURCE_MANAGER_TYPE_NAME
public static final String HOST_RESOURCE_MANAGER_TYPE_NAME
KEY_STORE_TYPE_NAME
public static final String KEY_STORE_TYPE_NAME
MULTI_DEVICE_RECOVERY_TYPE_NAME
public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME
RESOURCE_METRIC_COLLECTOR_TYPE_NAME
public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME
SANDBOX_FACTORY_TYPE_NAME
public static final String SANDBOX_FACTORY_TYPE_NAME
SCHEDULER_TYPE_NAME
public static final String SCHEDULER_TYPE_NAME
SHARDING_STRATEGY_TYPE_NAME
public static final String SHARDING_STRATEGY_TYPE_NAME
TF_DEVICE_MANAGEMENT_SERVER_NAME
public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME
TF_FEATURE_SERVER_NAME
public static final String TF_FEATURE_SERVER_NAME
TF_INVOCATION_SERVER_NAME
public static final String TF_INVOCATION_SERVER_NAME
WTF_HANDLER_TYPE_NAME
public static final String WTF_HANDLER_TYPE_NAME
Metode publik
membersihkan
public void cleanup ()
Pembersihan yang tepat saat tradefed shutdown.
cloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, String... allowlistConfigs)
Filter GlobalConfiguration berdasarkan daftar putih dan keluaran ke file XML.
Parameter | |
---|---|
exclusionPatterns | |
allowlistConfigs | String : array String konfigurasi untuk disertakan dalam file XML baru. Jika disetel ke null |
Pengembalian | |
---|---|
File | File yang berisi konfigurasi global baru yang difilter. |
cloneConfigWithFilter
public File cloneConfigWithFilter (exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)
Filter GlobalConfiguration berdasarkan daftar putih sambil mengizinkan manipulasi nilai opsi dan keluaran ke file XML.
Parameter | |
---|---|
exclusionPatterns | |
transformer | IConfigOptionValueTransformer |
deepCopy | boolean |
allowlistConfigs | String : array String konfigurasi untuk disertakan dalam file XML baru. Jika disetel ke null |
Pengembalian | |
---|---|
File | File yang berisi konfigurasi global baru yang difilter. |
cloneConfigWithFilter
public File cloneConfigWithFilter (String... allowlistConfigs)
Filter GlobalConfiguration berdasarkan daftar yang diizinkan dan keluaran ke file XML.
Misalnya, untuk konfigurasi berikut: <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>
semua konfigurasi kecuali "key_store" akan disaring, dan menghasilkan file konfigurasi dengan konten berikut: <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>
Parameter | |
---|---|
allowlistConfigs | String : array String konfigurasi untuk disertakan dalam file XML baru. Jika disetel ke null |
Pengembalian | |
---|---|
File | File yang berisi konfigurasi global baru yang difilter. |
createGlobalConfiguration
public staticcreateGlobalConfiguration (String[] args)
Menyiapkan singleton GlobalConfiguration
untuk instance TF ini. Harus dipanggil sekali dan hanya sekali, sebelum mencoba memanggil getInstance()
Parameter | |
---|---|
args | String |
Pengembalian | |
---|---|
Melempar | |
---|---|
IllegalStateException | jika dipanggil lebih dari sekali |
ConfigurationException |
getCommandScheduler
public ICommandScheduler getCommandScheduler ()
Mendapatkan ICommandScheduler
untuk digunakan dari konfigurasi.
Pengembalian | |
---|---|
ICommandScheduler | yang ICommandScheduler . Tidak akan pernah mengembalikan nol. |
getConfigurationObject
public Object getConfigurationObject (String typeName)
Mendapat objek konfigurasi khusus dengan nama yang diberikan.
Parameter | |
---|---|
typeName | String : tipe unik dari objek konfigurasi |
Pengembalian | |
---|---|
Object | objek atau null jika objek dengan nama tersebut tidak ditemukan |
getCredentialFactory
public ICredentialFactory getCredentialFactory ()
Mendapatkan ICredentialFactory
untuk membuat kredensial.
Pengembalian | |
---|---|
ICredentialFactory | ICredentialFactory atau null jika tidak ada yang ditentukan. |
getDescription
public String getDescription ()
Pengembalian | |
---|---|
String | deskripsi singkat yang dapat dibaca pengguna Configuration ini |
getDeviceManagementServer
public DeviceManagementGrpcServer getDeviceManagementServer ()
Mengembalikan DeviceManagementGrpcServer
atau null jika tidak ditentukan.
Pengembalian | |
---|---|
DeviceManagementGrpcServer |
getDeviceManager
public IDeviceManager getDeviceManager ()
Mendapatkan IDeviceManager
untuk digunakan dari konfigurasi. Mengelola kumpulan perangkat yang tersedia untuk pengujian
Pengembalian | |
---|---|
IDeviceManager | IDeviceManager disediakan dalam konfigurasi. |
getDeviceManagerInstance
public static IDeviceManager getDeviceManagerInstance ()
Mengembalikan referensi ke instance DeviceManager
tunggal untuk instance TF ini.
Pengembalian | |
---|---|
IDeviceManager |
Melempar | |
---|---|
IllegalStateException | jika createGlobalConfiguration(String[]) belum dipanggil. |
getDeviceMonitors
publicgetDeviceMonitors ()
Mendapatkan daftar IDeviceMonitor
dari konfigurasi global.
Pengembalian | |
---|---|
daftar IDeviceMonitor dari konfigurasi global, atau null jika tidak ditentukan. |
getDeviceRequirements
public IDeviceSelection getDeviceRequirements ()
Mendapatkan IDeviceSelection
untuk digunakan dari konfigurasi. Mewakili filter global di perangkat mana yang dapat dilihat DeviceManager
.
Pengembalian | |
---|---|
IDeviceSelection | IDeviceSelection disediakan dalam konfigurasi. |
getFeatureServer
public TradefedFeatureServer getFeatureServer ()
Mengembalikan TradefedFeatureServer
atau null jika tidak ditentukan.
Pengembalian | |
---|---|
TradefedFeatureServer |
getGlobalConfigServer
public IConfigurationServer getGlobalConfigServer ()
Mendapat server konfigurasi global. Server konfigurasi global digunakan untuk mendapatkan konfigurasi host dari server alih-alih mendapatkannya dari file lokal.
Pengembalian | |
---|---|
IConfigurationServer |
getHostMonitorInstances
public staticgetHostMonitorInstances ()
Pengembalian | |
---|---|
getHostMonitors
publicgetHostMonitors ()
Mendapat daftar IHostMonitor
dari konfigurasi global.
Pengembalian | |
---|---|
daftar IHostMonitor dari konfigurasi global, atau null jika tidak ditentukan. |
getHostOptions
public IHostOptions getHostOptions ()
Mendapat IHostOptions
untuk digunakan dari konfigurasi.
Pengembalian | |
---|---|
IHostOptions | IDeviceManager disediakan dalam konfigurasi. |
getHostResourceManager
public IHostResourceManager getHostResourceManager ()
Mendapatkan IHostResourceManager
dari konfigurasi global.
Pengembalian | |
---|---|
IHostResourceManager | IHostResourceManager dari konfigurasi global, atau implementasi default LocalHostResourceManager jika tidak ada yang ditentukan dalam konfigurasi host. |
getInstance
public static IGlobalConfiguration getInstance ()
Mengembalikan referensi ke instance GlobalConfiguration
tunggal untuk instance TF ini.
Pengembalian | |
---|---|
IGlobalConfiguration |
Melempar | |
---|---|
IllegalStateException | jika createGlobalConfiguration(String[]) belum dipanggil. |
getKeyStoreFactory
public IKeyStoreFactory getKeyStoreFactory ()
Mendapatkan IKeyStoreFactory
untuk digunakan dari konfigurasi.
Pengembalian | |
---|---|
IKeyStoreFactory | IKeyStoreFactory atau null jika tidak ada pabrik penyimpanan kunci yang disetel. |
getMultiDeviceRecoveryHandlers
publicgetMultiDeviceRecoveryHandlers ()
Mendapatkan daftar IMultiDeviceRecovery
untuk digunakan dari konfigurasi.
Pengembalian | |
---|---|
daftar IMultiDeviceRecovery , atau null jika tidak disetel. |
getOptionValues
publicgetOptionValues (String optionName)
Dapatkan daftar nilai opsi.
Parameter | |
---|---|
optionName | String : nama opsi peta |
Pengembalian | |
---|---|
daftar nilai opsi yang diberikan. null jika nama opsi tidak ada. |
getResourceMetricCollectors
publicgetResourceMetricCollectors ()
Mendapatkan daftar IResourceMetricCollector
dari konfigurasi global.
Pengembalian | |
---|---|
daftar IResourceMetricCollector dari konfigurasi global atau null jika tidak ada yang ditentukan. |
getSandboxFactory
public ISandboxFactory getSandboxFactory ()
Dapatkan pabrik kotak pasir yang dapat digunakan untuk menjalankan pemanggilan
Pengembalian | |
---|---|
ISandboxFactory |
getShardingStrategy
public IShardHelper getShardingStrategy ()
Mengembalikan IShardHelper
yang menentukan cara untuk melakukan shard konfigurasi.
Pengembalian | |
---|---|
IShardHelper |
getTestInvocationManagementSever
public TestInvocationManagementServer getTestInvocationManagementSever ()
Mengembalikan TestInvocationManagementServer
atau null jika tidak ditentukan.
Pengembalian | |
---|---|
TestInvocationManagementServer |
getWtfHandler
public ITerribleFailureHandler getWtfHandler ()
Mendapatkan ITerribleFailureHandler
untuk digunakan dari konfigurasi. Menangani apa yang harus dilakukan jika terjadi WTF (What a Terrible Failure).
Pengembalian | |
---|---|
ITerribleFailureHandler | ITerribleFailureHandler disediakan dalam konfigurasi, atau null jika tidak ada penangan yang disetel |
injectOptionValue
public void injectOptionValue (String optionName, String optionValue)
Menyuntikkan nilai opsi ke dalam kumpulan objek konfigurasi.
Berguna untuk memberikan nilai untuk opsi yang dihasilkan secara dinamis.Parameter | |
---|---|
optionName | String : nama opsi |
optionValue | String : nilai opsi |
Melempar | |
---|---|
ConfigurationException |
injectOptionValue
public void injectOptionValue (String optionName, String optionKey, String optionValue)
Menyuntikkan nilai opsi ke dalam kumpulan objek konfigurasi.
Berguna untuk memberikan nilai untuk opsi yang dihasilkan secara dinamis.Parameter | |
---|---|
optionName | String : nama opsi peta |
optionKey | String : kunci opsi peta |
optionValue | String : nilai opsi peta |
Melempar | |
---|---|
ConfigurationException |
printCommandUsage
public void printCommandUsage (boolean importantOnly, PrintStream out)
Mengeluarkan teks bantuan penggunaan baris perintah untuk konfigurasi ini ke printStream yang diberikan.
Parameter | |
---|---|
importantOnly | boolean |
out | PrintStream : ERROR(/PrintStream) yang akan digunakan. |
Melempar | |
---|---|
| com.android.tradefed.config.ConfigurationException |
ConfigurationException |
setCommandScheduler
public void setCommandScheduler (ICommandScheduler scheduler)
Setel ICommandScheduler
, ganti nilai yang ada.
setConfigurationFactory
public void setConfigurationFactory (IConfigurationFactory configFactory)
Atur IConfigurationFactory
untuk konfigurasi ini.
Parameter | |
---|---|
configFactory | IConfigurationFactory |
setConfigurationObject
public void setConfigurationObject (String typeName, Object configObject)
Metode generik untuk menyetel objek konfigurasi dengan nama yang diberikan, menggantikan nilai apa pun yang ada.
Parameter | |
---|---|
typeName | String : nama unik dari tipe objek konfigurasi. |
configObject | Object : objek konfigurasi |
Melempar | |
---|---|
ConfigurationException |
setConfigurationObjectList
public void setConfigurationObjectList (String typeName,configList)
Metode umum untuk menyetel daftar objek konfigurasi untuk nama yang diberikan, menggantikan nilai apa pun yang ada.
Parameter | |
---|---|
typeName | String : nama unik dari tipe objek konfigurasi. |
configList |
Melempar | |
---|---|
ConfigurationException |
setDeviceManagementServer
public void setDeviceManagementServer (DeviceManagementGrpcServer server)
Menyetel DeviceManagementGrpcServer
.
Parameter | |
---|---|
server | DeviceManagementGrpcServer |
setDeviceManager
public void setDeviceManager (IDeviceManager manager)
Setel IDeviceManager
, ganti nilai yang ada. Ini menetapkan pengelola untuk perangkat uji
setDeviceMonitor
public void setDeviceMonitor (IDeviceMonitor monitor)
Setel IDeviceMonitor
.
Parameter | |
---|---|
monitor | IDeviceMonitor : Monitor |
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
Setel IDeviceSelection
, ganti nilai yang ada. Ini menyetel filter perangkat global di perangkat mana yang dapat dilihat DeviceManager
.
setHostMonitors
public void setHostMonitors (hostMonitors)
Tetapkan daftar IHostMonitor
.
Parameter | |
---|---|
hostMonitors |
setHostOptions
public void setHostOptions (IHostOptions hostOptions)
Setel IHostOptions
, ganti nilai yang ada.
setHostResourceManager
public void setHostResourceManager (IHostResourceManager hostResourceManager)
Setel IHostResourceManager
, menggantikan nilai yang ada.
setInvocationServer
public void setInvocationServer (TestInvocationManagementServer server)
Menyetel TestInvocationManagementServer
.
Parameter | |
---|---|
server | TestInvocationManagementServer |
setKeyStoreFactory
public void setKeyStoreFactory (IKeyStoreFactory factory)
Setel IKeyStoreFactory
, ganti nilai yang ada.
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
Tetapkan bidang Option
konfigurasi global dengan serangkaian argumen baris perintah yang diberikan
ArgsOptionParser
untuk format yang diharapkanParameter | |
---|---|
listArgs |
Pengembalian | |
---|---|
argumen yang tidak termakan |
Melempar | |
---|---|
ConfigurationException |
setOriginalConfig
public void setOriginalConfig (String config)
Menetapkan konfigurasi asli yang digunakan untuk membuat konfigurasi global.
Parameter | |
---|---|
config | String |
setResourceMetricCollector
public void setResourceMetricCollector (IResourceMetricCollector collector)
Menyetel IResourceMetricCollector
.
Parameter | |
---|---|
collector | IResourceMetricCollector |
setSandboxFactory
public void setSandboxFactory (ISandboxFactory factory)
Setel ISandboxFactory
, ganti nilai yang ada.
setShardingStrategy
public void setShardingStrategy (IShardHelper sharding)
Menyetel IShardHelper
untuk digunakan saat melakukan sharding pada konfigurasi.
Parameter | |
---|---|
sharding | IShardHelper |
setTradefedFeatureServer
public void setTradefedFeatureServer (TradefedFeatureServer server)
Mengatur TradefedFeatureServer
.
Parameter | |
---|---|
server | TradefedFeatureServer |
setWtfHandler
public void setWtfHandler (ITerribleFailureHandler wtfHandler)
Tetapkan ITerribleFailureHandler
.
Parameter | |
---|---|
wtfHandler | ITerribleFailureHandler : penangan WTF |
mempersiapkan
public void setup ()
Pengaturan yang tepat di awal tradefed.
Melempar | |
---|---|
ConfigurationException |
validasiOptions
public void validateOptions ()
Validasi nilai opsi.
Saat ini hanya akan memvalidasi bahwa semua opsi wajib telah ditetapkan
Melempar | |
---|---|
ConfigurationException |
Metode yang dilindungi
getConfigurationFactory
protected IConfigurationFactory getConfigurationFactory ()
Pengembalian | |
---|---|
IConfigurationFactory |