com.ablecloud.service

接口 ACBindMgr

所有已知子接口:

ACBindMgrForTest

public interface ACBindMgr

方法概要

限定符和类型	方法和说明
ACUserDevice	bindDevice(java.lang.String subDomain, java.lang.String physicalDeviceId, java.lang.String name, long userId) 绑定设备
ACUserDevice	bindDeviceWithoutOwner(java.lang.String subDomain, java.lang.String physicalDeviceId, java.lang.String name, long userId) 绑定设备,无管理员概念,所有人都可以绑定设备,同时所有人只能使自己解绑设备
ACUserDevice	bindDeviceWithShareCode(java.lang.String shareCode, long userId) 通过分享码绑定设备
void	bindDeviceWithUser(long deviceId, long userId, long adminId) 设备的管理员用户将设备与指定的用户绑定起来。
void	bindDeviceWithUser(long deviceId, java.lang.String account, long adminId) 设备的管理员用户将设备与指定的用户绑定起来。
void	changeDevice(long userId, long deviceId, java.lang.String physicalDeviceId, java.lang.String subDomain) 使用物理ID为physicalDeviceId的新设备替换逻辑ID为deviceId的设备。
void	changeName(java.lang.String subDomain, long deviceId, java.lang.String name, long userId) 修改设备名
void	changeOwner(long deviceId, long userId) 管理员接口，更改设备管理员。
ACDeviceShareCode	fetchDeviceShareCode(long deviceId, long userId, long timeout) 取设备当前的分享码。
java.util.List<ACUserDevice>	getAllDevices(java.lang.String subDomain, long offset, long limit) 查询所有被绑定的设备。
long	getBindCount(java.lang.String subDomain) 查询已被绑定的设备的总数
ACObject	getDeviceCount(java.lang.String subDomain) 已过时。 本方法统计设备在线情况已废弃，不再返回在线设备数，现被getBindCount取代，仅获取绑定设备数。 如仍需获取在线设备数量，推荐使用getDeviceCountExt 查询已被绑定的设备的总数，并提供其中在线的设备数。
long	getDeviceCountOfUser(java.lang.String subDomain, long userId) 查询用户绑定的设备数目。
long	getDeviceId(java.lang.String subDomain, java.lang.String physicalDeviceId) 根据设备物理Id查询逻辑Id
ACObject	getDeviceProfile(long deviceId) 列举某一设备的所有扩展属性
java.util.List<ACUserDevice>	getDevicesOfUser(java.lang.String subDomain, long userId, long offset, long limit) 查询用户已绑定的设备。
java.util.List<ACObject>	getDevicesOfUserExt(java.lang.String subDomain, long userId, long offset, long limit) 查询用户已绑定的设备及其扩展属性。
java.lang.String	getShareCode(long deviceId, long userId) 已过时。 请使用方法fetchDeviceShareCode(long, long, long)及refreshDeviceShareCode(long, long, long)获取设备的分享二维码。 获取分享码（只有管理员可以获取 ，默认一小时内生效）
java.lang.String	getShareCode(long deviceId, long userId, long timeout) 已过时。 请使用方法fetchDeviceShareCode(long, long, long)及refreshDeviceShareCode(long, long, long)获取设备的分享二维码。 获取分享码
ACUserDevice	getUserDevice(long deviceId) 根据逻辑Id查询设备信息
boolean	isDeviceBound(java.lang.String subDomain, java.lang.String physicalDeviceId) 检查设备是否已经被用户绑定了。
boolean	isDeviceBoundByUser(long userId, long deviceId) 检查指定用户是否绑定了指定设备。
boolean	isDeviceBoundByUser(long userId, java.lang.String subDomain, java.lang.String physicalDeviceId) 检查指定用户是否绑定了指定设备。
boolean	isDeviceOnline(long deviceId) 查询设备在线状态
boolean	isDeviceOnline(java.lang.String subDomain, java.lang.String physicalDeviceId) 查询设备在线状态
java.util.List<ACUserDevice>	listDevices(long userId) 已过时。 本方法对查询的设备数量有限制。推荐使用方法getDeviceCountOfUser 及getDevicesOfUser。 列举用户绑定的所有设备（包括独立设备与网关设备等）。
java.util.List<ACDeviceUser>	listUsers(long deviceId) 列举某一设备的所有用户
ACDeviceShareCode	refreshDeviceShareCode(long deviceId, long userId, long timeout) 更新设备的分享码。
ACDeviceMsg	sendToDevice(java.lang.String subDomain, long deviceId, ACDeviceMsg reqMsg, long userId) 直接往设备发送命令/消息
ACDeviceMsg	sendToDevice(java.lang.String subDomain, java.lang.String physicalId, ACDeviceMsg reqMsg, long userId) 直接往设备发送命令/消息
void	setDeviceProfile(long userId, long deviceId, ACObject profile) 设置用户所绑定设备的扩展属性。
void	unbindDevice(java.lang.String subDomain, long deviceId, long userId) 解绑设备
void	unbindDeviceWithUser(long deviceId, long userId, long adminId) 设备的管理员用户解除设备与用户的绑定关系。

方法详细资料

listDevices

@Deprecated
java.util.List<ACUserDevice> listDevices(long userId)
                                              throws java.lang.Exception

已过时。 本方法对查询的设备数量有限制。推荐使用方法getDeviceCountOfUser 及getDevicesOfUser。 列举用户绑定的所有设备（包括独立设备与网关设备等）。

参数:

userId - 要查询的用户的ID。

返回:

所有设备信息

抛出:

java.lang.Exception

listUsers

java.util.List<ACDeviceUser> listUsers(long deviceId)
                                throws java.lang.Exception

列举某一设备的所有用户

参数:

deviceId - 设备逻辑id

返回:

所有设备信息

抛出:

java.lang.Exception

changeName

void changeName(java.lang.String subDomain,
                long deviceId,
                java.lang.String name,
                long userId)
         throws java.lang.Exception

修改设备名

参数:

subDomain - 子域名，如djj（豆浆机）

deviceId - 设备id（这里的id，是调用list接口返回的id，不是制造商提供的id）

name - 新的设备名

userId - 修改该设备名的用户的ID

抛出:

java.lang.Exception

bindDevice

ACUserDevice bindDevice(java.lang.String subDomain,
                        java.lang.String physicalDeviceId,
                        java.lang.String name,
                        long userId)
                 throws java.lang.Exception

绑定设备

参数:

subDomain - 拟被绑定的设备所属的子域的名字

physicalDeviceId - 设备物理id

name - 名字

userId - 要绑定该设备的用户的ID

抛出:

java.lang.Exception

bindDeviceWithoutOwner

ACUserDevice bindDeviceWithoutOwner(java.lang.String subDomain,
                                    java.lang.String physicalDeviceId,
                                    java.lang.String name,
                                    long userId)
                             throws java.lang.Exception

绑定设备,无管理员概念,所有人都可以绑定设备,同时所有人只能使自己解绑设备

参数:

subDomain - 拟被绑定的设备所属的子域的名字

physicalDeviceId - 设备物理id

name - 名字

userId - 要绑定该设备的用户的ID

抛出:

java.lang.Exception

getShareCode

java.lang.String getShareCode(long deviceId,
                              long userId)
                       throws java.lang.Exception

已过时。 请使用方法fetchDeviceShareCode(long, long, long)及refreshDeviceShareCode(long, long, long)获取设备的分享二维码。 获取分享码（只有管理员可以获取 ，默认一小时内生效）

参数:

deviceId - 设备逻辑id

userId - 设备的管理员用户的ID

返回:

分享码

抛出:

java.lang.Exception

getShareCode

java.lang.String getShareCode(long deviceId,
                              long userId,
                              long timeout)
                       throws java.lang.Exception

已过时。 请使用方法fetchDeviceShareCode(long, long, long)及refreshDeviceShareCode(long, long, long)获取设备的分享二维码。 获取分享码

参数:

deviceId - 设备逻辑id

userId - 设备的管理员用户

