RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Object
↳ com.android.tradefed.util.RestApiHelper

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

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

Константы

int DEFAULT_NUMBER_OF_RETRIES

String JSON_MIME

Поля

protected static final JsonFactory JSON_FACTORY

Публичные конструкторы

RestApiHelper (HttpRequestFactory requestFactory, String baseUri)

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

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

GenericUrl buildQueryUri (String[] uriParts, options)

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

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

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

HttpRequestFactory getRequestFactory ()

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

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

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

Константы

DEFAULT_NUMBER_OF_RETRIES 

protected static final int DEFAULT_NUMBER_OF_RETRIES

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

JSON_MIME 

protected static final String JSON_MIME

Постоянное значение: «application/json»

Поля

JSON_FACTORY 

protected static final JsonFactory JSON_FACTORY

Публичные конструкторы

RestApiHelper 

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

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

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

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 : URL-кодированные части URI, которые будут использоваться для построения URI запроса.

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

data JSONObject : данные, отправляемые вместе с запросом

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

getRequestFactory 

public HttpRequestFactory getRequestFactory ()

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

Выставлен для испытаний.

Возврат
HttpRequestFactory

newInstanceWithGoogleCredential 

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

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

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

jsonKeyFile File : файл ключа JSON учетной записи службы

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

Возврат
RestApiHelper

Броски
GeneralSecurityException
IOException