IHTTPヘルパー

public interface IHttpHelper

com.android.tradefed.util.net.IHttpHelper

http リクエストを実行するためのヘルパー メソッド。

まとめ

入れ子になったクラス

class IHttpHelper.DataSizeException

定数

int MAX_DATA_SIZE

パブリックメソッド

abstract String buildParameters ( MultiMap <String, String> paramMap)

エンコードされたパラメータ文字列を構築します。

abstract String buildUrl (String url, MultiMap <String, String> paramMap)

完全なエンコードされた URL リクエスト文字列を作成します。

abstract HttpURLConnection createConnection (URL url, String method, String contentType)

指定された URL への URL を作成します。

abstract HttpURLConnection createJsonConnection (URL url, String method)

json データを渡すために、指定された URL への接続を作成します。

abstract HttpURLConnection createXmlConnection (URL url, String method)

XML データを渡すために、指定された URL への接続を作成します。

abstract void doGet (String url, OutputStream outputStream)

指定された URL に対して GET HTTP リクエスト メソッドを実行し、結果をERROR(/OutputStream)にストリームします。

abstract String doGet (String url)

指定された URL に対して GET HTTP リクエスト メソッドを実行し、それをStringとして返します。

abstract void doGetIgnore (String url)

指定された URL パラメータを使用して、結果を無視して、指定された URL に対して GET を実行します。

abstract void doGetIgnoreWithRetry (String url)

