ผู้ช่วยRESTApi
public
class
RestApiHelper
extends Object
implements
IRestApiHelper
java.lang.Object | |
↳ | com.android.tradefed.util.RestApiHelper |
คลาสตัวช่วยสำหรับการเรียก API ของ REST
สรุป
ค่าคงที่ | |
---|---|
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,
สร้าง URI สำหรับการเรียก API ด้วยส่วนต่างๆ ของ URI และตัวเลือก |
HttpResponse
|
execute(String method, String[] uriParts,
ส่งคำขอ API |
HttpRequestFactory
|
getRequestFactory()
แสดงผล HttpRequestElement |
static
RestApiHelper
|
newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile,
สร้างอินสแตนซ์ตัวช่วย API ที่ใช้ |
ค่าคงที่
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
ช่างก่อสร้างสาธารณะ
ผู้ช่วยRESTApi
public RestApiHelper (HttpRequestFactory requestFactory, String baseUri)
สร้างอินสแตนซ์ตัวช่วยเหลือ API ด้วยข้อมูลที่ระบุ
พารามิเตอร์ | |
---|---|
requestFactory |
HttpRequestFactory : ค่าเริ่มต้นที่ใช้เมื่อสร้าง HttpRequest |
baseUri |
String : URI พื้นฐานของ API |
วิธีการสาธารณะ
ข้อความค้นหา Uri
public GenericUrl buildQueryUri (String[] uriParts,options)
สร้าง URI สำหรับการเรียก API ด้วยส่วนต่างๆ ของ URI และตัวเลือก uriParts ควรเป็น มีการเข้ารหัส URL อยู่แล้ว ส่วนตัวเลือกควรเป็นสตริงที่ไม่มีการเข้ารหัส
พารามิเตอร์ | |
---|---|
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 |
getRequestโรงงาน
public HttpRequestFactory getRequestFactory ()
แสดงผล HttpRequestElement
เปิดเผยสำหรับการทดสอบ
คิกรีเทิร์น | |
---|---|
HttpRequestFactory |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile,scopes)
สร้างอินสแตนซ์ตัวช่วย API ที่ใช้ Credential
สำหรับการตรวจสอบสิทธิ์
พารามิเตอร์ | |
---|---|
baseUri |
String : URI พื้นฐานของ API |
jsonKeyFile |
File : ไฟล์คีย์ JSON ของบัญชีบริการ |
scopes |
: คอลเล็กชันของขอบเขต OAuth ที่จะใช้กับบัญชีบริการ |
คิกรีเทิร์น | |
---|---|
RestApiHelper |
การขว้าง | |
---|---|
|
GeneralSecurityException |
|
ข้อยกเว้น IO |