Index (Terracotta Utilities Port Chooser 0.0.16 API)

A C D E F G H I L M N O P R S T U V W

A

anyLocal() - Method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.IPVersion: Gets the byte-array form of "any local address" for this IPVersion.

C

close() - Method in class org.terracotta.utilities.test.net.PortManager.PortRef: Closes this PortRef.
close(Set<PortManager.PortRef.CloseOption>) - Method in class org.terracotta.utilities.test.net.PortManager.PortRef: Closes this PortRef using the options provided.
code() - Method in exception org.terracotta.utilities.test.io.WindowsSpecialFolder.SpecialFolderException
commandLine() - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort: Gets the long representation of the command.
CommonFiles - Class in org.terracotta.utilities.test.io: Tool for creating a system-wide, all-user-writable application file.
CommonFiles() - Constructor for class org.terracotta.utilities.test.io.CommonFiles
createCommonAppFile(Path) - Static method in class org.terracotta.utilities.test.io.CommonFiles: Creates a file, using the relative path provided, in the system-appropriate directory for persistent, cross-process, cross-user data.

D

DISABLE_PORT_RELEASE_CHECK_ENV_VARIABLE - Static variable in class org.terracotta.utilities.test.net.PortManager: Environment variable checked for disabling the port release check performed at the time a port obtained from PortManager is returned to PortManger.
DISABLE_PORT_RELEASE_CHECK_PROPERTY - Static variable in class org.terracotta.utilities.test.net.PortManager: Property checked for disabling the port release check performed at the time a port obtained from PortManager is returned to PortManager.

E

EphemeralPorts - Class in org.terracotta.utilities.test.net
EphemeralPorts() - Constructor for class org.terracotta.utilities.test.net.EphemeralPorts
EphemeralPorts.Range - Class in org.terracotta.utilities.test.net
exitCode() - Method in exception org.terracotta.utilities.test.net.NetStat.HostExecutionException

F

findWindowsSystemRoot() - Static method in class org.terracotta.utilities.test.runtime.Os: Gets the Windows "System" folder.
fromId(String) - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.IPVersion: Determines the IPVersion from the identifier provided.
fromLsofString(String) - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.TcpState: Determine the TcpCode from the state string from the lsof command.
fromMicrosoftNumber(int) - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.TcpState: Determine the TcpState from the state number corresponding to a Microsoft System.Net.NetworkInformation.TcpState enum value.
fromMicrosoftString(String) - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.TcpState: Determine the TcpState from the state string from the Microsoft Get-NetTCPConnection cmdlet.
fromNettopString(String) - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.TcpState: Determine the TcpCode from the state string from the nettop command.

G

get() - Method in enum org.terracotta.utilities.test.io.WindowsSpecialFolder: Gets the Path assigned to the identified special folder.
getInetSocketAddress(String, String) - Method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.IPVersion: Gets an InetSocketAddress instance composed of the IP address and port provided.
getInstance() - Static method in class org.terracotta.utilities.test.net.PortManager: Gets the singleton instance of PortManager to use in a JVM.
getLower() - Method in class org.terracotta.utilities.test.net.EphemeralPorts.Range: The first port assigned to the ephemeral/dynamic port range.
getOsArch() - Static method in class org.terracotta.utilities.test.runtime.Os
getOsName() - Static method in class org.terracotta.utilities.test.runtime.Os
getPortRef(int) - Method in class org.terracotta.utilities.test.net.PortManager: Gets the active PortManager.PortRef instance for the designated port.
getRange() - Static method in class org.terracotta.utilities.test.net.EphemeralPorts
getUpper() - Method in class org.terracotta.utilities.test.net.EphemeralPorts.Range: The last port assigned to the ephemeral/dynamic port range.

H

HostExecutionException(String, Throwable) - Constructor for exception org.terracotta.utilities.test.net.NetStat.HostExecutionException
HostExecutionException(String, Shell.Result, Throwable) - Constructor for exception org.terracotta.utilities.test.net.NetStat.HostExecutionException
HostExecutionException(String, Shell.Result) - Constructor for exception org.terracotta.utilities.test.net.NetStat.HostExecutionException

I

info() - Static method in class org.terracotta.utilities.test.net.NetStat: Gets the list of busy ports on the current host.
info(int) - Static method in class org.terracotta.utilities.test.net.NetStat: Gets the list of busy ports associated with a single local port.
isAix() - Static method in class org.terracotta.utilities.test.runtime.Os
isArchx86() - Static method in class org.terracotta.utilities.test.runtime.Os
isClosed() - Method in class org.terracotta.utilities.test.net.PortManager.PortRef: Returns whether or not this PortRef is closed.
isHpux() - Static method in class org.terracotta.utilities.test.runtime.Os
isInRange(int) - Method in class org.terracotta.utilities.test.net.EphemeralPorts.Range
isLinux() - Static method in class org.terracotta.utilities.test.runtime.Os
isMac() - Static method in class org.terracotta.utilities.test.runtime.Os
isReservablePort(int) - Method in class org.terracotta.utilities.test.net.PortManager: Indicates if the designated port is in the range of ports that may be allocated by this class.
isSolaris() - Static method in class org.terracotta.utilities.test.runtime.Os
isUnix() - Static method in class org.terracotta.utilities.test.runtime.Os
isWindows() - Static method in class org.terracotta.utilities.test.runtime.Os

