IHttpHelper

public interface IHttpHelper

com.android.tradefed.util.net.IHttpHelper

متدهای کمکی برای انجام درخواست‌های http.

خلاصه

کلاس‌های تو در تو

class IHttpHelper.DataSizeException

ثابت‌ها

int MAX_DATA_SIZE

روش‌های عمومی

abstract String buildParameters ( MultiMap <String, String> paramMap)

رشته پارامتر کدگذاری شده را بسازید.

abstract String buildUrl (String url, MultiMap <String, String> paramMap)

رشته درخواست URL رمزگذاری شده کامل را بسازید.

abstract HttpURLConnection createConnection (URL url, String method, String contentType)

یک آدرس اینترنتی (url) به آدرس داده شده ایجاد کنید.

abstract HttpURLConnection createJsonConnection (URL url, String method)

برای ارسال داده‌های json، یک اتصال به URL داده شده ایجاد می‌کند.

abstract HttpURLConnection createXmlConnection (URL url, String method)

برای ارسال داده‌های xml، یک اتصال به URL داده شده ایجاد می‌کند.

abstract String doGet (String url)

یک متد درخواست GET HTTP را برای یک URL مشخص اجرا می‌کند و آن را به صورت یک String برمی‌گرداند.

abstract void doGet (String url, OutputStream outputStream)

یک متد درخواست GET HTTP را برای یک URL مشخص اجرا می‌کند و نتیجه را به یک OutputStream ارسال می‌کند.

abstract void doGetIgnore (String url)

یک GET را برای یک URL مشخص انجام می‌دهد، و پارامترهای URL مشخص شده نتیجه را نادیده می‌گیرند.

abstract void doGetIgnoreWithRetry (String url)

