GlobalConfiguration

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Object
   ↳ com.android.tradefed.config.GlobalConfiguration

読み込まれた構成オブジェクトをマップに保存する IGlobalConfiguration 実装

概要

定数

String CREDENTIAL_FACTORY_TYPE_NAME

String DEVICE_MANAGER_TYPE_NAME

String DEVICE_MONITOR_TYPE_NAME

String DEVICE_REQUIREMENTS_TYPE_NAME

String GLOBAL_CONFIG_SERVER

String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

String GLOBAL_CONFIG_VARIABLE

String HOST_MONITOR_TYPE_NAME

String HOST_OPTIONS_TYPE_NAME

String HOST_RESOURCE_MANAGER_TYPE_NAME

String KEY_STORE_TYPE_NAME

String MULTI_DEVICE_RECOVERY_TYPE_NAME

String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

String SANDBOX_FACTORY_TYPE_NAME

String SCHEDULER_TYPE_NAME

String SHARDING_STRATEGY_TYPE_NAME

String TF_DEVICE_MANAGEMENT_SERVER_NAME

String TF_FEATURE_SERVER_NAME

String TF_INVOCATION_SERVER_NAME

String WTF_HANDLER_TYPE_NAME

パブリック メソッド

void cleanup()

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

File cloneConfigWithFilter( exclusionPatterns, String... allowlistConfigs)

ホワイトリストに基づいて GlobalConfiguration をフィルタし、XML ファイルに出力します。
File cloneConfigWithFilter( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)

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

許可リストに基づいて GlobalConfiguration をフィルタし、XML ファイルに出力します。
static createGlobalConfiguration(String[] args)

この TF インスタンスの GlobalConfiguration シングルトンを設定します。
ICommandScheduler getCommandScheduler()

構成から使用する ICommandScheduler を取得します。
Object getConfigurationObject(String typeName)

指定された名前のカスタム構成オブジェクトを取得します。
ICredentialFactory getCredentialFactory()

認証情報を作成するための ICredentialFactory を取得します。
String getDescription()
DeviceManagementGrpcServer getDeviceManagementServer()

DeviceManagementGrpcServer を返します。未定義の場合は null を返します。
IDeviceManager getDeviceManager()

構成から使用する IDeviceManager を取得します。
static IDeviceManager getDeviceManagerInstance()

この TF インスタンスのシングルトン DeviceManager インスタンスへの参照を返します。
getDeviceMonitors()

グローバル構成から IDeviceMonitor のリストを取得します。
IDeviceSelection getDeviceRequirements()

構成から使用する IDeviceSelection を取得します。
TradefedFeatureServer getFeatureServer()

TradefedFeatureServer を返します。未定義の場合は null を返します。
IConfigurationServer getGlobalConfigServer()

グローバル構成サーバーを取得します。
static getHostMonitorInstances()
getHostMonitors()

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

構成から使用する IHostOptions を取得します。
IHostResourceManager getHostResourceManager()

グローバル構成から IHostResourceManager を取得します。
static IGlobalConfiguration getInstance()

この TF インスタンスのシングルトン GlobalConfiguration インスタンスへの参照を返します。
IKeyStoreFactory getKeyStoreFactory()

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

構成から使用する IMultiDeviceRecovery のリストを取得します。
String getName()
getOptionValues(String optionName)

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

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

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

構成をシャーディングする方法を定義する IShardHelper を返します。
TestInvocationManagementServer getTestInvocationManagementSever()

TestInvocationManagementServer を返します。未定義の場合は null を返します。
ITerribleFailureHandler getWtfHandler()

構成から使用する ITerribleFailureHandler を取得します。
void injectOptionValue(String optionName, String optionValue)

構成オブジェクトのセットにオプション値を挿入します。
void injectOptionValue(String optionName, String optionKey, String optionValue)

構成オブジェクトのセットにオプション値を挿入します。
void printCommandUsage(boolean importantOnly, PrintStream out)

この構成のコマンドライン使用法のヘルプテキストを指定された printStream に出力します。
void setCommandScheduler(ICommandScheduler scheduler)

ICommandScheduler を設定し、既存の値を置き換えます。
void setConfigurationFactory(IConfigurationFactory configFactory)

この構成の IConfigurationFactory を設定します。
void setConfigurationObject(String typeName, Object configObject)

指定された名前で構成オブジェクトを設定し、既存の値を置き換える汎用メソッド。
void setConfigurationObjectList(String typeName, configList)

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

void setDeviceManagementServer(DeviceManagementGrpcServer server)

DeviceManagementGrpcServer を設定します。
void setDeviceManager(IDeviceManager manager)

IDeviceManager を設定し、既存の値を置き換えます。
void setDeviceMonitor(IDeviceMonitor monitor)

IDeviceMonitor を設定します。
void setDeviceRequirements(IDeviceSelection devRequirements)

IDeviceSelection を設定し、既存の値を置き換えます。
void setHostMonitors( hostMonitors)

IHostMonitor リストを設定します。
void setHostOptions(IHostOptions hostOptions)

IHostOptions を設定し、既存の値を置き換えます。
void setHostResourceManager(IHostResourceManager hostResourceManager)

IHostResourceManager を設定し、既存の値を置き換えます。
void setInvocationServer(TestInvocationManagementServer server)

TestInvocationManagementServer を設定します。
void setKeyStoreFactory(IKeyStoreFactory factory)

IKeyStoreFactory を設定し、既存の値を置き換えます。
setOptionsFromCommandLineArgs( listArgs)

指定されたコマンドライン引数のセットを使用して、グローバル構成の Option フィールドを設定します。

適切な形式については、ArgsOptionParser をご覧ください。
void setOriginalConfig(String config)

グローバル構成の作成に使用された元の構成を設定します。
void setResourceMetricCollector(IResourceMetricCollector collector)

IResourceMetricCollector を設定します。
void setSandboxFactory(ISandboxFactory factory)

ISandboxFactory を設定し、既存の値を置き換えます。
void setShardingStrategy(IShardHelper sharding)

構成をシャーディングするときに使用する IShardHelper を設定します。
void setTradefedFeatureServer(TradefedFeatureServer server)

TradefedFeatureServer を設定します。
void setWtfHandler(ITerribleFailureHandler wtfHandler)

ITerribleFailureHandler を設定します。
void setup()

tradefed の開始時に適切に設定します。
void validateOptions()

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

保護されたメソッド

IConfigurationFactory getConfigurationFactory()

定数

CREDENTIAL_FACTORY_TYPE_NAME

public static final String CREDENTIAL_FACTORY_TYPE_NAME

定数値: "credential_factory"

DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

定数値: "device_manager"

デバイス モニターのタイプ名

public static final String DEVICE_MONITOR_TYPE_NAME

定数値: "device_monitor"

DEVICE_REQUIREMENTS_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

定数値: "device_requirements"

GLOBAL_CONFIG_SERVER

public static final String GLOBAL_CONFIG_SERVER

定数値: "global_config_server"

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

定数値: "TF_GLOBAL_CONFIG_SERVER_CONFIG"

GLOBAL_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_VARIABLE

定数値: "TF_GLOBAL_CONFIG"

HOST_MONITOR_TYPE_NAME

public static final String HOST_MONITOR_TYPE_NAME

定数値: "host_monitor"

HOST_OPTIONS_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

定数値: "host_options"

HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

定数値: "host_resource_manager"

KEY_STORE_TYPE_NAME

public static final String KEY_STORE_TYPE_NAME

定数値: "key_store"

MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

定数値: "multi_device_recovery"

RESOURCE_METRIC_COLLECTOR_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

定数値: "resource_metric_collector"

SANDBOX_FACTORY_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

定数値: "sandbox_factory"

SCHEDULER_TYPE_NAME

public static final String SCHEDULER_TYPE_NAME

定数値: "command_scheduler"

SHARDING_STRATEGY_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

定数値: "sharding_strategy"

TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

定数値: "tf_device_management_server"

TF_FEATURE_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

定数値: "tf_feature_server"

TF_INVOCATION_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

定数値: "tf_invocation_server"