失敗時に { doGetIgnore(String)の再試行を実行します。

abstract String doGetWithRetry (String url)

失敗時に { doGet(String)の再試行を実行します。

abstract String doPostWithRetry (String url, String postData)

指定された URL に対して POST HTTP リクエスト メソッドを実行し、それをStringとして返し、失敗した場合は再試行します。

abstract String doPostWithRetry (String url, String postData, String contentType)

指定された URL に対して POST HTTP リクエスト メソッドを実行し、それをStringとして返し、失敗した場合は再試行します。

abstract int getInitialPollInterval ()

初期ポーリング間隔をミリ秒単位で取得します。

abstract int getMaxPollInterval ()

最大ポーリング間隔をミリ秒単位で取得します。

abstract int getMaxTime ()

リクエストの試行を継続する最大時間をミリ秒単位で取得します。

abstract int getOpTimeout ()

操作のタイムアウトをミリ秒単位で取得します。

abstract void setInitialPollInterval (int time)

初期ポーリング間隔をミリ秒単位で設定します。

abstract void setMaxPollInterval (int time)

初期ポーリング間隔をミリ秒単位で設定します。

abstract void setMaxTime (int time)

リクエストを試行し続ける最大時間をミリ秒単位で設定します。

abstract void setOpTimeout (int time)

操作のタイムアウトをミリ秒単位で設定します。

定数

MAX_DATA_SIZE

public static final int MAX_DATA_SIZE

定数値: 65536 (0x00010000)

パブリックメソッド

ビルドパラメータ

public abstract String buildParameters (MultiMap<String, String> paramMap)

エンコードされたパラメータ文字列を構築します。

パラメーター
paramMap MultiMap : URL パラメータ

戻り値
Stringエンコードされたパラメータ文字列

投げる
IllegalArgumentException例外が発生した場合はパラメータをエンコードします。

ビルドURL

public abstract String buildUrl (String url, 
                MultiMap<String, String> paramMap)

完全なエンコードされた URL リクエスト文字列を作成します。

パラメーター
url String : ベース URL

paramMap MultiMap : URL パラメータ

戻り値
String構築された URL

投げる
IllegalArgumentException例外が発生した場合はパラメータをエンコードします。

接続の作成

public abstract HttpURLConnection createConnection (URL url, 
                String method, 
                String contentType)

指定された URL への URL を作成します。

パラメーター
url URL : 接続先のERROR(/URL) 。

method String : HTTP リクエストメソッド。たとえば、GET または POST です。

contentType String : コンテンツ タイプ。たとえば、「テキスト/html」などです。

戻り値
HttpURLConnection HttpURLConnection

投げる
IOException が発生した場合。

createJsonConnection

public abstract HttpURLConnection createJsonConnection (URL url, 
                String method)

json データを渡すために、指定された URL への接続を作成します。

パラメーター
url URL : 接続先のERROR(/URL) 。

method String : HTTP リクエストメソッド。たとえば、GET または POST です。

戻り値
HttpURLConnection ERROR(/HttpURLConnection)

投げる
接続に失敗した場合

createXmlConnection

public abstract HttpURLConnection createXmlConnection (URL url, 
                String method)

XML データを渡すために、指定された URL への接続を作成します。

パラメーター
url URL : 接続先のERROR(/URL) 。

method String : HTTP リクエストメソッド。たとえば、GET または POST です。

戻り値
HttpURLConnection ERROR(/HttpURLConnection)

投げる
接続に失敗した場合

doGet

public abstract void doGet (String url, 
                OutputStream outputStream)

指定された URL に対して GET HTTP リクエスト メソッドを実行し、結果をERROR(/OutputStream)にストリームします。

パラメーター
url String : URL

outputStream OutputStream : 応答データのストリーム

投げる
データの取得に失敗した場合

以下も参照してください。

doGet

public abstract String doGet (String url)

指定された URL に対して GET HTTP リクエスト メソッドを実行し、それをStringとして返します。

リモート コンテンツはメモリにロードされるため、この方法はデータ サイズが比較的小さい場合にのみ使用してください。

参考文献:

パラメーター
url String : URL

戻り値
String Stringリモートの内容

投げる
データの取得に失敗した場合
IHttpHelper.DataSizeException取得したデータがMAX_DATA_SIZEを超える場合

doGetIgnore

public abstract void doGetIgnore (String url)

指定された URL パラメータを使用して、結果を無視して、指定された URL に対して GET を実行します。

パラメーター
url String : URL

投げる
データの取得に失敗した場合

以下も参照してください。

doGetIgnoreWithRetry

public abstract void doGetIgnoreWithRetry (String url)

失敗時に { doGetIgnore(String)の再試行を実行します。

パラメーター
url String : URL

投げる
データの取得に失敗した場合

doGetWithRetry

public abstract String doGetWithRetry (String url)

失敗時に { doGet(String)の再試行を実行します。

パラメーター
url String : URL

戻り値
String Stringリモートの内容

投げる
データの取得に失敗した場合
IHttpHelper.DataSizeException取得したデータがMAX_DATA_SIZEを超える場合

doPostWithRetry

public abstract String doPostWithRetry (String url, 
                String postData)

指定された URL に対して POST HTTP リクエスト メソッドを実行し、それをStringとして返し、失敗した場合は再試行します。

リモート コンテンツはメモリにロードされるため、この方法はデータ サイズが比較的小さい場合にのみ使用してください。

パラメーター
url String : URL

postData String : 接続が開いたら送信されるデータ

戻り値
String Stringリモートの内容

投げる
データの取得に失敗した場合
IHttpHelper.DataSizeException取得したデータがMAX_DATA_SIZEを超える場合

doPostWithRetry

public abstract String doPostWithRetry (String url, 
                String postData, 
                String contentType)

指定された URL に対して POST HTTP リクエスト メソッドを実行し、それをStringとして返し、失敗した場合は再試行します。

リモート コンテンツはメモリにロードされるため、この方法はデータ サイズが比較的小さい場合にのみ使用してください。

パラメーター
url String : URL

postData String : 接続が開いたら送信されるデータ

contentType String : コンテンツ タイプ。たとえば、「テキスト/html」などです。

戻り値
String Stringリモートの内容

投げる
データの取得に失敗した場合
IHttpHelper.DataSizeException取得したデータがMAX_DATA_SIZEを超える場合

getInitialPollInterval

public abstract int getInitialPollInterval ()

初期ポーリング間隔をミリ秒単位で取得します。

戻り値
int

getMaxPollInterval

public abstract int getMaxPollInterval ()

最大ポーリング間隔をミリ秒単位で取得します。

戻り値
int

getMaxTime

public abstract int getMaxTime ()

リクエストの試行を継続する最大時間をミリ秒単位で取得します。

戻り値
int

getOpTimeout

public abstract int getOpTimeout ()

操作のタイムアウトをミリ秒単位で取得します。

戻り値
int

setInitialPollInterval

public abstract void setInitialPollInterval (int time)

初期ポーリング間隔をミリ秒単位で設定します。

パラメーター
time int

setMaxPollInterval

public abstract void setMaxPollInterval (int time)

初期ポーリング間隔をミリ秒単位で設定します。

パラメーター
time int

setMaxTime

public abstract void setMaxTime (int time)

リクエストを試行し続ける最大時間をミリ秒単位で設定します。

パラメーター
time int

setOpTimeout

public abstract void setOpTimeout (int time)

操作のタイムアウトをミリ秒単位で設定します。

パラメーター
time int