HostIdentifier

Class Overview

An abstraction that identifies a target host and communications protocol. The HostIdentifier, or hostid, provides a convenient string representation of the information needed to locate and communicate with a target host. The string, based on a URI, may specify the the communications protocol, host name, and protocol specific information for a target host. The format for a HostIdentifier string is:

       [protocol:][[//]hostname][:port][/servername]
 

There are actually no required components of this string, as a null string is interpreted to mean a local connection to the local host and is equivalent to the string local://localhost. The components of the HostIdentifier are:

• protocol - The communications protocol. If omitted, and a hostname is not specified, then default local protocol, local:, is assumed. If the protocol is omitted and a hostname is specified then the default remote protocol, rmi: is assumed.

• hostname - The hostname. If omitted, then localhost is assumed. If the protocol is also omitted, then default local protocol local: is also assumed. If the hostname is not omitted but the protocol is omitted, then the default remote protocol, rmi: is assumed.

• port - The port for the communications protocol. Treatment of the port parameter is implementation (protocol) specific. It is unused by the default local protocol, local:. For the default remote protocol, rmi:, port indicates the port number of the rmiregistry on the target host and defaults to port 1099.

• servername - The treatment of the Path, Query, and Fragment components of the HostIdentifier are implementation (protocol) dependent. These components are ignored by the default local protocol, local:. For the default remote protocol, rmi, the Path component is interpreted as the name of the RMI remote object. The Query component may contain an access mode specifier ?mode= specifying "r" or "rw" access (write access currently ignored). The Fragment part is ignored.

All HostIdentifier objects are represented as absolute, hierarchical URIs. The constructors accept relative URIs, but these will generally be transformed into an absolute URI specifying a default protocol. A HostIdentifier differs from a URI in that certain contractions and illicit syntactical constructions are allowed. The following are all valid HostIdentifier strings:

• < null > - transformed into "//localhost"

• localhost - transformed into "//localhost"

• hostname - transformed into "//hostname"

• hostname:port - transformed into "//hostname:port"

• proto:hostname - transformed into "proto://hostname"

• proto:hostname:port - transformed into "proto://hostname:port"

• proto://hostname:port

Summary

Public Constructors
	HostIdentifier(String uriString) Create a HostIdentifier instance from a string value.
	HostIdentifier(String scheme, String authority, String path, String query, String fragment) Create a HostIdentifier instance from component parts of a URI.
	HostIdentifier(VmIdentifier vmid) Create a HostIdentifier instance from a VmIdentifier.

Public Methods
boolean	equals(Object object) Test for quality with other objects.
String	getFragment() Return the Fragment part of this HostIdentifier.
String	getHost() Return the Host part of this HostIdentifier.
String	getMode() Return the mode indicated in this HostIdentifier.
String	getPath() Return the Path part of this HostIdentifier.
int	getPort() Return the Port for of this HostIdentifier.
String	getQuery() Return the Query part of this HostIdentifier.
String	getScheme() Return the Scheme, or protocol, portion of this HostIdentifier.
String	getSchemeSpecificPart() Return the Scheme Specific Part of this HostIdentifier.
URI	getURI() Return the URI associated with the HostIdentifier.
String	getUserInfo() Return the User Info part of this HostIdentifier.
int	hashCode() Return the hash code for this HostIdentifier.
VmIdentifier	resolve(VmIdentifier vmid) Resolve a VmIdentifier with this HostIdentifier.
String	toString() Convert to a string representation.

[Expand] Inherited Methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.