1 <html> |
1 <html> |
2 <head> |
2 <head> |
3 <title>JMX™ Remote API.</title> |
3 <title>JMX™ Remote API.</title> |
4 <!-- |
4 <!-- |
5 Copyright (c) 2002, 2017, Oracle and/or its affiliates. All rights reserved. |
5 Copyright (c) 2002, 2019, Oracle and/or its affiliates. All rights reserved. |
6 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
6 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
7 |
7 |
8 This code is free software; you can redistribute it and/or modify it |
8 This code is free software; you can redistribute it and/or modify it |
9 under the terms of the GNU General Public License version 2 only, as |
9 under the terms of the GNU General Public License version 2 only, as |
10 published by the Free Software Foundation. Oracle designates this |
10 published by the Free Software Foundation. Oracle designates this |
65 |
65 |
66 <p><u>Note</u>: the optional packages implementing |
66 <p><u>Note</u>: the optional packages implementing |
67 the optional part of the <em>JMX Remote API</em> |
67 the optional part of the <em>JMX Remote API</em> |
68 are not included in the <em>Java SE Platform</em> |
68 are not included in the <em>Java SE Platform</em> |
69 but are available from the <em>JMX Remote API |
69 but are available from the <em>JMX Remote API |
70 <a href="http://java.sun.com/products/JavaManagement/download.html"> |
70 <a href="https://www.oracle.com/technetwork/java/javasebusiness/downloads/java-archive-downloads-java-plat-419418.html"> |
71 Reference Implementation</a></em>.</p> |
71 Reference Implementation</a></em>.</p> |
72 |
72 |
73 |
73 |
74 <h3>Connector addresses</h3> |
74 <h2>Connector addresses</h2> |
75 |
75 |
76 <p>Typically, a connector server has an address, represented by the |
76 <p>Typically, a connector server has an address, represented by the |
77 class {@link javax.management.remote.JMXServiceURL |
77 class {@link javax.management.remote.JMXServiceURL |
78 JMXServiceURL}. An address for the RMI Connector can look |
78 JMXServiceURL}. An address for the RMI Connector can look |
79 like this:</p> |
79 like this:</p> |
90 <p>The example above shows only one form of address. |
90 <p>The example above shows only one form of address. |
91 An address for the RMI Connector can take several forms, |
91 An address for the RMI Connector can take several forms, |
92 as detailed in the documentation for the package |
92 as detailed in the documentation for the package |
93 <code>{@link javax.management.remote.rmi}</code>.</p> |
93 <code>{@link javax.management.remote.rmi}</code>.</p> |
94 |
94 |
95 <h3>Creating a connector server</h3> |
95 <h2>Creating a connector server</h2> |
96 |
96 |
97 <p>A connector server is created by constructing an instance of |
97 <p>A connector server is created by constructing an instance of |
98 a subclass of {@link |
98 a subclass of {@link |
99 javax.management.remote.JMXConnectorServer |
99 javax.management.remote.JMXConnectorServer |
100 JMXConnectorServer}. Usually, this instance is created |
100 JMXConnectorServer}. Usually, this instance is created |
106 <p>Typically, a connector server is associated with an MBean |
106 <p>Typically, a connector server is associated with an MBean |
107 server either by registering it in that MBean server, or by |
107 server either by registering it in that MBean server, or by |
108 supplying the MBean server as a parameter when creating the |
108 supplying the MBean server as a parameter when creating the |
109 connector server.</p> |
109 connector server.</p> |
110 |
110 |
111 <h3>Creating a connector client</h3> |
111 <h2>Creating a connector client</h2> |
112 |
112 |
113 <p>A connector client is usually created by supplying the |
113 <p>A connector client is usually created by supplying the |
114 <code>JMXServiceURL</code> of the connector server to connect to |
114 <code>JMXServiceURL</code> of the connector server to connect to |
115 to the {@link |
115 to the {@link |
116 javax.management.remote.JMXConnectorFactory#connect(JMXServiceURL) |
116 javax.management.remote.JMXConnectorFactory#connect(JMXServiceURL) |
121 javax.management.remote.JMXConnector JMXConnector} interface, |
121 javax.management.remote.JMXConnector JMXConnector} interface, |
122 for example the class {@link |
122 for example the class {@link |
123 javax.management.remote.rmi.RMIConnector |
123 javax.management.remote.rmi.RMIConnector |
124 RMIConnector}.</p> |
124 RMIConnector}.</p> |
125 |
125 |
126 <h3>Additional client or server parameters</h3> |
126 <h2>Additional client or server parameters</h2> |
127 |
127 |
128 <p>When creating a connector client or server, it is possible to |
128 <p>When creating a connector client or server, it is possible to |
129 supply an object of type {@link java.util.Map Map} that defines |
129 supply an object of type {@link java.util.Map Map} that defines |
130 additional parameters. Each entry in this Map has a key that is |
130 additional parameters. Each entry in this Map has a key that is |
131 a string and an associated value whose type is appropriate for |
131 a string and an associated value whose type is appropriate for |
132 that key. The standard keys defined by the JMX Remote API all |
132 that key. The standard keys defined by the JMX Remote API all |
133 begin with the string "<code>jmx.remote.</code>". The document |
133 begin with the string "<code>jmx.remote.</code>". The document |
134 <em>JMX Remote API</em> lists these standard keys.</p> |
134 <em>JMX Remote API</em> lists these standard keys.</p> |
135 |
135 |
136 <h3>Connection identifiers</h3> |
136 <h2>Connection identifiers</h2> |
137 |
137 |
138 <p>Every connection opened by a connector server has a string |
138 <p>Every connection opened by a connector server has a string |
139 identifier, called its <b>connection id</b>. This identifier |
139 identifier, called its <b>connection id</b>. This identifier |
140 appears in the {@link |
140 appears in the {@link |
141 javax.management.remote.JMXConnectionNotification |
141 javax.management.remote.JMXConnectionNotification |