RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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

Klasa pomocnicza do wykonywania wywołań interfejsu API REST.

Podsumowanie

Stałe

int DEFAULT_NUMBER_OF_RETRIES

String JSON_MIME

Fieldsem

protected static final JsonFactory JSON_FACTORY

Publiczne konstruktory

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

Tworzy instancję pomocnika interfejsu API z podanymi informacjami.

Metody publiczne

GenericUrl buildQueryUri(String[] uriParts, options)

Tworzy identyfikator URI wywołania interfejsu API z podanych części identyfikatora URI i opcji.

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

Wykonuje żądanie interfejsu API.

HttpRequestFactory getRequestFactory()

Zwraca HttpRequestFactory.

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

Tworzy instancję pomocnika interfejsu API, która do uwierzytelniania używa Credential.

Stałe

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Wartość stała: 2 (0x00000002)

JSON_MIME

protected static final String JSON_MIME

Wartość stała: "application/json"

Fieldsem

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

Publiczne konstruktory

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Tworzy instancję pomocnika interfejsu API z podanymi informacjami.

Parametry
requestFactory HttpRequestFactory: fabryka, która ma być używana podczas tworzenia obiektów HttpRequest.
baseUri String: podstawowy identyfikator URI interfejsu API

Metody publiczne

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Utwórz identyfikator URI dla wywołania interfejsu API z podanych części identyfikatora URI i opcji. Element uriParts powinien być już zakodowany, a opcje powinny być niezakodowanymi ciągami znaków.

Parametry
uriParts String

options

Zwroty
GenericUrl

execute

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

Wykonuje żądanie interfejsu API.

Parametry
method String: metoda HTTP żądania
uriParts String: zakodowane w formacie URL części identyfikatora URI, które zostaną użyte do utworzenia identyfikatora URI żądania.
options : niekodowane nazwy i wartości parametrów używane do tworzenia ciągu zapytania.
data JSONObject: dane do wysłania z żądaniem
Zwroty
HttpResponse obiekt HttpResponse,

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Zwraca HttpRequestFactory.

Udostępniono do testowania.

Zwroty
HttpRequestFactory

newInstanceWithGoogleCredential

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

Tworzy instancję pomocnika interfejsu API, która do uwierzytelniania używa Credential.

Parametry
baseUri String: podstawowy identyfikator URI interfejsu API
jsonKeyFile File: plik klucza JSON konta usługi
scopes : zbiór zakresów OAuth do użycia z kontem usługi,
Zwroty
RestApiHelper

Zgłasza
GeneralSecurityException
IOException