IHttpHelper

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 リクエスト メソッドを実行し、String として返します。

abstract void doGetIgnore(String url)

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

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)

パブリック メソッド

buildParameters

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

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

パラメータ
paramMap MultiMap: URL パラメータ
戻り値
String エンコードされたパラメータ文字列
例外
IllegalArgumentException パラメータのエンコード中に例外が発生した場合。

buildUrl

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

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

パラメータ
url String: ベース URL
paramMap MultiMap: URL パラメータ
戻り値
String 作成された URL
例外
IllegalArgumentException パラメータのエンコード中に例外が発生した場合。

createConnection

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

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

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

createJsonConnection

public abstract HttpURLConnection createJsonConnection (URL url, 
                String method)

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

パラメータ
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 のパラメータで 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: コンテンツ タイプ。例: 「text/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