WTF_HANDLER_TYPE_NAME

public static final String WTF_HANDLER_TYPE_NAME

定数値: "wtf_handler"

パブリック メソッド

クリーンアップ

public void cleanup ()

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

cloneConfigWithFilter

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

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

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

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

cloneConfigWithFilter

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

createGlobalConfiguration

public static  createGlobalConfiguration (String[] args)

この TF インスタンスの GlobalConfiguration シングルトンを設定します。getInstance() を呼び出す前に、1 回だけ呼び出す必要があります。

パラメータ
args String

戻り値
例外
IllegalStateException 複数回呼び出された場合
ConfigurationException

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

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

戻り値
ICommandScheduler ICommandScheduler。null が返されることはありません。

getConfigurationObject

public Object getConfigurationObject (String typeName)

指定された名前のカスタム構成オブジェクトを取得します。

パラメータ
typeName String: 構成オブジェクトの一意のタイプ
戻り値
Object オブジェクト。その名前のオブジェクトが見つからない場合は null

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

認証情報を作成するための ICredentialFactory を取得します。

戻り値
ICredentialFactory 指定されていない場合は ICredentialFactory または null。

getDescription

public String getDescription ()

戻り値
String この Configuration のユーザーが読める短い説明

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

DeviceManagementGrpcServer を返します。未定義の場合は null を返します。

戻り値
DeviceManagementGrpcServer

getDeviceManager

public IDeviceManager getDeviceManager ()

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

戻り値
IDeviceManager 構成で指定された IDeviceManager。

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

この TF インスタンスのシングルトン DeviceManager インスタンスへの参照を返します。

戻り値
IDeviceManager

例外
IllegalStateException createGlobalConfiguration(String[]) がまだ呼び出されていない場合。

getDeviceMonitors

public  getDeviceMonitors ()

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

戻り値
グローバル構成の IDeviceMonitor のリスト。指定されていない場合は null。

getDeviceRequirements

public IDeviceSelection getDeviceRequirements ()

構成から使用する IDeviceSelection を取得します。DeviceManager が認識できるデバイスのグローバル フィルタを表します。

戻り値
IDeviceSelection 構成で指定された IDeviceSelection。

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

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

戻り値
TradefedFeatureServer

getGlobalConfigServer

public IConfigurationServer getGlobalConfigServer ()

グローバル構成サーバーを取得します。グローバル構成サーバーは、ローカル ファイルからではなく、サーバーからホスト構成を取得するために使用されます。

戻り値
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

戻り値

getHostMonitors

public  getHostMonitors ()

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

戻り値
グローバル構成の IHostMonitor のリスト。指定されていない場合は null。

getHostOptions

public IHostOptions getHostOptions ()

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

戻り値
IHostOptions 構成で指定された IDeviceManager。

getHostResourceManager

public IHostResourceManager getHostResourceManager ()

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

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

getInstance

public static IGlobalConfiguration getInstance ()

この TF インスタンスのシングルトン GlobalConfiguration インスタンスへの参照を返します。

戻り値
IGlobalConfiguration

例外
IllegalStateException createGlobalConfiguration(String[]) がまだ呼び出されていない場合。

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

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

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

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

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

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

getName

public String getName ()

戻り値
String この Configuration の名前

getOptionValues

public  getOptionValues (String optionName)

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

パラメータ
optionName String: マップ オプション名
戻り値
指定されたオプションの値のリスト。オプション名が存在しない場合は null。

getResourceMetricCollectors

public  getResourceMetricCollectors ()

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

戻り値
グローバル構成の IResourceMetricCollector のリスト。指定されていない場合は null 。

getSandboxFactory

public ISandboxFactory getSandboxFactory ()

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

戻り値
ISandboxFactory

getShardingStrategy

public IShardHelper getShardingStrategy ()

構成をシャーディングする方法を定義する IShardHelper を返します。

戻り値
IShardHelper

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

TestInvocationManagementServer を返します。未定義の場合は null を返します。

戻り値
TestInvocationManagementServer

getWtfHandler

public ITerribleFailureHandler getWtfHandler ()

