| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
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.
jmx.remote.protocol.provider.pkgs
exists, then its value
is the 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:
ClassNotFoundException
, 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.
Field Summary | |
---|---|
static String |
DEFAULT_CLASS_LOADER
Name of the attribute that specifies the default class loader. |
static String |
DEFAULT_CLASS_LOADER_NAME
Name of the attribute that specifies the default class loader MBean name. |
static String |
PROTOCOL_PROVIDER_CLASS_LOADER
Name of the attribute that specifies the class loader for loading protocol providers. |
static String |
PROTOCOL_PROVIDER_PACKAGES
Name of the attribute that specifies the provider packages that are consulted when looking for the handler for a protocol. |
Method Summary | |
---|---|
static JMXConnectorServer |
newJMXConnectorServer(JMXServiceURL serviceURL, Map environment, MBeanServer mbeanServer) Creates a connector server at the given address. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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_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}.
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 (|
).
Method Detail |
---|
public static JMXConnectorServer newJMXConnectorServer(JMXServiceURL serviceURL, Map environment, MBeanServer mbeanServer) throws IOException
Creates a connector server at the given address. The resultant server is not started until its {@link JMXConnectorServer#start() start} method is called.
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.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.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.JMXConnectorServer
representing the new
connector server. Each successful call to this method produces
a different object.IOException
- if the connector server cannot be made
because of a communication problem.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |