com.jrockit.mc.rjmx
Interface IConnectionDescriptor

public interface IConnectionDescriptor

An IConnectionDescriptor describes a connection. It encapsulates the knowledge for how to connect to another JVM. The connection information is immutable and will not change. The extended properties collection is a set of application specific flags that will be persisted with the connection. It is free to use and change at the application's discretion. If you need to use the extended properties, please note that the key namespace com.jrockit.* is reserved for JRPG applications. The IConnectionDescriptor may opt to resolve its JMXServiceURL lazily.

Author:

Marcus Hirt

Method Summary

javax.management.remote.JMXServiceURL	createJMXServiceURL() Returns a JMXServiceURL based on the settings in the IConnectionDescriptor.
java.util.Map	getEnvironment() Returns the JMX environment.
java.util.Map	getExtendedProperties() Returns user data.
java.lang.String	getGUID() Returns the unique ID for this connection.
java.lang.String	getName() This is the symbolic name for this IConnectionDescriptor.

Method Detail

getName

java.lang.String getName()

This is the symbolic name for this IConnectionDescriptor. The following, often contradictory recommendations should be kept in mind:

• Try keeping the symbolic name short. It will be the name the users recognize and refer to the IConnectionDescriptor by.
• Try keeping the symbolic name unique. If you want to provide it to the DescriptorRepository so that it can be used by the different JRMC tools, this will be enforced.

Returns:

the symbolic name for this IConnectionDescriptor.

getGUID

java.lang.String getGUID()

Returns the unique ID for this connection.

Returns:

the globally unique ID for this connector.

createJMXServiceURL

javax.management.remote.JMXServiceURL createJMXServiceURL()
                                                          throws java.io.IOException

Returns a JMXServiceURL based on the settings in the IConnectionDescriptor. Some implementations may want to just return a pre-configured JMXServiceURL, whilst others may want to resolve the JMXService URL lazily, as resolving the URL may be quite expensive.

Returns:

the resolved JMXServiceURL.

Throws:

java.io.IOException - since this can be created lazily, potential problems whilst resolving the ServiceURL can throw IOException.

getEnvironment

java.util.Map getEnvironment()

Returns the JMX environment.

Returns:

the JMX environment. Usually contains credentials and similar.

getExtendedProperties

java.util.Map getExtendedProperties()

Returns user data.

Returns:

user data. Hints and pre-calculated values usable by different parts of Mission Control.