RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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

คลาสตัวช่วยสำหรับการเรียก REST API

สรุป

ค่าคงที่

int DEFAULT_NUMBER_OF_RETRIES

String JSON_MIME

ทุ่ง

protected static final JsonFactory JSON_FACTORY

เครื่องมือสร้างสาธารณะ

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

สร้างอินสแตนซ์ตัวช่วย API ด้วยข้อมูลที่ระบุ

เมธอดสาธารณะ

GenericUrl buildQueryUri(String[] uriParts, Map<String, Object> options)

สร้าง URI สำหรับการเรียก API ด้วยส่วนและตัวเลือก URI ที่ระบุ

HttpResponse execute(String method, String[] uriParts, Map<String, Object> options, JSONObject data)

ดำเนินการคำขอ API

HttpRequestFactory getRequestFactory()

แสดงผล HttpRequestFactory

static RestApiHelper newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, Collection<String> scopes)

สร้างอินสแตนซ์ผู้ช่วย API ซึ่งใช้ Credential ในการตรวจสอบสิทธิ์

ค่าคงที่

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

ค่าคงที่ 2 (0x00000002)

JSON_MIME

protected static final String JSON_MIME

ค่าคงที่: "application/json"

ทุ่ง

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

เครื่องมือสร้างสาธารณะ

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

สร้างอินสแตนซ์ตัวช่วย API ด้วยข้อมูลที่ระบุ

พารามิเตอร์
requestFactory HttpRequestFactory: โรงงานที่จะใช้เมื่อสร้าง HttpRequest
baseUri String: URI ฐานของ API

เมธอดสาธารณะ

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                Map<String, Object> options)

สร้าง URI สำหรับการเรียก API ด้วยส่วนและตัวเลือก URI ที่ระบุ uriParts ควรมีการเข้ารหัส URL อยู่แล้ว ส่วน options ควรเป็นสตริงที่ไม่ได้เข้ารหัส

พารามิเตอร์
uriParts String

options Map

การคืนสินค้า
GenericUrl

ดำเนินการ

public HttpResponse execute (String method, 
                String[] uriParts, 
                Map<String, Object> options, 
                JSONObject data)

ดำเนินการคำขอ API

พารามิเตอร์
method String: เมธอด HTTP ของคำขอ
uriParts String: ส่วน URI ที่เข้ารหัส URL ที่จะใช้สร้าง URI คำขอ
options Map: ชื่อและค่าพารามิเตอร์ที่ไม่ได้เข้ารหัสซึ่งใช้ในการสร้างสตริงการค้นหา
data JSONObject: ข้อมูลที่จะส่งพร้อมคำขอ
การคืนสินค้า
HttpResponse ออบเจ็กต์ HttpResponse
ส่ง
IOException

getRequestFactory

public HttpRequestFactory getRequestFactory ()

แสดงผล HttpRequestFactory

แสดงสำหรับการทดสอบ

การคืนสินค้า
HttpRequestFactory

newInstanceWithGoogleCredential

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

สร้างอินสแตนซ์ผู้ช่วย API ซึ่งใช้ Credential ในการตรวจสอบสิทธิ์

พารามิเตอร์
baseUri String: URI ฐานของ API
jsonKeyFile File: ไฟล์คีย์ JSON ของบัญชีบริการ
scopes Collection: ชุดขอบเขต OAuth ที่จะใช้กับบัญชีบริการ
การคืนสินค้า
RestApiHelper

ส่ง
java.io.IOException
java.security.GeneralSecurityException
GeneralSecurityException
IOException