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, options)

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

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

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

HttpRequestFactory getRequestFactory()

แสดงผล HttpRequestFactory

static RestApiHelper newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, 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, 
                 options)

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

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

options

คิกรีเทิร์น
GenericUrl

ดำเนินการ

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

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

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

getRequestFactory

public HttpRequestFactory getRequestFactory ()

แสดงผล HttpRequestFactory

เปิดเผยเพื่อการทดสอบ

คิกรีเทิร์น
HttpRequestFactory

newInstanceWithGoogleCredential

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

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

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

การขว้าง
GeneralSecurityException
IOException