در صورت عدم موفقیت، { doGetIgnore(String) تلاش مجدد را انجام می‌دهد.

abstract String doGetWithRetry (String url)

در صورت عدم موفقیت، { doGet(String) تلاش مجدد را انجام می‌دهد.

abstract String doPostWithRetry (String url, String postData)

یک متد درخواست POST HTTP را برای یک URL مشخص اجرا می‌کند و آن را به صورت یک String برمی‌گرداند و در صورت عدم موفقیت، دوباره تلاش می‌کند.

abstract String doPostWithRetry (String url, String postData, String contentType)

یک متد درخواست POST HTTP را برای یک URL مشخص اجرا می‌کند و آن را به صورت یک String برمی‌گرداند و در صورت عدم موفقیت، دوباره تلاش می‌کند.

abstract int getInitialPollInterval ()

فاصله اولیه نظرسنجی را بر حسب میلی‌ثانیه دریافت کنید.

abstract int getMaxPollInterval ()

حداکثر فاصله نظرسنجی را بر حسب میلی‌ثانیه دریافت کنید.

abstract int getMaxTime ()

حداکثر زمان لازم برای ادامه‌ی تلاش برای درخواست را بر حسب میلی‌ثانیه دریافت کنید.

abstract int getOpTimeout ()

مدت زمان اتمام عملیات را بر حسب میلی‌ثانیه دریافت کنید.

abstract void setInitialPollInterval (int time)

فاصله اولیه نظرسنجی را بر حسب میلی‌ثانیه تنظیم کنید.

abstract void setMaxPollInterval (int time)

فاصله اولیه نظرسنجی را بر حسب میلی‌ثانیه تنظیم کنید.

abstract void setMaxTime (int time)

حداکثر زمان برای ادامه‌ی تلاش برای درخواست را بر حسب میلی‌ثانیه تنظیم کنید.

abstract void setOpTimeout (int time)

زمان پایان عملیات را بر حسب میلی‌ثانیه تنظیم کنید.

ثابت‌ها

حداکثر اندازه داده 

public static final int MAX_DATA_SIZE

مقدار ثابت: ۶۵۵۳۶ (۰x۰۰۰۱۰۰۰۰)

روش‌های عمومی

پارامترهای ساخت 

public abstract String buildParameters (MultiMap<String, String> paramMap)

رشته پارامتر کدگذاری شده را بسازید.

پارامترها
paramMap MultiMap : پارامترهای URL

بازگشت‌ها
String رشته پارامتر کدگذاری شده

پرتاب‌ها
IllegalArgumentException اگر استثنایی رخ دهد، پارامترها را کدگذاری می‌کند.

ساخت آدرس اینترنتی 

public abstract String buildUrl (String url, 
                MultiMap<String, String> paramMap)

رشته درخواست URL رمزگذاری شده کامل را بسازید.

پارامترها
url String : آدرس پایه

paramMap MultiMap : پارامترهای URL

بازگشت‌ها
String آدرس اینترنتی ساخته شده

پرتاب‌ها
IllegalArgumentException اگر استثنایی رخ دهد، پارامترها را کدگذاری می‌کند.

ایجاد اتصال 

public abstract HttpURLConnection createConnection (URL url, 
                String method, 
                String contentType)

یک آدرس اینترنتی (url) به آدرس داده شده ایجاد کنید.

پارامترها
url URL : URL برای اتصال.

method String : روش درخواست HTTP. برای مثال، GET یا POST.

contentType String : نوع محتوا. برای مثال، "text/html".

بازگشت‌ها
HttpURLConnection اتصال HttpURLConnection

پرتاب‌ها
IOException اگر خطای IOException رخ دهد.

ایجادJsonConnection 

public abstract HttpURLConnection createJsonConnection (URL url, 
                String method)

برای ارسال داده‌های json، یک اتصال به URL داده شده ایجاد می‌کند.

پارامترها
url URL : URL برای اتصال.

method String : روش درخواست HTTP. برای مثال، GET یا POST.

بازگشت‌ها
HttpURLConnection اتصال HttpURLConnection

پرتاب‌ها
IOException اگر اتصال برقرار نشد

ایجادXmlConnection 

public abstract HttpURLConnection createXmlConnection (URL url, 
                String method)

برای ارسال داده‌های xml، یک اتصال به URL داده شده ایجاد می‌کند.

پارامترها
url URL : URL برای اتصال.

method String : روش درخواست HTTP. برای مثال، GET یا POST.

بازگشت‌ها
HttpURLConnection اتصال HttpURLConnection

پرتاب‌ها
IOException اگر اتصال برقرار نشد

دوگت 

public abstract String doGet (String url)

یک متد درخواست GET HTTP را برای یک URL مشخص اجرا می‌کند و آن را به صورت یک String برمی‌گرداند.

از آنجا که محتویات از راه دور در حافظه بارگذاری می‌شوند، این روش فقط باید برای داده‌های با اندازه نسبتاً کوچک استفاده شود.

مراجع:

پارامترها
url String : آدرس اینترنتی (URL)

بازگشت‌ها
String محتویات String از راه دور

پرتاب‌ها
IHttpHelper.DataSizeException اگر داده‌های بازیابی شده بزرگتر از MAX_DATA_SIZE باشند
IOException اگر بازیابی اطلاعات ناموفق بود

دوگت 

public abstract void doGet (String url, 
                OutputStream outputStream)

یک متد درخواست GET HTTP را برای یک URL مشخص اجرا می‌کند و نتیجه را به یک OutputStream ارسال می‌کند.

پارامترها
url String : آدرس اینترنتی (URL)

outputStream OutputStream : جریانی از داده‌های پاسخ

پرتاب‌ها
IOException اگر بازیابی اطلاعات ناموفق بود

همچنین ببینید:

نادیده گرفتن 

public abstract void doGetIgnore (String url)

یک GET را برای یک URL مشخص انجام می‌دهد، و پارامترهای URL مشخص شده نتیجه را نادیده می‌گیرند.

پارامترها
url String : آدرس اینترنتی (URL)

پرتاب‌ها
IOException اگر بازیابی اطلاعات ناموفق بود

همچنین ببینید:

انجام دریافت/نادیده گرفتن با تلاش مجدد 

public abstract void doGetIgnoreWithRetry (String url)

در صورت عدم موفقیت، { doGetIgnore(String) تلاش مجدد را انجام می‌دهد.

پارامترها
url String : آدرس اینترنتی (URL)

پرتاب‌ها
IOException اگر بازیابی اطلاعات ناموفق بود

doGetWithRetry 

public abstract String doGetWithRetry (String url)

در صورت عدم موفقیت، { doGet(String) تلاش مجدد را انجام می‌دهد.

پارامترها
url String : آدرس اینترنتی (URL)

بازگشت‌ها
String محتویات String از راه دور

پرتاب‌ها
IHttpHelper.DataSizeException اگر داده‌های بازیابی شده بزرگتر از MAX_DATA_SIZE باشند
IOException اگر بازیابی اطلاعات ناموفق بود

doPostWithRetry 

public abstract String doPostWithRetry (String url, 
                String postData)

یک متد درخواست POST HTTP را برای یک URL مشخص اجرا می‌کند و آن را به صورت یک String برمی‌گرداند و در صورت عدم موفقیت، دوباره تلاش می‌کند.

از آنجا که محتویات از راه دور در حافظه بارگذاری می‌شوند، این روش فقط باید برای داده‌های با اندازه نسبتاً کوچک استفاده شود.

پارامترها
url String : آدرس اینترنتی (URL)

postData String : داده‌هایی که پس از باز شدن اتصال ارسال می‌شوند

بازگشت‌ها
String محتویات String از راه دور

پرتاب‌ها
IHttpHelper.DataSizeException اگر داده‌های بازیابی شده بزرگتر از MAX_DATA_SIZE باشند
IOException اگر بازیابی اطلاعات ناموفق بود

doPostWithRetry 

public abstract String doPostWithRetry (String url, 
                String postData, 
                String contentType)

یک متد درخواست POST HTTP را برای یک URL مشخص اجرا می‌کند و آن را به صورت یک String برمی‌گرداند و در صورت عدم موفقیت، دوباره تلاش می‌کند.

از آنجا که محتویات از راه دور در حافظه بارگذاری می‌شوند، این روش فقط باید برای داده‌های با اندازه نسبتاً کوچک استفاده شود.

پارامترها
url String : آدرس اینترنتی (URL)

postData String : داده‌هایی که پس از باز شدن اتصال ارسال می‌شوند

contentType String : نوع محتوا. برای مثال، "text/html".

بازگشت‌ها
String محتویات String از راه دور

پرتاب‌ها
IHttpHelper.DataSizeException اگر داده‌های بازیابی شده بزرگتر از MAX_DATA_SIZE باشند
IOException اگر بازیابی اطلاعات ناموفق بود

getInitialPollInterval 

public abstract int getInitialPollInterval ()

فاصله اولیه نظرسنجی را بر حسب میلی‌ثانیه دریافت کنید.

بازگشت‌ها
int

getMaxPollInterval 

public abstract int getMaxPollInterval ()

حداکثر فاصله نظرسنجی را بر حسب میلی‌ثانیه دریافت کنید.

بازگشت‌ها
int

دریافت حداکثر زمان 

public abstract int getMaxTime ()

حداکثر زمان لازم برای ادامه‌ی تلاش برای درخواست را بر حسب میلی‌ثانیه دریافت کنید.

بازگشت‌ها
int

دریافت زمان فعال‌سازی 

public abstract int getOpTimeout ()

مدت زمان اتمام عملیات را بر حسب میلی‌ثانیه دریافت کنید.

بازگشت‌ها
int

setInitialPollInterval 

public abstract void setInitialPollInterval (int time)

فاصله اولیه نظرسنجی را بر حسب میلی‌ثانیه تنظیم کنید.

پارامترها
time int

setMaxPollInterval 

public abstract void setMaxPollInterval (int time)

فاصله اولیه نظرسنجی را بر حسب میلی‌ثانیه تنظیم کنید.

پارامترها
time int

حداکثر زمان تنظیم شده 

public abstract void setMaxTime (int time)

حداکثر زمان برای ادامه‌ی تلاش برای درخواست را بر حسب میلی‌ثانیه تنظیم کنید.

پارامترها
time int

setOpTimeout 

public abstract void setOpTimeout (int time)

زمان پایان عملیات را بر حسب میلی‌ثانیه تنظیم کنید.

پارامترها
time int