org.rvpf.base.tool

Class Inet

Object

Inet

@Immutable
public final class Inet
extends Object

Inet.

Provides some utility functions for Inet addresses.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCAL_HOST Local host.

Method Summary

Modifier and Type	Method and Description
static int	allocateTCPPort() Allocates a TCP port.
static int	allocateUDPPort() Allocates an UDP port.
static Optional<byte[]>	getHardwareAddress(Optional<String> name) Gets the hardware address.
static InetAddress	getLocalAddress(Optional<String> addressString) Gets a local address.
static InetAddress	getLocalHostAddress() Gets the local host address.
static boolean	isOnLocalHost(InetAddress address) Asks if the supplied address is on an interface of the local host.
static boolean	isOnLocalHost(URI uri) Asks if the supplied URI points to an interface on the local host.
static Optional<InetSocketAddress>	socketAddress(String addressString) Returns a SocketAddress from an address string.
static InetAddress	substituteAddress(InetAddress address) Returns the loopback address if the host address is on localhost.
static Optional<URI>	substituteURI(URI uri) Returns a loopback URI if the host address is on localhost.

Methods inherited from class Object

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

Field Detail

LOCAL_HOST

public static final String LOCAL_HOST

Local host.

See Also:

Constant Field Values

Method Detail

allocateTCPPort

@CheckReturnValue
public static int allocateTCPPort()

Allocates a TCP port.

Used by some tests to get an unallocated port. Also used to create a 'stealth' service registry.

Returns:

A free TCP port.

allocateUDPPort

@CheckReturnValue
public static int allocateUDPPort()

Allocates an UDP port.

Used by some tests to get an unallocated port.

Returns:

A free UDP port.

getHardwareAddress

@Nonnull
 @CheckReturnValue
public static Optional<byte[]> getHardwareAddress(@Nonnull
                                                                                Optional<String> name)

Gets the hardware address.

Parameters:

name - An optional host name to select an interface.

Returns:

The hardware address (empty if not available).

getLocalAddress

@Nullable
 @CheckReturnValue
public static InetAddress getLocalAddress(@Nonnull
                                                                         Optional<String> addressString)

Gets a local address.

Parameters:

addressString - An optional address string.

Returns:

The local address (null on failure).

getLocalHostAddress

@Nonnull
 @CheckReturnValue
public static InetAddress getLocalHostAddress()

Gets the local host address.

Returns:

The local host address (loopback address on failure).

isOnLocalHost

@CheckReturnValue
public static boolean isOnLocalHost(@Nonnull
                                                       InetAddress address)

Asks if the supplied address is on an interface of the local host.

Parameters:

address - The address.

Returns:

True if on local host.

isOnLocalHost

@CheckReturnValue
public static boolean isOnLocalHost(@Nonnull
                                                       URI uri)

Asks if the supplied URI points to an interface on the local host.

Parameters:

uri - The URI.

Returns:

True if on local host.

socketAddress

@Nonnull
 @CheckReturnValue
public static Optional<InetSocketAddress> socketAddress(@Nonnull
                                                                                      String addressString)

Returns a SocketAddress from an address string.

The format of the address string is "host:port". When present, a leading "//" or a trailing "/" are ignored to permit a more general, URL like, format.

Parameters:

addressString - The address string.

Returns:

The SocketAddress (empty when not available).

substituteAddress

@Nonnull
 @CheckReturnValue
public static InetAddress substituteAddress(@Nonnull
                                                                          InetAddress address)

Returns the loopback address if the host address is on localhost.

Parameters:

address - The original address.

Returns:

The original address or the loopback address.

substituteURI

@Nonnull
 @CheckReturnValue
public static Optional<URI> substituteURI(@Nonnull
                                                                        URI uri)

Returns a loopback URI if the host address is on localhost.

Parameters:

uri - The original URI.

Returns:

The original URI, a loopback URI or empty if the host is unknown.