File Doc Category Size Date Package
JMXConnectorServerFactory.java API Doc Java SE 6 API 13854 Tue Jun 10 00:26:18 BST 2008 javax.management.remote

JMXConnectorServerFactory

java.lang.Object

public class JMXConnectorServerFactory extends Object

Factory to create JMX API connector servers. There are no instances of this class.

Each connector server is created by an instance of {@link JMXConnectorServerProvider}. This instance is found as follows. Suppose the given {@link JMXServiceURL} looks like "service:jmx:protocol:remainder". Then the factory will attempt to find the appropriate {@link JMXConnectorServerProvider} for protocol. Each occurrence of the character + or - in protocol is replaced by . or _, respectively.

A provider package list is searched for as follows:

If the environment parameter to {@link #newJMXConnectorServer(JMXServiceURL,Map,MBeanServer) newJMXConnectorServer} contains the key jmx.remote.protocol.provider.pkgs then the associated value is the provider package list.
Otherwise, if the system property jmx.remote.protocol.provider.pkgs exists, then its value is the provider package list.
Otherwise, there is no provider package list.

The provider package list is a string that is interpreted as a list of non-empty Java package names separated by vertical bars (|). If the string is empty, then so is the provider package list. If the provider package list is not a String, or if it contains an element that is an empty string, a {@link JMXProviderException} is thrown.

If the provider package list exists and is not empty, then for each element pkg of the list, the factory will attempt to load the class

pkg.protocol.ServerProvider

If the environment parameter to {@link #newJMXConnectorServer(JMXServiceURL, Map, MBeanServer) newJMXConnectorServer} contains the key jmx.remote.protocol.provider.class.loader then the associated value is the class loader to use to load the provider. If the associated value is not an instance of {@link java.lang.ClassLoader}, an {@link java.lang.IllegalArgumentException} is thrown.

If the jmx.remote.protocol.provider.class.loader key is not present in the environment parameter, the calling thread's context class loader is used.

If the attempt to load this class produces a {@link ClassNotFoundException}, the search for a handler continues with the next element of the list.

Otherwise, a problem with the provider found is signalled by a {@link JMXProviderException} whose {@link JMXProviderException#getCause() cause} indicates the underlying exception, as follows:

if the attempt to load the class produces an exception other than ClassNotFoundException, that is the cause;
if {@link Class#newInstance()} for the class produces an exception, that is the cause.

If no provider is found by the above steps, including the default case where there is no provider package list, then the implementation will use its own provider for protocol, or it will throw a MalformedURLException if there is none. An implementation may choose to find providers by other means. For example, it may support the JAR conventions for service providers, where the service interface is JMXConnectorServerProvider.

Every implementation must support the RMI connector protocols, specified with the string rmi or iiop.

Once a provider is found, the result of the newJMXConnectorServer method is the result of calling {@link JMXConnectorServerProvider#newJMXConnectorServer(JMXServiceURL, Map, MBeanServer) newJMXConnectorServer} on the provider.

The Map parameter passed to the JMXConnectorServerProvider is a new read-only Map that contains all the entries that were in the environment parameter to {@link #newJMXConnectorServer(JMXServiceURL,Map,MBeanServer) JMXConnectorServerFactory.newJMXConnectorServer}, if there was one. Additionally, if the jmx.remote.protocol.provider.class.loader key is not present in the environment parameter, it is added to the new read-only Map. The associated value is the calling thread's context class loader.

since: 1.5
since.unbundled: 1.0

Fields Summary
public static final String
DEFAULT_CLASS_LOADER
Name of the attribute that specifies the default class loader. This class loader is used to deserialize objects in requests received from the client, possibly after consulting an MBean-specific class loader. The value associated with this attribute is an instance of {@link ClassLoader}.
public static final String
DEFAULT_CLASS_LOADER_NAME
Name of the attribute that specifies the default class loader MBean name. This class loader is used to deserialize objects in requests received from the client, possibly after consulting an MBean-specific class loader. The value associated with this attribute is an instance of {@link ObjectName}.
public static final String
PROTOCOL_PROVIDER_PACKAGES
Name of the attribute that specifies the provider packages that are consulted when looking for the handler for a protocol. The value associated with this attribute is a string with package names separated by vertical bars (|).
public static final String
PROTOCOL_PROVIDER_CLASS_LOADER
Name of the attribute that specifies the class loader for loading protocol providers. The value associated with this attribute is an instance of {@link ClassLoader}.
private static final String
PROTOCOL_PROVIDER_DEFAULT_PACKAGE
private static final ClassLogger
logger
Constructors Summary
private JMXConnectorServerFactory()
There are no instances of this class.
Methods Summary
private static javax.management.remote.JMXConnectorServer getConnectorServerAsService(java.lang.ClassLoader loader, javax.management.remote.JMXServiceURL url, java.util.Map map, javax.management.MBeanServer mbs)
Iterator providers = JMXConnectorFactory.getProviderIterator( JMXConnectorServerProvider.class, loader); JMXConnectorServerProvider provider = null; JMXConnectorServer connection = null; IOException exception = null; while (providers.hasNext()) { provider = (JMXConnectorServerProvider) providers.next(); try { connection = provider.newJMXConnectorServer(url, map, mbs); return connection; } catch (JMXProviderException e) { throw e; } catch (Exception e) { if (logger.traceOn()) logger.trace("getConnectorAsService", "URL[" + url + "] Service provider exception: " + e); if (!(e instanceof MalformedURLException)) { if (exception == null) { if (exception instanceof IOException) { exception = (IOException) e; } else { exception = EnvHelp.initCause( new IOException(e.getMessage()), e); } } } continue; } } if (exception == null) return null; else throw exception;
public static javax.management.remote.JMXConnectorServer newJMXConnectorServer(javax.management.remote.JMXServiceURL serviceURL, java.util.Map environment, javax.management.MBeanServer mbeanServer)
Creates a connector server at the given address. The resultant server is not started until its {@link JMXConnectorServer#start() start} method is called.
param
serviceURL the address of the new connector server. The actual address of the new connector server, as returned by its {@link JMXConnectorServer#getAddress() getAddress} method, will not necessarily be exactly the same. For example, it might include a port number if the original address did not.
param
environment a set of attributes to control the new connector server's behavior. This parameter can be null. Keys in this map must be Strings. The appropriate type of each associated value depends on the attribute. The contents of environment are not changed by this call.
param
mbeanServer the MBean server that this connector server is attached to. Null if this connector server will be attached to an MBean server by being registered in it.
return
a JMXConnectorServer representing the new connector server. Each successful call to this method produces a different object.
exception
NullPointerException if serviceURL is null.
exception
IOException if the connector server cannot be made because of a communication problem.
exception
MalformedURLException if there is no provider for the protocol in serviceURL.
exception
JMXProviderException if there is a provider for the protocol in serviceURL but it cannot be used for some reason.
if (environment == null) environment = new HashMap(); else { EnvHelp.checkAttributes(environment); environment = new HashMap(environment); } final Class targetInterface = JMXConnectorServerProvider.class; final ClassLoader loader = JMXConnectorFactory.resolveClassLoader(environment); final String protocol = serviceURL.getProtocol(); final String providerClassName = "ServerProvider"; JMXConnectorServerProvider provider = (JMXConnectorServerProvider) JMXConnectorFactory.getProvider(serviceURL, environment, providerClassName, targetInterface, loader); IOException exception = null; if (provider == null) { // Loader is null when context class loader is set to null // and no loader has been provided in map. // com.sun.jmx.remote.util.Service class extracted from j2se // provider search algorithm doesn't handle well null classloader. if (loader != null) { try { JMXConnectorServer connection = getConnectorServerAsService(loader, serviceURL, environment, mbeanServer); if (connection != null) return connection; } catch (JMXProviderException e) { throw e; } catch (IOException e) { exception = e; } } provider = (JMXConnectorServerProvider) JMXConnectorFactory.getProvider( protocol, PROTOCOL_PROVIDER_DEFAULT_PACKAGE, JMXConnectorFactory.class.getClassLoader(), providerClassName, targetInterface); } if (provider == null) { MalformedURLException e = new MalformedURLException("Unsupported protocol: " + protocol); if (exception == null) { throw e; } else { throw EnvHelp.initCause(e, exception); } } environment = Collections.unmodifiableMap(environment); return provider.newJMXConnectorServer(serviceURL, environment, mbeanServer);