RestApiHelper
public class RestApiHelper
extends Object
implements IRestApiHelper
java.lang.Object | |
↳ | com.android.tradefed.util.RestApiHelper |
Una clase auxiliar para realizar llamadas a la API REST.
Resumen
Constantes | |
---|---|
int | DEFAULT_NUMBER_OF_RETRIES
|
Los campos | |
---|---|
protected static final JsonFactory | JSON_FACTORY |
protected static final String | JSON_MIME
|
Constructores públicos | |
---|---|
RestApiHelper (HttpRequestFactory requestFactory, String baseUri) Crea una instancia de ayuda de API con la información proporcionada. |
Métodos públicos | |
---|---|
GenericUrl | buildQueryUri (String[] uriParts, options) buildQueryUri (String[] uriParts, options) Construya un URI para una llamada a la API con partes y opciones de URI dadas. |
HttpResponse | execute (String method, String[] uriParts, options, JSONObject data) execute (String method, String[] uriParts, options, JSONObject data) Ejecuta una solicitud de API. |
HttpRequestFactory | getRequestFactory () Devuelve HttpRequestFactory. |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) Crea una instancia de ayuda API que utiliza una |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) Crea una instancia de ayuda API que utiliza una |
Constantes
DEFAULT_NUMBER_OF_RETRIES
protected static final int DEFAULT_NUMBER_OF_RETRIES
Valor constante: 2 (0x00000002)
Los campos
JSON_FACTORY
protected static final JsonFactory JSON_FACTORY
JSON_MIME
protected static final String JSON_MIME
Constructores públicos
RestApiHelper
public RestApiHelper (HttpRequestFactory requestFactory, String baseUri)
Crea una instancia de ayuda de API con la información proporcionada.
Parámetros | |
---|---|
requestFactory | HttpRequestFactory : la fábrica para su uso en la creación de HttpRequest s. |
baseUri | String : el URI base del API |
Métodos públicos
buildQueryUri
public GenericUrl buildQueryUri (String[] uriParts,options)
Construya un URI para una llamada a la API con partes y opciones de URI dadas. uriParts ya debería estar codificado en URL, mientras que las opciones deberían ser Strings sin codificar.
Parámetros | |
---|---|
uriParts | String |
options |
Devoluciones | |
---|---|
GenericUrl |
ejecutar
public HttpResponse execute (String method, String[] uriParts,options, JSONObject data)
Ejecuta una solicitud de API.
Parámetros | |
---|---|
method | String : un método HTTP de la petición |
uriParts | String : URL codificada partes URI para ser usados para construir la petición URI. |
options | |
data | JSONObject : datos que deben enviarse con la solicitud |
Devoluciones | |
---|---|
HttpResponse | un objeto HttpResponse |
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Devuelve HttpRequestFactory.
Expuesto para pruebas.
Devoluciones | |
---|---|
HttpRequestFactory |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile,scopes)
Crea una instancia de ayuda API que utiliza una Credential
para la autenticación.
Parámetros | |
---|---|
baseUri | String : el URI base de la API |
jsonKeyFile | File : la cuenta de servicio de archivo de clave JSON |
scopes |
Devoluciones | |
---|---|
RestApiHelper |
Lanza | |
---|---|
| GeneralSecurityException |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile,scopes)
Crea una instancia de ayuda API que utiliza una Credential
para la autenticación.
Parámetros | |
---|---|
baseUri | String : el URI base de la API |
serviceAccount | String : el nombre de la cuenta de servicio para uso |
keyFile | File : la cuenta de servicio de archivo de clave |
scopes |
Devoluciones | |
---|---|
RestApiHelper |
Lanza | |
---|---|
| GeneralSecurityException |