com.palantir.giraffe.host

Class Host

java.lang.Object

com.palantir.giraffe.host.Host

public final class Host
extends Object

Represents a host with a unique hostname in a network.

Localhost Handling

This class attempts to resolve all representations of the local host to the same object. The canonical local host object is the one returned by localhost(). Factory methods that perform resolution return this object when given any loopback IP address or the string "localhost".

Method Summary

Modifier and Type	Method and Description
static void	addLocalUriScheme(String scheme) Adds a URI scheme to the set used by fromUri(URI) to identify the localhost URIs.
boolean	equals(Object obj) Determines if this Host is equal to another Host.
static Host	fromHostname(String name) Creates a Host from a valid hostname.
static Host	fromHostnameUnresolved(String name) Creates a Host with the given literal hostname.
static Host	fromInetAddress(InetAddress ia) Creates a Host from an InetAddress using the saved or resolved hostname.
static Host	fromUri(URI uri) Gets a Host from a URI.
String	getCanonicalHostname() Gets this host's canonical hostname by performing a reverse DNS lookup on this host's IP address.
String	getHostname() Returns the hostname of this host.
InetAddress	getInetAddress() Resolves this host's hostname to an IP address.
int	hashCode()
static Host	localhost() Gets the Host representing the local host.
boolean	resolvesToHost(Host other) Determines if this host has the same canonical name as another host.
String	toString() Returns the hostname of this host.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

addLocalUriScheme

public static void addLocalUriScheme(String scheme)

Adds a URI scheme to the set used by fromUri(URI) to identify the localhost URIs.

By default, the file scheme is included.

Parameters:

scheme - the scheme to add

fromHostname

public static Host fromHostname(String name)

Creates a Host from a valid hostname. The hostname is resolved to an InetAddress, which is used to create the host.

Parameters:

name - the hostname to resolve

Throws:

InetAddressUnresolvableException - if the hostname cannot be resolved

fromUri

public static Host fromUri(URI uri)

Gets a Host from a URI.

If the URI's scheme identifies resources on this host or if the host component is "localhost", returns the local host object. Otherwise, use the host component of the URI.

Parameters:

uri - the URI from which to extract the host

Returns:

a host for the given URI

Throws:

IllegalArgumentException - if the URI has no host component and does not have a known scheme

localhost

public static Host localhost()

Gets the Host representing the local host.

Throws:

InetAddressUnresolvableException - if "localhost" cannot be resolved

fromInetAddress

public static Host fromInetAddress(InetAddress ia)

Creates a Host from an InetAddress using the saved or resolved hostname.

Parameters:

ia - the InetAddress

fromHostnameUnresolved

public static Host fromHostnameUnresolved(String name)

Creates a Host with the given literal hostname. This method does not perform localhost resolution and getHostname() always returns the given hostname.

Parameters:

name - the hostname

getHostname

public String getHostname()

Returns the hostname of this host. The hostname is set at construction time and may not be in canonical form.

See Also:

getCanonicalHostname()

getInetAddress

public InetAddress getInetAddress()

Resolves this host's hostname to an IP address.

Returns:

an InetAddress for this host

Throws:

InetAddressUnresolvableException - if the hostname cannot be resolved

getCanonicalHostname

public String getCanonicalHostname()

Gets this host's canonical hostname by performing a reverse DNS lookup on this host's IP address.

See Also:

InetAddress.getCanonicalHostName()

resolvesToHost

public boolean resolvesToHost(Host other)

Determines if this host has the same canonical name as another host.

Parameters:

other - the other host

Returns:

true if the hosts have the same canonical hostname

Throws:

InetAddressUnresolvableException - if either hostname cannot be resolved

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Determines if this Host is equal to another Host. Two Hosts are equal if they have the same hostname.

Overrides:

equals in class Object

toString

public String toString()

Returns the hostname of this host.

Overrides:

toString in class Object