tachyon.util.network

Class NetworkAddressUtils

java.lang.Object

tachyon.util.network.NetworkAddressUtils

public final class NetworkAddressUtils
extends Object

Common network address related utilities shared by all components in Tachyon.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkAddressUtils.ServiceType Different types of services that client uses to connect.

Field Summary

Fields

Modifier and Type	Field and Description
static String	WILDCARD_ADDRESS
static boolean	WINDOWS Checks if the underlying OS is Windows.

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertValidPort(InetSocketAddress address, TachyonConf tachyonConf)
static void	assertValidPort(int port, TachyonConf tachyonConf)
static InetSocketAddress	getBindAddress(NetworkAddressUtils.ServiceType service, TachyonConf conf) Helper method to get the InetSocketAddress bind address on a given service.
static InetSocketAddress	getConnectAddress(NetworkAddressUtils.ServiceType service, TachyonConf conf) Helper method to get the InetSocketAddress address for client to communicate with the service.
static String	getConnectHost(NetworkAddressUtils.ServiceType service, TachyonConf conf) Provides an externally resolvable hostname for client to communicate with the service.
static String	getFqdnHost(InetSocketAddress addr) Get FQDN(Full Qualified Domain Name) from Java representations of network address, except String representation which should be handled by #resolveHostName(String hostname) which will handle the situation where hostname is null.
static String	getFqdnHost(NetAddress addr) Gets FQDN(Full Qualified Domain Name) from Tachyon representation of network address.
static String	getLocalHostName(int timeout) Gets a local host name for the host this JVM is running on
static String	getLocalHostName(TachyonConf conf) Gets a local host name for the host this JVM is running on
static String	getLocalIpAddress(int timeout) Gets a local IP address for the host this JVM is running on
static String	getLocalIpAddress(TachyonConf conf) Gets a local IP address for the host this JVM is running on
static int	getPort(NetworkAddressUtils.ServiceType service, TachyonConf conf) Gets the port number on a given service type.
static int	getThriftPort(org.apache.thrift.transport.TServerSocket thriftSocket) Gets the port for the underline socket.
static ServerSocket	getThriftSocket(org.apache.thrift.transport.TServerSocket thriftSocket) Extracts the port from the thrift socket.
static InetSocketAddress	parseInetSocketAddress(String address) Parses InetSocketAddress from a String.
static TachyonURI	replaceHostName(TachyonURI path) Replaces and resolves the hostname in a given address or path string.
static String	resolveHostName(String hostname) Resolves a given hostname by a canonical hostname.

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD_ADDRESS

public static final String WILDCARD_ADDRESS

See Also:

Constant Field Values

WINDOWS

public static final boolean WINDOWS

Checks if the underlying OS is Windows.

Method Detail

assertValidPort

public static void assertValidPort(int port,
                   TachyonConf tachyonConf)

assertValidPort

public static void assertValidPort(InetSocketAddress address,
                   TachyonConf tachyonConf)

getConnectAddress

public static InetSocketAddress getConnectAddress(NetworkAddressUtils.ServiceType service,
                                  TachyonConf conf)

Helper method to get the InetSocketAddress address for client to communicate with the service.

Parameters:

service - the service name used to connect

conf - the configuration of Tachyon

Returns:

the service address that a client (typically outside the service machine) uses to communicate with service.

getConnectHost

public static String getConnectHost(NetworkAddressUtils.ServiceType service,
                    TachyonConf conf)

Provides an externally resolvable hostname for client to communicate with the service. If the hostname is not explicitly specified, Tachyon will try to use the bind host. If the bind host is wildcard, Tachyon will automatically determine an appropriate hostname from local machine. The various possibilities shown in the following table:

Hostname Scenarios

Specified Hostname	Specified Bind Host	Returned Connect Host
hostname	hostname	hostname
not defined	hostname	hostname
hostname	0.0.0.0 or not defined	hostname
not defined	0.0.0.0 or not defined	localhost

Parameters:

service - Service type used to connect

conf - Tachyon configuration used to look up the host resolution timeout

Returns:

the externally resolvable hostname that the client can use to communicate with the service.

getPort

public static int getPort(NetworkAddressUtils.ServiceType service,
          TachyonConf conf)

