Getting the IP address of the current machine using Java Getting the IP address of the current machine using Java java java

Getting the IP address of the current machine using Java


This could be a bit tricky in the most general case.

On the face of it, InetAddress.getLocalHost() should give you the IP address of this host. The problem is that a host could have lots of network interfaces, and an interface could be bound to more than one IP address. And to top that, not all IP addresses will be reachable outside of your machine or your LAN. For example, they could be IP addresses for virtual network devices, private network IP addresses, and so on.

What this means is that the IP address returned by InetAddress.getLocalHost() might not be the right one to use.

How can you deal with this?

  • One approach is to use NetworkInterface.getNetworkInterfaces() to get all of the known network interfaces on the host, and then iterate over each NI's addresses.
  • Another approach is to (somehow) get the externally advertized FQDN for the host, and use InetAddress.getByName() to look up the primary IP address. (But how do you get it, and how do you deal with a DNS-based load balancer?)
  • A variation of the previous is to get the preferred FQDN from a config file or a command line parameter.
  • Another variation is to get the preferred IP address from a config file or a command line parameter.

In summary, InetAddress.getLocalHost() will typically work, but you may need to provide an alternative method for the cases where your code is run in an environment with "complicated" networking.


I am able to get all the IP addresses associated all Network Interfaces, but how do i distinguish them?

  • Any address in the range 127.xxx.xxx.xxx is a "loopback" address. It is only visible to "this" host.
  • Any address in the range 192.168.xxx.xxx is a private (aka site local) IP address. These are reserved for use within an organization. The same applies to 10.xxx.xxx.xxx addresses, and 172.16.xxx.xxx through 172.31.xxx.xxx.
  • Addresses in the range 169.254.xxx.xxx are link local IP addresses. These are reserved for use on a single network segment.
  • Addresses in the range 224.xxx.xxx.xxx through 239.xxx.xxx.xxx are multicast addresses.
  • The address 255.255.255.255 is the broadcast address.
  • Anything else should be a valid public point-to-point IPv4 address.

In fact, the InetAddress API provides methods for testing for loopback, link local, site local, multicast and broadcast addresses. You can use these to sort out which of the IP addresses you get back is most appropriate.


import java.net.DatagramSocket;import java.net.InetAddress;try(final DatagramSocket socket = new DatagramSocket()){  socket.connect(InetAddress.getByName("8.8.8.8"), 10002);  ip = socket.getLocalAddress().getHostAddress();}

This way works well when there are multiple network interfaces. It always returns the preferred outbound IP. The destination 8.8.8.8 is not needed to be reachable.

Connect on a UDP socket has the following effect: it sets the destination for Send/Recv, discards all packets from other addresses, and - which is what we use - transfers the socket into "connected" state, settings its appropriate fields. This includes checking the existence of the route to the destination according to the system's routing table and setting the local endpoint accordingly. The last part seems to be undocumented officially but it looks like an integral trait of Berkeley sockets API (a side effect of UDP "connected" state) that works reliably in both Windows and Linux across versions and distributions.

So, this method will give the local address that would be used to connect to the specified remote host. There is no real connection established, hence the specified remote ip can be unreachable.

Edit:

As @macomgil says, for MacOS you can do this:

Socket socket = new Socket();socket.connect(new InetSocketAddress("google.com", 80));System.out.println(socket.getLocalAddress());


Posting here tested IP ambiguity workaround code from https://issues.apache.org/jira/browse/JCS-40 (InetAddress.getLocalHost() ambiguous on Linux systems):

/** * Returns an <code>InetAddress</code> object encapsulating what is most likely the machine's LAN IP address. * <p/> * This method is intended for use as a replacement of JDK method <code>InetAddress.getLocalHost</code>, because * that method is ambiguous on Linux systems. Linux systems enumerate the loopback network interface the same * way as regular LAN network interfaces, but the JDK <code>InetAddress.getLocalHost</code> method does not * specify the algorithm used to select the address returned under such circumstances, and will often return the * loopback address, which is not valid for network communication. Details * <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4665037">here</a>. * <p/> * This method will scan all IP addresses on all network interfaces on the host machine to determine the IP address * most likely to be the machine's LAN address. If the machine has multiple IP addresses, this method will prefer * a site-local IP address (e.g. 192.168.x.x or 10.10.x.x, usually IPv4) if the machine has one (and will return the * first site-local address if the machine has more than one), but if the machine does not hold a site-local * address, this method will return simply the first non-loopback address found (IPv4 or IPv6). * <p/> * If this method cannot find a non-loopback address using this selection algorithm, it will fall back to * calling and returning the result of JDK method <code>InetAddress.getLocalHost</code>. * <p/> * * @throws UnknownHostException If the LAN address of the machine cannot be found. */private static InetAddress getLocalHostLANAddress() throws UnknownHostException {    try {        InetAddress candidateAddress = null;        // Iterate all NICs (network interface cards)...        for (Enumeration ifaces = NetworkInterface.getNetworkInterfaces(); ifaces.hasMoreElements();) {            NetworkInterface iface = (NetworkInterface) ifaces.nextElement();            // Iterate all IP addresses assigned to each card...            for (Enumeration inetAddrs = iface.getInetAddresses(); inetAddrs.hasMoreElements();) {                InetAddress inetAddr = (InetAddress) inetAddrs.nextElement();                if (!inetAddr.isLoopbackAddress()) {                    if (inetAddr.isSiteLocalAddress()) {                        // Found non-loopback site-local address. Return it immediately...                        return inetAddr;                    }                    else if (candidateAddress == null) {                        // Found non-loopback address, but not necessarily site-local.                        // Store it as a candidate to be returned if site-local address is not subsequently found...                        candidateAddress = inetAddr;                        // Note that we don't repeatedly assign non-loopback non-site-local addresses as candidates,                        // only the first. For subsequent iterations, candidate will be non-null.                    }                }            }        }        if (candidateAddress != null) {            // We did not find a site-local address, but we found some other non-loopback address.            // Server might have a non-site-local address assigned to its NIC (or it might be running            // IPv6 which deprecates the "site-local" concept).            // Return this non-loopback candidate address...            return candidateAddress;        }        // At this point, we did not find a non-loopback address.        // Fall back to returning whatever InetAddress.getLocalHost() returns...        InetAddress jdkSuppliedAddress = InetAddress.getLocalHost();        if (jdkSuppliedAddress == null) {            throw new UnknownHostException("The JDK InetAddress.getLocalHost() method unexpectedly returned null.");        }        return jdkSuppliedAddress;    }    catch (Exception e) {        UnknownHostException unknownHostException = new UnknownHostException("Failed to determine LAN address: " + e);        unknownHostException.initCause(e);        throw unknownHostException;    }}