Program 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ę pomocniczą interfejsu API z podanymi informacjami.

Metody publiczne

GenericUrl buildQueryUri(String[] uriParts, options)

Utwórz identyfikator URI dla wywołania interfejsu API z określonymi częściami i opcjami.

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

Wykonuje żądanie do interfejsu API.

HttpRequestFactory getRequestFactory()

Zwraca HttpRequestFactory.

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

Tworzy instancję pomocniczą 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

Program RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Tworzy instancję pomocniczą interfejsu API z podanymi informacjami.

Parametry
requestFactory HttpRequestFactory: fabryka używana podczas tworzenia komponentów typu HttpRequest.

baseUri String: podstawowy identyfikator URI API

Metody publiczne

BuildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Utwórz identyfikator URI dla wywołania interfejsu API z określonymi częściami i opcjami. Fragmenty URI powinny być Zakodowany na potrzeby adresu URL, natomiast opcje powinny być niezakodowane jako ciągi znaków.

Parametry
uriParts String

options

Zwroty
GenericUrl

Wykonaj

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

Wykonuje żądanie do interfejsu API.

Parametry
method String: metoda HTTP żądania

uriParts String: zakodowane w adresie URL części URI, które mają być używane do tworzenia identyfikatora URI żądania.

options : niezakodowane nazwy i wartości parametrów używane do tworzenia ciągu zapytania.

data JSONObject: dane do wysłania wraz z żądaniem

Zwroty
HttpResponse obiekt HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Zwraca HttpRequestFactory.

Przedstawione do testów.

Zwroty
HttpRequestFactory

nowa instancjaZ danymi uwierzytelniającymi Google

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

Tworzy instancję pomocniczą 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 protokołu OAuth do użycia z kontem usługi.

Zwroty
RestApiHelper

Rzuty
Ogólny wyjątek zabezpieczeń
IOWyjątek