deprecate(api): Deprecated net.admin related APIs (#5320)

* Deprecated ConnectionInfo Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated EthernetMonitorService and NetworkAdminService Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated NetInterface events Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated NetRouterMode Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated DnsMonitorService Signed-off-by: pierantoniomerlino <[email protected]> * Remove import from NetworkAdminService Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated CellularModem and ModemCdmaServiceProvider Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated several modem related classes and interfaces Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated RoutingAgentService Signed-off-by: pierantoniomerlino <[email protected]> * Deprecated wifi releated classes and interfaces Signed-off-by: pierantoniomerlino <[email protected]> * Small refactor Signed-off-by: pierantoniomerlino <[email protected]> * Small refactor again Signed-off-by: pierantoniomerlino <[email protected]> * Updated package export versions Signed-off-by: pierantoniomerlino <[email protected]> * Updated net.modem version; updated firewall imports Signed-off-by: pierantoniomerlino <[email protected]> --------- Signed-off-by: pierantoniomerlino <[email protected]>
eclipse-kura · Aug 13, 2024 · edbcf92 · edbcf92
1 parent 1ba7687
commit edbcf92
Show file tree

Hide file tree

Showing 27 changed files with 173 additions and 113 deletions.
diff --git a/kura/org.eclipse.kura.api/META-INF/MANIFEST.MF b/kura/org.eclipse.kura.api/META-INF/MANIFEST.MF
@@ -56,20 +56,20 @@ Export-Package: org.eclipse.kura;version="1.7.0",
  org.eclipse.kura.message;version="1.5.0",
  org.eclipse.kura.message.store;version="1.0.0",
  org.eclipse.kura.message.store.provider;version="1.0.0",
- org.eclipse.kura.net;version="2.6.0",
+ org.eclipse.kura.net;version="2.7.0",
  org.eclipse.kura.net.dhcp;version="1.2.0",
- org.eclipse.kura.net.dns;version="1.1.0",
+ org.eclipse.kura.net.dns;version="1.2.0",
  org.eclipse.kura.net.firewall;version="2.1.0",
- org.eclipse.kura.net.modem;version="2.4.0",
- org.eclipse.kura.net.route;version="1.0.2",
+ org.eclipse.kura.net.modem;version="2.5.0",
+ org.eclipse.kura.net.route;version="1.1.0",
  org.eclipse.kura.net.status;version="1.1.0",
  org.eclipse.kura.net.status.ethernet;version="1.0.0",
  org.eclipse.kura.net.status.loopback;version="1.0.0",
  org.eclipse.kura.net.status.modem;version="1.0.0",
  org.eclipse.kura.net.status.vlan;version="1.0.0",
  org.eclipse.kura.net.status.wifi;version="1.0.0",
  org.eclipse.kura.net.vlan;version="1.0.0",
- org.eclipse.kura.net.wifi;version="2.4.0",
+ org.eclipse.kura.net.wifi;version="2.5.0",
  org.eclipse.kura.position;version="1.3.0",
  org.eclipse.kura.security;version="1.3.0",
  org.eclipse.kura.security.keystore;version="1.1.0",

diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/ConnectionInfo.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/ConnectionInfo.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -17,14 +17,18 @@
 import org.osgi.annotation.versioning.ProviderType;
 
 /**
- * Interface for network interface 'connection info'. At runtime an interface may be associated with
- * gateways or DNS but the interface itself may not be active. If this is the case the ConnectionInfo
- * class is used to keep all relevant information in the event that this interface should become the
- * active one. This is necessary because many operating systems to not persist this information.
+ * Interface for network interface 'connection info'. At runtime an interface
+ * may be associated with gateways or DNS but the interface itself may not be
+ * active. If this is the case the ConnectionInfo class is used to keep all
+ * relevant information in the event that this interface should become the
+ * active one. This is necessary because many operating systems to not persist
+ * this information.
  *
  * @noimplement This interface is not intended to be implemented by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public interface ConnectionInfo {
 
     /**
@@ -37,7 +41,8 @@ public interface ConnectionInfo {
     /**
      * Gets the DNS addresses associated with this interface
      *
-     * @return A List of IP4Address objects representing the DNS of this interface. If there are none it returns an
+     * @return A List of IP4Address objects representing the DNS of this interface.
+     *         If there are none it returns an
      *         empty list.
      */
     public List<IP4Address> getDnsServers();

diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/EthernetMonitorService.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/EthernetMonitorService.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -18,7 +18,9 @@
  * Placeholder for the EthernetLinkStateMonitorService
  *
  * @noimplement This interface is not intended to be implemented by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public interface EthernetMonitorService {
 }
diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetInterfaceAddedEvent.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetInterfaceAddedEvent.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -21,8 +21,10 @@
  * An event raised when a new network interface has been added to the system.
  *
  * @noextend This class is not intended to be subclassed by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public class NetInterfaceAddedEvent extends Event {
 
     /** Topic of the NetworkInterfaceAddedEvent */

diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetInterfaceRemovedEvent.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetInterfaceRemovedEvent.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -21,8 +21,10 @@
  * An event raised when a network interface has been removed from the system.
  *
  * @noextend This class is not intended to be subclassed by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public class NetInterfaceRemovedEvent extends Event {
 
     /** Topic of the NetworkInterfaceRemovedEvent */

diff --git a/...rg.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetInterfaceStateChangedEvent.java b/...rg.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetInterfaceStateChangedEvent.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -21,8 +21,10 @@
  * Event raised when the state of a network interface has changed.
  *
  * @noextend This class is not intended to be subclassed by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public class NetInterfaceStateChangedEvent extends Event {
 
     /** Topic of the NetworkStateChangedEvent */
@@ -96,7 +98,9 @@ public enum Reason {
         /** The device could not be readied for configuration. */
         REASON_CONFIG_FAILED,
 
-        /** IP configuration could not be reserved (no available address, timeout, etc). */
+        /**
+         * IP configuration could not be reserved (no available address, timeout, etc).
+         */
         REASON_CONFIG_UNAVAILABLE,
 
         /** The IP configuration is no longer valid. */
@@ -105,7 +109,10 @@ public enum Reason {
         /** Secrets were required, but not provided. */
         REASON_NO_SECRETS,
 
-        /** The 802.1X supplicant disconnected from the access point or authentication server. */
+        /**
+         * The 802.1X supplicant disconnected from the access point or authentication
+         * server.
+         */
         REASON_SUPPLICANT_DISCONNECT,
 
         /** Configuration of the 802.1X supplicant failed. */

diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetRouterMode.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetRouterMode.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -14,7 +14,10 @@
 
 /**
  * Used to specify the route mode of each interface.
+ * 
+ * @deprecated since version 3.0.
  */
+@Deprecated
 public enum NetRouterMode {
     /** DHCP and NAT **/
     netRouterDchpNat,

diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetworkAdminService.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/NetworkAdminService.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2023 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -30,8 +30,10 @@
  * Service API for getting and setting network interface configurations.
  *
  * @noimplement This interface is not intended to be implemented by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public interface NetworkAdminService {
 
     /**
@@ -63,7 +65,7 @@ public List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>> g
      * @param interfaceName
      * @return list of NetConfig for this interface.
      * 
-     * @deprecated since 2.4. Use {@link getNetworkInterfaceConfigs(tring
+     * @deprecated since 2.4. Use {@link getNetworkInterfaceConfigs(String
      *             interfaceName, boolean recompute)} instead.
      */
     @Deprecated
@@ -81,8 +83,9 @@ public List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>> g
      *                      automatic default
      * @throws KuraException
      * 
-     * @deprecated Since 2.4. Use the {@link ConfigurationService} to update the
-     *             configuration of an Ethernet interface.
+     * @deprecated Since 2.4. Use the
+     *             {@link org.eclipse.kura.configuration.ConfigurationService} to
+     *             update the configuration of an Ethernet interface.
      */
     @Deprecated
     public void updateEthernetInterfaceConfig(String interfaceName, boolean autoConnect, int mtu,
@@ -97,8 +100,9 @@ public void updateEthernetInterfaceConfig(String interfaceName, boolean autoConn
      *                      - specifies the auto-connect value for the interface
      * @throws KuraException
      * 
-     * @deprecated Since 2.4. Use the {@link ConfigurationService} to update the
-     *             configuration of a Wifi interface.
+     * @deprecated Since 2.4. Use the
+     *             {@link org.eclipse.kura.configuration.ConfigurationService} to
+     *             update the configuration of a Wifi interface.
      */
     @Deprecated
     public void updateWifiInterfaceConfig(String interfaceName, boolean autoConnect, WifiAccessPoint accessPoint,
@@ -124,8 +128,9 @@ public void updateWifiInterfaceConfig(String interfaceName, boolean autoConnect,
      *                      - list of NetConfigs for this interface
      * @throws KuraException
      * 
-     * @deprecated Since 2.4. Use the {@link ConfigurationService} to update the
-     *             configuration of a Modem interface.
+     * @deprecated Since 2.4. Use the
+     *             {@link org.eclipse.kura.configuration.ConfigurationService} to
+     *             update the configuration of a Modem interface.
      */
     @Deprecated
     public void updateModemInterfaceConfig(String interfaceName, String serialNum, String modemId, int pppNumber,

diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/dns/DnsMonitorService.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/dns/DnsMonitorService.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -18,8 +18,10 @@
  * Marker interface for dns server monitoring service
  *
  * @noimplement This interface is not intended to be implemented by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public interface DnsMonitorService {
 
 }
diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/modem/CellularModem.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/net/modem/CellularModem.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2022 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -22,8 +22,10 @@
 
 /**
  * @noimplement This interface is not intended to be implemented by clients.
+ * @deprecated since 3.0
  */
 @ProviderType
+@Deprecated
 public interface CellularModem {
 
     public enum SerialPortType {
@@ -60,7 +62,8 @@ public enum SerialPortType {
      * @return IMSI number, null if not known
      * @throws KuraException
      * 
-     * @deprecated since 2.4. Use {@link getMobileSubscriberIdentity(boolean recompute)} instead.
+     * @deprecated since 2.4. Use {@link getMobileSubscriberIdentity(boolean
+     *             recompute)} instead.
      */
     @Deprecated
     public String getMobileSubscriberIdentity() throws KuraException;
@@ -71,7 +74,8 @@ public enum SerialPortType {
      * @return ICCID, "N/A" if not applicable
      * @throws KuraException
      * 
-     * @deprecated since 2.4. Use {@link getIntegratedCirquitCardId(boolean recompute)} instead.
+     * @deprecated since 2.4. Use {@link getIntegratedCirquitCardId(boolean
+     *             recompute)} instead.
      */
     @Deprecated
     public String getIntegratedCirquitCardId() throws KuraException;
@@ -95,7 +99,7 @@ public enum SerialPortType {
      * Reports if specified port can be opened
      *
      * @param port
-     *            - modem's serial port
+     *             - modem's serial port
      * @return 'true' if port can be opened, 'false' otherwise
      */
     public boolean isPortReachable(String port);
@@ -114,7 +118,8 @@ public enum SerialPortType {
      * @throws KuraException
      * @return signal strength
      * 
-     * @deprecated since 2.4. Use {@link getSignalStrength(boolean recompute)} instead.
+     * @deprecated since 2.4. Use {@link getSignalStrength(boolean recompute)}
+     *             instead.
      */
     @Deprecated
     public int getSignalStrength() throws KuraException;
@@ -125,7 +130,8 @@ public enum SerialPortType {
      * @throws KuraException
      * @return modem registration status as {@link ModemRegistrationStatus}
      * 
-     * @deprecated since 2.4. Use {@link getRegistrationStatus(boolean recompute)} instead.
+     * @deprecated since 2.4. Use {@link getRegistrationStatus(boolean recompute)}
+     *             instead.
      */
     @Deprecated
     public ModemRegistrationStatus getRegistrationStatus() throws KuraException;
@@ -251,7 +257,8 @@ public enum SerialPortType {
      * Reports signal strength in dBm
      * 
      * @param recompute:
-     *            if true the value is recomputed. Otherwise, a cached value is returned
+     *                   if true the value is recomputed. Otherwise, a cached value
+     *                   is returned
      * @return an integer representing the rssi
      * @throws KuraException
      * 
@@ -263,7 +270,8 @@ public enum SerialPortType {
      * Reports modem registration status
      *
      * @param recompute:
-     *            if true the value is recomputed. Otherwise, a cached value is returned
+     *                   if true the value is recomputed. Otherwise, a cached value
+     *                   is returned
      * @throws KuraException
      * @return modem registration status as {@link ModemRegistrationStatus}
      * 
@@ -275,7 +283,8 @@ public enum SerialPortType {
      * Answers International Mobile Subscribe Identity (IMSI)
      *
      * @param recompute:
-     *            if true the value is recomputed. Otherwise, a cached value is returned
+     *                   if true the value is recomputed. Otherwise, a cached value
+     *                   is returned
      * @return IMSI number, null if not known
      * @throws KuraException
      * 
@@ -287,7 +296,8 @@ public enum SerialPortType {
      * Answers Integrated Circuit Card Identification (ICCID)
      *
      * @param recompute:
-     *            if true the value is recomputed. Otherwise, a cached value is returned
+     *                   if true the value is recomputed. Otherwise, a cached value
+     *                   is returned
      * @return ICCID, "N/A" if not applicable
      * @throws KuraException
      * 

diff --git a/...g.eclipse.kura.api/src/main/java/org/eclipse/kura/net/modem/ModemCdmaServiceProvider.java b/...g.eclipse.kura.api/src/main/java/org/eclipse/kura/net/modem/ModemCdmaServiceProvider.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 2024 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -12,6 +12,10 @@
  ******************************************************************************/
 package org.eclipse.kura.net.modem;
 
+/**
+ * @deprecated since 3.0
+ */
+@Deprecated
 public enum ModemCdmaServiceProvider {
 
     UNKNOWN(0),