RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Object
↳ com.android.tradefed.util.RestApiHelper

Uma classe auxiliar para realizar chamadas de API REST.

Resumo

Constantes

int DEFAULT_NUMBER_OF_RETRIES

Campos

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

Construtores públicos

RestApiHelper (HttpRequestFactory requestFactory, String baseUri)

Cria uma instância auxiliar de API com as informações fornecidas.

Métodos públicos

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

Construa um URI para uma chamada de API com determinadas partes e opções de URI.

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

Executa uma solicitação de API.

HttpRequestFactory getRequestFactory ()

Retorna o HttpRequestFactory.

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

Cria uma instância auxiliar de API que usa uma Credential para autenticação.

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

Cria uma instância auxiliar de API que usa uma Credential para autenticação.

Constantes

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Valor Constante: 2 (0x00000002)

Campos

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Construtores públicos

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Cria uma instância auxiliar de API com as informações fornecidas.

Parâmetros
requestFactory HttpRequestFactory : a fábrica a ser usada ao criar HttpRequest s.

baseUri String : o URI base da API

Métodos públicos

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Construa um URI para uma chamada de API com determinadas partes e opções de URI. uriParts já deve estar codificado em URL, enquanto as opções devem ser Strings não codificadas.

Parâmetros
uriParts String

options

Devoluções
GenericUrl

executar

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

Executa uma solicitação de API.

Parâmetros
method String : um método HTTP da solicitação

uriParts String : partes de URI codificadas em URL a serem usadas para construir o URI de solicitação.

options : nomes e valores de parâmetros não codificados usados ​​para construir a string de consulta

data JSONObject : dados a serem enviados com a requisição

Devoluções
HttpResponse um objeto HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Retorna o HttpRequestFactory.

Exposto para testes.

Devoluções
HttpRequestFactory

novaInstanceWithGoogleCredential

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

Cria uma instância auxiliar de API que usa uma Credential para autenticação.

Parâmetros
baseUri String : o URI base da API

jsonKeyFile File : o arquivo de chave json da conta de serviço

scopes : a coleção de escopos OAuth a serem usados ​​com a conta de serviço

Devoluções
RestApiHelper

Lança
Exceção Geral de Segurança

novaInstanceWithGoogleCredential

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

Cria uma instância auxiliar de API que usa uma Credential para autenticação.

Parâmetros
baseUri String : o URI base da API

serviceAccount String : o nome da conta de serviço a ser usada

keyFile File : o arquivo de chave da conta de serviço

scopes : a coleção de escopos OAuth a serem usados ​​com a conta de serviço

Devoluções
RestApiHelper

Lança
Exceção Geral de Segurança