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, Map<String, Object> options)

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

HttpResponse execute (String method, String[] uriParts, Map<String, Object> options, JSONObject data)

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

HttpRequestFactory getRequestFactory ()

Возвращает объект HttpRequestFactory.

static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, Collection<String> 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, 
                Map<String, Object> options)

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

Параметры
uriParts String

options Map

Возвраты
GenericUrl

выполнять 

public HttpResponse execute (String method, 
                String[] uriParts, 
                Map<String, Object> options, 
                JSONObject data)

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

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

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

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

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

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

Броски
IOException

getRequestFactory 

public HttpRequestFactory getRequestFactory ()

Возвращает объект HttpRequestFactory.

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

Возвраты
HttpRequestFactory

newInstanceWithGoogleCredential 

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

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

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

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

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

Возвраты
RestApiHelper

Броски
java.io.IOException
java.security.GeneralSecurityException
GeneralSecurityException
IOException