IWifiHelper

public interface IWifiHelper

com.android.tradefed.device.IWifiHelper


デバイスの Wi-Fi サービスを操作するためのヘルパー インターフェース。

概要

パブリック メソッド

abstract boolean addOpenNetwork(String ssid)

ssid で識別されるオープン セキュリティ ネットワークを追加します。

abstract boolean addOpenNetwork(String ssid, boolean scanSsid)

ssid で識別されるオープン セキュリティ ネットワークを追加します。

abstract boolean addWpaPskNetwork(String ssid, String psk)

ssid で識別される WPA-PSK セキュリティ ネットワークを追加します。

abstract boolean addWpaPskNetwork(String ssid, String psk, boolean scanSsid)

ssid で識別される WPA-PSK セキュリティ ネットワークを追加します。

abstract boolean checkConnectivity(String urlToCheck)

指定された URL に HTTP リクエストを送信して接続を確認します。

abstract void cleanUp()

リソースと wifi ヘルパー パッケージのインストールをクリーンアップします。

abstract boolean connectToNetwork(String ssid, String psk, String urlToCheck)

Wi-Fi ネットワークに接続し、接続を確認します。

abstract IWifiHelper.WifiConnectionResult connectToNetwork(String ssid, String psk, String urlToCheck, boolean scanSsid, String defaultType)

Wi-Fi ネットワークに接続し、接続を確認します。

abstract IWifiHelper.WifiConnectionResult connectToNetwork(String ssid, String psk, String urlToCheck, boolean scanSsid)

Wi-Fi ネットワークに接続し、接続を確認します。

abstract boolean disableWifi()

デバイスの Wi-Fi 状態を無効にします。

abstract boolean disconnectFromNetwork()

現在の Wi-Fi ネットワークから切断し、Wi-Fi を無効にします。

abstract boolean enableWifi()

デバイスで Wi-Fi の状態を有効にします。

abstract String getBSSID()

現在アクセスしているアクセス ポイントの基本サービスセット識別子(BSSID)を取得します。

abstract String getIpAddress()

Wi-Fi インターフェースに関連付けられた IP アドレスを取得します。

abstract String getSSID()

現在接続されているネットワークのサービスセット識別子を取得します。

abstract Map<String, String> getWifiInfo()

現在の Wi-Fi 接続情報を取得します。

abstract boolean hasValidIp()
abstract boolean isWifiEnabled()

現在 Wi-Fi が有効になっているかどうかを確認します。

abstract boolean removeAllNetworks()

既知のすべてのネットワークを削除します。

abstract boolean startMonitor(long interval, String urlToCheck)

ネットワーク接続のモニタリングを開始します。

abstract List<Long> stopMonitor()

ネットワーク接続のモニタリングを停止します。

abstract boolean waitForIp(long timeout)

Wi-Fi アダプタに IP アドレスが割り当てられるまで待ちます。

abstract boolean waitForWifiDisabled(long timeout)

isWifiEnabled() が false になるまで待ちます。

abstract boolean waitForWifiDisabled()

デフォルトのタイムアウトで isWifiEnabled() が false になるまで待ちます。

abstract boolean waitForWifiEnabled(long timeout)

isWifiEnabled() が true になるまで待ちます。

abstract boolean waitForWifiEnabled()

デフォルトのタイムアウトで isWifiEnabled() が true になるまで待機します。

abstract boolean waitForWifiState(WifiState... expectedStates)

想定される Wi-Fi 状態のいずれかが発生するまで待機します。

パブリック メソッド

addOpenNetwork

public abstract boolean addOpenNetwork (String ssid)

ssid で識別されるオープン セキュリティ ネットワークを追加します。

Wi-Fi ネットワークに接続するには、まず wpa_supplicant 構成でネットワーク プロファイルを作成する必要があります。これにより、wpa_cli が呼び出され、ssid で識別されるオープン セキュリティ ネットワークが追加されます。

パラメータ
ssid String: 追加するネットワークの SSID。

戻り値
boolean ネットワークが正常に追加された場合は true、それ以外の場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

addOpenNetwork

public abstract boolean addOpenNetwork (String ssid, 
                boolean scanSsid)

ssid で識別されるオープン セキュリティ ネットワークを追加します。

Wi-Fi ネットワークに接続するには、まず wpa_supplicant 構成でネットワーク プロファイルを作成する必要があります。これにより、wpa_cli が呼び出され、ssid で識別されるオープン セキュリティ ネットワークが追加されます。

パラメータ
ssid String: 追加するネットワークの SSID。

scanSsid boolean: このネットワークの非表示 SSID をスキャンするかどうか。

戻り値
boolean ネットワークが正常に追加された場合は true、それ以外の場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

addWpaPskNetwork

public abstract boolean addWpaPskNetwork (String ssid, 
                String psk)

ssid で識別される WPA-PSK セキュリティ ネットワークを追加します。

パラメータ
ssid String: 追加するネットワークの SSID。

psk String: 使用する WPA-PSK パスフレーズ

戻り値
boolean ネットワークが正常に追加された場合は true、それ以外の場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

addWpaPskNetwork

public abstract boolean addWpaPskNetwork (String ssid, 
                String psk, 
                boolean scanSsid)

ssid で識別される WPA-PSK セキュリティ ネットワークを追加します。

パラメータ
ssid String: 追加するネットワークの SSID。

psk String: 使用する WPA-PSK パスフレーズ

scanSsid boolean: このネットワークの非表示 SSID をスキャンするかどうか。

戻り値
boolean ネットワークが正常に追加された場合は true、それ以外の場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

checkConnectivity

public abstract boolean checkConnectivity (String urlToCheck)

指定された URL に HTTP リクエストを送信して接続を確認します。

パラメータ
urlToCheck String: HTTP リクエスト チェックの宛先 URL

戻り値
boolean デバイスが接続チェックに合格した場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

cleanUp

public abstract void cleanUp ()

リソースと Wi-Fi ヘルパー パッケージのインストールをクリーンアップします。このメソッドは、呼び出しに Wi-Fi が不要になった場合にのみ呼び出す必要があります。ヘルパーがアンインストールされると、デバイスの Wi-Fi 接続が切断されるためです。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

connectToNetwork

public abstract boolean connectToNetwork (String ssid, 
                String psk, 
                String urlToCheck)

Wi-Fi ネットワークに接続し、接続を確認します。

パラメータ
ssid String: 接続するネットワークの SSID

psk String: 使用する WPA-PSK パスフレーズ。null になることもあります。

urlToCheck String: HTTP リクエスト チェックの宛先 URL

戻り値
boolean デバイスが接続チェックに合格した場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

connectToNetwork

public abstract IWifiHelper.WifiConnectionResult connectToNetwork (String ssid, 
                String psk, 
                String urlToCheck, 
                boolean scanSsid, 
                String defaultType)

Wi-Fi ネットワークに接続し、接続を確認します。

パラメータ
ssid String: 接続するネットワークの SSID

psk String: 使用する WPA-PSK パスフレーズ。null になることもあります。

urlToCheck String: HTTP リクエスト チェックの宛先 URL

scanSsid boolean: このネットワークで非表示の SSID をスキャンするかどうか

defaultType String: SSID のネットワークの種類が特定できない場合にフォールバックするデフォルトのネットワークの種類

戻り値
IWifiHelper.WifiConnectionResult Wi-Fi 接続結果を表す WifiConnectionResult

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

connectToNetwork

public abstract IWifiHelper.WifiConnectionResult connectToNetwork (String ssid, 
                String psk, 
                String urlToCheck, 
                boolean scanSsid)

Wi-Fi ネットワークに接続し、接続を確認します。

パラメータ
ssid String: 接続するネットワークの SSID

psk String: 使用する WPA-PSK パスフレーズ。null になることもあります。

urlToCheck String: HTTP リクエスト チェックの宛先 URL

scanSsid boolean: このネットワークで非表示の SSID をスキャンするかどうか

戻り値
IWifiHelper.WifiConnectionResult Wi-Fi 接続結果を表す WifiConnectionResult

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

disableWifi

public abstract boolean disableWifi ()

デバイスの Wi-Fi 状態を無効にします。

戻り値
boolean Wi-Fi が正常に無効になった場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

disconnectFromNetwork

public abstract boolean disconnectFromNetwork ()

現在の Wi-Fi ネットワークから切断し、Wi-Fi を無効にします。

戻り値
boolean オペレーションが成功した場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

enableWifi

public abstract boolean enableWifi ()

デバイスの Wi-Fi 状態を有効にします。

戻り値
boolean Wi-Fi が正常に有効になった場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBSSID

public abstract String getBSSID ()

現在アクセスしているアクセス ポイントの基本サービスセット識別子(BSSID)を取得します。

戻り値
String

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getIpAddress

public abstract String getIpAddress ()

Wi-Fi インターフェースに関連付けられた IP アドレスを取得します。IP アドレスの取得に失敗した場合は null を返します。

戻り値
String

例外
DeviceNotAvailableException

getSSID

public abstract String getSSID ()

現在接続されているネットワークのサービスセット識別子を取得します。

戻り値
String

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getWifiInfo

public abstract Map<String, String> getWifiInfo ()

現在の Wi-Fi 接続情報を取得します。

これには、SSID、BSSID、IP アドレス、リンク速度、RSSI が含まれます。

戻り値
Map<String, String> Wi-Fi 接続情報を含むマップ。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

hasValidIp

public abstract boolean hasValidIp ()

戻り値
boolean デバイスに有効な IP アドレスがある場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

isWifiEnabled

public abstract boolean isWifiEnabled ()

Wi-Fi が現在有効になっているかどうかを確認します。

戻り値
boolean

例外
DeviceNotAvailableException

removeAllNetworks

public abstract boolean removeAllNetworks ()

既知のすべてのネットワークを削除します。

戻り値
boolean

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

startMonitor

public abstract boolean startMonitor (long interval, 
                String urlToCheck)

ネットワーク接続のモニタリングを開始します。

パラメータ
interval long: 接続チェックの間隔。

urlToCheck String: 接続を確認する URL。

戻り値
boolean オペレーションが成功した場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

stopMonitor

public abstract List<Long> stopMonitor ()

ネットワーク接続のモニタリングを停止します。

また、前回の IWifiHelper.startMonitor(long,String) 呼び出し以降のレイテンシ履歴も返します。

戻り値
List<Long> レイテンシの履歴。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

waitForIp

public abstract boolean waitForIp (long timeout)

Wi-Fi アダプタに IP アドレスが割り当てられるまで待ちます。

パラメータ
timeout long: 待機時間

戻り値
boolean タイムアウト前に IP アドレスが割り当てられた場合は true、それ以外の場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

waitForWifiDisabled

public abstract boolean waitForWifiDisabled (long timeout)

isWifiEnabled() が false になるまで待ちます。

パラメータ
timeout long: 待機する時間(ミリ秒単位)

戻り値
boolean タイムアウト前に Wi-Fi が無効になっていた場合は true、それ以外の場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

waitForWifiDisabled

public abstract boolean waitForWifiDisabled ()

デフォルトのタイムアウトで isWifiEnabled() が false になるまで待ちます。

戻り値
boolean タイムアウト前に Wi-Fi が無効になっていた場合は true、それ以外の場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

waitForWifiEnabled

public abstract boolean waitForWifiEnabled (long timeout)

isWifiEnabled() が true になるまで待ちます。

パラメータ
timeout long: 待機する時間(ミリ秒単位)

戻り値
boolean タイムアウト前に Wi-Fi が有効になっていた場合は true、そうでない場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

waitForWifiEnabled

public abstract boolean waitForWifiEnabled ()

デフォルトのタイムアウトで isWifiEnabled() が true になるまで待機します。

戻り値
boolean タイムアウト前に Wi-Fi が有効になっていた場合は true、そうでない場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

waitForWifiState

public abstract boolean waitForWifiState (WifiState... expectedStates)

想定される Wi-Fi 状態のいずれかが発生するまで待機します。

パラメータ
expectedStates WifiState: 想定される 1 つ以上の Wi-Fi 状態

戻り値
boolean true(期待される状態のいずれかが発生した場合)。タイムアウトに達する前にどの状態も発生しなかった場合は false

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException