रेस्टएपी हेल्पर
public class RestApiHelper
extends Object
implements IRestApiHelper
java.lang.ऑब्जेक्ट | |
मैं | com.android.tradefed.util.RestApiHelper |
आरईएसटी एपीआई कॉल करने के लिए एक सहायक वर्ग।
सारांश
स्थिरांक | |
---|---|
int | DEFAULT_NUMBER_OF_RETRIES
|
खेत | |
---|---|
protected static final JsonFactory | JSON_FACTORY |
protected static final String | JSON_MIME
|
सार्वजनिक निर्माणकर्ता | |
---|---|
RestApiHelper (HttpRequestFactory requestFactory, String baseUri) दी गई जानकारी के साथ एक एपीआई सहायक उदाहरण बनाता है। |
सार्वजनिक तरीके | |
---|---|
GenericUrl | buildQueryUri (String[] uriParts, options) buildQueryUri (String[] uriParts, options) दिए गए URI भागों और विकल्पों के साथ API कॉल के लिए URI का निर्माण करें। |
HttpResponse | execute (String method, String[] uriParts, options, JSONObject data) execute (String method, String[] uriParts, options, JSONObject data) एक एपीआई अनुरोध निष्पादित करता है। |
HttpRequestFactory | getRequestFactory () HttpRequestFactory देता है। |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) एक API सहायक उदाहरण है, जिसमें एक का उपयोग करता है बनाता है |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) एक 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
सार्वजनिक निर्माणकर्ता
रेस्टएपी हेल्पर
public RestApiHelper (HttpRequestFactory requestFactory, String baseUri)
दी गई जानकारी के साथ एक एपीआई हेल्पर इंस्टेंस बनाता है।
मापदंडों | |
---|---|
requestFactory | HttpRequestFactory : बनाते समय उपयोग करने के लिए कारखाना HttpRequest रों। |
baseUri | String : एपीआई के आधार यूआरआई |
सार्वजनिक तरीके
बिल्डक्वेरीयूरी
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)
एक एपीआई अनुरोध निष्पादित करता है।
मापदंडों | |
---|---|
method | String : अनुरोध की एक HTTP विधि |
uriParts | String : यूआरएल इनकोडिंग अनुरोध 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 : एपीआई के आधार यूआरआई |
jsonKeyFile | File : सेवा खाते json कुंजी फ़ाइल |
scopes |
रिटर्न | |
---|---|
RestApiHelper |
फेंकता | |
---|---|
| सामान्य सुरक्षा अपवाद |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile,scopes)
एक API सहायक उदाहरण है, जिसमें एक का उपयोग करता है बनाता है Credential
प्रमाणन के लिए।
मापदंडों | |
---|---|
baseUri | String : एपीआई के आधार यूआरआई |
serviceAccount | String : सेवा के नाम पर उपयोग करने के लिए खाता |
keyFile | File : सेवा खाते कुंजी फ़ाइल |
scopes |
रिटर्न | |
---|---|
RestApiHelper |
फेंकता | |
---|---|
| सामान्य सुरक्षा अपवाद |