feat(web2): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService #3964

pierantoniomerlino · 2022-04-27T16:06:25Z

This PR replaces the NetAdminService with the ConfigurationService for updating the network and firewall configuration from the webUI.

MMaiero · 2022-05-02T12:50:05Z

kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetworkAdminService.java

@@ -66,7 +66,10 @@ public List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>> g
     * @param mtu
     *            - required MTU for the interface, -1 to keep the automatic default
     * @throws KuraException
+     * 
+     * @deprecated Since 2.4


Do we suggest the use of other APIs in replacement of these?

It doesn't exist a 1-to-1 replacement of this API. We can suggest to use directly the ConfigurationService.

MMaiero · 2022-05-02T12:51:22Z

kura/org.eclipse.kura.web2/src/main/java/org/eclipse/kura/web/server/GwtNetworkServiceImpl.java

+                nat.append(entry.getInInterface()).append(",");
+                nat.append(entry.getOutInterface()).append(",");
+                nat.append(entry.getProtocol()).append(",");
+                if (entry.getSourceNetwork() == null || entry.getSourceNetwork().equals(UNKNOWN_NETWORK)) {


maybe better using Objects.isNull()?

Or comparing using UNKNOWN_NETWORK.equals(entry.getSourceNetwork())?

MMaiero · 2022-05-02T12:52:28Z

kura/org.eclipse.kura.web2/src/main/java/org/eclipse/kura/web/server/GwtNetworkServiceImpl.java

-                    firewallPortForwardConfigIP.setPermittedNetwork(new NetworkPair<>(
-                            (IP4Address) IPAddress.parseHostAddress(network), Short.parseShort(prefix)));
+                nat.append(",");
+                if (entry.getDestinationNetwork() == null || entry.getDestinationNetwork().equals(UNKNOWN_NETWORK)) {


MMaiero · 2022-05-02T13:52:19Z

I have tested in a device with ppp connection and even if the device was able to set the IP, no dns servers are set living an empty value and preventing from connecting to the cloud.

MMaiero · 2022-05-02T13:53:25Z

2022-05-02T13:51:20,616 [pool-34-thread-1] INFO  o.e.k.n.a.m.ModemMonitorServiceImpl - monitor() :: previous PppState=CONNECTED
2022-05-02T13:51:20,618 [pool-34-thread-1] INFO  o.e.k.n.a.m.ModemMonitorServiceImpl - monitor() :: current PppState=IN_PROGRESS
2022-05-02T13:51:20,619 [pool-34-thread-1] INFO  o.e.k.n.a.m.ModemMonitorServiceImpl - monitor() :: Modem will be reset in 299 sec if not connected
2022-05-02T13:51:20,637 [pool-34-thread-1] WARN  o.e.k.l.n.u.LinuxNetworkUtil - error reading /sys/class/net/ppp1/carrier_changes, error message /sys/class/net/ppp1/carrier_changes (No such file or directory)
2022-05-02T13:51:20,673 [EventAdmin Async Event Dispatcher Thread] INFO  o.e.k.n.a.m.DnsMonitorServiceImpl - Current DNS servers are null - setting dns servers: []
2022-05-02T13:51:27,359 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.DataServiceImpl - Connecting...
2022-05-02T13:51:27,360 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - Creating a new client instance
2022-05-02T13:51:27,362 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - Using memory persistence for in-flight messages
2022-05-02T13:51:27,366 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - # ------------------------------------------------------------
2022-05-02T13:51:27,367 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  Connection Properties
2022-05-02T13:51:27,369 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  broker    = ssl://<endpoint>:8883
2022-05-02T13:51:27,370 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  clientId  = clientid
2022-05-02T13:51:27,371 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  username  = username
2022-05-02T13:51:27,372 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  password  = XXXXXXXXXXXXXX
2022-05-02T13:51:27,372 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  keepAlive = 30
2022-05-02T13:51:27,373 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  timeout   = 20
2022-05-02T13:51:27,374 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  cleanSession    = true
2022-05-02T13:51:27,375 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  MQTT version    = 3.1.1
2022-05-02T13:51:27,375 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  willDestination = $EDC/ec-provisioning/00E0C709917D/MQTT/LWT
2022-05-02T13:51:27,376 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  willMessage     =
2022-05-02T13:51:27,377 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #
2022-05-02T13:51:27,378 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - #  Connecting...
2022-05-02T13:51:27,382 [MQTT Con: 00E0C709917D] INFO  o.e.k.c.s.SSLSocketFactoryWrapper - SSL Endpoint Identification enabled.
2022-05-02T13:51:27,386 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] WARN  o.e.k.c.d.t.m.MqttDataTransport - xxxxx  Connect failed. Forcing disconnect. xxxxx
2022-05-02T13:51:27,387 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - Forcing client disconnect...
2022-05-02T13:51:52,014 [pool-34-thread-1] INFO  o.e.k.n.a.m.ModemMonitorServiceImpl - monitor() :: previous PppState=IN_PROGRESS
2022-05-02T13:51:52,015 [pool-34-thread-1] INFO  o.e.k.n.a.m.ModemMonitorServiceImpl - monitor() :: current PppState=CONNECTED
2022-05-02T13:51:52,066 [EventAdmin Async Event Dispatcher Thread] INFO  o.e.k.n.a.m.DnsMonitorServiceImpl - Current DNS servers are null - setting dns servers: []
2022-05-02T13:51:57,398 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - Closing client...
2022-05-02T13:51:57,399 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] INFO  o.e.k.c.d.t.m.MqttDataTransport - Closed
2022-05-02T13:51:57,400 [DataServiceImpl:ReconnectTask:org.eclipse.kura.data.DataService] WARN  o.e.k.c.d.DataServiceImpl - Connect failed
org.eclipse.kura.KuraConnectException: "Connection failed. Cannot connect"
	at org.eclipse.kura.core.data.transport.mqtt.MqttDataTransport.connect(MqttDataTransport.java:359)
	at org.eclipse.kura.core.data.DataServiceImpl$2.run(DataServiceImpl.java:606)
	at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
	at java.util.concurrent.FutureTask.runAndReset(FutureTask.java:308)
	at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$301(ScheduledThreadPoolExecutor.java:180)
	at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:294)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at java.lang.Thread.run(Thread.java:748)
Caused by: MqttException (0) - java.net.UnknownHostException: broker-sbx.everyware.io
	at org.eclipse.paho.client.mqttv3.internal.ExceptionHelper.createMqttException(ExceptionHelper.java:38)
	at org.eclipse.paho.client.mqttv3.internal.ClientComms$ConnectBG.run(ClientComms.java:736)
	... 1 more
Caused by: java.net.UnknownHostException: broker-sbx.everyware.io
	at java.net.AbstractPlainSocketImpl.connect(AbstractPlainSocketImpl.java:184)
	at java.net.SocksSocketImpl.connect(SocksSocketImpl.java:392)
	at java.net.Socket.connect(Socket.java:607)
	at sun.security.ssl.SSLSocketImpl.connect(SSLSocketImpl.java:284)
	at org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule.start(TCPNetworkModule.java:74)
	at org.eclipse.paho.client.mqttv3.internal.SSLNetworkModule.start(SSLNetworkModule.java:130)
	at org.eclipse.paho.client.mqttv3.internal.ClientComms$ConnectBG.run(ClientComms.java:722)
	... 1 more

MMaiero · 2022-05-09T07:08:26Z

@pierantoniomerlino is the PR ready for review? Please also give a check on sonar

pierantoniomerlino · 2022-05-09T07:11:40Z

I'm running some tests for the dhcp feature. I'll take a look at sonar too.

nicolatimeus · 2022-05-10T07:36:30Z

kura/org.eclipse.kura.web2/src/main/java/org/eclipse/kura/web/server/GwtNetworkServiceImpl.java

