NetworkInterface (Java SE 10 & JDK 10 ) (original) (raw)
- java.net.NetworkInterface
public final class NetworkInterface
extends Object
This class represents a Network Interface made up of a name, and a list of IP addresses assigned to this interface. It is used to identify the local interface on which a multicast group is joined. Interfaces are normally known by names such as "le0".
Since:
1.4
Method Summary
All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type Method Description boolean equals(Object obj) Compares this object against the specified object. static NetworkInterface getByIndex(int index) Get a network interface given its index. static NetworkInterface getByInetAddress(InetAddress addr) Convenience method to search for a network interface that has the specified Internet Protocol (IP) address bound to it. static NetworkInterface getByName(String name) Searches for the network interface with the specified name. String getDisplayName() Get the display name of this network interface. byte[] getHardwareAddress() Returns the hardware address (usually MAC) of the interface if it has one and if it can be accessed given the current privileges. int getIndex() Returns the index of this network interface. Enumeration<InetAddress> getInetAddresses() Get an Enumeration with all or a subset of the InetAddresses bound to this network interface. List<InterfaceAddress> getInterfaceAddresses() Get a List of all or a subset of the InterfaceAddresses of this network interface. int getMTU() Returns the Maximum Transmission Unit (MTU) of this interface. String getName() Get the name of this network interface. static Enumeration<NetworkInterface> getNetworkInterfaces() Returns an Enumeration of all the interfaces on this machine. NetworkInterface getParent() Returns the parent NetworkInterface of this interface if this is a subinterface, or null if it is a physical (non virtual) interface or has no parent. Enumeration<NetworkInterface> getSubInterfaces() Get an Enumeration with all the subinterfaces (also known as virtual interfaces) attached to this network interface. Stream<InetAddress> inetAddresses() Get a Stream of all or a subset of the InetAddresses bound to this network interface. boolean isLoopback() Returns whether a network interface is a loopback interface. boolean isPointToPoint() Returns whether a network interface is a point to point interface. boolean isUp() Returns whether a network interface is up and running. boolean isVirtual() Returns whether this interface is a virtual interface (also called subinterface). static Stream<NetworkInterface> networkInterfaces() Returns a Stream of all the interfaces on this machine. Stream<NetworkInterface> subInterfaces() Get a Stream of all subinterfaces (also known as virtual interfaces) attached to this network interface. boolean supportsMulticast() Returns whether a network interface supports multicasting or not. * ### Methods declared in class java.lang.[Object](../../java/lang/Object.html "class in java.lang") `[clone](../../java/lang/Object.html#clone%28%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,int%29)`Method Detail
* #### getName public [String](../../java/lang/String.html "class in java.lang") getName() Get the name of this network interface. Returns: the name of this network interface * #### getInetAddresses public [Enumeration](../../java/util/Enumeration.html "interface in java.util")<[InetAddress](../../java/net/InetAddress.html "class in java.net")> getInetAddresses() Get an Enumeration with all or a subset of the InetAddresses bound to this network interface. If there is a security manager, its `checkConnect` method is called for each InetAddress. Only InetAddresses where the `checkConnect` doesn't throw a SecurityException will be returned in the Enumeration. However, if the caller has the[NetPermission](../../java/net/NetPermission.html "class in java.net")("getNetworkInformation") permission, then all InetAddresses are returned. Returns: an Enumeration object with all or a subset of the InetAddresses bound to this network interface See Also: [inetAddresses()](../../java/net/NetworkInterface.html#inetAddresses%28%29) * #### inetAddresses public [Stream](../../java/util/stream/Stream.html "interface in java.util.stream")<[InetAddress](../../java/net/InetAddress.html "class in java.net")> inetAddresses() Get a Stream of all or a subset of the InetAddresses bound to this network interface. If there is a security manager, its `checkConnect` method is called for each InetAddress. Only InetAddresses where the `checkConnect` doesn't throw a SecurityException will be returned in the Stream. However, if the caller has the[NetPermission](../../java/net/NetPermission.html "class in java.net")("getNetworkInformation") permission, then all InetAddresses are returned. Returns: a Stream object with all or a subset of the InetAddresses bound to this network interface Since: 9 * #### getInterfaceAddresses public [List](../../java/util/List.html "interface in java.util")<[InterfaceAddress](../../java/net/InterfaceAddress.html "class in java.net")> getInterfaceAddresses() Get a List of all or a subset of the `InterfaceAddresses` of this network interface. If there is a security manager, its `checkConnect` method is called with the InetAddress for each InterfaceAddress. Only InterfaceAddresses where the `checkConnect` doesn't throw a SecurityException will be returned in the List. Returns: a `List` object with all or a subset of the InterfaceAddresss of this network interface Since: 1.6 * #### getSubInterfaces public [Enumeration](../../java/util/Enumeration.html "interface in java.util")<[NetworkInterface](../../java/net/NetworkInterface.html "class in java.net")> getSubInterfaces() Get an Enumeration with all the subinterfaces (also known as virtual interfaces) attached to this network interface. For instance eth0:1 will be a subinterface to eth0. Returns: an Enumeration object with all of the subinterfaces of this network interface Since: 1.6 See Also: [subInterfaces()](../../java/net/NetworkInterface.html#subInterfaces%28%29) * #### subInterfaces public [Stream](../../java/util/stream/Stream.html "interface in java.util.stream")<[NetworkInterface](../../java/net/NetworkInterface.html "class in java.net")> subInterfaces() Get a Stream of all subinterfaces (also known as virtual interfaces) attached to this network interface. Returns: a Stream object with all of the subinterfaces of this network interface Since: 9 * #### getParent public [NetworkInterface](../../java/net/NetworkInterface.html "class in java.net") getParent() Returns the parent NetworkInterface of this interface if this is a subinterface, or `null` if it is a physical (non virtual) interface or has no parent. Returns: The `NetworkInterface` this interface is attached to. Since: 1.6 * #### getIndex public int getIndex() Returns the index of this network interface. The index is an integer greater or equal to zero, or `-1` for unknown. This is a system specific value and interfaces with the same name can have different indexes on different machines. Returns: the index of this network interface or `-1` if the index is unknown Since: 1.7 See Also: [getByIndex(int)](../../java/net/NetworkInterface.html#getByIndex%28int%29) * #### getDisplayName public [String](../../java/lang/String.html "class in java.lang") getDisplayName() Get the display name of this network interface. A display name is a human readable String describing the network device. Returns: a non-empty string representing the display name of this network interface, or null if no display name is available. * #### getByName public static [NetworkInterface](../../java/net/NetworkInterface.html "class in java.net") getByName([String](../../java/lang/String.html "class in java.lang") name) throws [SocketException](../../java/net/SocketException.html "class in java.net") Searches for the network interface with the specified name. Parameters: `name` \- The name of the network interface. Returns: A `NetworkInterface` with the specified name, or `null` if there is no network interface with the specified name. Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- If an I/O error occurs. `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If the specified name is `null`. * #### getByIndex public static [NetworkInterface](../../java/net/NetworkInterface.html "class in java.net") getByIndex(int index) throws [SocketException](../../java/net/SocketException.html "class in java.net") Get a network interface given its index. Parameters: `index` \- an integer, the index of the interface Returns: the NetworkInterface obtained from its index, or `null` if there is no interface with such an index on the system Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs. `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if index has a negative value Since: 1.7 See Also: [getIndex()](../../java/net/NetworkInterface.html#getIndex%28%29) * #### getByInetAddress public static [NetworkInterface](../../java/net/NetworkInterface.html "class in java.net") getByInetAddress([InetAddress](../../java/net/InetAddress.html "class in java.net") addr) throws [SocketException](../../java/net/SocketException.html "class in java.net") Convenience method to search for a network interface that has the specified Internet Protocol (IP) address bound to it. If the specified IP address is bound to multiple network interfaces it is not defined which network interface is returned. Parameters: `addr` \- The `InetAddress` to search with. Returns: A `NetworkInterface` or `null` if there is no network interface with the specified IP address. Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- If an I/O error occurs. `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If the specified address is `null`. * #### getNetworkInterfaces public static [Enumeration](../../java/util/Enumeration.html "interface in java.util")<[NetworkInterface](../../java/net/NetworkInterface.html "class in java.net")> getNetworkInterfaces() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns an `Enumeration` of all the interfaces on this machine. The`Enumeration` contains at least one element, possibly representing a loopback interface that only supports communication between entities on this machine. API Note: this method can be used in combination with[getInetAddresses()](../../java/net/NetworkInterface.html#getInetAddresses%28%29) to obtain all IP addresses for this node Returns: an Enumeration of NetworkInterfaces found on this machine Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs, or if the platform does not have at least one configured network interface. See Also: [networkInterfaces()](../../java/net/NetworkInterface.html#networkInterfaces%28%29) * #### networkInterfaces public static [Stream](../../java/util/stream/Stream.html "interface in java.util.stream")<[NetworkInterface](../../java/net/NetworkInterface.html "class in java.net")> networkInterfaces() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns a `Stream` of all the interfaces on this machine. The`Stream` contains at least one interface, possibly representing a loopback interface that only supports communication between entities on this machine. API Note: this method can be used in combination with[inetAddresses()](../../java/net/NetworkInterface.html#inetAddresses%28%29)} to obtain a stream of all IP addresses for this node, for example: ` Stream<InetAddress> addrs = NetworkInterface.networkInterfaces() .flatMap(NetworkInterface::inetAddresses); ` Returns: a Stream of NetworkInterfaces found on this machine Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs, or if the platform does not have at least one configured network interface. Since: 9 * #### isUp public boolean isUp() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns whether a network interface is up and running. Returns: `true` if the interface is up and running. Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs. Since: 1.6 * #### isLoopback public boolean isLoopback() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns whether a network interface is a loopback interface. Returns: `true` if the interface is a loopback interface. Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs. Since: 1.6 * #### isPointToPoint public boolean isPointToPoint() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns whether a network interface is a point to point interface. A typical point to point interface would be a PPP connection through a modem. Returns: `true` if the interface is a point to point interface. Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs. Since: 1.6 * #### supportsMulticast public boolean supportsMulticast() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns whether a network interface supports multicasting or not. Returns: `true` if the interface supports Multicasting. Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs. Since: 1.6 * #### getHardwareAddress public byte[] getHardwareAddress() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns the hardware address (usually MAC) of the interface if it has one and if it can be accessed given the current privileges. If a security manager is set, then the caller must have the permission [NetPermission](../../java/net/NetPermission.html "class in java.net")("getNetworkInformation"). Returns: a byte array containing the address, or `null` if the address doesn't exist, is not accessible or a security manager is set and the caller does not have the permission NetPermission("getNetworkInformation") Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs. Since: 1.6 * #### getMTU public int getMTU() throws [SocketException](../../java/net/SocketException.html "class in java.net") Returns the Maximum Transmission Unit (MTU) of this interface. Returns: the value of the MTU for that interface. Throws: `[SocketException](../../java/net/SocketException.html "class in java.net")` \- if an I/O error occurs. Since: 1.6 * #### isVirtual public boolean isVirtual() Returns whether this interface is a virtual interface (also called subinterface). Virtual interfaces are, on some systems, interfaces created as a child of a physical interface and given different settings (like address or MTU). Usually the name of the interface will the name of the parent followed by a colon (:) and a number identifying the child since there can be several virtual interfaces attached to a single physical interface. Returns: `true` if this interface is a virtual interface. Since: 1.6 * #### equals public boolean equals([Object](../../java/lang/Object.html "class in java.lang") obj) Compares this object against the specified object. The result is `true` if and only if the argument is not `null` and it represents the same NetworkInterface as this object. Two instances of `NetworkInterface` represent the same NetworkInterface if both name and addrs are the same for both. Overrides: `[equals](../../java/lang/Object.html#equals%28java.lang.Object%29)` in class `[Object](../../java/lang/Object.html "class in java.lang")` Parameters: `obj` \- the object to compare against. Returns: `true` if the objects are the same;`false` otherwise. See Also: [InetAddress.getAddress()](../../java/net/InetAddress.html#getAddress%28%29)
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2018, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.