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

Fieldsem

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

Konstruktory publiczne

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

Tworzy instancję pomocy interfejsu API z podanymi informacjami.

Metody publiczne

GenericUrl buildQueryUri(String[] uriParts, options)

Utwórz identyfikator URI wywołania interfejsu API z podanymi częściami i opcjami identyfikatora URI.

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

Wykonuje żądanie interfejsu API.

HttpRequestFactory getRequestFactory()

Zwraca obiekt 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)

Fieldsem

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Konstruktory publiczne

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Tworzy instancję pomocy interfejsu API z podanymi informacjami.

Parametry
requestFactory HttpRequestFactory: fabryka do użycia podczas tworzenia HttpRequest.

baseUri String: podstawowy identyfikator URI interfejsu API

Metody publiczne

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Utwórz URI dla wywołania interfejsu API z podanymi częściami i opcjami URI. Części uri powinny być już zakodowane w formacie URL, a opcje powinny być niespakowanymi ciągami znaków.

Parametry
uriParts String

options

Zwroty
GenericUrl

wykonać

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 służą do tworzenia identyfikatora URI żądania.

options : niekodowane nazwy i wartości parametrów użyte do utworzenia ciągu zapytania.

data JSONObject: dane do wysłania wraz z prośbą

Zwroty
HttpResponse obiekt HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Zwraca obiekt HttpRequestFactory.

Wyeksponowane 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

Rzuty
GeneralSecurityException
IOException