グローバル構成

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.オブジェクト
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 ()

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

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

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

File cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) 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) 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) 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) 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 ()

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

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

グローバル構成の作成

public static  createGlobalConfiguration (String[] args)

この TF インスタンスのGlobalConfigurationシングルトンをセットアップします。 getInstance()を呼び出す前に、一度だけ呼び出す必要があります。

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

get説明

public String getDescription ()

戻り値
Stringユーザーが読みやすいこのConfiguration短い説明

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

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

戻り値
DeviceManagementGrpcServer

getデバイスマネージャー

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

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

public IHostResourceManager getHostResourceManager ()

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

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

インスタンスの取得

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

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

public ISandboxFactory getSandboxFactory ()

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

戻り値
ISandboxFactory

getSharding戦略

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

printコマンドの使用法

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

setデバイスマネージャー

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

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

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

検証オプション

public void validateOptions ()

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

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

投げる
ConfigurationException

保護されたメソッド

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

戻り値
IConfigurationFactory