Support IGD v2 port mappings

Handle newer gateways and routers that describe ports differently. Fixes #366 Signed-off-by: Giovanni Menzano <giovanni.menzano@gmail.com>
wborn · Jul 29, 2026 · Jul 23, 2026 · Jul 27, 2026 · Jul 23, 2026 · 38fd3d8755af246869efa3f56802aec8858bd34a
commit 38fd3d8755af246869efa3f56802aec8858bd34a
diff --git a/bundles/org.jupnp.support/src/main/java/org/jupnp/support/igd/PortMappingListener.java b/bundles/org.jupnp.support/src/main/java/org/jupnp/support/igd/PortMappingListener.java
@@ -172,7 +172,7 @@ public void failure(ActionInvocation invocation, UpnpResponse operation, String
     }
 
     protected Service<?, ?> discoverConnectionService(Device<?, ?, ?> device) {
-        if (!device.getType().equals(IGD_DEVICE_TYPE)) {
+        if (!device.getType().implementsVersion(IGD_DEVICE_TYPE)) {
             return null;
         }
 

diff --git a/bundles/org.jupnp.support/src/main/java/org/jupnp/support/igd/callback/PortMappingAdd.java b/bundles/org.jupnp.support/src/main/java/org/jupnp/support/igd/callback/PortMappingAdd.java
@@ -38,10 +38,10 @@ protected PortMappingAdd(Service<?, ?> service, ControlPoint controlPoint, PortM
 
         this.portMapping = portMapping;
 
-        getActionInvocation().setInput("NewExternalPort", portMapping.getExternalPort());
+        getActionInvocation().setInput("NewExternalPort", portMapping.getExternalPort().toString());
         getActionInvocation().setInput("NewProtocol", portMapping.getProtocol());
         getActionInvocation().setInput("NewInternalClient", portMapping.getInternalClient());
-        getActionInvocation().setInput("NewInternalPort", portMapping.getInternalPort());
+        getActionInvocation().setInput("NewInternalPort", portMapping.getInternalPort().toString());
         getActionInvocation().setInput("NewLeaseDuration", portMapping.getLeaseDurationSeconds());
         getActionInvocation().setInput("NewEnabled", portMapping.isEnabled());
         if (portMapping.hasRemoteHost()) {

diff --git a/...les/org.jupnp.support/src/main/java/org/jupnp/support/igd/callback/PortMappingDelete.java b/...les/org.jupnp.support/src/main/java/org/jupnp/support/igd/callback/PortMappingDelete.java
@@ -38,7 +38,7 @@ protected PortMappingDelete(Service<?, ?> service, ControlPoint controlPoint, Po
 
         this.portMapping = portMapping;
 
-        getActionInvocation().setInput("NewExternalPort", portMapping.getExternalPort());
+        getActionInvocation().setInput("NewExternalPort", portMapping.getExternalPort().toString());
         getActionInvocation().setInput("NewProtocol", portMapping.getProtocol());
         if (portMapping.hasRemoteHost()) {
             getActionInvocation().setInput("NewRemoteHost", portMapping.getRemoteHost());

diff --git a/bundles/org.jupnp.support/src/test/java/org/jupnp/support/igd/PortMappingListenerTest.java b/bundles/org.jupnp.support/src/test/java/org/jupnp/support/igd/PortMappingListenerTest.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2011-2026 4th Line GmbH, Switzerland and others
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License Version 1 or later
+ * ("CDDL") (collectively, the "License"). You may not use this file
+ * except in compliance with the License. See LICENSE.txt for more
+ * information.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ *
+ * SPDX-License-Identifier: CDDL-1.0
+ */
+package org.jupnp.support.igd;
+
+import static org.junit.jupiter.api.Assertions.assertSame;
+
+import java.net.InetAddress;
+import java.net.URI;
+import java.net.URL;
+
+import org.junit.jupiter.api.Test;
+import org.jupnp.model.meta.DeviceDetails;
+import org.jupnp.model.meta.RemoteDevice;
+import org.jupnp.model.meta.RemoteDeviceIdentity;
+import org.jupnp.model.meta.RemoteService;
+import org.jupnp.model.meta.Service;
+import org.jupnp.model.types.UDADeviceType;
+import org.jupnp.model.types.UDAServiceId;
+import org.jupnp.model.types.UDAServiceType;
+import org.jupnp.model.types.UDN;
+import org.jupnp.support.model.PortMapping;
+
+class PortMappingListenerTest {
+
+    @Test
+    void discoversVersionTwoInternetGatewayDevice() throws Exception {
+        final RemoteService connectionService = new RemoteService(new UDAServiceType("WANIPConnection", 1),
+                new UDAServiceId("WANIPConnection"), URI.create("service.xml"), URI.create("control"),
+                URI.create("events"));
+        final RemoteDevice connectionDevice = new RemoteDevice(identity("connection"),
+                new UDADeviceType("WANConnectionDevice", 1), new DeviceDetails("WAN connection"),
+                new RemoteService[] { connectionService });
+        final RemoteDevice gateway = new RemoteDevice(identity("gateway"),
+                new UDADeviceType("InternetGatewayDevice", 2), new DeviceDetails("Internet gateway"),
+                new RemoteService[0], new RemoteDevice[] { connectionDevice });
+
+        final Service<?, ?> discovered = new PortMappingListener(new PortMapping()).discoverConnectionService(gateway);
+
+        assertSame(connectionService, discovered);
+    }
+
+    private RemoteDeviceIdentity identity(final String name) throws Exception {
+        final URL descriptorUrl = new URL("http://127.0.0.1/" + name + ".xml");
+        final InetAddress localAddress = InetAddress.getLoopbackAddress();
+        return new RemoteDeviceIdentity(new UDN("uuid:" + name), 1800, descriptorUrl, null, localAddress);
+    }
+}
diff --git a/...g.jupnp.support/src/test/java/org/jupnp/support/igd/callback/PortMappingCallbackTest.java b/...g.jupnp.support/src/test/java/org/jupnp/support/igd/callback/PortMappingCallbackTest.java
@@ -0,0 +1,107 @@
+/*
+ * Copyright (C) 2011-2026 4th Line GmbH, Switzerland and others
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License Version 1 or later
+ * ("CDDL") (collectively, the "License"). You may not use this file
+ * except in compliance with the License. See LICENSE.txt for more
+ * information.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ *
+ * SPDX-License-Identifier: CDDL-1.0
+ */
+package org.jupnp.support.igd.callback;
+
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+
+import java.net.URI;
+
+import org.junit.jupiter.api.Test;
+import org.jupnp.model.action.ActionInvocation;
+import org.jupnp.model.message.UpnpResponse;
+import org.jupnp.model.meta.Action;
+import org.jupnp.model.meta.ActionArgument;
+import org.jupnp.model.meta.RemoteService;
+import org.jupnp.model.meta.StateVariable;
+import org.jupnp.model.meta.StateVariableTypeDetails;
+import org.jupnp.model.types.Datatype;
+import org.jupnp.model.types.UDAServiceId;
+import org.jupnp.model.types.UDAServiceType;
+import org.jupnp.model.types.UnsignedIntegerFourBytes;
+import org.jupnp.support.model.PortMapping;
+
+class PortMappingCallbackTest {
+
+    @Test
+    void addUsesPortDatatypeAdvertisedByTheService() throws Exception {
+        final PortMappingAdd callback = new PortMappingAdd(portMappingService(Datatype.Builtin.UI4.getDatatype(), true),
+                mapping()) {
+            @Override
+            public void success(final ActionInvocation invocation) {
+            }
+
+            @Override
+            public void failure(final ActionInvocation invocation, final UpnpResponse operation,
+                    final String defaultMsg) {
+            }
+        };
+        final ActionInvocation<?> invocation = callback.getActionInvocation();
+
+        assertInstanceOf(UnsignedIntegerFourBytes.class, invocation.getInput("NewExternalPort").getValue());
+        assertInstanceOf(UnsignedIntegerFourBytes.class, invocation.getInput("NewInternalPort").getValue());
+    }
+
+    @Test
+    void deleteUsesPortDatatypeAdvertisedByTheService() throws Exception {
+        final PortMappingDelete callback = new PortMappingDelete(
+                portMappingService(Datatype.Builtin.UI4.getDatatype(), false), mapping()) {
+            @Override
+            public void success(final ActionInvocation invocation) {
+            }
+
+            @Override
+            public void failure(final ActionInvocation invocation, final UpnpResponse operation,
+                    final String defaultMsg) {
+            }
+        };
+        final ActionInvocation<?> invocation = callback.getActionInvocation();
+
+        assertInstanceOf(UnsignedIntegerFourBytes.class, invocation.getInput("NewExternalPort").getValue());
+    }
+
+    private PortMapping mapping() {
+        return new PortMapping(36743, "192.168.1.99", PortMapping.Protocol.TCP, "jUPnP test");
+    }
+
+    private RemoteService portMappingService(final Datatype<?> portDatatype, final boolean add) throws Exception {
+        final StateVariable[] variables = new StateVariable[] { variable("ExternalPort", portDatatype),
+                variable("InternalPort", portDatatype), variable("Protocol", Datatype.Builtin.STRING.getDatatype()),
+                variable("InternalClient", Datatype.Builtin.STRING.getDatatype()),
+                variable("LeaseDuration", Datatype.Builtin.UI4.getDatatype()),
+                variable("Enabled", Datatype.Builtin.BOOLEAN.getDatatype()),
+                variable("Description", Datatype.Builtin.STRING.getDatatype()) };
+        final Action action = add
+                ? new Action("AddPortMapping",
+                        new ActionArgument[] { input("NewExternalPort", "ExternalPort"),
+                                input("NewProtocol", "Protocol"), input("NewInternalClient", "InternalClient"),
+                                input("NewInternalPort", "InternalPort"), input("NewLeaseDuration", "LeaseDuration"),
+                                input("NewEnabled", "Enabled"), input("NewPortMappingDescription", "Description") })
+                : new Action("DeletePortMapping", new ActionArgument[] { input("NewExternalPort", "ExternalPort"),
+                        input("NewProtocol", "Protocol") });
+
+        return new RemoteService(new UDAServiceType("WANIPConnection", 1), new UDAServiceId("WANIPConnection"),
+                URI.create("service.xml"), URI.create("control"), URI.create("events"), new Action[] { action },
+                variables);
+    }
+
+    private StateVariable variable(final String name, final Datatype<?> datatype) {
+        return new StateVariable(name, new StateVariableTypeDetails(datatype));
+    }
+
+    private ActionArgument input(final String name, final String stateVariable) {
+        return new ActionArgument(name, stateVariable, ActionArgument.Direction.IN);
+    }
+}