com.yunpian.sdk.api

Class YunpianApi

java.lang.Object

com.yunpian.sdk.api.YunpianApi

All Implemented Interfaces:

YunpianApiResult, YunpianConstant

Direct Known Subclasses:

CallApi, FlowApi, ShortUrlApi, SignApi, SmsApi, TplApi, UserApi, VoiceApi, VoidApi

public abstract class YunpianApi
extends Object
implements YunpianConstant, YunpianApiResult

TODO 优化:

• 返回值处理，接口设计问题，1小时代码现在1天
• 去除冗余字段,如api_version
• 时间处理，国际化

Since:

1.2.0

Author:

dzh

creation class date

Nov 23, 2016 1:10:02 PM

mutable object

Nested Class Summary

Nested classes/interfaces inherited from interface com.yunpian.sdk.api.YunpianApiResult

YunpianApiResult.AbstractResultHandler<R,T>, YunpianApiResult.ListResultHandler<R,T>, YunpianApiResult.MapResultHandler<T>, YunpianApiResult.ResultHandler<R,T>, YunpianApiResult.SimpleListResultHandler<T>

Field Summary

Fields inherited from interface com.yunpian.sdk.constant.YunpianConstant

_SIGN, ALARM_BALANCE, ANONYMOUS_NUMBER, API_SECRET, API_VERSION, APIKEY, APPLYVIP, AREA_CODE, BALANCE, CALLBACK_URL, CARRIER, CHECK_STATUS, CODE, COUNT, COUNTRY_CODE, DATA, DEFAULT_ENCRYPT, DETAIL, DISPLAY_NUM, DURATION, EMAIL, EMERGENCY_CONTACT, EMERGENCY_MOBILE, ENCRYPT, END_TIME, EXTEND, FEE, FLOW_PACKAGE, FLOW_STATUS, FROM, GMT_CREATED, HTTP_CHARSET, HTTP_CHARSET_DEFAULT, HTTP_CONN_MAXPERROUTE, HTTP_CONN_MAXPREROUTE, HTTP_CONN_MAXTOTAL, HTTP_CONN_TIMEOUT, HTTP_SO_TIMEOUT, HTTP_SSL_KEYSTORE, HTTP_SSL_PASSWD, INDUSTRYTYPE, IP_WHITELIST, ISONLYGLOBAL, LANG, LICENSE_URL, LONG_URL, MESSAGE_ID, MOBILE, MOBILE_STAT, MSG, NAME, NICK, NOTIFY, NOTIFY_TYPE, OLD_SIGN, PAGE_NUM, PAGE_SIZE, PROVIDER, REASON, RECORD_ID, REGISTER, RESULT, SEPERATOR_COMMA, SHORT_URL, SID, SIGN, SMS, SMS_REPLY, SMS_STATUS, SN, START_TIME, STAT, STAT_DURATION, TEMPLATE, TEXT, TIME, TO, TOTAL, TOTAL_COUNT, TOTAL_FEE, TPL_CONTENT, TPL_ID, TPL_VALUE, UID, UNIT, USER, VERSION_V1, VERSION_V2, VOICE_STATUS, YP_APIKEY, YP_CALL_HOST, YP_FILE, YP_FLOW_HOST, YP_SHORT_URL_HOST, YP_SIGN_HOST, YP_SMS_HOST, YP_TPL_HOST, YP_USER_HOST, YP_VERSION, YP_VOICE_HOST

Constructor Summary

Constructors

Constructor and Description
YunpianApi()

Method Summary

Modifier and Type	Method and Description
String	apikey()
YunpianApi	apikey(String apikey)
String	charset()
YunpianApi	charset(String charset)
YunpianClient	client()
static Integer	code(Map<String,String> rsp, String version)
boolean	equals(Object obj)
String	host()
YunpianApi	host(String host)
void	init(YunpianClient clnt)
abstract String	name() Api名称,如UserApi的name就是https://sms.yunpian.com/v2/user/get.json里的user
protected <T> List<org.apache.http.NameValuePair>	param2pair(Map<String,String> param, Result<T> r, String... must)
String	path()
YunpianApi	path(String path)
String	post(String uri, String data)
<R,T> Result<T>	post(String uri, String data, YunpianApiResult.ResultHandler<R,T> h, Result<T> r)
<R,T> Result<T>	post(String data, YunpianApiResult.ResultHandler<R,T> h)
<R,T> Result<T>	post(String data, YunpianApiResult.ResultHandler<R,T> h, Result<T> r)
<R,T> Result<T>	result(String rspContent, YunpianApiResult.ResultHandler<R,T> h, Result<T> r) 获取最终的结果
String	toString()
String	uri()
protected String	urlEncode(List<org.apache.http.NameValuePair> param)
String	urlEncode(String text)
String	version()
YunpianApi	version(String v)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

YunpianApi

public YunpianApi()

Method Detail

client

public YunpianClient client()

init

public void init(YunpianClient clnt)

Parameters:

clnt -

charset

public String charset()

charset

public YunpianApi charset(String charset)

uri

public String uri()

Returns:

请求全路径

name

public abstract String name()

Api名称,如UserApi的name就是https://sms.yunpian.com/v2/user/get.json里的user

Returns:

host

public String host()

Returns:

请求域名，如https://sms.yunpian.com

host

public YunpianApi host(String host)

version

public String version()

Returns:

接口版本，如v2

version

public YunpianApi version(String v)

path

public String path()

Returns:

请求路径，如user/get.json

path

public YunpianApi path(String path)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

apikey

public String apikey()

apikey

public YunpianApi apikey(String apikey)

post

public String post(String uri,
                   String data)
            throws Exception

Throws:

Exception

post

public <R,T> Result<T> post(String data,
                            YunpianApiResult.ResultHandler<R,T> h)

post

public <R,T> Result<T> post(String data,
                            YunpianApiResult.ResultHandler<R,T> h,
                            Result<T> r)

post

public <R,T> Result<T> post(String uri,
                            String data,
                            YunpianApiResult.ResultHandler<R,T> h,
                            Result<T> r)

code

public static Integer code(Map<String,String> rsp,
                           String version)

result

public <R,T> Result<T> result(String rspContent,
                              YunpianApiResult.ResultHandler<R,T> h,
                              Result<T> r)

Description copied from interface: YunpianApiResult

获取最终的结果

Specified by:

result in interface YunpianApiResult

Parameters:

rspContent - 响应结果

h - 结果处理器

r - 返回结果，若r=null则自动创建

Returns:

param2pair

protected <T> List<org.apache.http.NameValuePair> param2pair(Map<String,String> param,
                                                             Result<T> r,
                                                             String... must)

Parameters:

param - http request

r - must be not null

must - necessary parameters

Returns:

urlEncode

protected String urlEncode(List<org.apache.http.NameValuePair> param)

Parameters:

param -

Returns:

'application/x-www-form-urlencoded' format

urlEncode

public String urlEncode(String text)

Parameters:

text -

Returns:

Since:

1.2.2