dendi-wang/thingsboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactored config properties

Browse Source
This commit is contained in:
dashevchenko 2023-07-05 15:06:42 +03:00
parent fee8aa359a
commit 3baa12ce77
4 changed files with 153 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
application/src/main/resources/thingsboard.yml
View File

@ -775,10 +775,6 @@ transport:
worker_group_thread_count: "${NETTY_WORKER_GROUP_THREADS:12}"
max_payload_size: "${NETTY_MAX_PAYLOAD_SIZE:65536}"
so_keep_alive: "${NETTY_SO_KEEPALIVE:false}"
# Mqtt device connectivity host to publish telemetry
device_connectivity_host: "${MQTT_DEVICE_CONNECTIVITY_HOST:localhost}"
# Mqtt device connectivity port to publish telemetry
device_connectivity_port: "${MQTT_DEVICE_CONNECTIVITY_PORT:1883}"
# MQTT SSL configuration
ssl:
# Enable/disable SSL support
@ -789,10 +785,6 @@ transport:
bind_port: "${MQTT_SSL_BIND_PORT:8883}"
# SSL protocol: See https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#sslcontext-algorithms
protocol: "${MQTT_SSL_PROTOCOL:TLSv1.2}"
# Mqtt ssl device connectivity host to publish telemetry
device_connectivity_host: "${MQTT_DEVICE_CONNECTIVITY_HOST:localhost}"
# Mqtt ssl device connectivity port to publish telemetry
device_connectivity_port: "${MQTT_DEVICE_CONNECTIVITY_PORT:8883}"
# Server SSL credentials
credentials:
# Server credentials type (PEM - pem certificate file; KEYSTORE - java keystore)
@ -829,10 +821,6 @@ transport:
piggyback_timeout: "${COAP_PIGGYBACK_TIMEOUT:500}"
psm_activity_timer: "${COAP_PSM_ACTIVITY_TIMER:10000}"
paging_transmission_window: "${COAP_PAGING_TRANSMISSION_WINDOW:10000}"
# Coap device connectivity host to publish telemetry
device_connectivity_host: "${COAP_DEVICE_CONNECTIVITY_HOST:localhost}"
# Coap device connectivity port to publish telemetry
device_connectivity_port: "${COAP_DEVICE_CONNECTIVITY_PORT:5683}"
dtls:
# Enable/disable DTLS 1.2 support
enabled: "${COAP_DTLS_ENABLED:false}"
@ -842,10 +830,6 @@ transport:
bind_address: "${COAP_DTLS_BIND_ADDRESS:0.0.0.0}"
# CoAP DTLS bind port
bind_port: "${COAP_DTLS_BIND_PORT:5684}"
# Coap DTLS device connectivity host to publish telemetry
device_connectivity_host: "${COAP_DEVICE_CONNECTIVITY_HOST:localhost}"
# Coap DTLS device connectivity port to publish telemetry
device_connectivity_port: "${COAP_DEVICE_CONNECTIVITY_PORT:5684}"
# Server DTLS credentials
credentials:
# Server credentials type (PEM - pem certificate file; KEYSTORE - java keystore)
@ -994,6 +978,25 @@ transport:
enabled: "${TB_TRANSPORT_STATS_ENABLED:true}"
print-interval-ms: "${TB_TRANSPORT_STATS_PRINT_INTERVAL_MS:60000}"
# Device connectivity properties to publish telemetry
device:
connectivity:
http:
host: "${DEVICE_CONNECTIVITY_HTTP_HOST:localhost}"
port: "${DEVICE_CONNECTIVITY_HTTP_PORT:8080}"
mqtt:
host: "${DEVICE_CONNECTIVITY_MQTT_HOST:localhost}"
port: "${DEVICE_CONNECTIVITY_MQTT_PORT:1883}"
mqtts:
host: "${DEVICE_CONNECTIVITY_MQTTS_HOST:localhost}"
port: "${DEVICE_CONNECTIVITY_MQTTS_PORT:8883}"
coap:
host: "${DEVICE_CONNECTIVITY_COAP_HOST:localhost}"
port: "${DEVICE_CONNECTIVITY_COAP_PORT:5683}"
coaps:
host: "${DEVICE_CONNECTIVITY_COAPS_HOST:localhost}"
port: "${DEVICE_CONNECTIVITY_COAPS_PORT:5684}"
# Edges parameters
edges:
enabled: "${EDGES_ENABLED:true}"

24
dao/src/main/java/org/thingsboard/server/dao/device/DeviceConnectivityConfiguration.java
View File

