org.jetlinks.core

接口 ProtocolSupport

所有超级接口:

Comparable<ProtocolSupport>, reactor.core.Disposable, org.springframework.core.Ordered

所有已知实现类:

CompositeProtocolSupport

public interface ProtocolSupport
extends reactor.core.Disposable, org.springframework.core.Ordered, Comparable<ProtocolSupport>

消息协议支持接口，通过实现此接口来自定义消息协议

从以下版本开始:

1.0.0

作者:

zhouhao

嵌套类概要

从接口继承的嵌套类/接口 reactor.core.Disposable

reactor.core.Disposable.Composite, reactor.core.Disposable.Swap

字段概要

从接口继承的字段 org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

方法概要

限定符和类型	方法和说明
reactor.core.publisher.Mono<AuthenticationResponse>	authenticate(AuthenticationRequest request, DeviceOperator deviceOperation) 进行设备认证
default reactor.core.publisher.Mono<AuthenticationResponse>	authenticate(AuthenticationRequest request, DeviceRegistry registry) 对不明确的设备进行认证
default int	compareTo(ProtocolSupport o)
default void	dispose() 销毁协议
default reactor.core.publisher.Mono<DeviceInfo>	doBeforeDeviceCreate(Transport transport, DeviceInfo deviceInfo) 在执行设备创建之前,执行指定的操作。
default reactor.core.publisher.Mono<ConfigMetadata>	getConfigMetadata(Transport transport) 获取协议所需的配置信息定义
default reactor.core.publisher.Mono<DeviceMetadata>	getDefaultMetadata(Transport transport) 获取默认物模型
String	getDescription()
default reactor.core.publisher.Flux<Feature>	getFeatures(Transport transport) 获取协议支持的某些自定义特性
String	getId()
default reactor.core.publisher.Mono<ConfigMetadata>	getInitConfigMetadata() 获取协议初始化所需要的配置定义
reactor.core.publisher.Mono<? extends DeviceMessageCodec>	getMessageCodec(Transport transport) 获取设备消息编码解码器 用于将平台统一的消息对象转码为设备的消息 用于将设备发送的消息转吗为平台统一的消息对象
DeviceMetadataCodec	getMetadataCodec() 获取默认的设备物模型编解码器 用于将平台统一的设备定义规范转码为协议的规范 用于将协议的规范转为平台统一的设备定义规范
default reactor.core.publisher.Flux<DeviceMetadataCodec>	getMetadataCodecs() 获取所有支持的物模型编解码器
default reactor.core.publisher.Flux<ConfigMetadata>	getMetadataExpandsConfig(Transport transport, DeviceMetadataType metadataType, String metadataId, String dataTypeId) 获取物模型拓展配置定义
String	getName()
default int	getOrder()
default reactor.core.publisher.Mono<DeviceMessageSenderInterceptor>	getSenderInterceptor() 获取设备消息发送拦截器, 用于拦截发送消息的行为.
default reactor.core.publisher.Mono<DeviceStateChecker>	getStateChecker() 获取自定义设备状态检查器,用于检查设备状态.
reactor.core.publisher.Flux<? extends Transport>	getSupportedTransport()
default void	init(Map<String,Object> configuration) 初始化协议
default reactor.core.publisher.Mono<Void>	onChildBind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动绑定子设备到网关设备
default reactor.core.publisher.Mono<Void>	onChildUnbind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动接触绑定子设备到网关设备
default reactor.core.publisher.Mono<Void>	onClientConnect(Transport transport, ClientConnection connection, DeviceGatewayContext context) 客户端创建连接时调用,返回设备ID,表示此设备上线.
default reactor.core.publisher.Mono<Void>	onDeviceMetadataChanged(DeviceOperator operator) 当设备物模型变更时调用
default reactor.core.publisher.Mono<Void>	onDeviceRegister(DeviceOperator operator) 当设备注册生效后调用
default reactor.core.publisher.Mono<Void>	onDeviceUnRegister(DeviceOperator operator) 当设备注销前调用
default reactor.core.publisher.Mono<Void>	onProductMetadataChanged(DeviceProductOperator operator) 当产品物模型变更时调用
default reactor.core.publisher.Mono<Void>	onProductRegister(DeviceProductOperator operator) 当产品注册后调用
default reactor.core.publisher.Mono<Void>	onProductUnRegister(DeviceProductOperator operator) 当产品注销前调用

从接口继承的方法 reactor.core.Disposable

isDisposed

方法详细资料

getId

@Nonnull
String getId()

返回:

协议ID

getName

String getName()

返回:

协议名称

getDescription

String getDescription()

返回:

说明

getSupportedTransport

reactor.core.publisher.Flux<? extends Transport> getSupportedTransport()

返回:

获取支持的协议类型

getMessageCodec

@Nonnull
reactor.core.publisher.Mono<? extends DeviceMessageCodec> getMessageCodec(Transport transport)

获取设备消息编码解码器

• 用于将平台统一的消息对象转码为设备的消息
• 用于将设备发送的消息转吗为平台统一的消息对象

返回:

消息编解码器

getSenderInterceptor

default reactor.core.publisher.Mono<DeviceMessageSenderInterceptor> getSenderInterceptor()

获取设备消息发送拦截器, 用于拦截发送消息的行为.

返回:

监听器

getMetadataCodec

@Nonnull
DeviceMetadataCodec getMetadataCodec()

获取默认的设备物模型编解码器

• 用于将平台统一的设备定义规范转码为协议的规范
• 用于将协议的规范转为平台统一的设备定义规范

返回:

物模型编解码器

getMetadataCodecs

default reactor.core.publisher.Flux<DeviceMetadataCodec> getMetadataCodecs()

获取所有支持的物模型编解码器

返回:

物模型

