org.jetlinks.core.defaults

类 CompositeProtocolSupport

java.lang.Object

org.jetlinks.core.defaults.CompositeProtocolSupport

所有已实现的接口:

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

public class CompositeProtocolSupport
extends Object
implements ProtocolSupport

嵌套类概要

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

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

字段概要

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器和说明
CompositeProtocolSupport()

方法概要

限定符和类型	方法和说明
void	addAuthenticator(Transport transport, Authenticator authenticator)
void	addConfigMetadata(Transport transport, ConfigMetadata metadata)
void	addConfigMetadata(Transport transport, java.util.function.Supplier<reactor.core.publisher.Mono<ConfigMetadata>> metadata)
void	addDefaultMetadata(Transport transport, DeviceMetadata metadata)
void	addDefaultMetadata(Transport transport, reactor.core.publisher.Mono<DeviceMetadata> metadata)
void	addDeviceMetadataCodec(DeviceMetadataCodec codec)
void	addFeature(Feature... features) 添加全局Feature
void	addFeature(Iterable<Feature> features) 添加全局Feature
void	addFeature(Transport transport, Feature... features) 给指定的Transport添加Feature
void	addFeature(Transport transport, reactor.core.publisher.Flux<Feature> features) 给指定的Transport添加Feature
void	addFeature(Transport transport, Iterable<Feature> features) 给指定的Transport添加Feature
void	addMessageCodecSupport(DeviceMessageCodec codec)
void	addMessageCodecSupport(Transport transport, DeviceMessageCodec codec)
void	addMessageCodecSupport(Transport transport, java.util.function.Supplier<reactor.core.publisher.Mono<DeviceMessageCodec>> supplier)
void	addMessageSenderInterceptor(DeviceMessageSenderInterceptor interceptor)
reactor.core.publisher.Mono<AuthenticationResponse>	authenticate(AuthenticationRequest request, DeviceOperator deviceOperation) 进行设备认证
reactor.core.publisher.Mono<AuthenticationResponse>	authenticate(AuthenticationRequest request, DeviceRegistry registry) 对不明确的设备进行认证
void	dispose() 销毁协议
reactor.core.publisher.Mono<DeviceInfo>	doBeforeDeviceCreate(Transport transport, DeviceInfo deviceInfo) 在执行设备创建之前,执行指定的操作。
void	doOnChildBind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildBind)
void	doOnChildUnbind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildUnbind)
void	doOnClientConnect(Transport transport, java.util.function.BiFunction<ClientConnection,DeviceGatewayContext,reactor.core.publisher.Mono<Void>> handler) 监听客户端连接,只有部分协议支持此操作,如: support.doOnClientConnect(TCP,(connection,context)->{ //客户端创建连接时,发送消息给客户端 return connection .sendMessage(createHelloMessage()) .then(); })
CompositeProtocolSupport	doOnDeviceMetadataChanged(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)
CompositeProtocolSupport	doOnDeviceRegister(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)
CompositeProtocolSupport	doOnDeviceUnRegister(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)
CompositeProtocolSupport	doOnDispose(reactor.core.Disposable disposable)
CompositeProtocolSupport	doOnInit(java.util.function.Consumer<Map<String,Object>> runnable)
CompositeProtocolSupport	doOnProductMetadataChanged(java.util.function.Function<DeviceProductOperator,reactor.core.publisher.Mono<Void>> executor)
CompositeProtocolSupport	doOnProductRegister(java.util.function.Function<DeviceProductOperator,reactor.core.publisher.Mono<Void>> executor)
CompositeProtocolSupport	doOnProductUnRegister(java.util.function.Function<DeviceProductOperator,reactor.core.publisher.Mono<Void>> executor)
reactor.core.publisher.Mono<ConfigMetadata>	getConfigMetadata(Transport transport) 获取协议所需的配置信息定义
reactor.core.publisher.Mono<DeviceMetadata>	getDefaultMetadata(Transport transport) 获取默认物模型
reactor.core.publisher.Flux<Feature>	getFeatures(Transport transport) 获取协议支持的某些自定义特性
reactor.core.publisher.Mono<ConfigMetadata>	getInitConfigMetadata() 获取协议初始化所需要的配置定义
reactor.core.publisher.Mono<? extends DeviceMessageCodec>	getMessageCodec(Transport transport) 获取设备消息编码解码器 用于将平台统一的消息对象转码为设备的消息 用于将设备发送的消息转吗为平台统一的消息对象
DeviceMetadataCodec	getMetadataCodec() 获取默认的设备物模型编解码器 用于将平台统一的设备定义规范转码为协议的规范 用于将协议的规范转为平台统一的设备定义规范
reactor.core.publisher.Flux<DeviceMetadataCodec>	getMetadataCodecs() 获取所有支持的物模型编解码器
reactor.core.publisher.Flux<ConfigMetadata>	getMetadataExpandsConfig(Transport transport, DeviceMetadataType metadataType, String metadataId, String dataTypeId) 获取物模型拓展配置定义
reactor.core.publisher.Mono<DeviceMessageSenderInterceptor>	getSenderInterceptor() 获取设备消息发送拦截器, 用于拦截发送消息的行为.
reactor.core.publisher.Mono<DeviceStateChecker>	getStateChecker() 获取自定义设备状态检查器,用于检查设备状态.
reactor.core.publisher.Flux<Transport>	getSupportedTransport()
void	init(Map<String,Object> configuration) 初始化协议
void	onBeforeDeviceCreate(Transport transport, java.util.function.Function<DeviceInfo,reactor.core.publisher.Mono<DeviceInfo>> listener) 注册设备添加监听器,用于在创建设备时,进行自定义配置生成等操作.
reactor.core.publisher.Mono<Void>	onChildBind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动绑定子设备到网关设备
reactor.core.publisher.Mono<Void>	onChildUnbind(DeviceOperator gateway, reactor.core.publisher.Flux<DeviceOperator> child) 触发手动接触绑定子设备到网关设备
reactor.core.publisher.Mono<Void>	onClientConnect(Transport transport, ClientConnection connection, DeviceGatewayContext context) 客户端创建连接时调用,返回设备ID,表示此设备上线.
reactor.core.publisher.Mono<Void>	onDeviceMetadataChanged(DeviceOperator operator) 当设备物模型变更时调用
reactor.core.publisher.Mono<Void>	onDeviceRegister(DeviceOperator operator) 当设备注册生效后调用
reactor.core.publisher.Mono<Void>	onDeviceUnRegister(DeviceOperator operator) 当设备注销前调用
reactor.core.publisher.Mono<Void>	onProductMetadataChanged(DeviceProductOperator operator) 当产品物模型变更时调用
reactor.core.publisher.Mono<Void>	onProductRegister(DeviceProductOperator operator) 当产品注册后调用
reactor.core.publisher.Mono<Void>	onProductUnRegister(DeviceProductOperator operator) 当产品注销前调用
void	setExpandsConfigMetadata(Transport transport, ExpandsConfigMetadataSupplier supplier)
void	setInitConfigMetadata(ConfigMetadata metadata)

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

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

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

compareTo, getDescription, getId, getName, getOrder

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

isDisposed

构造器详细资料

CompositeProtocolSupport

public CompositeProtocolSupport()

方法详细资料

dispose

public void dispose()

从接口复制的说明: ProtocolSupport

销毁协议

指定者:

dispose 在接口中 ProtocolSupport

指定者:

dispose 在接口中 reactor.core.Disposable

setInitConfigMetadata

public void setInitConfigMetadata(ConfigMetadata metadata)

init

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

从接口复制的说明: ProtocolSupport

初始化协议

指定者:

init 在接口中 ProtocolSupport

参数:

configuration - 配置信息

doOnDispose

public CompositeProtocolSupport doOnDispose(reactor.core.Disposable disposable)

doOnInit

public CompositeProtocolSupport doOnInit(java.util.function.Consumer<Map<String,Object>> runnable)

addMessageCodecSupport

public void addMessageCodecSupport(Transport transport,
                                   java.util.function.Supplier<reactor.core.publisher.Mono<DeviceMessageCodec>> supplier)

addMessageCodecSupport

public void addMessageCodecSupport(Transport transport,
                                   DeviceMessageCodec codec)

addMessageCodecSupport

public void addMessageCodecSupport(DeviceMessageCodec codec)

addAuthenticator

public void addAuthenticator(Transport transport,
                             Authenticator authenticator)

addDefaultMetadata

public void addDefaultMetadata(Transport transport,
                               reactor.core.publisher.Mono<DeviceMetadata> metadata)

addDefaultMetadata

public void addDefaultMetadata(Transport transport,
                               DeviceMetadata metadata)

getSenderInterceptor

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

从接口复制的说明: ProtocolSupport

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

指定者:

getSenderInterceptor 在接口中 ProtocolSupport

返回:

监听器

addMessageSenderInterceptor

public void addMessageSenderInterceptor(DeviceMessageSenderInterceptor interceptor)

addConfigMetadata

public void addConfigMetadata(Transport transport,
                              java.util.function.Supplier<reactor.core.publisher.Mono<ConfigMetadata>> metadata)

addConfigMetadata

public void addConfigMetadata(Transport transport,
                              ConfigMetadata metadata)

setExpandsConfigMetadata

public void setExpandsConfigMetadata(Transport transport,
                                     ExpandsConfigMetadataSupplier supplier)

getMetadataExpandsConfig

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

从接口复制的说明: ProtocolSupport

获取物模型拓展配置定义

指定者:

getMetadataExpandsConfig 在接口中 ProtocolSupport

参数:

transport - 传输协议类型

metadataType - 物模型类型

metadataId - 物模型标识

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

返回:

配置定义

getDefaultMetadata

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

从接口复制的说明: ProtocolSupport

获取默认物模型

指定者:

getDefaultMetadata 在接口中 ProtocolSupport

参数:

transport - 传输协议

返回:

物模型信息

getSupportedTransport

public reactor.core.publisher.Flux<Transport> getSupportedTransport()

指定者:

getSupportedTransport 在接口中 ProtocolSupport

返回:

获取支持的协议类型

getMessageCodec

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

从接口复制的说明: ProtocolSupport

获取设备消息编码解码器

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

指定者:

getMessageCodec 在接口中 ProtocolSupport

返回:

消息编解码器

getMetadataCodec

@Nonnull
public DeviceMetadataCodec getMetadataCodec()

从接口复制的说明: ProtocolSupport

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

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

指定者:

getMetadataCodec 在接口中 ProtocolSupport

返回:

物模型编解码器

getMetadataCodecs

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

从接口复制的说明: ProtocolSupport

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

指定者:

getMetadataCodecs 在接口中 ProtocolSupport

返回:

物模型

addDeviceMetadataCodec

public void addDeviceMetadataCodec(DeviceMetadataCodec codec)

authenticate

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

从接口复制的说明: ProtocolSupport

进行设备认证

指定者:

authenticate 在接口中 ProtocolSupport

参数:

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

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

返回:

认证结果

另请参阅:

MqttAuthenticationRequest

authenticate

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

从接口复制的说明: ProtocolSupport

对不明确的设备进行认证

指定者:

authenticate 在接口中 ProtocolSupport

参数:

request - 认证请求

registry - 注册中心

返回:

认证结果

getConfigMetadata

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

从接口复制的说明: ProtocolSupport

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

指定者:

getConfigMetadata 在接口中 ProtocolSupport

返回:

配置定义

另请参阅:

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

getInitConfigMetadata

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

从接口复制的说明: ProtocolSupport

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

指定者:

getInitConfigMetadata 在接口中 ProtocolSupport

返回:

配置定义

getStateChecker

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

从接口复制的说明: ProtocolSupport

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

指定者:

getStateChecker 在接口中 ProtocolSupport

返回:

设备状态检查器

doOnDeviceRegister

public CompositeProtocolSupport doOnDeviceRegister(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)

doOnDeviceUnRegister

public CompositeProtocolSupport doOnDeviceUnRegister(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)

doOnProductRegister

public CompositeProtocolSupport doOnProductRegister(java.util.function.Function<DeviceProductOperator,reactor.core.publisher.Mono<Void>> executor)

doOnProductUnRegister

public CompositeProtocolSupport doOnProductUnRegister(java.util.function.Function<DeviceProductOperator,reactor.core.publisher.Mono<Void>> executor)

doOnProductMetadataChanged

public CompositeProtocolSupport doOnProductMetadataChanged(java.util.function.Function<DeviceProductOperator,reactor.core.publisher.Mono<Void>> executor)

doOnDeviceMetadataChanged

public CompositeProtocolSupport doOnDeviceMetadataChanged(java.util.function.Function<DeviceOperator,reactor.core.publisher.Mono<Void>> executor)

doOnClientConnect

public void doOnClientConnect(Transport transport,
                              java.util.function.BiFunction<ClientConnection,DeviceGatewayContext,reactor.core.publisher.Mono<Void>> handler)

监听客户端连接,只有部分协议支持此操作,如:

 support.doOnClientConnect(TCP,(connection,context)->{
  //客户端创建连接时,发送消息给客户端
  return connection
   .sendMessage(createHelloMessage())
    .then();
  })
 

参数:

transport - 通信协议,如: DefaultTransport.TCP

handler - 处理器

从以下版本开始:

1.1.6

onDeviceRegister

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

从接口复制的说明: ProtocolSupport

当设备注册生效后调用

指定者:

onDeviceRegister 在接口中 ProtocolSupport

参数:

operator - 设备操作接口

返回:

void

onDeviceUnRegister

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

从接口复制的说明: ProtocolSupport

当设备注销前调用

指定者:

onDeviceUnRegister 在接口中 ProtocolSupport

参数:

operator - 设备操作接口

返回:

void

onProductRegister

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

从接口复制的说明: ProtocolSupport

当产品注册后调用

指定者:

onProductRegister 在接口中 ProtocolSupport

参数:

operator - 产品操作接口

返回:

void

onProductUnRegister

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

从接口复制的说明: ProtocolSupport

当产品注销前调用

指定者:

onProductUnRegister 在接口中 ProtocolSupport

参数:

operator - 产品操作接口

返回:

void

onDeviceMetadataChanged

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

从接口复制的说明: ProtocolSupport

当设备物模型变更时调用

指定者:

onDeviceMetadataChanged 在接口中 ProtocolSupport

参数:

operator - 设备操作接口

返回:

void

onProductMetadataChanged

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

从接口复制的说明: ProtocolSupport

当产品物模型变更时调用

指定者:

onProductMetadataChanged 在接口中 ProtocolSupport

参数:

operator - 产品操作接口

返回:

void

doOnChildBind

public void doOnChildBind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildBind)

doOnChildUnbind

public void doOnChildUnbind(java.util.function.BiFunction<DeviceOperator,reactor.core.publisher.Flux<DeviceOperator>,reactor.core.publisher.Mono<Void>> onChildUnbind)

onClientConnect

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

从接口复制的说明: ProtocolSupport

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

指定者:

onClientConnect 在接口中 ProtocolSupport

参数:

transport - 传输协议

connection - 客户端连接

返回:

void

onChildBind

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

从接口复制的说明: ProtocolSupport

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

指定者:

onChildBind 在接口中 ProtocolSupport

参数:

gateway - 网关

child - 子设备流

返回:

void

onChildUnbind

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

从接口复制的说明: ProtocolSupport

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

指定者:

onChildUnbind 在接口中 ProtocolSupport

参数:

gateway - 网关

child - 子设备流

返回:

void

addFeature

public void addFeature(Transport transport,
                       Feature... features)

给指定的Transport添加Feature

参数:

features - Feature

addFeature

public void addFeature(Transport transport,
                       Iterable<Feature> features)

给指定的Transport添加Feature

参数:

features - Feature

addFeature

public void addFeature(Transport transport,
                       reactor.core.publisher.Flux<Feature> features)

给指定的Transport添加Feature

参数:

features - Feature

addFeature

public void addFeature(Feature... features)

添加全局Feature

参数:

features - Feature

另请参阅:

MetadataFeature, ManagementFeature

addFeature

public void addFeature(Iterable<Feature> features)

添加全局Feature

参数:

features - Feature

onBeforeDeviceCreate

public void onBeforeDeviceCreate(Transport transport,
                                 java.util.function.Function<DeviceInfo,reactor.core.publisher.Mono<DeviceInfo>> listener)

注册设备添加监听器,用于在创建设备时,进行自定义配置生成等操作.

参数:

transport - 传输协议

listener - 监听器

从以下版本开始:

1.1.8

doBeforeDeviceCreate

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

从接口复制的说明: ProtocolSupport

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

指定者:

doBeforeDeviceCreate 在接口中 ProtocolSupport

deviceInfo - 设备信息

返回:

新等设备信息

getFeatures

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

从接口复制的说明: ProtocolSupport

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

指定者:

getFeatures 在接口中 ProtocolSupport

返回:

特性集