A partir de 27 de março de 2025, recomendamos usar android-latest-release em vez de aosp-main para criar e contribuir com o AOSP. Para mais informações, consulte Mudanças no AOSP.

Esta página foi traduzida pela API Cloud Translation.

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)` Crie um URI para uma chamada de API com as partes e opções de URI fornecidas.
`HttpResponse`	`execute(String method, String[] uriParts, options, JSONObject data)` Executa uma solicitação de API.
`HttpRequestFactory`	`getRequestFactory()` Retorna a HttpRequestFactory.
`static RestApiHelper`	`newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, scopes)` Cria uma instância auxiliar de API que usa um `Credential` para autenticação.
`static RestApiHelper`	`newInstanceWithGoogleCredential(String baseUri, String serviceAccount, File keyFile, scopes)` Cria uma instância auxiliar de API que usa um `Credential` para autenticação.

Constantes

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Valor da 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)

Cria um URI para uma chamada de API com partes e opções de URI fornecidas. As uriParts precisam estar codificadas por URL, e as opções precisam ser strings não codificadas.

Parâmetros
`uriParts`	`String`
`options`

Retorna
`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 do URI codificadas em URL a serem usadas para criar o URI da 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 solicitação

Retorna
`HttpResponse`	um objeto HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Retorna a HttpRequestFactory.

Exposto para testes.

Retorna
`HttpRequestFactory`

newInstanceWithGoogleCredential

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

Cria uma instância auxiliar de API que usa um 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 do OAuth a serem usados com a conta de serviço

Retorna
`RestApiHelper`

Gera
	GeneralSecurityException

newInstanceWithGoogleCredential

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

Cria uma instância auxiliar de API que usa um 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 do OAuth a serem usados com a conta de serviço

Retorna
`RestApiHelper`

Gera
	GeneralSecurityException