RestApiHelper
public class RestApiHelper
extends Object
implements IRestApiHelper
java.lang.Objek | |
↳ | com.android.tradefed.util.RestApiHelper |
Kelas pembantu untuk melakukan panggilan REST API.
Ringkasan
Konstanta | |
---|---|
int | DEFAULT_NUMBER_OF_RETRIES
|
Bidang | |
---|---|
protected static final JsonFactory | JSON_FACTORY |
protected static final String | JSON_MIME
|
Konstruktor publik | |
---|---|
RestApiHelper (HttpRequestFactory requestFactory, String baseUri) Membuat instance pembantu API dengan informasi yang diberikan. |
Metode publik | |
---|---|
GenericUrl | buildQueryUri (String[] uriParts, options) buildQueryUri (String[] uriParts, options) Bangun URI untuk panggilan API dengan bagian dan opsi URI yang diberikan. |
HttpResponse | execute (String method, String[] uriParts, options, JSONObject data) execute (String method, String[] uriParts, options, JSONObject data) Mengeksekusi permintaan API. |
HttpRequestFactory | getRequestFactory () Mengembalikan HttpRequestFactory. |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) Membuat instance pembantu API yang menggunakan |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) Membuat instance pembantu API yang menggunakan |
Konstanta
DEFAULT_NUMBER_OF_RETRIES
protected static final int DEFAULT_NUMBER_OF_RETRIES
Nilai Konstan: 2 (0x00000002)
Bidang
JSON_FACTORY
protected static final JsonFactory JSON_FACTORY
JSON_MIME
protected static final String JSON_MIME
Konstruktor publik
RestApiHelper
public RestApiHelper (HttpRequestFactory requestFactory, String baseUri)
Membuat instance pembantu API dengan informasi yang diberikan.
Parameter | |
---|---|
requestFactory | HttpRequestFactory : pabrik yang akan digunakan saat membuat HttpRequest s. |
baseUri | String : URI dasar API |
Metode publik
buildQueryUri
public GenericUrl buildQueryUri (String[] uriParts,options)
Bangun URI untuk panggilan API dengan bagian dan opsi URI yang diberikan. uriParts harus sudah dikodekan URL, sedangkan opsi harus berupa Strings yang tidak dikodekan.
Parameter | |
---|---|
uriParts | String |
options |
Pengembalian | |
---|---|
GenericUrl |
menjalankan
public HttpResponse execute (String method, String[] uriParts,options, JSONObject data)
Mengeksekusi permintaan API.
Parameter | |
---|---|
method | String : metode permintaan HTTP |
uriParts | String : bagian URI yang disandikan URL untuk digunakan untuk menyusun URI permintaan. |
options | |
data | JSONObject : data yang akan dikirim dengan permintaan |
Pengembalian | |
---|---|
HttpResponse | objek HttpResponse |
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Mengembalikan HttpRequestFactory.
Diekspos untuk pengujian.
Pengembalian | |
---|---|
HttpRequestFactory |
Instance baruDengan GoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile,scopes)
Membuat instance pembantu API yang menggunakan Credential
untuk autentikasi.
Parameter | |
---|---|
baseUri | String : URI dasar API |
jsonKeyFile | File : file kunci json akun layanan |
scopes |
Pengembalian | |
---|---|
RestApiHelper |
Melempar | |
---|---|
| Pengecualian Keamanan Umum |
| IOException |
Instance baruDengan GoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile,scopes)
Membuat instance pembantu API yang menggunakan Credential
untuk autentikasi.
Parameter | |
---|---|
baseUri | String : URI dasar API |
serviceAccount | String : nama akun layanan yang akan digunakan |
keyFile | File : file kunci akun layanan |
scopes |
Pengembalian | |
---|---|
RestApiHelper |
Melempar | |
---|---|
| Pengecualian Keamanan Umum |
| IOException |