SDK使用说明（联通用户专用）
非联通用户请查看设备接入服务。
SDK Demo总体架构
- Demo代码是调用SDK接口的样例代码，包括初始化及各个接口调用，仅供开发者参考。
- SDK提供JAVA方法调用物联网平台的API接口与平台通信。
- 消息推送回调使用JAVA代码实现回调接口，供平台推送消息给应用服务器时调用，应用通过继承PushMessageReceiver类并重写类中的方法接收推送消息的内容。
- Test API提供测试SDK接口的功能，主要测试SDK与平台之间的基本功能是否可用，并输出测试结果。测试时会分别使用内部测试证书和开发者设置的证书，以便排查证书问题。
NorthApiClient类方法
用于创建应用实例，是调用SDK其他接口的前提。主要方法如下：
方法 |
说明 |
|---|---|
public void setClientInfo( ClientInfo clientInfo) |
初始化NorthApiClient中的参数，ClientInfo的定义参考Clientinfo类方法。 |
public void setHttpConnection(int httpSocketTimeout, int httpConnectionTimeout, int maxConnectionAmount, int maxConnectionAmountPerRoute, int clearIdleTime, int httpRetryTimes) |
HTTP连接池设置，可对如下参数进行设置。
需要在initSSLConfig()或initSSLConfig(SSLConfig sslConfig)前调用。 |
public void initSSLConfig() |
初始化双向认证的配置，调用后才可以使用其他方法。
须知：
本方法使用了测试证书，非正式证书，且不做主机名校验，故仅在集成对接的调试阶段使用。 |
public void initSSLConfig(SSLConfig sslConfig) |
初始化双向认证的配置，调用后才可以使用其他方法。SSLConfig的定义参考SSLConfig类方法。
须知：
本方法用于导入证书，可以在商用阶段使用。在调用本方法前可调用setHostnameVerifier(HostnameVerifier hostnameVerifier)方法进行主机名校验，否则默认使用严格主机名校验。 |
public void setHostnameVerifier(HostnameVerifier hostnameVerifier) |
自定义主机名校验方法，在initSSLConfig(SSLConfig sslConfig)方法前调用，否则默认使用严格主机名校验。
须知：
|
public String getVersion() |
查询SDK版本号。 |
Clientinfo类方法
用于设置与物联网平台对接的基本信息。主要方法（省略get方法）如下：
方法 |
说明 |
|---|---|
public void setPlatformIp(String platformIp) |
设置物联网平台的IP地址。 |
public void setPlatformPort(String platformPort) |
设置物联网平台的端口，如8743。 |
public void setAppId(String appId) |
设置应用的appId。appId是物联网平台为第三方应用分配的身份标识，用于唯一标识一个应用。 |
public void setSecret(String secret) |
设置应用的secret。secret是与平台appId配套的密码。 |
NorthApiException类方法
当SDK的处理有异常，或者物联网平台对SDK的请求处理有异常时，抛出NorthApiException类方法。主要方法（省略set方法）如下：
方法 |
说明 |
|---|---|
public String geterror_code() |
获取异常的错误码，SDK自身处理异常会抛出四位数字的错误码，物联网平台处理异常会抛出六位数字的错误码。 |
public String getError_desc() |
获取异常错误码对应的错误描述。 |
public String getHttpStatusCode() |
获取异常http状态码。 本SDK封装了http restful API，因此当SDK在调用restful API异常时，会得到异常的http状态码，如404、200等。 |
public String getHttpReasonPhase() |
获取异常http状态码对应的原因解释（ReasonPhrase）。 如http状态码为400时，原因解释为“Not Found”；StatusCode为200时，原因解释为“OK”。 |
public String getHttpMessage() |
当物联网平台处理请求异常，并且异常中未包含错误码时，将该异常的内容通过本方法返回。 |
SSLConfig类方法
用于设置证书路径及密码。主要方法（省略get方法）如下：
方法 |
说明 |
|---|---|
public String setSelfCertPath(String selfCertPath) |
设置客户端的证书位置的绝对路径。 |
public String setSelfCertPwd(String selfCertPwd) |
设置客户端证书的密码。 |
public String setTrustCAPath(String trustCAPath) |
设置服务端CA证书位置的绝对路径。 |
public String setTrustCAPwd(String trustCAPwd) |
设置服务端CA证书的密码。 |
BasicTest类方法
用于测试证书、登录、注册设备等基本功能是否正常。方法如下：
方法 |
说明 |
|---|---|
public static void beginBasicTest(String platformIp, String platformPort, String appId, String secret, SSLConfig sslConfig) |
用户设置好平台IP、端口、appId、密码、商用证书（可选参数）后，可使用该方法测试证书、登录、注册设备等基本功能是否正常，如有异常则给出原因及建议（在控制台打印输出）。 |
