Iグローバル構成

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration


単一の Trade Federation インスタンスのグローバル構成情報を包含するクラス (実際の構成の任意の数の呼び出しを包含)。

まとめ

パブリックメソッド

abstract void cleanup ()

トレードオフ時のシャットダウン時の適切なクリーンアップ。

abstract File cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs)

ホワイト リストに基づいて GlobalConfiguration をフィルタリングし、XML ファイルに出力します。

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

ホワイト リストに基づいて GlobalConfiguration をフィルタリングし、オプション値の操作と XML ファイルへの出力を許可します。

abstract File cloneConfigWithFilter (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 getDeviceMonitors ()

グローバル設定からIDeviceMonitorのリストを取得します。

abstract IDeviceSelection getDeviceRequirements ()

使用するIDeviceSelection構成から取得します。

abstract TradefedFeatureServer getFeatureServer ()

TradefedFeatureServerを返すか、未定義の場合は null を返します。

abstract IConfigurationServer getGlobalConfigServer ()

グローバル構成サーバーを取得します。

abstract getHostMonitors ()

グローバル構成からIHostMonitorのリストを取得します。

abstract IHostOptions getHostOptions ()

使用するIHostOptions構成から取得します。

abstract IHostResourceManager getHostResourceManager ()

グローバル構成からIHostResourceManagerを取得します。

abstract IKeyStoreFactory getKeyStoreFactory ()

使用するIKeyStoreFactoryを構成から取得します。

abstract getMultiDeviceRecoveryHandlers ()

使用するIMultiDeviceRecoveryのリストを構成から取得します。

abstract getOptionValues (String optionName)

オプションの値のリストを取得します。

abstract 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, configList) setConfigurationObjectList (String typeName, 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 ( hostMonitors) setHostMonitors ( 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 setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( 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 ()

トレードオフ時のシャットダウン時の適切なクリーンアップ。

cloneConfigWithFilter

public abstract File cloneConfigWithFilter ( exclusionPatterns, 
                String... allowlistConfigs)

ホワイト リストに基づいて GlobalConfiguration をフィルタリングし、XML ファイルに出力します。

パラメーター
exclusionPatterns : ダンプから除外するクラス名のパターン。

allowlistConfigs String : 新しい XML ファイルに含まれる構成のString配列。 null , a default list should be used.
戻り値
File新しいフィルタリングされたグローバル構成を含むファイル。

投げる
IO例外

以下も参照してください。

cloneConfigWithFilter

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

ホワイト リストに基づいて GlobalConfiguration をフィルタリングし、オプション値の操作と XML ファイルへの出力を許可します。

パラメーター
exclusionPatterns : ダンプから除外するクラス名のパターン。

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String : 新しい XML ファイルに含まれる構成のString配列。 null , a default list should be used.
戻り値
File新しいフィルタリングされたグローバル構成を含むファイル。

以下も参照してください。

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 : 新しい XML ファイルに含まれる構成のString配列。 null , a default list should be used.
戻り値
File新しいフィルタリングされたグローバル構成を含むファイル。

投げる
IO例外

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

getデバイスマネージャー

public abstract IDeviceManager getDeviceManager ()

使用するIDeviceManagerを構成から取得します。テストに使用可能なデバイスのセットを管理します

戻り値
IDeviceManager構成で提供されるIDeviceManager

getDeviceMonitors

public abstract  getDeviceMonitors ()

グローバル設定から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  getHostMonitors ()

グローバル構成からIHostMonitorのリストを取得します。

戻り値
グローバル構成からのIHostMonitorのリスト、または何も指定されていない場合はnull

getHostOptions

public abstract IHostOptions getHostOptions ()

使用するIHostOptions構成から取得します。

戻り値
IHostOptions構成で提供されるIDeviceManager

getホストリソースマネージャー

public abstract IHostResourceManager getHostResourceManager ()

グローバル構成からIHostResourceManagerを取得します。

戻り値
IHostResourceManagerグローバル構成からのIHostResourceManager 、またはホスト構成で何も指定されていない場合はデフォルトの実装LocalHostResourceManager

getKeyStoreFactory

public abstract IKeyStoreFactory getKeyStoreFactory ()

使用するIKeyStoreFactoryを構成から取得します。

戻り値
IKeyStoreFactory IKeyStoreFactory 、またはキー ストア ファクトリが設定されていない場合は null。

getMultiDeviceRecoveryHandlers

public abstract  getMultiDeviceRecoveryHandlers ()

使用するIMultiDeviceRecoveryのリストを構成から取得します。

戻り値
IMultiDeviceRecoveryのリスト、または設定されていない場合はnull

getOptionValues

public abstract  getOptionValues (String optionName)

オプションの値のリストを取得します。

パラメーター
optionName String : マップ オプション名

戻り値
指定されたオプションの値のリスト。オプション名が存在しない場合はnull

getResourceMetricCollectors

public abstract  getResourceMetricCollectors ()

グローバル構成からIResourceMetricCollectorのリストを取得します。

戻り値
グローバル構成からのIResourceMetricCollectorのリスト、または何も指定されていない場合はnull

getサンドボックスファクトリー

public abstract ISandboxFactory getSandboxFactory ()

呼び出しの実行に使用できるサンドボックス ファクトリを取得します。

戻り値
ISandboxFactory

getSharding戦略

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

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

指定された名前の構成オブジェクト リストを設定し、既存の値を置き換える一般的なメソッド。

パラメーター
typeName String : 構成オブジェクト タイプの一意の名前。

configList : 構成オブジェクトのリスト

投げる
ConfigurationExceptionリスト内のオブジェクトが正しいタイプではない場合

setDeviceManagementServer

public abstract void setDeviceManagementServer (DeviceManagementGrpcServer server)

DeviceManagementGrpcServerを設定します。

パラメーター
server DeviceManagementGrpcServer

setデバイスマネージャー

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

IHostMonitorリストを設定します。

パラメーター
hostMonitors :モニター一覧

投げる
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  setOptionsFromCommandLineArgs ( listArgs)

指定された一連のコマンド ライン引数を使用してグローバル設定Optionフィールドを設定します。

予想される形式についてはArgsOptionParser参照してください。

パラメーター
listArgs : コマンドライン引数

戻り値
未消費の引数

投げる
ConfigurationException

setOriginalConfig

public abstract void setOriginalConfig (String config)

グローバル構成の作成に使用される元の構成を設定します。

パラメーター
config String

setResourceMetricCollector

public abstract void setResourceMetricCollector (IResourceMetricCollector collector)

IResourceMetricCollectorを設定します。

パラメーター
collector IResourceMetricCollector

セットサンドボックスファクトリー

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

検証オプション

public abstract void validateOptions ()

オプションの値を検証します。

現時点では、これはすべての必須オプションが設定されていることを検証するだけです

投げる
ConfigurationException設定に必須フィールドが欠落している場合