timeout - 分享码的超时时间(以秒为单位)

返回:

分享码

抛出:

java.lang.Exception

fetchDeviceShareCode

ACDeviceShareCode fetchDeviceShareCode(long deviceId,
                                       long userId,
                                       long timeout)
                                throws java.lang.Exception

取设备当前的分享码。

参数:

deviceId - 设备的逻辑ID。

userId - 设备的管理员用户的ID。

timeout - 分享码的有效时长（以秒为单位）。此参数取值为0时表示仅取当前有效即未过期的分享码，若不存在有效的分享码则抛出分享码不存在的异常。 此参数值大于0时，若存在有效的分享码，则将其有效时长重置为此值后返回该分享码；若不存在有效的分享码则生成一个新的有效时长为timeout的分享码并返回之。 此参数的值不能超过3153600000秒（约100年），否则将被截取为此最大值。此参数小于0时也表示取此最大值。

返回:

设备的分享码。

抛出:

java.lang.Exception

refreshDeviceShareCode

ACDeviceShareCode refreshDeviceShareCode(long deviceId,
                                         long userId,
                                         long timeout)
                                  throws java.lang.Exception

更新设备的分享码。此更新操作将删除已经存在的有效分享码。

参数:

deviceId - 设备的逻辑ID。

userId - 设备的管理员用户的ID。

timeout - 分享码的有效时长（以秒为单位）。此参数的值为0时表示取值3600秒（1小时）。此参数的值大于0时不能超过3153600000秒（约100年），否则将被截取为此最大值。 此参数的值小于0时也表示取此最大值。

返回:

设备的分享码。

抛出:

java.lang.Exception

bindDeviceWithShareCode

ACUserDevice bindDeviceWithShareCode(java.lang.String shareCode,
                                     long userId)
                              throws java.lang.Exception

通过分享码绑定设备

参数:

shareCode - 分享码

userId - 要通过分享码绑定设备的用户的ID

返回:

绑定的设备的信息。

抛出:

java.lang.Exception

bindDeviceWithUser

void bindDeviceWithUser(long deviceId,
                        java.lang.String account,
                        long adminId)
                 throws java.lang.Exception

设备的管理员用户将设备与指定的用户绑定起来。

参数:

deviceId - 设备的逻辑ID。

account - 要帮定设备的用户的登录名。

adminId - 设备的管理员用户的ID。

抛出:

java.lang.Exception

bindDeviceWithUser

void bindDeviceWithUser(long deviceId,
                        long userId,
                        long adminId)
                 throws java.lang.Exception

设备的管理员用户将设备与指定的用户绑定起来。

参数:

deviceId - 设备的逻辑ID。

userId - 要帮定设备的用户的ID。

adminId - 设备的管理员用户的ID。

抛出:

java.lang.Exception

unbindDevice

void unbindDevice(java.lang.String subDomain,
                  long deviceId,
                  long userId)
           throws java.lang.Exception

解绑设备

参数:

subDomain - 要被解除绑定的设备所属的子域的名字。可选。

deviceId - 设备逻辑id。

userId - 要解除与设备的绑定关系的用户的ID。

抛出:

java.lang.Exception

unbindDeviceWithUser

void unbindDeviceWithUser(long deviceId,
                          long userId,
                          long adminId)
                   throws java.lang.Exception

设备的管理员用户解除设备与用户的绑定关系。

参数:

deviceId - 设备的逻辑ID。

userId - 要被解除绑定关系的用户的ID。

adminId - 设备的管理员用户的ID。

抛出:

java.lang.Exception

changeOwner

void changeOwner(long deviceId,
                 long userId)
          throws java.lang.Exception

管理员接口，更改设备管理员。 调用该接口时需要同时指定设备的新、旧管理员用户的ID。参数userId用于指定新管理员；旧管理员ID则需要通过ACContext.setUserId()方法设置。

参数:

deviceId - 设备的逻辑id

userId - 新管理员的id

抛出:

java.lang.Exception

changeDevice