構成から使用する ITerribleFailureHandler を取得します。WTF（What a Terrible Failure）が発生した場合の処理を制御します。

戻り値
ITerribleFailureHandler 構成で指定された ITerribleFailureHandler。ハンドラが設定されていない場合は null

injectOptionValue

public void injectOptionValue (String optionName, 
                String optionValue)

構成オブジェクトのセットにオプション値を挿入します。

動的に生成されるオプションの値を指定する場合に便利です。

パラメータ
optionName String: オプション名
optionValue String: オプション値
例外
ConfigurationException

injectOptionValue

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

構成オブジェクトのセットにオプション値を挿入します。

動的に生成されるオプションの値を指定する場合に便利です。

パラメータ
optionName String: マップ オプション名
optionKey String: マップ オプション キー
optionValue String: マップ オプションの値
例外
ConfigurationException

printCommandUsage

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

この構成のコマンドライン使用法のヘルプテキストを指定された printStream に出力します。

パラメータ
importantOnly boolean

out PrintStream: 使用する ERROR(/PrintStream)。
例外
com.android.tradefed.config.ConfigurationException
ConfigurationException

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

ICommandScheduler を設定し、既存の値を置き換えます。

setConfigurationFactory

public void setConfigurationFactory (IConfigurationFactory configFactory)

この構成の IConfigurationFactory を設定します。

パラメータ
configFactory IConfigurationFactory

setConfigurationObject

public void setConfigurationObject (String typeName, 
                Object configObject)

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

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

setConfigurationObjectList

public void setConfigurationObjectList (String typeName, 
                 configList)

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

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

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

DeviceManagementGrpcServer を設定します。

パラメータ
server DeviceManagementGrpcServer

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

IDeviceManager を設定し、既存の値を置き換えます。これにより、テストデバイスのマネージャーが設定されます。

setDeviceMonitor

public void setDeviceMonitor (IDeviceMonitor monitor)

IDeviceMonitor を設定します。

パラメータ
monitor IDeviceMonitor: モニター

setDeviceRequirements

public void setDeviceRequirements (IDeviceSelection devRequirements)

IDeviceSelection を設定し、既存の値を置き換えます。これにより、DeviceManager が確認できるデバイスにグローバル デバイス フィルタが設定されます。

setHostMonitors

public void setHostMonitors ( hostMonitors)

IHostMonitor リストを設定します。

パラメータ
hostMonitors : モニターのリスト

setHostOptions

public void setHostOptions (IHostOptions hostOptions)

IHostOptions を設定し、既存の値を置き換えます。

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

IHostResourceManager を設定し、既存の値を置き換えます。

setInvocationServer

public void setInvocationServer (TestInvocationManagementServer server)

TestInvocationManagementServer を設定します。

パラメータ
server TestInvocationManagementServer

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

IKeyStoreFactory を設定し、既存の値を置き換えます。

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

指定されたコマンドライン引数のセットを使用して、グローバル構成の Option フィールドを設定します。

適切な形式については、ArgsOptionParser をご覧ください。

パラメータ
listArgs : コマンドライン引数
戻り値
未消費の引数
例外
ConfigurationException

setOriginalConfig

public void setOriginalConfig (String config)

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

パラメータ
config String

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

IResourceMetricCollector を設定します。

パラメータ
collector IResourceMetricCollector

setSandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

ISandboxFactory を設定し、既存の値を置き換えます。

setShardingStrategy

public void setShardingStrategy (IShardHelper sharding)

構成をシャーディングするときに使用する IShardHelper を設定します。

パラメータ
sharding IShardHelper

setTradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

TradefedFeatureServer を設定します。

パラメータ
server TradefedFeatureServer

setWtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

ITerribleFailureHandler を設定します。

パラメータ
wtfHandler ITerribleFailureHandler: WTF ハンドラ

設定

public void setup ()

tradefed の開始時に適切に設定します。

例外
ConfigurationException

validateOptions

public void validateOptions ()

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

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

例外
ConfigurationException

保護されたメソッド

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

戻り値
IConfigurationFactory