IGlobalConfiguration

public interface IGlobalConfiguration

com.android.tradefed.config.IGlobalConfiguration

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

概要

パブリック メソッド

abstract void cleanup()

tradefed のシャットダウン時に適切にクリーンアップ。

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

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

abstract File 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)

既存の値を置き換えて、指定された名前の config オブジェクトを設定する汎用メソッド。

abstract void setConfigurationObjectList(String typeName, configList)

指定された名前の config オブジェクトのリストを設定するための汎用メソッド。既存の値を置き換えます。

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)

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)

指定されたコマンドライン引数のセットでグローバル構成 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 ( exclusionPatterns, 
                String... allowlistConfigs)

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

パラメータ
exclusionPatterns : ダンプから除外するクラス名のパターン。
allowlistConfigs String: 新しい XML ファイルに含める構成の String 配列。null, a default list should be used.

 に設定されている場合
戻り値
File 新しいフィルタされたグローバル構成を含むファイル。
例外
IOException

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 新しいフィルタされたグローバル構成を含むファイル。
例外
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  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。

getHostResourceManager

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 。

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

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)

既存の値を置き換えて、指定された名前の config オブジェクトを設定する汎用メソッド。

パラメータ
name String: 構成オブジェクト タイプの一意の名前。
configObject Object: config オブジェクト
例外
ConfigurationException configObject の型が正しくない場合

setConfigurationObjectList

public abstract void setConfigurationObjectList (String typeName, 
                 configList)

指定された名前の config オブジェクトのリストを設定するための汎用メソッド。既存の値を置き換えます。

パラメータ
typeName String: 構成オブジェクト タイプの一意の名前。
configList : 構成オブジェクトのリスト
例外
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 ( 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

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 構成に必須フィールドがないかどうか