OpenJDK 27 · sun.jvmstat.monitor.HostIdentifier · APIdia, the JavaDoc alternative

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 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

Field Summary

Modifier and Type	Field and Description
private URI	uri

Constructor Summary

Access	Constructor and Description
public	HostIdentifier(String a string representing a target host. The syntax of the string must conform to the rules specified in the class documentation. uriString) Create a HostIdentifier instance from a string value.
public	HostIdentifier(String the `URI#getScheme` component of a URI. scheme, String the `URI#getAuthority` component of a URI. authority, String the `URI#getPath` component of a URI. path, String the `URI#getQuery` component of a URI. query, String the `URI#getFragment` component of a URI. fragment) Create a HostIdentifier instance from component parts of a URI.
public	HostIdentifier(VmIdentifier the VmIdentifier use to construct the HostIdentifier. vmid) Create a HostIdentifier instance from a VmIdentifier.

Method Summary

Modifier and Type	Method and Description
private URI	canonicalize(String uriString) creates a canonical representation of the uriString.
public boolean	Returns: boolean - returns true if the given object is of type HostIdentifier and its URI field is equal to this object's URI field. Otherwise, returns false. equals(Object the object to be test for equality. object) Overrides java.lang.Object.equals. Test for quality with other objects.
public String	Returns: String - the fragment part for this HostIdentifier. getFragment() Return the Fragment part of this HostIdentifier.
public String	Returns: String - the host part for this HostIdentifier, or "localhost" if the URI.getHost() returns null. getHost() Return the Host part of this HostIdentifier.
public String	Returns: String - the path part for this HostIdentifier. getPath() Return the Path part of this HostIdentifier.
public int	Returns: String - the port for this HostIdentifier getPort() Return the Port for of this HostIdentifier.
public String	Returns: String - the query part for this HostIdentifier. getQuery() Return the Query part of this HostIdentifier.
public String	Returns: String - the scheme for this HostIdentifier. getScheme() Return the Scheme, or protocol, portion of this HostIdentifier.
public String	Returns: String - the scheme specific part for this HostIdentifier. getSchemeSpecificPart() Return the Scheme Specific Part of this HostIdentifier.
public URI	Returns: URI - the URI. getURI() Return the URI associated with the HostIdentifier.
public String	Returns: String - the user info part for this HostIdentifier. getUserInfo() Return the User Info part of this HostIdentifier.
public int	Returns: int - the hashcode. hashCode() Overrides java.lang.Object.hashCode. Return the hash code for this HostIdentifier.
public VmIdentifier	Returns: VmIdentifier - the resolved VmIdentifier. If vmid was resolved on entry to this method, then the returned VmIdentifier will be equal, but not identical, to vmid. resolve(VmIdentifier the unresolved VmIdentifier. vmid) Resolve a VmIdentifier with this HostIdentifier.
public String	Returns: String - a String representation of the HostIdentifier. toString() Overrides java.lang.Object.toString. Convert to a string representation.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

uri	back to summary
private URI uri

Constructor Detail

HostIdentifier	back to summary
public HostIdentifier(String uriString) throws URISyntaxException Create a HostIdentifier instance from a string value. Parameters uriString:String a string representing a target host. The syntax of the string must conform to the rules specified in the class documentation. Exceptions URISyntaxException: Thrown when the uriString or its canonical form is poorly formed. This exception may get encapsulated into a MonitorException in a future version.

HostIdentifier

back to summary

public HostIdentifier(String uriString) throws URISyntaxException

Create a HostIdentifier instance from a string value.

Parameters

uriString:String: a string representing a target host. The syntax of the string must conform to the rules specified in the class documentation.

Exceptions

URISyntaxException:: Thrown when the uriString or its canonical form is poorly formed. This exception may get encapsulated into a MonitorException in a future version.

HostIdentifier back to summary

HostIdentifier	back to summary
public HostIdentifier(String scheme, String authority, String path, String query, String fragment) throws URISyntaxException Create a HostIdentifier instance from component parts of a URI. Parameters scheme:String the `URI#getScheme` component of a URI. authority:String the `URI#getAuthority` component of a URI. path:String the `URI#getPath` component of a URI. query:String the `URI#getQuery` component of a URI. fragment:String the `URI#getFragment` component of a URI. Exceptions URISyntaxException: Thrown when the uriString or its canonical form is poorly formed. This exception may get encapsulated into a MonitorException in a future version. See Also `URI`

