AuthClientDto.java 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. package com.iwbnet.iot.model;
  2. import io.swagger.annotations.ApiModel;
  3. import io.swagger.annotations.ApiModelProperty;
  4. import lombok.Data;
  5. @ApiModel("mqtt认证实体")
  6. @Data
  7. public class AuthClientDto {
  8. //${clientid}: 客户端的 ID
  9. // ${username}: 客户端登录时用的用户名
  10. // ${peerhost}: 客户端的源 IP 地址
  11. // ${proto_name}: 客户端使用的协议名称。例如 MQTT,CoAP 等
  12. // ${mountpoint}: 网关监听器的挂载点(主题前缀)
  13. // ${action}: 当前执行的动作请求,例如 publish,subscribe
  14. // ${topic}: 当前请求想要发布或订阅的主题(或主题过滤器)
  15. // ${qos}: 当前请求想要发布或订阅的消息 QoS
  16. // ${retain}: 当前请求想要发布的消息是否为保留消息
  17. @ApiModelProperty("客户端的ID")
  18. private String clientId;
  19. @ApiModelProperty("客户端登录时用的用户名")
  20. private String username;
  21. @ApiModelProperty("当前请求想要发布或订阅的主题(或主题过滤器)")
  22. private String topic;
  23. @ApiModelProperty("当前执行的动作请求,例如publish,subscribe")
  24. private String action;
  25. @ApiModelProperty("客户端的源IP地址")
  26. private String peerHost;
  27. @ApiModelProperty("客户端使用的协议名称。例如 MQTT,CoAP 等")
  28. private String protoName;
  29. // @ApiModelProperty("网关监听器的挂载点(主题前缀)")
  30. private String mountPoint;
  31. @ApiModelProperty("当前请求想要发布或订阅的消息 QoS")
  32. private String qos;
  33. @ApiModelProperty("当前请求想要发布的消息是否为保留消息")
  34. private String retain;
  35. }