org.jetlinks.core.defaults

类 DefaultDeviceOperator

java.lang.Object

org.jetlinks.core.defaults.DefaultDeviceOperator

所有已实现的接口:

StorageConfigurable, Configurable, DeviceOperator, Thing, Wrapper

public class DefaultDeviceOperator
extends Object
implements DeviceOperator, StorageConfigurable

字段概要

字段

限定符和类型	字段和说明
static DeviceStateChecker	DEFAULT_STATE_CHECKER

构造器概要

构造器

构造器和说明
DefaultDeviceOperator(String id, ProtocolSupports supports, ConfigStorageManager storageManager, DeviceOperationBroker handler, DeviceRegistry registry)
DefaultDeviceOperator(String id, ProtocolSupports supports, ConfigStorageManager storageManager, DeviceOperationBroker handler, DeviceRegistry registry, DeviceMessageSenderInterceptor interceptor)
DefaultDeviceOperator(String id, ProtocolSupports supports, ConfigStorageManager storageManager, DeviceOperationBroker handler, DeviceRegistry registry, DeviceMessageSenderInterceptor interceptor, DeviceStateChecker deviceStateChecker)

方法概要

限定符和类型	方法和说明
reactor.core.publisher.Mono<AuthenticationResponse>	authenticate(AuthenticationRequest request) 进行授权
reactor.core.publisher.Mono<Byte>	checkState() 检查设备的真实状态,此操作将检查设备真实的状态.
reactor.core.publisher.Mono<Boolean>	disconnect() 断开设备连接
reactor.core.publisher.Mono<String>	getAddress() 获取设备地址,通常是ip地址.
reactor.core.publisher.Mono<String>	getConnectionServerId()
String	getDeviceId()
reactor.core.publisher.Mono<DeviceMetadata>	getMetadata() 获取当前物的物模型,如果当前物没有单独配置物模型,则获取模版里的物模型
reactor.core.publisher.Mono<Long>	getOfflineTime()
reactor.core.publisher.Mono<Long>	getOnlineTime()
reactor.core.publisher.Mono<DeviceProductOperator>	getParent() 获取上级配置器
reactor.core.publisher.Mono<DeviceProductOperator>	getProduct()
reactor.core.publisher.Mono<ProtocolSupport>	getProtocol()
reactor.core.publisher.Mono<ConfigStorage>	getReactiveStorage() 异步获取配置器
reactor.core.publisher.Mono<Value>	getSelfConfig(String key) 获取设备自身的配置,如果配置不存在则返回Mono.empty()
reactor.core.publisher.Mono<Values>	getSelfConfigs(Collection<String> keys) 获取设备自身的多个配置,不会返回Mono.empty(),通过从Values中获取对应的值
reactor.core.publisher.Mono<String>	getSessionId()
reactor.core.publisher.Mono<Byte>	getState() 获取设备当前缓存的状态,此状态可能与实际的状态不一致.
DeviceMessageSender	messageSender()
reactor.core.publisher.Mono<Boolean>	offline() 设置设备离线
reactor.core.publisher.Mono<Boolean>	online(String serverId, String sessionId, String address)
reactor.core.publisher.Mono<Boolean>	putState(byte state)
reactor.core.publisher.Mono<Void>	resetMetadata() 重置当前设备的独立物模型
ThingRpcSupport	rpc() 获取RPC操作接口
reactor.core.publisher.Mono<Void>	setAddress(String address) 设置设备地址
reactor.core.publisher.Mono<Boolean>	setConfigs(Map<String,Object> conf) 批量设置配置
reactor.core.publisher.Mono<Boolean>	updateMetadata(String metadata) 设置当前设备的独立物模型,如果没有设置,这使用产品的物模型配置
reactor.core.publisher.Mono<Boolean>	updateMetadata(ThingMetadata metadata) 更新物模型

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.jetlinks.core.device.DeviceOperator

getSelfConfig, getSelfConfigs, getSelfConfigs, getTemplate, getType, isOnline, online

从接口继承的方法 org.jetlinks.core.things.Thing

getId

从接口继承的方法 org.jetlinks.core.Configurable

