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.

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ę pomocnika API z podanymi informacjami.

Metody publiczne

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

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

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

Wykonuje żądanie API.

HttpRequestFactory getRequestFactory ()

Zwraca HttpRequestFactory.

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

Tworzy API wystąpienie pomocniczym, który wykorzystuje Credential do uwierzytelniania.

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

Tworzy API wystąpienie pomocniczym, który wykorzystuje Credential do uwierzytelniania.

Stałe

DEFAULT_NUMBER_OF_RETIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Stała wartość: 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ę pomocnika API z podanymi informacjami.

Parametry
requestFactory HttpRequestFactory : fabryka do wykorzystania przy tworzeniu HttpRequest s.

baseUri String : baza URI API

Metody publiczne

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

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

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 : URL zakodowane części URI zostać wykorzystane do skonstruowania żądania URI.

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

data JSONObject : Dane należy przesłać wraz z wnioskiem

Zwroty
HttpResponse obiekt HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Zwraca HttpRequestFactory.

Wystawiony do testów.

Zwroty
HttpRequestFactory

nowa instancja z poświadczeniami Google

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

Tworzy API wystąpienie pomocniczym, który wykorzystuje Credential do uwierzytelniania.

Parametry
baseUri String : baza URI API

jsonKeyFile File : plik klucza json konto usługi

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

Zwroty
RestApiHelper

Rzuty
Wyjątek dotyczący bezpieczeństwa ogólnego

nowa instancja z poświadczeniami Google

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

Tworzy API wystąpienie pomocniczym, który wykorzystuje Credential do uwierzytelniania.

Parametry
baseUri String : baza URI API

serviceAccount String : nazwa usługi konto aby używać

keyFile File : plik klucza konto usługi

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

Zwroty
RestApiHelper

Rzuty
Wyjątek dotyczący bezpieczeństwa ogólnego