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 リクエスト メソッドを実行し、結果を
|
abstract
String
|
doGet(String url)
指定された URL に対して GET HTTP リクエスト メソッドを実行し、 |
abstract
void
|
doGetIgnore(String url)
指定された URL に対して GET を実行します。指定された URL パラメータでは結果は無視されます。 |
abstract
void
|
doGetIgnoreWithRetry(String url)
失敗時に { |
abstract
String
|
doGetWithRetry(String url)
失敗時に { |
abstract
String
|
doPostWithRetry(String url, String postData)
指定された URL に対して POST HTTP リクエスト メソッドを実行し、 |
abstract
String
|
doPostWithRetry(String url, String postData, String contentType)
指定された URL に対して POST HTTP リクエスト メソッドを実行し、 |
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)
オペレーション タイムアウトをミリ秒単位で設定します。 |
定数
最大データサイズ
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 |
例外 | |
---|---|
|
発生します。 |
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
として返します。
リモート コンテンツはメモリに読み込まれるため、このメソッドは 比較的小さなデータサイズです。
関連資料:
- Java URL 接続: <ph type="x-smartling-placeholder"></ph> http://java.sun.com/docs/books/tutorial/networking/urls/readingWriting.html
- Java URL リーダー: <ph type="x-smartling-placeholder"></ph> http://java.sun.com/docs/books/tutorial/networking/urls/readingURL.html
- Java でプロキシを設定: <ph type="x-smartling-placeholder"></ph> http://java.sun.com/docs/books/tutorial/networking/urls/_setProxy.html
パラメータ | |
---|---|
url |
String : URL |
戻り値 | |
---|---|
String |
String リモート コンテンツ |
例外 | |
---|---|
|
データの取得に失敗した場合 |
IHttpHelper.DataSizeException |
取得したデータが >MAX_DATA_SIZE |
doGetIgnore
public abstract void doGetIgnore (String url)
指定された URL に対して GET を実行します。指定された URL パラメータでは結果は無視されます。
パラメータ | |
---|---|
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 |