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

Pola

protected static final JsonFactory JSON_FACTORY

Konstruktory publiczne

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

Tworzy instancję pomocnika interfejsu API z podanymi informacjami.

Metody publiczne

GenericUrl buildQueryUri(String[] uriParts, Map<String, Object> options)

Tworzy identyfikator URI do wywołania interfejsu API z podanymi częściami identyfikatora URI i opcjami.

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

Wykonuje żądanie do interfejsu API.

HttpRequestFactory getRequestFactory()

Zwraca HttpRequestFactory.

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

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

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"

Pola

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

Konstruktory publiczne

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Tworzy instancję pomocnika interfejsu API z podanymi informacjami.

Parametry
requestFactory HttpRequestFactory: fabryka, której należy użyć podczas tworzenia HttpRequest.
baseUri String: podstawowy identyfikator URI interfejsu API

Metody publiczne

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                Map<String, Object> options)

Tworzy identyfikator URI do wywołania interfejsu API z podanymi częściami identyfikatora URI i opcjami. Części identyfikatora URI powinny być już zakodowane w adresie URL, a opcje powinny być niezakodowanymi ciągami znaków.

Parametry
uriParts String

options Map

Zwraca
GenericUrl

execute

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

Wykonuje żądanie do interfejsu API.

Parametry
method String: metoda HTTP żądania
uriParts String: części identyfikatora URI zakodowane w adresie URL, które mają być użyte do utworzenia identyfikatora URI żądania.
options Map: niezakodowane nazwy i wartości parametrów używane do tworzenia ciągu zapytania
data JSONObject: dane, które mają być wysłane z żądaniem
Zwraca
HttpResponse obiekt HttpResponse
Zgłasza
IOException

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Zwraca HttpRequestFactory.

Udostępniono na potrzeby testowania.

Zwraca
HttpRequestFactory

newInstanceWithGoogleCredential

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

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

Parametry
baseUri String: podstawowy identyfikator URI interfejsu API
jsonKeyFile File: plik klucza JSON konta usługi
scopes Collection: zbiór zakresów OAuth, które mają być używane z kontem usługi
Zwraca
RestApiHelper

Zgłasza
java.io.IOException
java.security.GeneralSecurityException
GeneralSecurityException
IOException