JMXServiceURL JDK 1.6)

Description

public class JMXServiceURL

The address of a JMX API connector server.

The address of a JMX API connector server. Instances of this class are immutable.

The address is an Abstract Service URL for SLP, as defined in RFC 2609 and amended by RFC 3111. It must look like this:

service:jmx:protocol:sap

Here, protocol is the transport protocol to be used to connect to the connector server. It is a string of one or more ASCII characters, each of which is a letter, a digit, or one of the characters + or -. The first character must be a letter. Uppercase letters are converted into lowercase ones.

sap is the address at which the connector server is found. This address uses a subset of the syntax defined by RFC 2609 for IP-based protocols. It is a subset because the user@host syntax is not supported.

The other syntaxes defined by RFC 2609 are not currently supported by this class.

The supported syntax is:

//[host[:port]][url-path]

Square brackets [] indicate optional parts of the address. Not all protocols will recognize all optional parts.

The host is a host name, an IPv4 numeric host address, or an IPv6 numeric address enclosed in square brackets.

The port is a decimal port number. 0 means a default or anonymous port, depending on the protocol.

The host and port can be omitted. The port cannot be supplied without a host.

The url-path, if any, begins with a slash (/) or a semicolon (;) and continues to the end of the address. It can contain attributes using the semicolon syntax specified in RFC 2609. Those attributes are not parsed by this class and incorrect attribute syntax is not detected.

Although it is legal according to RFC 2609 to have a url-path that begins with a semicolon, not all implementations of SLP allow it, so it is recommended to avoid that syntax.

Case is not significant in the initial service:jmx:protocol string or in the host part of the address. Depending on the protocol, case can be significant in the url-path.

See also: RFC 2609, "Service Templates and Service: Schemes" RFC 3111, "Service Location Protocol Modifications for IPv6"

Constructors

public JMXServiceURL (String serviceURL) throws MalformedURLException

Constructs a JMXServiceURL by parsing a Service URL string.

Parameters:
- serviceURL - the URL string to be parsed.
Throws:
- NullPointerException - if serviceURL is null.
- MalformedURLException - if serviceURL does not conform to the syntax for an Abstract Service URL or if it is not a valid name for a JMX Remote API service. A JMXServiceURL must begin with the string "service:jmx:" (case-insensitive). It must not contain any characters that are not printable ASCII characters.

public JMXServiceURL (String protocol, String host, int port) throws MalformedURLException

Constructs a JMXServiceURL with the given protocol, host, and port.

Constructs a JMXServiceURL with the given protocol, host, and port. This constructor is equivalent to JMXServiceURL(protocol, host, port, null).

Parameters:
- protocol - the protocol part of the URL. If null, defaults to jmxmp.
- host - the host part of the URL. If null, defaults to the local host name, as determined by InetAddress.getLocalHost().getHostName(). If it is a numeric IPv6 address, it can optionally be enclosed in square brackets [].
- port - the port part of the URL.
Throws:
- MalformedURLException - if one of the parts is syntactically incorrect, or if host is null and it is not possible to find the local host name, or if port is negative.

public JMXServiceURL (String protocol, String host, int port, String urlPath) throws MalformedURLException

Constructs a JMXServiceURL with the given parts.

Methods

Hide/Show inherited methods

public boolean equals (Object obj)

Indicates whether some other object is equal to this one.

public String getHost ()

The host part of the Service URL.

public int getPort ()

The port of the Service URL.

public String getProtocol ()

The protocol part of the Service URL.

public String getURLPath ()

The URL Path part of the Service URL.

public int hashCode ()

public String toString ()

The string representation of this Service URL.