void changeDevice(long userId,
                  long deviceId,
                  java.lang.String physicalDeviceId,
                  java.lang.String subDomain)
           throws java.lang.Exception

使用物理ID为physicalDeviceId的新设备替换逻辑ID为deviceId的设备。替换成功后，physicalDeviceId对应的设备的逻辑ID为deviceId。

参数:

userId - 逻辑ID为deviceId的设备的管理员用户的ID。

deviceId - 要被替换的设备的逻辑ID。

physicalDeviceId - 新设备的物理ID。

subDomain - 新设备所属的子域的名字。

抛出:

java.lang.Exception

isDeviceOnline

boolean isDeviceOnline(long deviceId)
                throws java.lang.Exception

查询设备在线状态

参数:

deviceId - 设备逻辑id

返回:

设备是否在线

抛出:

java.lang.Exception

isDeviceOnline

boolean isDeviceOnline(java.lang.String subDomain,
                       java.lang.String physicalDeviceId)
                throws java.lang.Exception

查询设备在线状态

参数:

subDomain - 设备所属的子域的名字。

physicalDeviceId - 设备物理id。

返回:

设备是否在线。

抛出:

java.lang.Exception

isDeviceBound

boolean isDeviceBound(java.lang.String subDomain,
                      java.lang.String physicalDeviceId)
               throws java.lang.Exception

检查设备是否已经被用户绑定了。

参数:

subDomain - 设备所属的子域的名字。

physicalDeviceId - 要被检查的设备的物理ID。

返回:

返回true表示设备已被绑定；返回true表示设备未被绑定。

抛出:

java.lang.Exception

isDeviceBoundByUser

boolean isDeviceBoundByUser(long userId,
                            long deviceId)
                     throws java.lang.Exception

检查指定用户是否绑定了指定设备。

参数:

userId - 用户ID。

deviceId - 设备逻辑ID。

返回:

返回true表示用户绑定了该设备，否则表示没有绑定。

抛出:

java.lang.Exception

isDeviceBoundByUser

boolean isDeviceBoundByUser(long userId,
                            java.lang.String subDomain,
                            java.lang.String physicalDeviceId)
                     throws java.lang.Exception

检查指定用户是否绑定了指定设备。

参数:

userId - 用户ID。

subDomain - 设备所属的子域的名字。

physicalDeviceId - 设备的物理ID。

返回:

返回true表示用户绑定了该设备，否则表示没有绑定。

抛出:

java.lang.Exception

getDeviceId

long getDeviceId(java.lang.String subDomain,
                 java.lang.String physicalDeviceId)
          throws java.lang.Exception

根据设备物理Id查询逻辑Id

参数:

subDomain - 设备所属的子域的名字。

physicalDeviceId - 设备物理id。

返回:

设备逻辑id。

抛出:

java.lang.Exception

getUserDevice

ACUserDevice getUserDevice(long deviceId)
                    throws java.lang.Exception

根据逻辑Id查询设备信息

参数:

deviceId - 设备逻辑id

返回:

ACUserDevice 设备对象信息

抛出:

java.lang.Exception

setDeviceProfile

void setDeviceProfile(long userId,
                      long deviceId,
                      ACObject profile)
               throws java.lang.Exception

设置用户所绑定设备的扩展属性。

参数:

userId - 发起该操作的用户的ID。

deviceId - 要设置其扩展属性的设备的逻辑ID。

profile - 由键值对表达的设备的扩展属性。

抛出:

java.lang.Exception

getDeviceProfile

ACObject getDeviceProfile(long deviceId)
                   throws java.lang.Exception

列举某一设备的所有扩展属性

参数:

deviceId - 设备逻辑id

返回:

所有设备扩展属性信息

抛出:

java.lang.Exception

sendToDevice

ACDeviceMsg sendToDevice(java.lang.String subDomain,
                         long deviceId,
                         ACDeviceMsg reqMsg,
                         long userId)
                  throws java.lang.Exception

直接往设备发送命令/消息

参数:

subDomain - 设备所属的子域的名字。

deviceId - 设备逻辑id。

reqMsg - 具体的消息内容。