+    private void fillDhcpServerProperties(GwtNetInterfaceConfig config, Map<String, Object> properties,
+            String basePropName) throws UnknownHostException {
+        StringBuilder dhcpServer4PropName = new StringBuilder(basePropName).append("dhcpServer4.");
+        properties.put(dhcpServer4PropName.toString() + ENABLED, true);


StringBuilder.toString() allocates a new string at each invocation. As an enhancement we could refactor the code to avoid calling this method multiple times to produce the same string.

nicolatimeus · 2022-05-10T10:04:32Z

kura/org.eclipse.kura.web2/src/main/java/org/eclipse/kura/web/server/GwtNetworkServiceImpl.java

-                    }
+        try {
+            for (GwtFirewallOpenPortEntry entry : entries) {
+                openPorts.append(entry.getPortRange()).append(",");


If entry.getPortRange() returns null, this will probably add the null string in the configuration. Is this ok? This probably applies also to other fields.

Mhh... the null value is not allowed here. I mean, the web UI forces to set a value in the port range property.

Signed-off-by: Merlino <[email protected]>

pierantoniomerlino added the enhancement label Apr 27, 2022

pierantoniomerlino requested a review from MMaiero April 27, 2022 16:06

pierantoniomerlino self-assigned this Apr 27, 2022

MMaiero requested a review from nicolatimeus April 27, 2022 16:24

pierantoniomerlino changed the title ~~Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService~~ feat(web): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService Apr 29, 2022

pierantoniomerlino changed the title ~~feat(web): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService~~ feat(web2): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService Apr 29, 2022

MMaiero reviewed May 2, 2022

View reviewed changes

pierantoniomerlino force-pushed the web_configuration_service branch from 25685e7 to 258d267 Compare May 5, 2022 13:55

nicolatimeus reviewed May 10, 2022

View reviewed changes

pierantoniomerlino added 13 commits May 10, 2022 15:49

Replaced NetAdmin with ConfService in update configuration

f4cb5b3

Signed-off-by: Merlino <[email protected]>

Fixed wifi password management

f5c3455

Signed-off-by: Merlino <[email protected]>

Fixed netmask and dhcp config

979d983

Signed-off-by: Merlino <[email protected]>

Code refactor

87e6e28

Signed-off-by: Merlino <[email protected]>

Code refactor again

062fcf2

Signed-off-by: Merlino <[email protected]>

Replaced NetAdmin with ConfService in update firewall configuration

4900f47

Signed-off-by: Merlino <[email protected]>

Fixed firewall ip/port forwarding config

e89cc1d

Signed-off-by: Merlino <[email protected]>

Removed useless constant

a9b6c6f

Signed-off-by: Merlino <[email protected]>

Fixed dns server management

922c1ed

Signed-off-by: Merlino <[email protected]>

Deprecated method in NetworkAdminService

bf26619

Signed-off-by: Merlino <[email protected]>

Put empty properties when switched to DHCP mode

4c6376c

Signed-off-by: Merlino <[email protected]>

Added missing default properties values

eb33890

Signed-off-by: Merlino <[email protected]>

Removed password encryption; small code refactor

211f29e

Signed-off-by: Merlino <[email protected]>

pierantoniomerlino added 4 commits May 10, 2022 15:49

Small refactor in nat rules

ef522a5

Signed-off-by: Merlino <[email protected]>

Added deprecation messages in NetworkAdminService

1a709e8

Signed-off-by: Merlino <[email protected]>

Fixed sonar hint on firewall open port object

19778b7

Signed-off-by: Merlino <[email protected]>

Replaced StringBuilder with String

489a2fe

Signed-off-by: Merlino <[email protected]>

pierantoniomerlino force-pushed the web_configuration_service branch from 0c1aced to 489a2fe Compare May 10, 2022 13:49

nicolatimeus approved these changes May 12, 2022

View reviewed changes

MMaiero merged commit ec6e97e into develop May 14, 2022

MMaiero deleted the web_configuration_service branch May 14, 2022 08:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(web2): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService #3964

feat(web2): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService #3964

pierantoniomerlino commented Apr 27, 2022 •

edited

Loading

MMaiero May 2, 2022

pierantoniomerlino May 4, 2022

MMaiero May 2, 2022

MMaiero May 2, 2022

MMaiero May 2, 2022

MMaiero commented May 2, 2022

MMaiero commented May 2, 2022

MMaiero commented May 9, 2022

pierantoniomerlino commented May 9, 2022

nicolatimeus May 10, 2022

nicolatimeus May 10, 2022 •

edited

Loading

pierantoniomerlino May 10, 2022

feat(web2): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService #3964

feat(web2): Replace NetAdmin with ConfigurationService in GwtNetworkConfigurationService #3964

Conversation

pierantoniomerlino commented Apr 27, 2022 • edited Loading

MMaiero May 2, 2022

Choose a reason for hiding this comment

pierantoniomerlino May 4, 2022

Choose a reason for hiding this comment

MMaiero May 2, 2022

Choose a reason for hiding this comment

MMaiero May 2, 2022

Choose a reason for hiding this comment

MMaiero May 2, 2022

Choose a reason for hiding this comment

MMaiero commented May 2, 2022

MMaiero commented May 2, 2022

MMaiero commented May 9, 2022

pierantoniomerlino commented May 9, 2022

nicolatimeus May 10, 2022

Choose a reason for hiding this comment

nicolatimeus May 10, 2022 • edited Loading

Choose a reason for hiding this comment

pierantoniomerlino May 10, 2022

Choose a reason for hiding this comment

pierantoniomerlino commented Apr 27, 2022 •

edited

Loading

nicolatimeus May 10, 2022 •

edited

Loading