GlobalConfiguration

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

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

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

概要

フィールド

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

パブリック メソッド

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)

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

void setConfigurationObjectList(String typeName, configList)

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

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

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

パブリック メソッド

クリーンアップ

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)

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

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

setConfigurationObjectList

public void setConfigurationObjectList (String typeName, 
                 configList)

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

パラメータ
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