public HostIdentifier(String scheme, String authority, String path, String query, String fragment) throws URISyntaxException

Create a HostIdentifier instance from component parts of a URI.

Parameters

scheme:String: the URI#getScheme component of a URI.
authority:String: the URI#getAuthority component of a URI.
path:String: the URI#getPath component of a URI.
query:String: the URI#getQuery component of a URI.
fragment:String: the URI#getFragment component of a URI.

Exceptions

URISyntaxException:: Thrown when the uriString or its canonical form is poorly formed. This exception may get encapsulated into a MonitorException in a future version.

See Also

URI

HostIdentifier	back to summary
public HostIdentifier(VmIdentifier vmid) Create a HostIdentifier instance from a VmIdentifier. The necessary components of the VmIdentifier are extracted and reassembled into a HostIdentifier. If a "file:" scheme (protocol) is specified, the returned HostIdentifier will always be equivalent to HostIdentifier("file://localhost"). Parameters vmid:VmIdentifier the VmIdentifier use to construct the HostIdentifier.

HostIdentifier

back to summary

public HostIdentifier(VmIdentifier vmid)

Create a HostIdentifier instance from a VmIdentifier. The necessary components of the VmIdentifier are extracted and reassembled into a HostIdentifier. If a "file:" scheme (protocol) is specified, the returned HostIdentifier will always be equivalent to HostIdentifier("file://localhost").

Parameters

vmid:VmIdentifier: the VmIdentifier use to construct the HostIdentifier.

Method Detail

canonicalize	back to summary
private URI canonicalize(String uriString) throws URISyntaxException creates a canonical representation of the uriString. This method performs certain translations depending on the type of URI generated by the string.

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Test for quality with other objects. Parameters object:Object the object to be test for equality. Returns:boolean boolean - returns true if the given object is of type HostIdentifier and its URI field is equal to this object's URI field. Otherwise, returns false. See Also `URI#equals(Object)`

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Test for quality with other objects.

Parameters

object:Object: the object to be test for equality.

Returns:boolean

boolean - returns true if the given object is of type HostIdentifier and its URI field is equal to this object's URI field. Otherwise, returns false.

See Also

URI#equals(Object)

getFragment back to summary

getFragment	back to summary
public String getFragment() Return the Fragment part of this HostIdentifier. Returns:String String - the fragment part for this HostIdentifier. See Also `URI#getFragment()`

public String getFragment()

Return the Fragment part of this HostIdentifier.

Returns:String: String - the fragment part for this HostIdentifier.
See Also: URI#getFragment()

getHost back to summary

getHost	back to summary
public String getHost() Return the Host part of this HostIdentifier. Returns:String String - the host part for this HostIdentifier, or "localhost" if the URI.getHost() returns null. See Also `URI#getUserInfo()`

public String getHost()

Return the Host part of this HostIdentifier.

Returns:String: String - the host part for this HostIdentifier, or "localhost" if the URI.getHost() returns null.
See Also: URI#getUserInfo()

getPath back to summary

getPath	back to summary
public String getPath() Return the Path part of this HostIdentifier. Returns:String String - the path part for this HostIdentifier. See Also `URI#getPath()`

public String getPath()

Return the Path part of this HostIdentifier.

Returns:String: String - the path part for this HostIdentifier.
See Also: URI#getPath()

getPort back to summary

getPort	back to summary
public int getPort() Return the Port for of this HostIdentifier. Returns:int String - the port for this HostIdentifier See Also `URI#getPort()`

public int getPort()

Return the Port for of this HostIdentifier.

Returns:int: String - the port for this HostIdentifier
See Also: URI#getPort()

getQuery back to summary

getQuery	back to summary
public String getQuery() Return the Query part of this HostIdentifier. Returns:String String - the query part for this HostIdentifier. See Also `URI#getQuery()`

public String getQuery()

Return the Query part of this HostIdentifier.

Returns:String: String - the query part for this HostIdentifier.
See Also: URI#getQuery()

getScheme back to summary

getScheme	back to summary
public String getScheme() Return the Scheme, or protocol, portion of this HostIdentifier. Returns:String String - the scheme for this HostIdentifier. See Also `URI#getScheme()`

public String getScheme()

Return the Scheme, or protocol, portion of this HostIdentifier.

Returns:String: String - the scheme for this HostIdentifier.
See Also: URI#getScheme()

getSchemeSpecificPart back to summary

