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 を作成します。

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 リクエスト メソッドを実行し、それをERROR(/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 リクエスト メソッドを実行し、それをERROR(/String)として返し、失敗した場合は再試行します。

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

指定された URL に対して POST HTTP リクエスト メソッドを実行し、それをERROR(/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エンコードされたパラメータ文字列

スロー
パラメータのエンコードで例外が発生した場合。

buildUrl

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

完全にエンコードされた URL 要求文字列を作成します。

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

paramMap MultiMap : URL パラメータ

戻り値
String構築された URL

スロー
パラメータのエンコードで例外が発生した場合。

createConnection

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

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

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

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

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

戻り値
HttpURLConnection HttpURL 接続

スロー
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 リクエスト メソッドを実行し、それをERROR(/String)として返します。

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

参考文献:

パラメーター
url String : URL

戻り値
String ERROR(/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 ERROR(/String)リモート コンテンツ

スロー
データの取得に失敗した場合
IHttpHelper.DataSizeException取得したデータが > MAX_DATA_SIZEの場合

doPostWithRetry

public abstract String doPostWithRetry (String url, 
                String postData)

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

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

パラメーター
url String : URL

postData String : 接続が開かれるとポストされるデータ

戻り値
String ERROR(/String)リモート コンテンツ

スロー
データの取得に失敗した場合
IHttpHelper.DataSizeException取得したデータが > MAX_DATA_SIZEの場合

doPostWithRetry

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

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

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

パラメーター
url String : URL

postData String : 接続が開かれるとポストされるデータ

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

戻り値
String ERROR(/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