VmIdentifier

Class Overview

An abstraction that identifies a target Java Virtual Machine. The VmIdentifier, or vmid, provides a convenient string representation of the information needed to locate and communicate with a target Java Virtual Machine. The string, based on a URI, may specify the communications protocol, host name, local vm identifier, and protocol specific information for a target Java Virtual Machine. The format for a VmIdentifier string is:

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

The only required component of this string is the Local Virtual Machine Identifier, or lvmid, which uniquely identifies the target Java Virtual Machine on a host. The optional components of the VmIdentifier include:

• protocol - The communications protocol. A VmIdentifier omitting the protocol must be resolved against a HostIdentifier using resolve(VmIdentifier).

• hostname - A hostname or IP address indicating the target host. A VmIdentifier omitting the protocol must be resolved against a HostIdentifier using resolve(VmIdentifier).

• port - The port for the communications protocol. Treatment of the port parameter is implementation (protocol) specific. A VmIdentifier omitting the protocol should be resolved against a HostIdentifier using resolve(VmIdentifier).

• servername - The treatment of the Path, Query, and Fragment components of the VmIdentifier are implementation (protocol) dependent. A VmIdentifier omitting the protocol should be resolved against a HostIdentifier using resolve(VmIdentifier).

All VmIdentifier instances are constructed as absolute, hierarchical URIs. The constructors will accept relative (and even some malformed, though convenient) URI strings. Such strings are transformed into legitimate, absolute URI strings.

With the exception of file: based VmIdentifier strings, all VmIdentifier strings must include a lvmid. Attempting to construct a non-file based VmIdentifier that doesn't include a lvmid component will result in a MonitorException.

Here are some examples of VmIdentifier strings.

• Relative URIs

• 1234 - Specifies the Java Virtual Machine identified by lvmid 1234 on an unnamed host. This string is transformed into the absolute form //1234, which must be resolved against a HostIdentifier.

• 1234@hostname - Specifies the Java Virtual Machine identified by lvmid 1234 on host hostname with an unnamed protocol. This string is transformed into the absolute form //1234@hostname, which must be resolved against a HostIdentifier.

• 1234@hostname:2099 - Specifies the Java Virtual Machine identified by lvmid 1234 on host hostname with an unnamed protocol, but with port 2099. This string is transformed into the absolute form //1234@hostname:2099, which must be resolved against a HostIdentifier.

• Absolute URIs

• rmi://1234@hostname:2099/remoteobjectname - Specifies the Java Virtual Machine identified by lvmid 1234 on host hostname accessed using the rmi: protocol through the rmi remote object named remoteobjectname as registered with the rmiserver on port 2099 on host hostname.

• file:/path/file - Identifies a Java Virtual Machine through accessing a special file based protocol to use as the communications mechanism.

Summary

Public Constructors
	VmIdentifier(String uriString) Create a VmIdentifier instance from a string value.
	VmIdentifier(URI uri) Create a VmIdentifier instance from a URI object.

Public Methods
boolean	equals(Object object) Test for quality with other objects.
String	getAuthority() Return the Authority part of this VmIdentifier.
String	getFragment() Return the Fragment part of this VmIdentifier.
String	getHost() Return the Host part of this VmIdentifier.
HostIdentifier	getHostIdentifier() Return the corresponding HostIdentifier for this VmIdentifier.
int	getLocalVmId() Return the Local Virtual Machine Identifier for this VmIdentifier.
String	getMode() Return the mode indicated in this VmIdentifier.
String	getPath() Return the Path part of this VmIdentifier.
int	getPort() Return the Port part of this VmIdentifier.
String	getQuery() Return the Query part of this VmIdentifier.
String	getScheme() Return the Scheme, or protocol, portion of this VmIdentifier.
String	getSchemeSpecificPart() Return the Scheme Specific Part of this VmIdentifier.
URI	getURI() Return the URI associated with the VmIdentifier.
String	getUserInfo() Return the UserInfo part of this VmIdentifier.
int	hashCode() Return the hash code for this VmIdentifier.
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.