getSchemeSpecificPart	back to summary
public String getSchemeSpecificPart() Return the Scheme Specific Part of this HostIdentifier. Returns:String String - the scheme specific part for this HostIdentifier. See Also `URI#getSchemeSpecificPart()`

public String getSchemeSpecificPart()

Return the Scheme Specific Part of this HostIdentifier.

Returns:String: String - the scheme specific part for this HostIdentifier.
See Also: URI#getSchemeSpecificPart()

getURI back to summary

getURI	back to summary
public URI getURI() Return the URI associated with the HostIdentifier. Returns:URI URI - the URI. See Also `URI`

public URI getURI()

Return the URI associated with the HostIdentifier.

Returns:URI: URI - the URI.
See Also: URI

getUserInfo back to summary

getUserInfo	back to summary
public String getUserInfo() Return the User Info part of this HostIdentifier. Returns:String String - the user info part for this HostIdentifier. See Also `URI#getUserInfo()`

public String getUserInfo()

Return the User Info part of this HostIdentifier.

Returns:String: String - the user info part for this HostIdentifier.
See Also: URI#getUserInfo()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Return the hash code for this HostIdentifier. The hash code is identical to the hash code for the contained URI. Returns:int int - the hashcode. See Also `URI#hashCode()`

public int hashCode()

Overrides java.lang.Object.hashCode.

Return the hash code for this HostIdentifier. The hash code is identical to the hash code for the contained URI.

Returns:int: int - the hashcode.
See Also: URI#hashCode()

resolve	back to summary
public VmIdentifier resolve(VmIdentifier vmid) throws URISyntaxException, MonitorException Resolve a VmIdentifier with this HostIdentifier. A VmIdentifier, such as 1234 or 1234@hostname or any other string that omits certain components of the URI string may be valid, but is certainly incomplete. They are missing critical information for identifying the the communications protocol, target host, or other parameters. A VmIdentifier of this form is considered unresolved. This method uses components of the HostIdentifier to resolve the missing components of the VmIdentifier. Specified components of the unresolved VmIdentifier take precedence over their HostIdentifier counterparts. For example, if the VmIdentifier indicates 1234@hostname:2099 and the HostIdentifier indicates rmi://hostname:1099/, then the resolved VmIdentifier will be rmi://1234@hostname:2099. Any component not explicitly specified or assumed by the HostIdentifier, will remain unresolved in resolved VmIdentifier. A VmIdentifier specifying a file: scheme (protocol), is not changed in any way by this method. Parameters vmid:VmIdentifier the unresolved VmIdentifier. Returns:VmIdentifier VmIdentifier - the resolved VmIdentifier. If vmid was resolved on entry to this method, then the returned VmIdentifier will be equal, but not identical, to vmid.

resolve

back to summary

public VmIdentifier resolve(VmIdentifier vmid) throws URISyntaxException, MonitorException

Resolve a VmIdentifier with this HostIdentifier. A VmIdentifier, such as 1234 or 1234@hostname or any other string that omits certain components of the URI string may be valid, but is certainly incomplete. They are missing critical information for identifying the the communications protocol, target host, or other parameters. A VmIdentifier of this form is considered unresolved. This method uses components of the HostIdentifier to resolve the missing components of the VmIdentifier.

Specified components of the unresolved VmIdentifier take precedence over their HostIdentifier counterparts. For example, if the VmIdentifier indicates 1234@hostname:2099 and the HostIdentifier indicates rmi://hostname:1099/, then the resolved VmIdentifier will be rmi://1234@hostname:2099. Any component not explicitly specified or assumed by the HostIdentifier, will remain unresolved in resolved VmIdentifier.

A VmIdentifier specifying a file: scheme (protocol), is not changed in any way by this method.

Parameters

vmid:VmIdentifier: the unresolved VmIdentifier.

Returns:VmIdentifier

VmIdentifier - the resolved VmIdentifier. If vmid was resolved on entry to this method, then the returned VmIdentifier will be equal, but not identical, to vmid.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Convert to a string representation. Conversion is identical to calling getURI().toString(). This may change in a future release. Returns:String String - a String representation of the HostIdentifier. See Also `URI#toString()`

public String toString()

Overrides java.lang.Object.toString.

Convert to a string representation. Conversion is identical to calling getURI().toString(). This may change in a future release.

Returns:String: String - a String representation of the HostIdentifier.
See Also: URI#toString()

public Class HostIdentifier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail