RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

Obiekt Java.lang.Object
↳ com.android.tradefed.util.RestApiHelper

Klasa pomocnicza do wykonywania wywołań API REST.

Streszczenie

Stałe

int DEFAULT_NUMBER_OF_RETRIES

Pola

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

Konstruktorzy publiczni

RestApiHelper (HttpRequestFactory requestFactory, String baseUri)

Tworzy instancję pomocniczą API z podanymi informacjami.

Metody publiczne

GenericUrl buildQueryUri (String[] uriParts, options) buildQueryUri (String[] uriParts, options)

Skonstruuj identyfikator URI dla wywołania API z podanymi częściami i opcjami URI.

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

Wykonuje żądanie API.

HttpRequestFactory getRequestFactory ()

Zwraca fabrykę HttpRequestFactory.

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

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

static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, 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)

Pola

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Konstruktorzy publiczni

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Tworzy instancję pomocniczą API z podanymi informacjami.

Parametry
requestFactory HttpRequestFactory : fabryka używana podczas tworzenia HttpRequest s.

baseUri String : podstawowy identyfikator URI API

Metody publiczne

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Skonstruuj identyfikator URI dla wywołania API z podanymi częściami i opcjami URI. uriParts powinny być już zakodowane w adresie URL, podczas gdy opcje powinny być niezakodowanymi ciągami znaków.

Parametry
uriParts String

options

Zwroty
GenericUrl

wykonać

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

Wykonuje żądanie API.

Parametry
method String : metoda HTTP żądania

uriParts String : Części URI zakodowane w adresie URL, które mają zostać użyte do skonstruowania identyfikatora URI żądania.

options : niezakodowane nazwy parametrów i wartości użyte do skonstruowania ciągu zapytania

data JSONObject : dane, które mają zostać przesłane wraz z żądaniem

Zwroty
HttpResponse obiekt HttpResponse

pobierzRequestFactory

public HttpRequestFactory getRequestFactory ()

Zwraca fabrykę HttpRequestFactory.

Wystawiony do testów.

Zwroty
HttpRequestFactory

newInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                File jsonKeyFile, 
                 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 : zbiór zakresów OAuth do użycia z kontem usługi

Zwroty
RestApiHelper

Rzuca
Wyjątek bezpieczeństwa ogólnego
Wyjątek IO

newInstanceWithGoogleCredential

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

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

Parametry
baseUri String : podstawowy identyfikator URI interfejsu API

serviceAccount String : nazwa konta usługi, którego chcesz użyć

keyFile File : plik klucza konta usługi

scopes : zbiór zakresów OAuth do użycia z kontem usługi

Zwroty
RestApiHelper

Rzuca
Wyjątek bezpieczeństwa ogólnego
Wyjątek IO