userId - 向设备发送消息的用户的ID。

返回:

设备返回的消息

抛出:

java.lang.Exception

sendToDevice

ACDeviceMsg sendToDevice(java.lang.String subDomain,
                         java.lang.String physicalId,
                         ACDeviceMsg reqMsg,
                         long userId)
                  throws java.lang.Exception

直接往设备发送命令/消息

参数:

subDomain - 设备所属的子域的名字。

physicalId - 设备的物理Id。

reqMsg - 具体的消息内容。

userId - 向设备发送消息的用户的ID。

返回:

设备返回的消息

抛出:

java.lang.Exception

getDeviceCount

@Deprecated
ACObject getDeviceCount(java.lang.String subDomain)
                             throws java.lang.Exception

已过时。 本方法统计设备在线情况已废弃，不再返回在线设备数，现被getBindCount取代，仅获取绑定设备数。 如仍需获取在线设备数量，推荐使用getDeviceCountExt 查询已被绑定的设备的总数，并提供其中在线的设备数。

参数:

subDomain - 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。

返回:

返回的对象包含键名分别为count和online的两个键值对，分别表示设备总数和在线的设备数目。

抛出:

java.lang.Exception

getBindCount

long getBindCount(java.lang.String subDomain)
           throws java.lang.Exception

查询已被绑定的设备的总数

参数:

subDomain - 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。

返回:

返回绑定的设备数目。

抛出:

java.lang.Exception

getAllDevices

java.util.List<ACUserDevice> getAllDevices(java.lang.String subDomain,
                                           long offset,
                                           long limit)
                                    throws java.lang.Exception

查询所有被绑定的设备。

参数:

subDomain - 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。

offset - offset与limit限制查询的范围。offset是非负整数，表示返回的记录在原始集合中的偏移量。

limit - limit与offset参数指定查询的范围。limit是正整数，表示最多返回的记录的数目，并且其最大值不能超过100。

返回:

返回设备列表。返回的有效的设备信息包括：设备的逻辑ID，设备的管理员ID，设备名字，设备所属的子域ID，设备的在线状态，设备的物理ID，设备的用户ID列表。

抛出:

java.lang.Exception

getDeviceCountOfUser

long getDeviceCountOfUser(java.lang.String subDomain,
                          long userId)
                   throws java.lang.Exception

查询用户绑定的设备数目。

参数:

subDomain - 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。

userId - 拟查询的用户的ID。

返回:

该用户已经绑定的设备的数目。

抛出:

java.lang.Exception

getDevicesOfUser

java.util.List<ACUserDevice> getDevicesOfUser(java.lang.String subDomain,
                                              long userId,
                                              long offset,
                                              long limit)
                                       throws java.lang.Exception

查询用户已绑定的设备。

参数:

subDomain - 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。

userId - 拟查询的用户的ID。

offset - offset与limit限制查询的范围。offset是非负整数，表示返回的记录在原始集合中的偏移量。

limit - limit与offset参数指定查询的范围。limit是正整数，表示最多返回的记录的数目，并且其最大值不能超过100。

返回:

返回设备列表。返回的有效的设备信息包括：设备的逻辑ID，设备的管理员ID，设备名字，设备所属的子域ID，设备的在线状态，设备的物理ID，设备的用户ID列表。

抛出:

java.lang.Exception

getDevicesOfUserExt

java.util.List<ACObject> getDevicesOfUserExt(java.lang.String subDomain,
                                             long userId,
                                             long offset,
                                             long limit)
                                      throws java.lang.Exception

查询用户已绑定的设备及其扩展属性。

参数:

subDomain - 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。

userId - 拟查询的用户的ID。

offset - offset与limit限制查询的范围。offset是非负整数，表示返回的记录在原始集合中的偏移量。

limit - limit与offset参数指定查询的范围。limit是正整数，表示最多返回的记录的数目，并且其最大值不能超过100。

返回:

返回设备列表，其中包含的设备属性包括设备的基础信息、绑定时间、扩展属性、故障信息等。

抛出:

java.lang.Exception