getAndRemoveConfig, getConfig, getConfig, getConfigs, getConfigs, getConfigs, refreshAllConfig, refreshConfig, removeConfig, removeConfigs, removeConfigs, setConfig, setConfig, setConfig, setConfigs

从接口继承的方法 org.jetlinks.core.Wrapper

isWrapperFor, unwrap

从接口继承的方法 org.jetlinks.core.config.StorageConfigurable

getAndRemoveConfig, getConfig, getConfig, getConfigs, getConfigs, refreshAllConfig, refreshConfig, removeConfig, removeConfigs, setConfig

字段详细资料

DEFAULT_STATE_CHECKER

public static final DeviceStateChecker DEFAULT_STATE_CHECKER

构造器详细资料

DefaultDeviceOperator

public DefaultDeviceOperator(String id,
                             ProtocolSupports supports,
                             ConfigStorageManager storageManager,
                             DeviceOperationBroker handler,
                             DeviceRegistry registry)

DefaultDeviceOperator

public DefaultDeviceOperator(String id,
                             ProtocolSupports supports,
                             ConfigStorageManager storageManager,
                             DeviceOperationBroker handler,
                             DeviceRegistry registry,
                             DeviceMessageSenderInterceptor interceptor)

DefaultDeviceOperator

public DefaultDeviceOperator(String id,
                             ProtocolSupports supports,
                             ConfigStorageManager storageManager,
                             DeviceOperationBroker handler,
                             DeviceRegistry registry,
                             DeviceMessageSenderInterceptor interceptor,
                             DeviceStateChecker deviceStateChecker)

方法详细资料

getReactiveStorage

public reactor.core.publisher.Mono<ConfigStorage> getReactiveStorage()

从接口复制的说明: StorageConfigurable

异步获取配置器

指定者:

getReactiveStorage 在接口中 StorageConfigurable

返回:

ConfigStorage

getDeviceId

public String getDeviceId()

指定者:

getDeviceId 在接口中 DeviceOperator

返回:

设备ID

getConnectionServerId

public reactor.core.publisher.Mono<String> getConnectionServerId()

指定者:

getConnectionServerId 在接口中 DeviceOperator

返回:

当前设备连接所在服务器ID，如果设备未上线 DeviceState.online，则返回null

getSessionId

public reactor.core.publisher.Mono<String> getSessionId()

指定者:

getSessionId 在接口中 DeviceOperator

返回:

当前设备连接会话ID

getAddress

public reactor.core.publisher.Mono<String> getAddress()

从接口复制的说明: DeviceOperator

获取设备地址,通常是ip地址.

指定者:

getAddress 在接口中 DeviceOperator

返回:

地址

setAddress

public reactor.core.publisher.Mono<Void> setAddress(String address)

从接口复制的说明: DeviceOperator

设置设备地址

指定者:

setAddress 在接口中 DeviceOperator

参数:

address - 地址

返回:

Mono

putState

public reactor.core.publisher.Mono<Boolean> putState(byte state)

指定者:

putState 在接口中 DeviceOperator

参数:

state - 状态

另请参阅:

DeviceState.online

getState

public reactor.core.publisher.Mono<Byte> getState()

从接口复制的说明: DeviceOperator

获取设备当前缓存的状态,此状态可能与实际的状态不一致.

指定者:

getState 在接口中 DeviceOperator

返回:

获取当前状态

另请参阅:

DeviceState

checkState

public reactor.core.publisher.Mono<Byte> checkState()

从接口复制的说明: DeviceOperator

检查设备的真实状态,此操作将检查设备真实的状态. 如果设备协议中指定了ProtocolSupport.getStateChecker(),则将调用指定的状态检查器进行检查.
默认的状态检查逻辑:

指定者:

checkState 在接口中 DeviceOperator

另请参阅:

DeviceStateChecker

getOnlineTime

public reactor.core.publisher.Mono<Long> getOnlineTime()

指定者:

getOnlineTime 在接口中 DeviceOperator

返回:

上线时间

getOfflineTime

public reactor.core.publisher.Mono<Long> getOfflineTime()

指定者:

getOfflineTime 在接口中 DeviceOperator

返回:

离线时间

offline

public reactor.core.publisher.Mono<Boolean> offline()

从接口复制的说明: DeviceOperator

设置设备离线

指定者:

