IGlobalConfiguration
public
interface
IGlobalConfiguration
com.android.tradefed.config.IGlobalConfiguration |
Một lớp để bao gồm thông tin cấu hình chung cho một thực thể Trade Federation (bao gồm mọi lệnh gọi của cấu hình thực tế).
Tóm tắt
Phương thức công khai | |
---|---|
abstract
void
|
cleanup()
Dọn dẹp đúng cách khi tắt tradefed. |
abstract
File
|
cloneConfigWithFilter(
Lọc GlobalConfiguration dựa trên danh sách trắng và xuất ra tệp XML. |
abstract
File
|
cloneConfigWithFilter(
Lọc GlobalConfiguration dựa trên một danh sách trắng, đồng thời cho phép thao tác với các giá trị tuỳ chọn và xuất ra tệp XML. |
abstract
File
|
cloneConfigWithFilter(String... allowlistConfigs)
Lọc GlobalConfiguration dựa trên danh sách được phép và xuất kết quả thành tệp XML. |
abstract
ICommandScheduler
|
getCommandScheduler()
Lấy |
abstract
Object
|
getConfigurationObject(String typeName)
Lấy đối tượng cấu hình tuỳ chỉnh có tên cụ thể. |
abstract
ICredentialFactory
|
getCredentialFactory()
Lấy |
abstract
DeviceManagementGrpcServer
|
getDeviceManagementServer()
Trả về |
abstract
IDeviceManager
|
getDeviceManager()
Lấy |
abstract
|
getDeviceMonitors()
Lấy danh sách |
abstract
IDeviceSelection
|
getDeviceRequirements()
Lấy |
abstract
TradefedFeatureServer
|
getFeatureServer()
Trả về |
abstract
IConfigurationServer
|
getGlobalConfigServer()
Lấy máy chủ cấu hình toàn cục. |
abstract
|
getHostMonitors()
Lấy danh sách |
abstract
IHostOptions
|
getHostOptions()
Lấy |
abstract
IHostResourceManager
|
getHostResourceManager()
Lấy |
abstract
IKeyStoreFactory
|
getKeyStoreFactory()
Lấy |
abstract
|
getMultiDeviceRecoveryHandlers()
Lấy danh sách |
abstract
|
getOptionValues(String optionName)
Lấy danh sách các giá trị của tuỳ chọn. |
abstract
|
getResourceMetricCollectors()
Lấy danh sách |
abstract
ISandboxFactory
|
getSandboxFactory()
Lấy một nhà máy hộp cát có thể dùng để chạy lệnh gọi |
abstract
IShardHelper
|
getShardingStrategy()
Trả về |
abstract
TestInvocationManagementServer
|
getTestInvocationManagementSever()
Trả về |
abstract
ITerribleFailureHandler
|
getWtfHandler()
Lấy |
abstract
void
|
injectOptionValue(String optionName, String optionValue)
Chèn một giá trị tuỳ chọn vào tập hợp các đối tượng cấu hình. |
abstract
void
|
injectOptionValue(String optionName, String optionKey, String optionValue)
Chèn một giá trị tuỳ chọn vào tập hợp các đối tượng cấu hình. |
abstract
void
|
setCommandScheduler(ICommandScheduler scheduler)
Đặt |
abstract
void
|
setConfigurationFactory(IConfigurationFactory configFactory)
Đặt |
abstract
void
|
setConfigurationObject(String name, Object configObject)
Phương thức chung để đặt đối tượng cấu hình có tên đã cho, thay thế mọi giá trị hiện có. |
abstract
void
|
setConfigurationObjectList(String typeName,
Phương thức chung để đặt danh sách đối tượng cấu hình cho tên đã cho, thay thế mọi giá trị hiện có. |
abstract
void
|
setDeviceManagementServer(DeviceManagementGrpcServer server)
|
abstract
void
|
setDeviceManager(IDeviceManager deviceManager)
Đặt |
abstract
void
|
setDeviceMonitor(IDeviceMonitor deviceMonitor)
Đặt |
abstract
void
|
setDeviceRequirements(IDeviceSelection deviceSelection)
Đặt |
abstract
void
|
setHostMonitors(
Đặt danh sách |
abstract
void
|
setHostOptions(IHostOptions hostOptions)
Đặt |
abstract
void
|
setHostResourceManager(IHostResourceManager hostResourceManager)
Đặt |
abstract
void
|
setInvocationServer(TestInvocationManagementServer server)
Thiết lập |
abstract
void
|
setKeyStoreFactory(IKeyStoreFactory factory)
Đặt |
abstract
|
setOptionsFromCommandLineArgs(
Đặt các trường
Xem |
abstract
void
|
setOriginalConfig(String config)
Đặt cấu hình ban đầu dùng để tạo cấu hình chung. |
abstract
void
|
setResourceMetricCollector(IResourceMetricCollector collector)
|
abstract
void
|
setSandboxFactory(ISandboxFactory factory)
Đặt |
abstract
void
|
setShardingStrategy(IShardHelper sharding)
Đặt |
abstract
void
|
setTradefedFeatureServer(TradefedFeatureServer server)
|
abstract
void
|
setWtfHandler(ITerribleFailureHandler wtfHandler)
|
abstract
void
|
setup()
Thiết lập đúng cách khi bắt đầu tradefed. |
abstract
void
|
validateOptions()
Xác thực giá trị của tuỳ chọn. |
Phương thức công khai
dọn dẹp
public abstract void cleanup ()
Dọn dẹp đúng cách khi tắt tradefed.
cloneConfigWithFilter
public abstract File cloneConfigWithFilter (exclusionPatterns, String... allowlistConfigs)
Lọc GlobalConfiguration dựa trên một danh sách trắng và xuất thành tệp XML.
Tham số | |
---|---|
exclusionPatterns |
: Mẫu tên lớp cần loại trừ khỏi tệp kết xuất. |
allowlistConfigs |
String : một mảng String của các cấu hình sẽ được đưa vào tệp XML mới.
Nếu được đặt thành null |
Giá trị trả về | |
---|---|
File |
Tệp chứa cấu hình chung mới được lọc. |
Gửi | |
---|---|
|
IOException |
Xem thêm:
copyrightConfigWithFilter
public abstract File cloneConfigWithFilter (exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)
Lọc GlobalConfiguration dựa trên danh sách trắng trong khi cho phép thao tác với các giá trị tuỳ chọn và đầu ra vào tệp XML.
Tham số | |
---|---|
exclusionPatterns |
: Mẫu tên lớp cần loại trừ khỏi tệp kết xuất. |
transformer |
IConfigOptionValueTransformer |
deepCopy |
boolean |
allowlistConfigs |
String : một mảng String của các cấu hình sẽ được đưa vào tệp XML mới.
Nếu được đặt thành null |
Giá trị trả về | |
---|---|
File |
Tệp chứa cấu hình chung được lọc mới. |
Xem thêm:
copyrightConfigWithFilter
public abstract File cloneConfigWithFilter (String... allowlistConfigs)
Lọc GlobalConfiguration dựa trên danh sách được phép và xuất kết quả thành tệp XML.
Ví dụ: đối với cấu hình sau: <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>
tất cả cấu hình ngoại trừ "key_store" sẽ bị lọc ra và tạo ra một tệp cấu hình có nội dung sau: <xml>
<configuration>
<key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" />
</configuration>
</xml>
Tham số | |
---|---|
allowlistConfigs |
String : một mảng cấu hình String cần đưa vào tệp XML mới.
Nếu được đặt thành null |
Giá trị trả về | |
---|---|
File |
Tệp chứa cấu hình chung mới được lọc. |
Gửi | |
---|---|
|
IOException |
getCommandScheduler
public abstract ICommandScheduler getCommandScheduler ()
Lấy ICommandScheduler
để sử dụng từ cấu hình.
Giá trị trả về | |
---|---|
ICommandScheduler |
ICommandScheduler . Sẽ không bao giờ trả về giá trị rỗng. |
getConfigurationObject
public abstract Object getConfigurationObject (String typeName)
Lấy đối tượng cấu hình tuỳ chỉnh có tên cụ thể.
Tham số | |
---|---|
typeName |
String : loại duy nhất của đối tượng cấu hình |
Giá trị trả về | |
---|---|
Object |
đối tượng hoặc giá trị rỗng nếu không tìm thấy đối tượng có tên đó |
getCredentialFactory
public abstract ICredentialFactory getCredentialFactory ()
Nhận ICredentialFactory
để tạo thông tin xác thực.
Giá trị trả về | |
---|---|
ICredentialFactory |
ICredentialFactory hoặc null nếu không có thuộc tính nào được chỉ định. |
getDeviceManagementServer
public abstract DeviceManagementGrpcServer getDeviceManagementServer ()
Trả về DeviceManagementGrpcServer
hoặc giá trị rỗng nếu không xác định.
Giá trị trả về | |
---|---|
DeviceManagementGrpcServer |
getDeviceManager
public abstract IDeviceManager getDeviceManager ()
Lấy IDeviceManager
để sử dụng từ cấu hình. Quản lý tập hợp các thiết bị có sẵn để kiểm thử
Giá trị trả về | |
---|---|
IDeviceManager |
IDeviceManager được cung cấp trong cấu hình. |
getDeviceMonitors
public abstractgetDeviceMonitors ()
Lấy danh sách IDeviceMonitor
qua cấu hình chung.
Giá trị trả về | |
---|---|
|
danh sách IDeviceMonitor từ cấu hình chung hoặc null nếu
không có thuộc tính nào được chỉ định. |
getDeviceRequested
public abstract IDeviceSelection getDeviceRequirements ()
Lấy IDeviceSelection
để sử dụng từ cấu hình. Đại diện cho một bộ lọc chung trên các thiết bị mà DeviceManager
có thể xem.
Giá trị trả về | |
---|---|
IDeviceSelection |
IDeviceSelection được cung cấp trong cấu hình. |
getFeatureServer
public abstract TradefedFeatureServer getFeatureServer ()
Trả về TradefedFeatureServer
hoặc giá trị rỗng nếu không xác định.
Giá trị trả về | |
---|---|
TradefedFeatureServer |
getGlobalConfigServer
public abstract IConfigurationServer getGlobalConfigServer ()
Lấy máy chủ cấu hình toàn cầu. Máy chủ cấu hình toàn cục được dùng để lấy cấu hình máy chủ lưu trữ từ một máy chủ thay vì lấy từ các tệp cục bộ.
Giá trị trả về | |
---|---|
IConfigurationServer |
getHostMonitor
public abstractgetHostMonitors ()
Lấy danh sách IHostMonitor
từ cấu hình toàn cục.
Giá trị trả về | |
---|---|
|
danh sách IHostMonitor từ cấu hình chung hoặc null nếu không có giá trị nào được chỉ định. |
getHostOptions
public abstract IHostOptions getHostOptions ()
Lấy IHostOptions
để sử dụng từ cấu hình.
Giá trị trả về | |
---|---|
IHostOptions |
IDeviceManager được cung cấp trong cấu hình. |
getHostResourceManager
public abstract IHostResourceManager getHostResourceManager ()
Lấy IHostResourceManager
từ cấu hình chung.
Giá trị trả về | |
---|---|
IHostResourceManager |
IHostResourceManager từ cấu hình chung hoặc phương thức triển khai mặc định LocalHostResourceManager nếu không có phương thức triển khai nào được chỉ định trong cấu hình máy chủ. |
getKeyStoreFactory
public abstract IKeyStoreFactory getKeyStoreFactory ()
Lấy IKeyStoreFactory
để sử dụng từ cấu hình.
Giá trị trả về | |
---|---|
IKeyStoreFactory |
IKeyStoreFactory hoặc rỗng nếu bạn chưa đặt factory lưu trữ khoá. |
getMultiDeviceRecoveryHandlers
public abstractgetMultiDeviceRecoveryHandlers ()
Lấy danh sách IMultiDeviceRecovery
để sử dụng từ cấu hình.
Giá trị trả về | |
---|---|
|
danh sách IMultiDeviceRecovery hoặc null nếu không được đặt. |
giá trị getOption
public abstractgetOptionValues (String optionName)
Nhận danh sách giá trị của lựa chọn.
Tham số | |
---|---|
optionName |
String : tên tuỳ chọn bản đồ |
Giá trị trả về | |
---|---|
|
danh sách các giá trị của tuỳ chọn đã cho. null nếu tên tuỳ chọn không tồn tại. |
getResourceMetricCollectionor
public abstractgetResourceMetricCollectors ()
Lấy danh sách IResourceMetricCollector
từ cấu hình toàn cục.
Giá trị trả về | |
---|---|
|
danh sách IResourceMetricCollector từ cấu hình chung hoặc null
nếu không có danh sách nào được chỉ định. |
getSandboxFactory
public abstract ISandboxFactory getSandboxFactory ()
Nhận nhà máy hộp cát có thể dùng để chạy lệnh gọi
Giá trị trả về | |
---|---|
ISandboxFactory |
getShardingStrategy
public abstract IShardHelper getShardingStrategy ()
Trả về IShardHelper
xác định cách phân đoạn cấu hình.
Giá trị trả về | |
---|---|
IShardHelper |
getTestInvocationManagementSever
public abstract TestInvocationManagementServer getTestInvocationManagementSever ()
Trả về TestInvocationManagementServer
hoặc giá trị rỗng nếu không xác định.
Giá trị trả về | |
---|---|
TestInvocationManagementServer |
getWtfHandler
public abstract ITerribleFailureHandler getWtfHandler ()
Lấy ITerribleFailureHandler
để sử dụng từ cấu hình.
Xử lý việc cần làm trong trường hợp xảy ra lỗi WTF (What a Terrible Failure – Lỗi nghiêm trọng).
Giá trị trả về | |
---|---|
ITerribleFailureHandler |
ITerribleFailureHandler được cung cấp trong cấu hình hoặc rỗng nếu không đặt trình xử lý |
injectOptionValue
public abstract void injectOptionValue (String optionName, String optionValue)
Chèn một giá trị tuỳ chọn vào tập hợp đối tượng cấu hình.
Hữu ích để cung cấp giá trị cho các tuỳ chọn được tạo động.
Tham số | |
---|---|
optionName |
String : tên tuỳ chọn |
optionValue |
String : (các) giá trị lựa chọn |
Gửi | |
---|---|
ConfigurationException |
nếu không đặt được giá trị của tuỳ chọn |
InsertOptionValue
public abstract void injectOptionValue (String optionName, String optionKey, String optionValue)
Chèn một giá trị tuỳ chọn vào tập hợp đối tượng cấu hình.
Hữu ích để cung cấp giá trị cho các tuỳ chọn được tạo động.
Tham số | |
---|---|
optionName |
String : tên tuỳ chọn bản đồ |
optionKey |
String : khoá tuỳ chọn bản đồ |
optionValue |
String : giá trị tuỳ chọn ánh xạ |
Gửi | |
---|---|
ConfigurationException |
nếu không đặt được giá trị của tuỳ chọn |
setCommandScheduler
public abstract void setCommandScheduler (ICommandScheduler scheduler)
Đặt ICommandScheduler
, thay thế mọi giá trị hiện có.
setConfigurationFactory
public abstract void setConfigurationFactory (IConfigurationFactory configFactory)
Đặt IConfigurationFactory
cho cấu hình này.
Tham số | |
---|---|
configFactory |
IConfigurationFactory |
setConfigurationObject
public abstract void setConfigurationObject (String name, Object configObject)
Phương thức chung để đặt đối tượng cấu hình bằng tên đã cho, thay thế mọi giá trị hiện có.
Tham số | |
---|---|
name |
String : tên duy nhất của loại đối tượng cấu hình. |
configObject |
Object : đối tượng cấu hình |
Gửi | |
---|---|
ConfigurationException |
nếu configObject không phải là loại chính xác |
Danh sách đối tượng setConfiguration
public abstract void setConfigurationObjectList (String typeName,configList)
Phương thức chung để đặt danh sách đối tượng cấu hình cho tên đã cho, thay thế mọi giá trị hiện có.
Tham số | |
---|---|
typeName |
String : tên duy nhất của loại đối tượng cấu hình. |
configList |
: danh sách đối tượng cấu hình |
Gửi | |
---|---|
ConfigurationException |
nếu có đối tượng nào trong danh sách không thuộc đúng loại |
setDeviceManagementServer
public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)
Thiết lập DeviceManagementGrpcServer
.
Tham số | |
---|---|
server |
DeviceManagementGrpcServer |
setDeviceManager
public abstract void setDeviceManager (IDeviceManager deviceManager)
Đặt IDeviceManager
, thay thế mọi giá trị hiện có. Thao tác này sẽ đặt trình quản lý cho các thiết bị thử nghiệm
setDeviceMonitor
public abstract void setDeviceMonitor (IDeviceMonitor deviceMonitor)
Đặt IDeviceMonitor
.
Tham số | |
---|---|
deviceMonitor |
IDeviceMonitor : Màn hình |
Gửi | |
---|---|
ConfigurationException |
nếu bạn đã đặt IDeviceMonitor . |
setDeviceRequirements
public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)
Đặt IDeviceSelection
, thay thế mọi giá trị hiện có. Thao tác này sẽ đặt một bộ lọc thiết bị chung trên những thiết bị mà DeviceManager
có thể xem.
setHostMonitor
public abstract void setHostMonitors (hostMonitors)
Đặt danh sách IHostMonitor
.
Tham số | |
---|---|
hostMonitors |
: Danh sách màn hình |
Gửi | |
---|---|
ConfigurationException |
nếu bạn đã đặt IHostMonitor . |
setHostOptions
public abstract void setHostOptions (IHostOptions hostOptions)
Đặt IHostOptions
, thay thế mọi giá trị hiện có.
setHostResourceManager
public abstract void setHostResourceManager (IHostResourceManager hostResourceManager)
Đặt IHostResourceManager
, thay thế mọi giá trị hiện có.
setInvocationServer
public abstract void setInvocationServer (TestInvocationManagementServer server)
Đặt TestInvocationManagementServer
.
Tham số | |
---|---|
server |
TestInvocationManagementServer |
setKeyStoreFactory
public abstract void setKeyStoreFactory (IKeyStoreFactory factory)
Đặt IKeyStoreFactory
, thay thế mọi giá trị hiện có.
setOptionsFromCommandLineArgs
public abstractsetOptionsFromCommandLineArgs ( listArgs)
Đặt các trường Option
cấu hình chung bằng tập hợp đối số dòng lệnh nhất định
Xem ArgsOptionParser
để biết định dạng dự kiến
Tham số | |
---|---|
listArgs |
: đối số dòng lệnh |
Giá trị trả về | |
---|---|
|
các đối số không được sử dụng |
Gửi | |
---|---|
ConfigurationException |
setOriginalConfig
public abstract void setOriginalConfig (String config)
Đặt cấu hình ban đầu dùng để tạo cấu hình chung.
Tham số | |
---|---|
config |
String |
setResourceMetricCollector
public abstract void setResourceMetricCollector (IResourceMetricCollector collector)
Thiết lập IResourceMetricCollector
.
Tham số | |
---|---|
collector |
IResourceMetricCollector |
setSandboxFactory
public abstract void setSandboxFactory (ISandboxFactory factory)
Đặt ISandboxFactory
, thay thế mọi giá trị hiện có.
setShardingStrategy
public abstract void setShardingStrategy (IShardHelper sharding)
Đặt IShardHelper
để sử dụng khi phân đoạn cấu hình.
Tham số | |
---|---|
sharding |
IShardHelper |
setTradefedFeatureServer
public abstract void setTradefedFeatureServer (TradefedFeatureServer server)
Thiết lập TradefedFeatureServer
.
Tham số | |
---|---|
server |
TradefedFeatureServer |
setWtfHandler
public abstract void setWtfHandler (ITerribleFailureHandler wtfHandler)
Tham số | |
---|---|
wtfHandler |
ITerribleFailureHandler : trình xử lý WTF |
Gửi | |
---|---|
ConfigurationException |
nếu bạn đã đặt ITerribleFailureHandler . |
thiết lập
public abstract void setup ()
Thiết lập đúng cách khi bắt đầu tradefed.
Gửi | |
---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
Tùy chọn xác thực
public abstract void validateOptions ()
Xác thực giá trị của tuỳ chọn.
Hiện tại, thao tác này sẽ chỉ xác thực rằng tất cả các tuỳ chọn bắt buộc đều đã được đặt
Gửi | |
---|---|
ConfigurationException |
nếu cấu hình thiếu các trường bắt buộc |