@ -1,9 +1,29 @@
/**
* Copyright © 2016-2023 The Thingsboard Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.thingsboard.server.dao.device;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import java.util.Map;
@Configuration
@ConfigurationProperties(prefix = "device")
@Data
public class DeviceConnectivityConfiguration {
private String deviceConnectivityHost;
private Integer deviceConnectivityPort;
private Map<String, DeviceConnectivityInfo> connectivity;
}

26
dao/src/main/java/org/thingsboard/server/dao/device/DeviceConnectivityInfo.java Normal file
View File

@ -0,0 +1,26 @@
/**
* Copyright © 2016-2023 The Thingsboard Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.thingsboard.server.dao.device;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
@Data
public class DeviceConnectivityInfo {
private String host;
private Integer port;
}

168
dao/src/main/java/org/thingsboard/server/dao/device/DeviceServiceImpl.java
View File

@ -20,9 +20,6 @@ import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.transaction.event.TransactionalEventListener;
@ -108,7 +105,7 @@ public class DeviceServiceImpl extends AbstractCachedEntityService<DeviceCacheKe
public static final String INCORRECT_DEVICE_ID = "Incorrect deviceId ";
public static final String INCORRECT_EDGE_ID = "Incorrect edgeId ";
public static final String PAYLOAD = "\"{temperature:25}\"";
public static final String NOT_SUPPORTED = "Not supported";
@Autowired
private DeviceDao deviceDao;
@ -128,45 +125,8 @@ public class DeviceServiceImpl extends AbstractCachedEntityService<DeviceCacheKe
@Autowired
private EntityCountService countService;
@Bean
@ConfigurationProperties(prefix = "transport.mqtt")
public DeviceConnectivityConfiguration mqttDeviceConnectivityProperties() {
return new DeviceConnectivityConfiguration ();
}
@Bean
@ConfigurationProperties(prefix = "transport.mqtt.ssl")
public DeviceConnectivityConfiguration mqttsDeviceConnectivityProperties() {
return new DeviceConnectivityConfiguration ();
}
@Bean
@ConfigurationProperties(prefix = "transport.coap")
public DeviceConnectivityConfiguration coapDeviceConnectivityProperties() {
return new DeviceConnectivityConfiguration ();
}
@Bean
@ConfigurationProperties(prefix = "transport.coap.dtls")
public DeviceConnectivityConfiguration coapsDeviceConnectivityProperties() {
return new DeviceConnectivityConfiguration ();
}
@Autowired
@Qualifier("mqttDeviceConnectivityProperties")
private DeviceConnectivityConfiguration mqttProperties;
@Autowired
@Qualifier("mqttsDeviceConnectivityProperties")
private DeviceConnectivityConfiguration mqttsProperties;
@Autowired
@Qualifier("coapDeviceConnectivityProperties")
private DeviceConnectivityConfiguration coapProperties;
@Autowired
@Qualifier("coapsDeviceConnectivityProperties")
private DeviceConnectivityConfiguration coapsProperties;
private DeviceConnectivityConfiguration deviceConnectivityConfiguration;
@Override
public DeviceInfo findDeviceInfoById(TenantId tenantId, DeviceId deviceId) {
@ -191,24 +151,11 @@ public class DeviceServiceImpl extends AbstractCachedEntityService<DeviceCacheKe
switch (transportType) {
case DEFAULT:
switch (credentialsType) {
case ACCESS_TOKEN:
commands.put("http", getHttpPublishCommand(baseUrl, creds));
commands.put("mqtt", getMqttPublishCommand(mqttProperties.getDeviceConnectivityHost(), mqttProperties.getDeviceConnectivityPort(), creds));
commands.put("mqtts", getMqttPublishCommand(mqttsProperties.getDeviceConnectivityHost(), mqttsProperties.getDeviceConnectivityPort(), creds));
commands.put("coap", getCoapPublishCommand(coapProperties.getDeviceConnectivityHost(), coapProperties.getDeviceConnectivityPort(), creds));
commands.put("coaps", getCoapPublishCommand(coapsProperties.getDeviceConnectivityHost(), coapsProperties.getDeviceConnectivityPort(), creds)); break;
case MQTT_BASIC:
commands.put("mqtt", getMqttPublishCommand(mqttProperties.getDeviceConnectivityHost(), mqttProperties.getDeviceConnectivityPort(), creds));
commands.put("mqtts", getMqttPublishCommand(mqttsProperties.getDeviceConnectivityHost(), mqttsProperties.getDeviceConnectivityPort(), creds));
break;
case X509_CERTIFICATE:
commands.put("mqtt", getMqttPublishCommand(mqttProperties.getDeviceConnectivityHost(), mqttProperties.getDeviceConnectivityPort(), creds));
commands.put("mqtts", getMqttPublishCommand(mqttsProperties.getDeviceConnectivityHost(), mqttsProperties.getDeviceConnectivityPort(), creds));
commands.put("coap", getCoapPublishCommand(coapProperties.getDeviceConnectivityHost(), coapProperties.getDeviceConnectivityPort(), creds));
commands.put("coaps", getCoapPublishCommand(coapsProperties.getDeviceConnectivityHost(), coapsProperties.getDeviceConnectivityPort(), creds));
break;
}
Optional.ofNullable(getHttpPublishCommand(baseUrl, creds)).ifPresent(v -> commands.put("http", v));
Optional.ofNullable(getMqttPublishCommand(creds)).ifPresent(v -> commands.put("mqtt", v));
Optional.ofNullable(getMqttsPublishCommand(creds)).ifPresent(v -> commands.put("mqtts", v));
Optional.ofNullable(getCoapPublishCommand(creds)).ifPresent(v -> commands.put("coap", v));
Optional.ofNullable(getCoapsPublishCommand(creds)).ifPresent(v -> commands.put("coaps", v));
break;
case MQTT:
MqttDeviceProfileTransportConfiguration transportConfiguration =
@ -217,25 +164,22 @@ public class DeviceServiceImpl extends AbstractCachedEntityService<DeviceCacheKe
TransportPayloadType payloadType = transportConfiguration.getTransportPayloadTypeConfiguration().getTransportPayloadType();
String payload = (payloadType == TransportPayloadType.PROTOBUF) ? " -f protobufFileName" : " -m " + PAYLOAD;
commands.put("mqtt", getMqttPublishCommand(mqttProperties.getDeviceConnectivityHost(), mqttProperties.getDeviceConnectivityPort(),
topicName, creds, payload));
commands.put("mqtts", getMqttPublishCommand(mqttProperties.getDeviceConnectivityHost(), mqttProperties.getDeviceConnectivityPort(),
topicName, creds, payload));
Optional.ofNullable(getMqttPublishCommand(topicName, creds, payload)).ifPresent(v -> commands.put("mqtt", v));
Optional.ofNullable(getMqttsPublishCommand(topicName, creds, payload)).ifPresent(v -> commands.put("mqtts", v));
break;
case COAP:
CoapDeviceProfileTransportConfiguration coapTransportConfiguration =
(CoapDeviceProfileTransportConfiguration) deviceProfile.getProfileData().getTransportConfiguration();
CoapDeviceTypeConfiguration coapConfiguration = coapTransportConfiguration.getCoapDeviceTypeConfiguration();
if (coapConfiguration instanceof DefaultCoapDeviceTypeConfiguration) {
commands.put("coap", getCoapPublishCommand(coapProperties.getDeviceConnectivityHost(), coapProperties.getDeviceConnectivityPort(), creds));
commands.put("coaps", getCoapPublishCommand(coapsProperties.getDeviceConnectivityHost(), coapsProperties.getDeviceConnectivityPort(), creds));
Optional.ofNullable(getCoapPublishCommand(creds)).ifPresent(v -> commands.put("coap", v));
Optional.ofNullable(getCoapsPublishCommand(creds)).ifPresent(v -> commands.put("coaps", v));
} else if (coapConfiguration instanceof EfentoCoapDeviceTypeConfiguration) {
commands.put("coap", "Not supported");
commands.put("coaps", "Not supported");
commands.put("coap for efento", "Not supported");
}
break;
default:
commands.put(transportType.name(), "Not supported");
commands.put(transportType.name(), NOT_SUPPORTED);
}
return commands;
}
@ -800,18 +744,23 @@ public class DeviceServiceImpl extends AbstractCachedEntityService<DeviceCacheKe
}
private String getHttpPublishCommand(String baseurl, DeviceCredentials deviceCredentials) {
if (deviceCredentials.getCredentialsType() == DeviceCredentialsType.ACCESS_TOKEN) {
return String.format("curl -v -X POST %s/api/v1/%s/telemetry --header Content-Type:application/json --data " + PAYLOAD,
baseurl, deviceCredentials.getCredentialsId());
}
private String getMqttPublishCommand(String host, Integer port, DeviceCredentials deviceCredentials) {
return getMqttPublishCommand(host, port, "v1/devices/me/telemetry", deviceCredentials, " -m " + PAYLOAD);
return null;
}
private String getMqttPublishCommand(String host, Integer port, String deviceTelemetryTopic, DeviceCredentials deviceCredentials, String payload) {
private String getMqttPublishCommand(DeviceCredentials deviceCredentials) {
return getMqttPublishCommand("v1/devices/me/telemetry", deviceCredentials, " -m " + PAYLOAD);
}
private String getMqttPublishCommand(String deviceTelemetryTopic, DeviceCredentials deviceCredentials, String payload) {
DeviceConnectivityInfo mqttProps = deviceConnectivityConfiguration.getConnectivity().get("mqtt");
StringBuilder command = new StringBuilder("mosquitto_pub -d -q 1");
command.append(" -h ").append(host);
command.append(" -p ").append(port);
command.append(" -h ").append(mqttProps.getHost());
command.append(" -p ").append(mqttProps.getPort());
command.append(" -t ").append(deviceTelemetryTopic);
switch (deviceCredentials.getCredentialsType()) {
@ -833,23 +782,76 @@ public class DeviceServiceImpl extends AbstractCachedEntityService<DeviceCacheKe
}
}
break;
case X509_CERTIFICATE:
command.append(" --cafile server.pem --key key.pem --cert cert.pem");
default:
return null;
}
command.append(payload);
return command.toString();
}
private String getCoapPublishCommand(String host, Integer port, DeviceCredentials deviceCredentials) {
private String getMqttsPublishCommand(DeviceCredentials deviceCredentials) {
return getMqttsPublishCommand("v1/devices/me/telemetry", deviceCredentials, " -m " + PAYLOAD);
}
private String getMqttsPublishCommand(String deviceTelemetryTopic, DeviceCredentials deviceCredentials, String payload) {
DeviceConnectivityInfo mqttsProps = deviceConnectivityConfiguration.getConnectivity().get("mqtts");
StringBuilder command = new StringBuilder("mosquitto_pub --cafile tb-server-chain.pem -d -q 1");
command.append(" -h ").append(mqttsProps.getHost());
command.append(" -p ").append(mqttsProps.getPort());
command.append(" -t ").append(deviceTelemetryTopic);
switch (deviceCredentials.getCredentialsType()) {
case ACCESS_TOKEN:
return String.format("coap-client -m post coap://%s:%s/api/v1/%s/telemetry -t json -e %s",
host, port, deviceCredentials.getCredentialsId(), PAYLOAD);
command.append(" -u ").append(deviceCredentials.getCredentialsId());
break;
case MQTT_BASIC:
BasicMqttCredentials credentials = JacksonUtil.fromString(deviceCredentials.getCredentialsValue(),
BasicMqttCredentials.class);
if (credentials != null) {
if (credentials.getClientId() != null) {
command.append(" -i ").append(credentials.getClientId());
}
if (credentials.getUserName() != null) {
command.append(" -u ").append(credentials.getUserName());
}
if (credentials.getPassword() != null) {
command.append(" -P ").append(credentials.getPassword());
}
} else {
return null;
}
break;
case X509_CERTIFICATE:
return String.format("coap-client-openssl -v 9 -c cert.pem -j key.pem -m POST -t json -e %s " +
"coaps://%s:%s/api/v1/telemetry", PAYLOAD, host, port);
command.append(" --key key.pem --cert cert.pem");
break;
default:
return "Not supported";
return null;
}
command.append(payload);
return command.toString();
}
private String getCoapPublishCommand(DeviceCredentials deviceCredentials) {
DeviceConnectivityInfo coapProperties = deviceConnectivityConfiguration.getConnectivity().get("coap");
if (deviceCredentials.getCredentialsType() == DeviceCredentialsType.ACCESS_TOKEN) {
return String.format("coap-client -m POST coap://%s:%s/api/v1/%s/telemetry -t json -e %s",
coapProperties.getHost(), coapProperties.getPort(), deviceCredentials.getCredentialsId(), PAYLOAD);
}
return null;
}
private String getCoapsPublishCommand(DeviceCredentials deviceCredentials) {
DeviceConnectivityInfo coapsProperties = deviceConnectivityConfiguration.getConnectivity().get("coaps");
switch (deviceCredentials.getCredentialsType()) {
case ACCESS_TOKEN:
return String.format("coap-client-openssl -v 9 -m POST coaps://%s:%s/api/v1/%s/telemetry -t json -e %s ",
coapsProperties.getHost(), coapsProperties.getPort(), deviceCredentials.getCredentialsId(), PAYLOAD);
case X509_CERTIFICATE:
return String.format("coap-client-openssl -v 9 -c cert.pem -j key.pem -m POST " +
"coaps://%s:%s/api/v1/telemetry -t json -e %s ", coapsProperties.getHost(), coapsProperties.getPort(), PAYLOAD);
default:
return null;
}
}
}