IHttpHelper

public interface IHttpHelper

com.android.tradefed.util.net.IHttpHelper

Известные косвенные подклассы HttpHelper , SsoClientHttpHelper HttpHelper Содержит вспомогательные методы для выполнения HTTP-запросов. SsoClientHttpHelper Содержит вспомогательные методы для выполнения HTTP-запросов с использованием исполняемого файла клиента SSO.

---

Вспомогательные методы для выполнения 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) Создает соединение с указанным URL-адресом для передачи данных в формате JSON.
abstract HttpURLConnection	createXmlConnection (URL url, String method) Создает соединение с указанным URL-адресом для передачи XML-данных.
abstract String	doGet (String url) Выполняет HTTP-запрос GET для заданного URL-адреса и возвращает его в виде String .
abstract void	doGet (String url, OutputStream outputStream) Выполняет HTTP-запрос GET для заданного URL-адреса и передает результат в поток OutputStream .
abstract void	doGetIgnore (String url) Выполняет GET-запрос к заданному URL-адресу, игнорируя результат, указанный в параметрах URL.
abstract void	doGetIgnoreWithRetry (String url) Выполняет повторную попытку при неудаче с помощью метода ` doGetIgnore(String) .
abstract String	doGetWithRetry (String url) Выполняет повторную попытку получения строки с помощью метода doGet(String) в случае неудачи.
abstract String	doPostWithRetry (String url, String postData) Выполняет HTTP-запрос POST для заданного URL-адреса и возвращает его в виде String , повторяя попытку в случае неудачи.
abstract String	doPostWithRetry (String url, String postData, String contentType) Выполняет HTTP-запрос POST для заданного URL-адреса и возвращает его в виде 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	если возникнет исключение при кодировании параметров.

создать соединение

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

Создайте ссылку на заданный URL-адрес.

Параметры
url	URL : URL для подключения.
method	String : метод HTTP-запроса. Например, GET или POST.
contentType	String : тип содержимого. Например, "text/html".

Возвраты
HttpURLConnection	HttpURLConnection

Броски
IOException	если возникнет исключение IOException.

createJsonConnection

public abstract HttpURLConnection createJsonConnection (URL url, 
                String method)

Создает соединение с указанным URL-адресом для передачи данных в формате JSON.

Параметры
url	URL : URL для подключения.
method	String : метод HTTP-запроса. Например, GET или POST.

Возвраты
HttpURLConnection	HttpURLConnection

Броски
IOException	если соединение не удалось установить

createXmlConnection

public abstract HttpURLConnection createXmlConnection (URL url, 
                String method)

Создает соединение с указанным URL-адресом для передачи XML-данных.

Параметры
url	URL : URL для подключения.
method	String : метод HTTP-запроса. Например, GET или POST.

Возвраты
HttpURLConnection	HttpURLConnection

Броски
IOException	если соединение не удалось установить

doGet

public abstract String doGet (String url)

Выполняет HTTP-запрос GET для заданного URL-адреса и возвращает его в виде String .

Поскольку удаленные данные загружаются в память, этот метод следует использовать только для относительно небольших объемов данных.

Ссылки:

• Подключение по URL-адресу в Java: http://java.sun.com/docs/books/tutorial/networking/urls/readingWriting.html
• Java URL Reader: http://java.sun.com/docs/books/tutorial/networking/urls/readingURL.html
• Настройка прокси в Java: http://java.sun.com/docs/books/tutorial/networking/urls/_setProxy.html

Параметры
url	String : URL

Возвраты
String	удаленное содержимое String

Броски
IHttpHelper.DataSizeException	если полученный объем данных превышает MAX_DATA_SIZE
IOException	если не удалось получить данные

doGet

public abstract void doGet (String url, 
                OutputStream outputStream)

Выполняет HTTP-запрос GET для заданного URL-адреса и передает результат в поток OutputStream .

Параметры
url	String : URL
outputStream	OutputStream : поток данных ответа

Броски
IOException	если не удалось получить данные

См. также:

• doGet(String)

doGetIgnore

public abstract void doGetIgnore (String url)

Выполняет GET-запрос к заданному URL-адресу, игнорируя результат, указанный в параметрах URL.

Параметры
url	String : URL

Броски
IOException	если не удалось получить данные

См. также:

• doGet(String)

doGetIgnoreWithRetry

public abstract void doGetIgnoreWithRetry (String url)

Выполняет повторную попытку при неудаче с помощью метода ` doGetIgnore(String) .

Параметры
url	String : URL

Броски
IOException	если не удалось получить данные

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

doGetWithRetry

public abstract String doGetWithRetry (String url)

Выполняет повторную попытку получения строки с помощью метода doGet(String) в случае неудачи.

Параметры
url	String : URL

Возвраты
String	удаленное содержимое String

Броски
IHttpHelper.DataSizeException	если полученный объем данных превышает MAX_DATA_SIZE
IOException	если не удалось получить данные

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

doPostWithRetry

public abstract String doPostWithRetry (String url, 
                String postData)

Выполняет HTTP-запрос POST для заданного URL-адреса и возвращает его в виде String , повторяя попытку в случае неудачи.

Поскольку удаленные данные загружаются в память, этот метод следует использовать только для относительно небольших объемов данных.

Параметры
url	String : URL
postData	String : данные, которые будут отправлены после открытия соединения.

Возвраты
String	удаленное содержимое String

Броски
IHttpHelper.DataSizeException	если полученный объем данных превышает MAX_DATA_SIZE
IOException	если не удалось получить данные

doPostWithRetry

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

Выполняет HTTP-запрос POST для заданного URL-адреса и возвращает его в виде String , повторяя попытку в случае неудачи.

Поскольку удаленные данные загружаются в память, этот метод следует использовать только для относительно небольших объемов данных.

Параметры
url	String : URL
postData	String : данные, которые будут отправлены после открытия соединения.
contentType	String : тип содержимого. Например, "text/html".

Возвраты
String	удаленное содержимое String

Броски
IHttpHelper.DataSizeException	если полученный объем данных превышает MAX_DATA_SIZE
IOException	если не удалось получить данные

getInitialPollInterval

public abstract int getInitialPollInterval ()

Получите начальный интервал опроса в миллисекундах.

Возвраты
int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

getMaxPollInterval

public abstract int getMaxPollInterval ()

Получите максимальный интервал опроса в миллисекундах.

Возвраты
int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

getMaxTime

public abstract int getMaxTime ()

Вычислите максимальное время, в течение которого можно повторять запрос (в миллисекундах).

Возвраты
int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

getOpTimeout

public abstract int getOpTimeout ()

Получите время ожидания операции в миллисекундах.

Возвраты
int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

setInitialPollInterval

public abstract void setInitialPollInterval (int time)

Установите начальный интервал опроса в миллисекундах.

Параметры
time	int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

setMaxPollInterval

public abstract void setMaxPollInterval (int time)

Установите начальный интервал опроса в миллисекундах.

Параметры
time	int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

setMaxTime

public abstract void setMaxTime (int time)

Установите максимальное время, в течение которого будет повторяться запрос (в миллисекундах).

Параметры
time	int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)

setOpTimeout

public abstract void setOpTimeout (int time)

Установите время ожидания операции в миллисекундах.

Параметры
time	int

См. также:

• IRunUtil.runEscalatingTimedRetry(long,long,long,long,com.android.tradefed.util.IRunUtil.IRunnableResult)