com.simtechdata.waifupnp

Class UPnP

java.lang.Object

com.simtechdata.waifupnp.UPnP

public class UPnP
extends Object

The original project for this library can be found at this repository, however the project is being published to Maven Central from this repository.

This class contains static methods that allow quick access to UPnP Port Mapping and is the only class you will need to interact with. Commands in this class will be sent to the default gateway as it is configured on your computer or device.

Author:

Federico

Constructor Summary

Constructors

Constructor and Description
UPnP()

Method Summary

Modifier and Type	Method and Description
static boolean	closePortTCP(int port) Closes a TCP port on the gateway. Some routers seem to refuse to do this.
static boolean	closePortUDP(int port) Closes a UDP port on the gateway. Some routers seem to refuse to do this.
static String	getDefaultGatewayIP() Gets the internal IP address of the router. 192.168.1.1 is typically the default IP address for most SOHO (Small Office Home Office) routers.
static String	getExternalIP() Gets the external IP address of the default gateway. This is the public IP address that is assigned to your router by your Internet Service Provider.
static String	getLocalIP() Gets the IP address of the machine or device that your program is currently running on. If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable().
static boolean	isMappedTCP(int port) Checks if a TCP port is mapped. If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable().
static boolean	isMappedUDP(int port) Checks if a UDP port is mapped. If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable().
static boolean	isUPnPAvailable() This method gets your computer or devices configured default gateway (usually 192.168.1.1 by default on most SOHO routers) and it queries it to find out if the UPnP service is enabled.
static boolean	openPortTCP(int port) Opens a TCP port on the gateway. If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable().
static boolean	openPortUDP(int port) Opens a UDP port on the gateway. If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UPnP

public UPnP()

Method Detail

isUPnPAvailable

public static boolean isUPnPAvailable()

This method gets your computer or devices configured default gateway (usually 192.168.1.1 by default on most SOHO routers) and it queries it to find out if the UPnP service is enabled. This method is blocking and can take some time to complete the first time it is run after your program launches. Run it in a thread if you need it not to block code execution.

The remaining methods in this class will first call this method before doing what they do, so if you opt to not run this method when your code starts, then be aware that the first time you call any method in this class, it will take some time to finish, but subsequent calls to methods in this class should run quickly after the first call.

Returns:

true if available, false if not

openPortTCP

public static boolean openPortTCP(int port)

Opens a TCP port on the gateway.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Parameters:

port - TCP port (0-65535)

Returns:

true if the operation was successful, false otherwise

openPortUDP

public static boolean openPortUDP(int port)

Opens a UDP port on the gateway.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Parameters:

port - UDP port (0-65535)

Returns:

true if the operation was successful, false otherwise

closePortTCP

public static boolean closePortTCP(int port)

Closes a TCP port on the gateway.
Some routers seem to refuse to do this.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Parameters:

port - TCP port (0-65535)

Returns:

true if the operation was successful, false otherwise

closePortUDP

public static boolean closePortUDP(int port)

Closes a UDP port on the gateway.
Some routers seem to refuse to do this.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Parameters:

port - UDP port (0-65535)

Returns:

true if the operation was successful, false otherwise

isMappedTCP

public static boolean isMappedTCP(int port)

Checks if a TCP port is mapped.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Parameters:

port - TCP port (0-65535)

Returns:

true if the port is mapped, false otherwise

isMappedUDP

public static boolean isMappedUDP(int port)

Checks if a UDP port is mapped.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Parameters:

port - UDP port (0-65535)

Returns:

true if the port is mapped, false otherwise

getExternalIP

public static String getExternalIP()

Gets the external IP address of the default gateway.

This is the public IP address that is assigned to your router by your Internet Service Provider.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Returns:

external IP address as string, or null if not available

getLocalIP

public static String getLocalIP()

Gets the IP address of the machine or device that your program is currently running on.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Returns:

internal IP address as string, or null if not available

getDefaultGatewayIP

public static String getDefaultGatewayIP()

Gets the internal IP address of the router.

192.168.1.1 is typically the default IP address for most SOHO (Small Office Home Office) routers.

If this is the first method called after your program starts, it will take a while because it first needs to run isUPnPAvailable(). But after it has run one time, subsequent interactions should be fast.

Returns:

internal IP address as string, or null if not available