RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Object
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 : 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

newInstanceWithGoogleCredential

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

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

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

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

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

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

Возврат
RestApiHelper

Броски
GeneralSecurityException