Gets the port number on a given service type. If user defined port number is not explicitly specified, Tachyon will use the default service port.

Parameters:

service - Service type used to connect

conf - Tachyon configuration

Returns:

the service port number

getBindAddress

public static InetSocketAddress getBindAddress(NetworkAddressUtils.ServiceType service,
                               TachyonConf conf)

Helper method to get the InetSocketAddress bind address on a given service.

Host bind information searching order:

1. System properties or environment variables via tachyon-env.sh
2. Default properties via tachyon-default.properties file
3. A externally resolvable local hostname for the host this JVM is running on

Parameters:

service - the service name used to connect

conf - the configuration of Tachyon

Returns:

the InetSocketAddress the service will bind to

getLocalHostName

public static String getLocalHostName(TachyonConf conf)

Gets a local host name for the host this JVM is running on

Parameters:

conf - Tachyon configuration used to look up the host resolution timeout

Returns:

the local host name, which is not based on a loopback ip address

getLocalHostName

public static String getLocalHostName(int timeout)

Gets a local host name for the host this JVM is running on

Parameters:

timeout - Timeout in milliseconds to use for checking that a possible local host is reachable

Returns:

the local host name, which is not based on a loopback ip address

getLocalIpAddress

public static String getLocalIpAddress(TachyonConf conf)

Gets a local IP address for the host this JVM is running on

Parameters:

conf - Tachyon configuration

Returns:

the local ip address, which is not a loopback address and is reachable

getLocalIpAddress

public static String getLocalIpAddress(int timeout)

Gets a local IP address for the host this JVM is running on

Parameters:

timeout - Timeout in milliseconds to use for checking that a possible local IP is reachable

Returns:

the local ip address, which is not a loopback address and is reachable

replaceHostName

public static TachyonURI replaceHostName(TachyonURI path)
                                  throws UnknownHostException

Replaces and resolves the hostname in a given address or path string.

Parameters:

path - an address or path string, e.g., "hdfs://host:port/dir", "file:///dir", "/dir".

Returns:

an address or path string with hostname resolved, or the original path intact if no hostname is embedded, or null if the given path is null or empty.

Throws:

UnknownHostException - if the hostname cannot be resolved.

resolveHostName

public static String resolveHostName(String hostname)
                              throws UnknownHostException

Resolves a given hostname by a canonical hostname. When a hostname alias (e.g., those specified in /etc/hosts) is given, the alias may not be resolvable on other hosts in a cluster unless the same alias is defined there. In this situation, loadufs would break.

Parameters:

hostname - the input hostname, which could be an alias.

Returns:

the canonical form of the hostname, or null if it is null or empty

Throws:

UnknownHostException - if the given hostname cannot be resolved.

getFqdnHost

public static String getFqdnHost(InetSocketAddress addr)

Get FQDN(Full Qualified Domain Name) from Java representations of network address, except String representation which should be handled by #resolveHostName(String hostname) which will handle the situation where hostname is null.

Parameters:

addr - the input network address representation, can not be null

Returns:

the resolved FQDN host name

getFqdnHost

public static String getFqdnHost(NetAddress addr)
                          throws UnknownHostException

Gets FQDN(Full Qualified Domain Name) from Tachyon representation of network address.

Parameters:

addr - the input network address representation

Returns:

the resolved FQDN host name

Throws:

UnknownHostException - if the host is not known

getThriftPort

public static int getThriftPort(org.apache.thrift.transport.TServerSocket thriftSocket)

Gets the port for the underline socket. This function calls getThriftSocket(org.apache.thrift.transport.TServerSocket), so reflection will be used to get the port.

See Also:

getThriftSocket(org.apache.thrift.transport.TServerSocket)

getThriftSocket

public static ServerSocket getThriftSocket(org.apache.thrift.transport.TServerSocket thriftSocket)

Extracts the port from the thrift socket. As of thrift 0.9, the internal socket used is not exposed in the API, so this function will use reflection to get access to it.

Throws:

RuntimeException - if reflection calls fail

parseInetSocketAddress

public static InetSocketAddress parseInetSocketAddress(String address)
                                                throws IOException

Parses InetSocketAddress from a String.

Parameters:

address - socket address to parse

Returns:

InetSocketAddress of the String

Throws:

IOException - if the socket address is invalid