RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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


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

สรุป

ค่าคงที่

int DEFAULT_NUMBER_OF_RETRIES

ช่อง

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

ตัวสร้างแบบสาธารณะ

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_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

ตัวสร้างแบบสาธารณะ

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