HttpHelper

public class HttpHelper
extends Object implements IHttpHelper

java.lang.Object
   ↳ com.android.tradefed.util.net.HttpHelper

HTTP リクエストを行うためのヘルパー メソッドが含まれています。

概要

ネストされたクラス

class HttpHelper.RequestRunnable

IRunUtil.runEscalatingTimedRetry(long, long, long, long, IRunnableResult) を使用してリクエストを実行するための実行可能ファイル。 

パブリック コンストラクタ

HttpHelper()

パブリック メソッド

String buildParameters(MultiMap<String, String> paramMap)

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

String buildUrl(String baseUrl, MultiMap<String, String> paramMap)

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

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

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

HttpURLConnection createJsonConnection(URL url, String method)

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

HttpURLConnection createXmlConnection(URL url, String method)

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

void doGet(String url, OutputStream outputStream)

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

String doGet(String url)

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

void doGetIgnore(String url)

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

void doGetIgnoreWithRetry(String url)

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

String doGetWithRetry(String url)

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

String doPostWithRetry(String url, String postData)

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

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

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

int getInitialPollInterval()

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

int getMaxPollInterval()

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

int getMaxTime()

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

int getOpTimeout()

オペレーションのタイムアウトをミリ秒単位で取得します。

IRunUtil getRunUtil()

使用する IRunUtil を取得します。

void setInitialPollInterval(int time)

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

void setMaxPollInterval(int time)

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

void setMaxTime(int time)

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

void setOpTimeout(int time)

オペレーションのタイムアウトをミリ秒単位で設定します。

パブリック コンストラクタ

HttpHelper

public HttpHelper ()

パブリック メソッド

buildParameters

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

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

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

buildUrl

public String buildUrl (String baseUrl, 
                MultiMap<String, String> paramMap)

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

パラメータ
baseUrl String: ベース URL
paramMap MultiMap: URL パラメータ
戻り値
String 作成された URL

createConnection

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

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

パラメータ
url URL: 接続先の ERROR(/URL)。
method String: HTTP リクエスト メソッド。たとえば、GET や POST などです。
contentType String: コンテンツ タイプ。たとえば、「text/html」です。
戻り値
HttpURLConnection HttpURLConnection

createJsonConnection

public HttpURLConnection createJsonConnection (URL url, 
                String method)

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

パラメータ
url URL: 接続先の ERROR(/URL)。
method String: HTTP リクエスト メソッド。たとえば、GET や POST などです。
戻り値
HttpURLConnection ERROR(/HttpURLConnection)

createXmlConnection

public HttpURLConnection createXmlConnection (URL url, 
                String method)

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

パラメータ
url URL: 接続先の ERROR(/URL)。
method String: HTTP リクエスト メソッド。たとえば、GET や POST などです。
戻り値
HttpURLConnection ERROR(/HttpURLConnection)

doGet

public void doGet (String url, 
                OutputStream outputStream)

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

パラメータ
url String: URL
outputStream OutputStream: レスポンス データのストリーミング

doGet

public String doGet (String url)

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

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

参照:

パラメータ
url String: URL
戻り値
String String リモート コンテンツ
例外
IHttpHelper.DataSizeException

doGetIgnore

public void doGetIgnore (String url)

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

パラメータ
url String: URL

doGetIgnoreWithRetry

public void doGetIgnoreWithRetry (String url)

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

パラメータ
url String: URL

doGetWithRetry

public String doGetWithRetry (String url)

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

パラメータ
url String: URL
戻り値
String String リモート コンテンツ
例外
IHttpHelper.DataSizeException

doPostWithRetry

public String doPostWithRetry (String url, 
                String postData)

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

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

パラメータ
url String: URL
postData String: 接続が開かれた後に投稿されるデータ
戻り値
String String リモート コンテンツ
例外
IHttpHelper.DataSizeException

doPostWithRetry

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

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

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

パラメータ
url String: URL
postData String: 接続が開かれた後に投稿されるデータ
contentType String: コンテンツ タイプ。たとえば、「text/html」です。
戻り値
String String リモート コンテンツ
例外
IHttpHelper.DataSizeException

getInitialPollInterval

public int getInitialPollInterval ()

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

戻り値
int

getMaxPollInterval

public int getMaxPollInterval ()

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

戻り値
int

getMaxTime

public int getMaxTime ()

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

戻り値
int

getOpTimeout

public int getOpTimeout ()

オペレーションのタイムアウト（ミリ秒単位）を取得します。

戻り値
int

getRunUtil

public IRunUtil getRunUtil ()

使用する IRunUtil を取得します。単体テストでモックできるように公開されています。

戻り値
IRunUtil

setInitialPollInterval

public void setInitialPollInterval (int time)

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

パラメータ
time int

setMaxPollInterval

public void setMaxPollInterval (int time)

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

パラメータ
time int

setMaxTime

public void setMaxTime (int time)

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

パラメータ
time int

setOpTimeout

public void setOpTimeout (int time)

オペレーションのタイムアウトをミリ秒単位で設定します。

パラメータ
time int