hydra

Class HostHelper

java.lang.Object

hydra.HostHelper

public class HostHelper
extends java.lang.Object

Supports queries about hosts and their operating system types. It also differentiates platforms where needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostHelper.OSType Enumerates the legal values for HostPrms.osTypes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ONLY_ON_PLATFORMS_PROP The onlyOnPlatforms system property

Constructor Summary

Constructors

Constructor and Description
HostHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	applyRFC2732(java.lang.String hostname) Process the String form of a hostname to make it comply with Jmx URL restrictions.
protected static boolean	compareHosts(java.lang.String host1, java.lang.String host2) Returns true if the noncanonical hostname of each host is the same or if one contains the other.
static java.lang.String	getCanonicalHostName() Returns the canonical name of the local host, based on the IPv4 address.
static java.lang.String	getCanonicalHostName(java.lang.String host) Returns the canonical name of the given host, based on the IPv4 address.
static java.lang.String	getHostAddress() Returns the address for the local host.
static java.lang.String	getHostAddress(java.net.InetAddress addr) A wrapper for InetAddress.getHostAddress() that removes the scope_id from all IPv4 address and all global IPv6 addresses.
static HostHelper.OSType	getHostOS(java.lang.String host) Returns the O/S type for the specified host.
static java.net.InetAddress	getIPAddress() Returns the IP address for the local host.
protected static java.net.InetAddress	getIPv4Address() Returns the IPv4 address for the local host.
static java.net.InetAddress	getIPv6Address() Returns the IPv6 address for the local host.
static java.lang.String	getLocalHost() Returns the non-canonical name of the local host, based on the IPv4 address.
static HostHelper.OSType	getLocalHostOS() Returns the OSType of the local host O/S.
protected static java.lang.String	getNoncanonicalHostName(java.lang.String host) Returns the non-canonical host name of the given host.
static boolean	isLocalHost(java.lang.String host) Answers whether the specified host is the local host.
static boolean	isWindows() Returns true if the OSType for this JVM is "windows".
static boolean	shouldRun(java.lang.String onlyOnPlatforms) Returns whether or the given value of the onlyOnPlatforms system property applies to this host.

Methods inherited from class java.lang.Object

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

Field Detail

ONLY_ON_PLATFORMS_PROP

public static final java.lang.String ONLY_ON_PLATFORMS_PROP

The onlyOnPlatforms system property

See Also:

shouldRun(java.lang.String), Constant Field Values

Constructor Detail

HostHelper

public HostHelper()

Method Detail

getLocalHost

public static java.lang.String getLocalHost()

Returns the non-canonical name of the local host, based on the IPv4 address. For example, stut.

Throws:

HydraRuntimeException - if the IPv4 address is not found.

getCanonicalHostName

public static java.lang.String getCanonicalHostName()

Returns the canonical name of the local host, based on the IPv4 address. For example, stut.gemstone.com.

Throws:

HydraRuntimeException - if the IPv4 address is not found.

compareHosts

protected static boolean compareHosts(java.lang.String host1,
                                      java.lang.String host2)

Returns true if the noncanonical hostname of each host is the same or if one contains the other. For example, "stut.gemstone.com" will match "stut6.gemstone.com";

getNoncanonicalHostName

protected static java.lang.String getNoncanonicalHostName(java.lang.String host)

Returns the non-canonical host name of the given host. For example, "stut.gemstone.com" is returned as "stut". No attempt is made to validate that the host is real.

Throws:

HydraRuntimeException - if no host is specified.

getCanonicalHostName

public static java.lang.String getCanonicalHostName(java.lang.String host)

Returns the canonical name of the given host, based on the IPv4 address.

Throws:

HydraRuntimeException - if the host is not found.

isLocalHost

public static boolean isLocalHost(java.lang.String host)

Answers whether the specified host is the local host.

getHostAddress

public static java.lang.String getHostAddress()

Returns the address for the local host. Distinguishes IPv4 and IPv6.

Throws:

HydraRuntimeException - if an address of the appropriate type cannot be found.

getHostAddress

public static java.lang.String getHostAddress(java.net.InetAddress addr)

A wrapper for InetAddress.getHostAddress() that removes the scope_id from all IPv4 address and all global IPv6 addresses. We don't need to use isIPv6LinkLocalAddress(java.net.Inet6Address) because that is for the case where the scope_id is missing.

Parameters:

addr -

Returns:

the address with the scope_id stripped off (assuming the address would still be valid with it removed)

getIPAddress

public static java.net.InetAddress getIPAddress()

Returns the IP address for the local host. Distinguishes IPv4 and IPv6.

Throws:

HydraRuntimeException - if an address of the appropriate type cannot be found.

getIPv4Address

protected static java.net.InetAddress getIPv4Address()

Returns the IPv4 address for the local host.

Throws:

HydraRuntimeException - if the IPv4 address cannot be found.

getIPv6Address

public static java.net.InetAddress getIPv6Address()

Returns the IPv6 address for the local host.

Throws:

HydraRuntimeException - if the IPv6 address cannot be found.

isWindows

public static boolean isWindows()

Returns true if the OSType for this JVM is "windows".

getLocalHostOS

public static HostHelper.OSType getLocalHostOS()

Returns the OSType of the local host O/S.

getHostOS

public static HostHelper.OSType getHostOS(java.lang.String host)

Returns the O/S type for the specified host.

shouldRun

public static boolean shouldRun(java.lang.String onlyOnPlatforms)

Returns whether or the given value of the onlyOnPlatforms system property applies to this host. Note that this only applies to the host on which MasterController runs. Another mechanism must be used if you want to restrict the platforms on which client VMs can run.

Parameters:

onlyOnPlatforms - A comma-separated string of platforms (as determined by the os.name Java system property) on which a test should be run. Examples of platforms are SunOS, Linux, and WindowsIf null or an empty string (""), then the test should be run on all platforms.

Since:

3.5

applyRFC2732

public static java.lang.String applyRFC2732(java.lang.String hostname)

Process the String form of a hostname to make it comply with Jmx URL restrictions. Namely wrap IPv6 literal address with "[", "]"

Parameters:

hostname - the name to safeguard.

Returns:

a string representation suitable for use in a Jmx connection URL