从以下版本开始:

1.1.4

authenticate

@Nonnull
reactor.core.publisher.Mono<AuthenticationResponse> authenticate(@Nonnull
                                                                          AuthenticationRequest request,
                                                                          @Nonnull
                                                                          DeviceOperator deviceOperation)

进行设备认证

参数:

request - 认证请求，不同的连接方式实现不同

deviceOperation - 设备操作接口,可用于配置设备

返回:

认证结果

另请参阅:

MqttAuthenticationRequest

authenticate

@Nonnull
default reactor.core.publisher.Mono<AuthenticationResponse> authenticate(@Nonnull
                                                                                  AuthenticationRequest request,
                                                                                  @Nonnull
                                                                                  DeviceRegistry registry)

对不明确的设备进行认证

参数:

request - 认证请求

registry - 注册中心

返回:

认证结果

getStateChecker

@Nonnull
default reactor.core.publisher.Mono<DeviceStateChecker> getStateChecker()

获取自定义设备状态检查器,用于检查设备状态.

返回:

设备状态检查器

getConfigMetadata

default reactor.core.publisher.Mono<ConfigMetadata> getConfigMetadata(Transport transport)

获取协议所需的配置信息定义

返回:

配置定义

另请参阅:

Configurable.getConfigs(String...), Configurable.setConfigs(Map)

getInitConfigMetadata

default reactor.core.publisher.Mono<ConfigMetadata> getInitConfigMetadata()

获取协议初始化所需要的配置定义

返回:

配置定义

从以下版本开始:

1.1.2

init

default void init(Map<String,Object> configuration)

初始化协议

参数:

configuration - 配置信息

dispose

default void dispose()

销毁协议

指定者:

dispose 在接口中 reactor.core.Disposable

getDefaultMetadata

default reactor.core.publisher.Mono<DeviceMetadata> getDefaultMetadata(Transport transport)

获取默认物模型

参数:

transport - 传输协议

返回:

物模型信息

从以下版本开始:

1.1.4

getMetadataExpandsConfig

default reactor.core.publisher.Flux<ConfigMetadata> getMetadataExpandsConfig(Transport transport,
                                                                             DeviceMetadataType metadataType,
                                                                             String metadataId,
                                                                             String dataTypeId)

获取物模型拓展配置定义

参数:

transport - 传输协议类型

metadataType - 物模型类型

dataTypeId - 数据类型ID Metadata.getId()

metadataId - 物模型标识

返回:

配置定义

从以下版本开始:

1.1.4

onDeviceRegister

default reactor.core.publisher.Mono<Void> onDeviceRegister(DeviceOperator operator)

当设备注册生效后调用

参数:

operator - 设备操作接口

返回:

void

从以下版本开始:

1.1.5

onDeviceUnRegister

default reactor.core.publisher.Mono<Void> onDeviceUnRegister(DeviceOperator operator)

当设备注销前调用

参数:

operator - 设备操作接口

返回:

void

从以下版本开始:

1.1.5

onProductRegister

default reactor.core.publisher.Mono<Void> onProductRegister(DeviceProductOperator operator)

当产品注册后调用

参数:

operator - 产品操作接口

返回:

void

从以下版本开始:

1.1.5

onProductUnRegister

default reactor.core.publisher.Mono<Void> onProductUnRegister(DeviceProductOperator operator)

当产品注销前调用

参数:

operator - 产品操作接口

返回:

void

从以下版本开始:

1.1.5

onProductMetadataChanged

default reactor.core.publisher.Mono<Void> onProductMetadataChanged(DeviceProductOperator operator)

当产品物模型变更时调用

参数:

operator - 产品操作接口

返回:

void

从以下版本开始:

1.1.6

onDeviceMetadataChanged

default reactor.core.publisher.Mono<Void> onDeviceMetadataChanged(DeviceOperator operator)

当设备物模型变更时调用

参数:

operator - 设备操作接口

返回:

void

从以下版本开始:

1.1.6

onClientConnect

default reactor.core.publisher.Mono<Void> onClientConnect(Transport transport,
                                                          ClientConnection connection,
                                                          DeviceGatewayContext context)

客户端创建连接时调用,返回设备ID,表示此设备上线.

参数:

transport - 传输协议

connection - 客户端连接

返回:

void

从以下版本开始:

1.1.6

onChildBind

default reactor.core.publisher.Mono<Void> onChildBind(DeviceOperator gateway,
                                                      reactor.core.publisher.Flux<DeviceOperator> child)

触发手动绑定子设备到网关设备

参数:

gateway - 网关

child - 子设备流

返回:

void

从以下版本开始:

1.1.6

onChildUnbind

default reactor.core.publisher.Mono<Void> onChildUnbind(DeviceOperator gateway,
                                                        reactor.core.publisher.Flux<DeviceOperator> child)

触发手动接触绑定子设备到网关设备

参数:

gateway - 网关

child - 子设备流

返回:

void

从以下版本开始:

1.1.6

getFeatures

default reactor.core.publisher.Flux<Feature> getFeatures(Transport transport)

获取协议支持的某些自定义特性

返回:

特性集

从以下版本开始:

1.1.6

doBeforeDeviceCreate

default reactor.core.publisher.Mono<DeviceInfo> doBeforeDeviceCreate(Transport transport,
                                                                     DeviceInfo deviceInfo)

在执行设备创建之前,执行指定的操作。通常用于自定义默认配置生成等操作

参数:

deviceInfo - 设备信息

返回:

新等设备信息

getOrder

default int getOrder()

指定者:

getOrder 在接口中 org.springframework.core.Ordered

compareTo

default int compareTo(@Nonnull
                      ProtocolSupport o)

指定者:

compareTo 在接口中 Comparable<ProtocolSupport>