org.terracotta.utilities.test.net

Class NetStat

java.lang.Object

org.terracotta.utilities.test.net.NetStat

public class NetStat
extends java.lang.Object

Produces a network status collection similar to that obtained using netstat. This class is intended for diagnostic purposes; elevated privileges may be required for full status collection.

Implementation Notes

• For a Windows platform, powershell must be available via PATH.
• For a Mac OS X platform, nettop and ps must be available via PATH.
• For a Linux platform, lsof and ps must be available via PATH. For a complete port list, the effective user must be permitted to use sudo to execute the lsof command without a password.
• Not all connections observed using netstat are shown by lsof -- see lsof FAQ item 3.29.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetStat.BusyPort Describes an active TCP port and associates it with the controlling process.
static class	NetStat.HostExecutionException Thrown to indicate the failure of a host command used in construction of TCP connection status information.

Method Summary

Modifier and Type	Method and Description
static java.util.List<NetStat.BusyPort>	info() Gets the list of busy ports on the current host.
static java.util.List<NetStat.BusyPort>	info(int port) Gets the list of busy ports associated with a single local port.
static void	main(java.lang.String[] args) Writes the list returned by info() to System.out.

Methods inherited from class java.lang.Object

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

Method Detail

info

public static java.util.List<NetStat.BusyPort> info()

Gets the list of busy ports on the current host.

Note that individual ports may appear more than once in the returned list. Depending on the source, a port may be listed for both IPv4 and IPv6 uses; for some applications (e.g. sshd), a port may be shared among multiple processes.

Returns:

the list of NetStat.BusyPort instances representing the busy TCP ports

Throws:

java.lang.RuntimeException - if the busy port information cannot be obtained

info

public static java.util.List<NetStat.BusyPort> info(int port)

Gets the list of busy ports associated with a single local port.

Note that individual ports may appear more than once in the returned list. Depending on the source, a port may be listed for both IPv4 and IPv6 uses; for some applications (e.g. sshd), a port may be shared among multiple processes.

Parameters:

port - the target port

Returns:

the list of NetStat.BusyPort instances representing the busy TCP ports

Throws:

java.lang.IllegalArgumentException - if port is not a valid port number

java.lang.RuntimeException - if the busy port information cannot be obtained

main

public static void main(java.lang.String[] args)

Writes the list returned by info() to System.out.

Parameters:

args - zero or more port numbers to check