RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Объект
com.android.tradefed.util.RestApiHelper


Вспомогательный класс для выполнения вызовов REST API.

Краткое содержание

Константы

int DEFAULT_NUMBER_OF_RETRIES

Поля

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

Общественные конструкторы

RestApiHelper (HttpRequestFactory requestFactory, String baseUri)

Создает экземпляр вспомогательного API с заданной информацией.

Публичные методы

GenericUrl buildQueryUri (String[] uriParts, options) buildQueryUri (String[] uriParts, options)

Создайте URI для вызова API с заданными частями и параметрами URI.

HttpResponse execute (String method, String[] uriParts, options, JSONObject data) execute (String method, String[] uriParts, options, JSONObject data)

Выполняет запрос API.

HttpRequestFactory getRequestFactory ()

Возвращает HttpRequestFactory.

static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes)

Создает вспомогательный экземпляр API, который использует Credential для аутентификации.

static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes)

Создает вспомогательный экземпляр API, который использует Credential для аутентификации.

Константы

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Постоянное значение: 2 (0x00000002)

Поля

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Общественные конструкторы

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Создает экземпляр вспомогательного API с заданной информацией.

Параметры
requestFactory HttpRequestFactory : фабрика, используемая при создании HttpRequest s.

baseUri String : базовый URI API.

Публичные методы

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Создайте URI для вызова API с заданными частями и параметрами URI. uriParts уже должны быть закодированы в URL-адресе, а параметры должны быть незакодированными строками.

Параметры
uriParts String

options

Возврат
GenericUrl

выполнять

public HttpResponse execute (String method, 
                String[] uriParts, 
                 options, 
                JSONObject data)

Выполняет запрос API.

Параметры
method String : HTTP-метод запроса.

uriParts String : части URI в кодировке URL, которые будут использоваться для создания URI запроса.

options : некодированные имена и значения параметров, используемые для построения строки запроса.

data JSONObject : данные, которые будут отправлены вместе с запросом.

Возврат
HttpResponse объект HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Возвращает HttpRequestFactory.

Выставлено на тестирование.

Возврат
HttpRequestFactory

новыйInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                File jsonKeyFile, 
                 scopes)

Создает вспомогательный экземпляр API, который использует Credential для аутентификации.

Параметры
baseUri String : базовый URI API.

jsonKeyFile File : JSON-файл ключа сервисной учетной записи.

scopes : набор областей OAuth для использования с учетной записью службы.

Возврат
RestApiHelper

Броски
Генеральная безопасностьИсключение
Исключение IO

новыйInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                String serviceAccount, 
                File keyFile, 
                 scopes)

Создает вспомогательный экземпляр API, который использует Credential для аутентификации.

Параметры
baseUri String : базовый URI API.

serviceAccount String : имя используемой учетной записи службы.

keyFile File : файл ключей сервисной учетной записи.

scopes : набор областей OAuth для использования с учетной записью службы.

Возврат
RestApiHelper

Броски
Генеральная безопасностьИсключение
Исключение IO