offline 在接口中 DeviceOperator

另请参阅:

DeviceState.offline

online

public reactor.core.publisher.Mono<Boolean> online(String serverId,
                                                   String sessionId,
                                                   String address)

指定者:

online 在接口中 DeviceOperator

getSelfConfig

public reactor.core.publisher.Mono<Value> getSelfConfig(String key)

从接口复制的说明: DeviceOperator

获取设备自身的配置,如果配置不存在则返回Mono.empty()

指定者:

getSelfConfig 在接口中 DeviceOperator

指定者:

getSelfConfig 在接口中 Thing

参数:

key - 配置Key

返回:

配置值

getSelfConfigs

public reactor.core.publisher.Mono<Values> getSelfConfigs(Collection<String> keys)

从接口复制的说明: DeviceOperator

获取设备自身的多个配置,不会返回Mono.empty(),通过从Values中获取对应的值

指定者:

getSelfConfigs 在接口中 DeviceOperator

指定者:

getSelfConfigs 在接口中 Thing

参数:

keys - 配置key列表

返回:

配置值

disconnect

public reactor.core.publisher.Mono<Boolean> disconnect()

从接口复制的说明: DeviceOperator

断开设备连接

指定者:

disconnect 在接口中 DeviceOperator

返回:

断开结果

authenticate

public reactor.core.publisher.Mono<AuthenticationResponse> authenticate(AuthenticationRequest request)

从接口复制的说明: DeviceOperator

进行授权

指定者:

authenticate 在接口中 DeviceOperator

参数:

request - 授权请求

返回:

授权结果

另请参阅:

MqttAuthenticationRequest

getMetadata

public reactor.core.publisher.Mono<DeviceMetadata> getMetadata()

从接口复制的说明: Thing

获取当前物的物模型,如果当前物没有单独配置物模型,则获取模版里的物模型

指定者:

getMetadata 在接口中 DeviceOperator

指定者:

getMetadata 在接口中 Thing

返回:

获取设备的元数据

getParent

public reactor.core.publisher.Mono<DeviceProductOperator> getParent()

从接口复制的说明: StorageConfigurable

获取上级配置器

指定者:

getParent 在接口中 StorageConfigurable

返回:

Configurable

getProtocol

public reactor.core.publisher.Mono<ProtocolSupport> getProtocol()

指定者:

getProtocol 在接口中 DeviceOperator

返回:

获取此设备使用的协议支持

getProduct

public reactor.core.publisher.Mono<DeviceProductOperator> getProduct()

指定者:

getProduct 在接口中 DeviceOperator

返回:

获取设备对应的产品操作接口

messageSender

public DeviceMessageSender messageSender()

指定者:

messageSender 在接口中 DeviceOperator

返回:

消息发送器, 用于发送消息给设备

updateMetadata

public reactor.core.publisher.Mono<Boolean> updateMetadata(String metadata)

从接口复制的说明: DeviceOperator

设置当前设备的独立物模型,如果没有设置,这使用产品的物模型配置

指定者:

updateMetadata 在接口中 DeviceOperator

指定者:

updateMetadata 在接口中 Thing

参数:

metadata - 物模型

返回:

true

resetMetadata

public reactor.core.publisher.Mono<Void> resetMetadata()

从接口复制的说明: DeviceOperator

重置当前设备的独立物模型

指定者:

resetMetadata 在接口中 DeviceOperator

指定者:

resetMetadata 在接口中 Thing

返回:

void

updateMetadata

public reactor.core.publisher.Mono<Boolean> updateMetadata(ThingMetadata metadata)

从接口复制的说明: Thing

更新物模型

指定者:

updateMetadata 在接口中 Thing

参数:

metadata - 物模型对象

返回:

true

setConfigs

public reactor.core.publisher.Mono<Boolean> setConfigs(Map<String,Object> conf)

从接口复制的说明: Configurable

批量设置配置

指定者:

setConfigs 在接口中 StorageConfigurable

指定者:

setConfigs 在接口中 Configurable

参数:

conf - 配置内容

rpc

public ThingRpcSupport rpc()

从接口复制的说明: Thing

获取RPC操作接口

指定者:

rpc 在接口中 Thing

返回:

ThingRpcSupport