L

localEndpoint() - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort: Gets the local endpoint socket address.
loopback() - Method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.IPVersion: Gets the byte-array form of the "loopback address" for this IPVersion.

M

main(String[]) - Static method in class org.terracotta.utilities.test.net.EphemeralPorts
main(String[]) - Static method in class org.terracotta.utilities.test.net.NetStat: Writes the list returned by NetStat.info() to System.out.
main(String[]) - Static method in class org.terracotta.utilities.test.net.ReservedPorts

N

NetStat - Class in org.terracotta.utilities.test.net: Produces a network status collection similar to that obtained using netstat.
NetStat.BusyPort - Class in org.terracotta.utilities.test.net: Describes an active TCP port and associates it with the controlling process.
NetStat.BusyPort.IPVersion - Enum in org.terracotta.utilities.test.net: Enumerates the types of IP addresses supported.
NetStat.BusyPort.TcpState - Enum in org.terracotta.utilities.test.net: TCP Connection states.
NetStat.HostExecutionException - Exception in org.terracotta.utilities.test.net: Thrown to indicate the failure of a host command used in construction of TCP connection status information.

O

org.terracotta.utilities.test.io - package org.terracotta.utilities.test.io
org.terracotta.utilities.test.net - package org.terracotta.utilities.test.net
org.terracotta.utilities.test.runtime - package org.terracotta.utilities.test.runtime
Os - Class in org.terracotta.utilities.test.runtime: O/S functions
output() - Method in exception org.terracotta.utilities.test.net.NetStat.HostExecutionException

P

platform() - Static method in class org.terracotta.utilities.test.runtime.Os
port() - Method in class org.terracotta.utilities.test.net.PortManager.PortRef: Gets the reserved port number.
PortManager - Class in org.terracotta.utilities.test.net: Manages TCP port reservation/de-reservation while attempting to avoid intra- and extra-JVM interference.
PortManager.PortRef - Class in org.terracotta.utilities.test.net: Represents a reserved TCP port.
PortManager.PortRef.CloseOption - Enum in org.terracotta.utilities.test.net: Options that may be used with PortManager.PortRef.close(Set).
processId() - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort: Gets the process id associated with this connection.

R

remoteEndpoint() - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort: Gets the remote endpoint socket address.
reserve(int) - Method in class org.terracotta.utilities.test.net.PortManager: Attempts to reserve the specified port.
ReservedPorts - Class in org.terracotta.utilities.test.net: Identifies reserved ports on a platform.
ReservedPorts() - Constructor for class org.terracotta.utilities.test.net.ReservedPorts
reservePort() - Method in class org.terracotta.utilities.test.net.PortManager: Reserve a single, randomly selected port.
reservePorts(int) - Method in class org.terracotta.utilities.test.net.PortManager: Reserves the specified number of ports returning a list of PortManager.PortRef instances for those reserved.

S

shortCommand() - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort: Gets the short representation of the command as provided by the TCP connection information source.
state() - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort: Gets the state of this TCP connection.

T

toString() - Method in class org.terracotta.utilities.test.net.EphemeralPorts.Range
toString(String) - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort: Produces a print-suitable string of this BusyPort instance.
toString() - Method in class org.terracotta.utilities.test.net.NetStat.BusyPort

U

unspecified() - Method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.IPVersion: Returns an InetAddress instance indicating an "unspecified" (or failed) host address.

V

valueOf(String) - Static method in enum org.terracotta.utilities.test.io.WindowsSpecialFolder: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.IPVersion: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.TcpState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.terracotta.utilities.test.net.PortManager.PortRef.CloseOption: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.terracotta.utilities.test.io.WindowsSpecialFolder: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.IPVersion: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.terracotta.utilities.test.net.NetStat.BusyPort.TcpState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.terracotta.utilities.test.net.PortManager.PortRef.CloseOption: Returns an array containing the constants of this enum type, in the order they are declared.

W

WindowsSpecialFolder - Enum in org.terracotta.utilities.test.io: Provides the value for Windows Special Folder identifiers.
WindowsSpecialFolder.SpecialFolderException - Exception in org.terracotta.utilities.test.io: Thrown when the folder assigned to a Windows Special Folder identifier cannot be determined.

A C D E F G H I L M N O P R S T U V W