1 *java.lang.management.ManagementFactory* *ManagementFactory* The ManagementFacto
3 public class ManagementFactory
4 extends |java.lang.Object|
6 |java.lang.management.ManagementFactory_Description|
7 |java.lang.management.ManagementFactory_Fields|
8 |java.lang.management.ManagementFactory_Constructors|
9 |java.lang.management.ManagementFactory_Methods|
11 ================================================================================
13 *java.lang.management.ManagementFactory_Fields*
14 |java.lang.String_java.lang.management.ManagementFactory.CLASS_LOADING_MXBEAN_NAME|
15 |java.lang.String_java.lang.management.ManagementFactory.COMPILATION_MXBEAN_NAME|
16 |java.lang.String_java.lang.management.ManagementFactory.GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE|
17 |java.lang.String_java.lang.management.ManagementFactory.MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE|
18 |java.lang.String_java.lang.management.ManagementFactory.MEMORY_MXBEAN_NAME|
19 |java.lang.String_java.lang.management.ManagementFactory.MEMORY_POOL_MXBEAN_DOMAIN_TYPE|
20 |java.lang.String_java.lang.management.ManagementFactory.OPERATING_SYSTEM_MXBEAN_NAME|
21 |java.lang.String_java.lang.management.ManagementFactory.RUNTIME_MXBEAN_NAME|
22 |java.lang.String_java.lang.management.ManagementFactory.THREAD_MXBEAN_NAME|
24 *java.lang.management.ManagementFactory_Methods*
25 |java.lang.management.ManagementFactory.getClassLoadingMXBean()|Returns the man
26 |java.lang.management.ManagementFactory.getCompilationMXBean()|Returns the mana
27 |java.lang.management.ManagementFactory.getGarbageCollectorMXBeans()|Returns a
28 |java.lang.management.ManagementFactory.getMemoryManagerMXBeans()|Returns a lis
29 |java.lang.management.ManagementFactory.getMemoryMXBean()|Returns the managed b
30 |java.lang.management.ManagementFactory.getMemoryPoolMXBeans()|Returns a list o
31 |java.lang.management.ManagementFactory.getOperatingSystemMXBean()|Returns the
32 |java.lang.management.ManagementFactory.getPlatformMBeanServer()|Returns the pl
33 |java.lang.management.ManagementFactory.getRuntimeMXBean()|Returns the managed
34 |java.lang.management.ManagementFactory.getThreadMXBean()|Returns the managed b
35 |java.lang.management.ManagementFactory.newPlatformMXBeanProxy(MBeanServerConnection,String,Class)|
37 *java.lang.management.ManagementFactory_Description*
39 The ManagementFactory class is a factory class for getting managed beans for
40 the Java platform. This class consists of static methods each of which returns
41 one or more platform MXBean(s) representing the management interface of a
42 component of the Java virtual machine.
44 An application can access a platform MXBean in the following ways:
46 Direct access to an MXBean interface
48 Get the MXBean instance through the static factory method and access the MXBean
49 locally of the running virtual machine.
51 Construct an MXBean proxy instance that forwards the method calls to a given
52 MBeanServer(|javax.management.MBeanServer|) by calling
53 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
54 typically constructed to remotely access an MXBean of another running virtual
57 Indirect access to an MXBean interface via MBeanServer
59 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
60 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
61 remotely. The attributes and operations of an MXBean use only JMX open types
62 which include basic data types,
63 CompositeData(|javax.management.openmbean.CompositeData|) , and
64 TabularData(|javax.management.openmbean.TabularData|) defined in
65 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
70 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
71 Instrumentation Specification and only uses a set of basic data types described
72 below. A JMX management application and the platform MBeanServer can
73 interoperate without requiring classes for MXBean specific data types. The data
74 types being transmitted between the JMX connector server and the connector
75 client are open types(|javax.management.openmbean.OpenType|) and this allows
76 interoperation across versions.
78 The platform MXBean interfaces use only the following data types:
80 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
81 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
82 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
83 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
84 define a static from method with a
85 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
86 from an input CompositeData to an instance of that class
88 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
89 an enum class, or a class supporting conversion from a CompositeData to its
92 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
93 class, an enum class, or a class supporting conversion from a CompositeData to
98 When an attribute or operation of a platform MXBean is accessed via an
99 MBeanServer, the data types are mapped as follows:
101 A primitive type or a wrapper class is mapped to the same type.
103 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
104 constant. A class that defines only getter methods and a static from method
105 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
106 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
108 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
109 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
110 with two items whose names are "key" and "value" and the item types are the
111 corresponding mapped type of K and V respectively and the "key" is the index.
113 List<E> is mapped to an array with the mapped type of E as the element type.
115 An array of element type E is mapped to an array of the same dimenions with the
116 mapped type of E as the element type.
118 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
119 data types of the attributes and operations as primitive or open types mapped
122 For example, the (|java.lang.management.MemoryMXBean|) interface has the
123 following getter and setter methods:
127 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
128 void setVerbose(boolean value);
130 These attributes in the MBeanInfo of the MemoryMXBean have the following names
137 HeapMemoryUsage CompositeData representing
138 MemoryUsage(|java.lang.management.MemoryUsage|)
144 Implementation Note: The mapping specified above could be done in the
145 implementation of each platform MXBean. One good implementation choice is to
146 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
148 MXBean Names Each platform MXBean for a Java virtual machine has a unique
149 ObjectName(|javax.management.ObjectName|) for registration in the platform
150 MBeanServer. A Java virtual machine has a single instance of the following
151 management interfaces:
155 Management Interface ObjectName
157 (|java.lang.management.ClassLoadingMXBean|)
158 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
160 (|java.lang.management.MemoryMXBean|)
161 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
163 (|java.lang.management.ThreadMXBean|)
164 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
166 (|java.lang.management.RuntimeMXBean|)
167 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
169 (|java.lang.management.OperatingSystemMXBean|)
170 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
175 A Java virtual machine has zero or a single instance of the following
176 management interfaces.
180 Management Interface ObjectName
182 (|java.lang.management.CompilationMXBean|)
183 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
187 A Java virtual machine may have one or more instances of the following
188 management interfaces.
192 Management Interface ObjectName
194 (|java.lang.management.GarbageCollectorMXBean|)
195 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
196 ,name=collector's name
198 (|java.lang.management.MemoryManagerMXBean|)
199 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
202 (|java.lang.management.MemoryPoolMXBean|)
203 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
209 *java.lang.String_java.lang.management.ManagementFactory.CLASS_LOADING_MXBEAN_NAME*
211 The ManagementFactory class is a factory class for getting managed beans for
212 the Java platform. This class consists of static methods each of which returns
213 one or more platform MXBean(s) representing the management interface of a
214 component of the Java virtual machine.
216 An application can access a platform MXBean in the following ways:
218 Direct access to an MXBean interface
220 Get the MXBean instance through the static factory method and access the MXBean
221 locally of the running virtual machine.
223 Construct an MXBean proxy instance that forwards the method calls to a given
224 MBeanServer(|javax.management.MBeanServer|) by calling
225 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
226 typically constructed to remotely access an MXBean of another running virtual
229 Indirect access to an MXBean interface via MBeanServer
231 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
232 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
233 remotely. The attributes and operations of an MXBean use only JMX open types
234 which include basic data types,
235 CompositeData(|javax.management.openmbean.CompositeData|) , and
236 TabularData(|javax.management.openmbean.TabularData|) defined in
237 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
242 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
243 Instrumentation Specification and only uses a set of basic data types described
244 below. A JMX management application and the platform MBeanServer can
245 interoperate without requiring classes for MXBean specific data types. The data
246 types being transmitted between the JMX connector server and the connector
247 client are open types(|javax.management.openmbean.OpenType|) and this allows
248 interoperation across versions.
250 The platform MXBean interfaces use only the following data types:
252 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
253 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
254 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
255 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
256 define a static from method with a
257 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
258 from an input CompositeData to an instance of that class
260 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
261 an enum class, or a class supporting conversion from a CompositeData to its
264 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
265 class, an enum class, or a class supporting conversion from a CompositeData to
270 When an attribute or operation of a platform MXBean is accessed via an
271 MBeanServer, the data types are mapped as follows:
273 A primitive type or a wrapper class is mapped to the same type.
275 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
276 constant. A class that defines only getter methods and a static from method
277 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
278 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
280 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
281 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
282 with two items whose names are "key" and "value" and the item types are the
283 corresponding mapped type of K and V respectively and the "key" is the index.
285 List<E> is mapped to an array with the mapped type of E as the element type.
287 An array of element type E is mapped to an array of the same dimenions with the
288 mapped type of E as the element type.
290 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
291 data types of the attributes and operations as primitive or open types mapped
294 For example, the (|java.lang.management.MemoryMXBean|) interface has the
295 following getter and setter methods:
299 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
300 void setVerbose(boolean value);
302 These attributes in the MBeanInfo of the MemoryMXBean have the following names
309 HeapMemoryUsage CompositeData representing
310 MemoryUsage(|java.lang.management.MemoryUsage|)
316 Implementation Note: The mapping specified above could be done in the
317 implementation of each platform MXBean. One good implementation choice is to
318 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
320 MXBean Names Each platform MXBean for a Java virtual machine has a unique
321 ObjectName(|javax.management.ObjectName|) for registration in the platform
322 MBeanServer. A Java virtual machine has a single instance of the following
323 management interfaces:
327 Management Interface ObjectName
329 (|java.lang.management.ClassLoadingMXBean|)
330 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
332 (|java.lang.management.MemoryMXBean|)
333 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
335 (|java.lang.management.ThreadMXBean|)
336 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
338 (|java.lang.management.RuntimeMXBean|)
339 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
341 (|java.lang.management.OperatingSystemMXBean|)
342 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
347 A Java virtual machine has zero or a single instance of the following
348 management interfaces.
352 Management Interface ObjectName
354 (|java.lang.management.CompilationMXBean|)
355 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
359 A Java virtual machine may have one or more instances of the following
360 management interfaces.
364 Management Interface ObjectName
366 (|java.lang.management.GarbageCollectorMXBean|)
367 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
368 ,name=collector's name
370 (|java.lang.management.MemoryManagerMXBean|)
371 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
374 (|java.lang.management.MemoryPoolMXBean|)
375 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
381 *java.lang.String_java.lang.management.ManagementFactory.COMPILATION_MXBEAN_NAME*
383 The ManagementFactory class is a factory class for getting managed beans for
384 the Java platform. This class consists of static methods each of which returns
385 one or more platform MXBean(s) representing the management interface of a
386 component of the Java virtual machine.
388 An application can access a platform MXBean in the following ways:
390 Direct access to an MXBean interface
392 Get the MXBean instance through the static factory method and access the MXBean
393 locally of the running virtual machine.
395 Construct an MXBean proxy instance that forwards the method calls to a given
396 MBeanServer(|javax.management.MBeanServer|) by calling
397 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
398 typically constructed to remotely access an MXBean of another running virtual
401 Indirect access to an MXBean interface via MBeanServer
403 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
404 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
405 remotely. The attributes and operations of an MXBean use only JMX open types
406 which include basic data types,
407 CompositeData(|javax.management.openmbean.CompositeData|) , and
408 TabularData(|javax.management.openmbean.TabularData|) defined in
409 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
414 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
415 Instrumentation Specification and only uses a set of basic data types described
416 below. A JMX management application and the platform MBeanServer can
417 interoperate without requiring classes for MXBean specific data types. The data
418 types being transmitted between the JMX connector server and the connector
419 client are open types(|javax.management.openmbean.OpenType|) and this allows
420 interoperation across versions.
422 The platform MXBean interfaces use only the following data types:
424 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
425 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
426 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
427 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
428 define a static from method with a
429 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
430 from an input CompositeData to an instance of that class
432 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
433 an enum class, or a class supporting conversion from a CompositeData to its
436 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
437 class, an enum class, or a class supporting conversion from a CompositeData to
442 When an attribute or operation of a platform MXBean is accessed via an
443 MBeanServer, the data types are mapped as follows:
445 A primitive type or a wrapper class is mapped to the same type.
447 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
448 constant. A class that defines only getter methods and a static from method
449 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
450 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
452 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
453 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
454 with two items whose names are "key" and "value" and the item types are the
455 corresponding mapped type of K and V respectively and the "key" is the index.
457 List<E> is mapped to an array with the mapped type of E as the element type.
459 An array of element type E is mapped to an array of the same dimenions with the
460 mapped type of E as the element type.
462 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
463 data types of the attributes and operations as primitive or open types mapped
466 For example, the (|java.lang.management.MemoryMXBean|) interface has the
467 following getter and setter methods:
471 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
472 void setVerbose(boolean value);
474 These attributes in the MBeanInfo of the MemoryMXBean have the following names
481 HeapMemoryUsage CompositeData representing
482 MemoryUsage(|java.lang.management.MemoryUsage|)
488 Implementation Note: The mapping specified above could be done in the
489 implementation of each platform MXBean. One good implementation choice is to
490 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
492 MXBean Names Each platform MXBean for a Java virtual machine has a unique
493 ObjectName(|javax.management.ObjectName|) for registration in the platform
494 MBeanServer. A Java virtual machine has a single instance of the following
495 management interfaces:
499 Management Interface ObjectName
501 (|java.lang.management.ClassLoadingMXBean|)
502 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
504 (|java.lang.management.MemoryMXBean|)
505 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
507 (|java.lang.management.ThreadMXBean|)
508 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
510 (|java.lang.management.RuntimeMXBean|)
511 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
513 (|java.lang.management.OperatingSystemMXBean|)
514 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
519 A Java virtual machine has zero or a single instance of the following
520 management interfaces.
524 Management Interface ObjectName
526 (|java.lang.management.CompilationMXBean|)
527 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
531 A Java virtual machine may have one or more instances of the following
532 management interfaces.
536 Management Interface ObjectName
538 (|java.lang.management.GarbageCollectorMXBean|)
539 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
540 ,name=collector's name
542 (|java.lang.management.MemoryManagerMXBean|)
543 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
546 (|java.lang.management.MemoryPoolMXBean|)
547 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
553 *java.lang.String_java.lang.management.ManagementFactory.GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE*
555 The ManagementFactory class is a factory class for getting managed beans for
556 the Java platform. This class consists of static methods each of which returns
557 one or more platform MXBean(s) representing the management interface of a
558 component of the Java virtual machine.
560 An application can access a platform MXBean in the following ways:
562 Direct access to an MXBean interface
564 Get the MXBean instance through the static factory method and access the MXBean
565 locally of the running virtual machine.
567 Construct an MXBean proxy instance that forwards the method calls to a given
568 MBeanServer(|javax.management.MBeanServer|) by calling
569 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
570 typically constructed to remotely access an MXBean of another running virtual
573 Indirect access to an MXBean interface via MBeanServer
575 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
576 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
577 remotely. The attributes and operations of an MXBean use only JMX open types
578 which include basic data types,
579 CompositeData(|javax.management.openmbean.CompositeData|) , and
580 TabularData(|javax.management.openmbean.TabularData|) defined in
581 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
586 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
587 Instrumentation Specification and only uses a set of basic data types described
588 below. A JMX management application and the platform MBeanServer can
589 interoperate without requiring classes for MXBean specific data types. The data
590 types being transmitted between the JMX connector server and the connector
591 client are open types(|javax.management.openmbean.OpenType|) and this allows
592 interoperation across versions.
594 The platform MXBean interfaces use only the following data types:
596 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
597 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
598 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
599 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
600 define a static from method with a
601 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
602 from an input CompositeData to an instance of that class
604 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
605 an enum class, or a class supporting conversion from a CompositeData to its
608 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
609 class, an enum class, or a class supporting conversion from a CompositeData to
614 When an attribute or operation of a platform MXBean is accessed via an
615 MBeanServer, the data types are mapped as follows:
617 A primitive type or a wrapper class is mapped to the same type.
619 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
620 constant. A class that defines only getter methods and a static from method
621 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
622 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
624 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
625 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
626 with two items whose names are "key" and "value" and the item types are the
627 corresponding mapped type of K and V respectively and the "key" is the index.
629 List<E> is mapped to an array with the mapped type of E as the element type.
631 An array of element type E is mapped to an array of the same dimenions with the
632 mapped type of E as the element type.
634 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
635 data types of the attributes and operations as primitive or open types mapped
638 For example, the (|java.lang.management.MemoryMXBean|) interface has the
639 following getter and setter methods:
643 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
644 void setVerbose(boolean value);
646 These attributes in the MBeanInfo of the MemoryMXBean have the following names
653 HeapMemoryUsage CompositeData representing
654 MemoryUsage(|java.lang.management.MemoryUsage|)
660 Implementation Note: The mapping specified above could be done in the
661 implementation of each platform MXBean. One good implementation choice is to
662 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
664 MXBean Names Each platform MXBean for a Java virtual machine has a unique
665 ObjectName(|javax.management.ObjectName|) for registration in the platform
666 MBeanServer. A Java virtual machine has a single instance of the following
667 management interfaces:
671 Management Interface ObjectName
673 (|java.lang.management.ClassLoadingMXBean|)
674 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
676 (|java.lang.management.MemoryMXBean|)
677 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
679 (|java.lang.management.ThreadMXBean|)
680 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
682 (|java.lang.management.RuntimeMXBean|)
683 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
685 (|java.lang.management.OperatingSystemMXBean|)
686 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
691 A Java virtual machine has zero or a single instance of the following
692 management interfaces.
696 Management Interface ObjectName
698 (|java.lang.management.CompilationMXBean|)
699 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
703 A Java virtual machine may have one or more instances of the following
704 management interfaces.
708 Management Interface ObjectName
710 (|java.lang.management.GarbageCollectorMXBean|)
711 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
712 ,name=collector's name
714 (|java.lang.management.MemoryManagerMXBean|)
715 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
718 (|java.lang.management.MemoryPoolMXBean|)
719 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
725 *java.lang.String_java.lang.management.ManagementFactory.MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE*
727 The ManagementFactory class is a factory class for getting managed beans for
728 the Java platform. This class consists of static methods each of which returns
729 one or more platform MXBean(s) representing the management interface of a
730 component of the Java virtual machine.
732 An application can access a platform MXBean in the following ways:
734 Direct access to an MXBean interface
736 Get the MXBean instance through the static factory method and access the MXBean
737 locally of the running virtual machine.
739 Construct an MXBean proxy instance that forwards the method calls to a given
740 MBeanServer(|javax.management.MBeanServer|) by calling
741 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
742 typically constructed to remotely access an MXBean of another running virtual
745 Indirect access to an MXBean interface via MBeanServer
747 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
748 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
749 remotely. The attributes and operations of an MXBean use only JMX open types
750 which include basic data types,
751 CompositeData(|javax.management.openmbean.CompositeData|) , and
752 TabularData(|javax.management.openmbean.TabularData|) defined in
753 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
758 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
759 Instrumentation Specification and only uses a set of basic data types described
760 below. A JMX management application and the platform MBeanServer can
761 interoperate without requiring classes for MXBean specific data types. The data
762 types being transmitted between the JMX connector server and the connector
763 client are open types(|javax.management.openmbean.OpenType|) and this allows
764 interoperation across versions.
766 The platform MXBean interfaces use only the following data types:
768 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
769 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
770 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
771 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
772 define a static from method with a
773 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
774 from an input CompositeData to an instance of that class
776 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
777 an enum class, or a class supporting conversion from a CompositeData to its
780 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
781 class, an enum class, or a class supporting conversion from a CompositeData to
786 When an attribute or operation of a platform MXBean is accessed via an
787 MBeanServer, the data types are mapped as follows:
789 A primitive type or a wrapper class is mapped to the same type.
791 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
792 constant. A class that defines only getter methods and a static from method
793 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
794 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
796 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
797 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
798 with two items whose names are "key" and "value" and the item types are the
799 corresponding mapped type of K and V respectively and the "key" is the index.
801 List<E> is mapped to an array with the mapped type of E as the element type.
803 An array of element type E is mapped to an array of the same dimenions with the
804 mapped type of E as the element type.
806 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
807 data types of the attributes and operations as primitive or open types mapped
810 For example, the (|java.lang.management.MemoryMXBean|) interface has the
811 following getter and setter methods:
815 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
816 void setVerbose(boolean value);
818 These attributes in the MBeanInfo of the MemoryMXBean have the following names
825 HeapMemoryUsage CompositeData representing
826 MemoryUsage(|java.lang.management.MemoryUsage|)
832 Implementation Note: The mapping specified above could be done in the
833 implementation of each platform MXBean. One good implementation choice is to
834 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
836 MXBean Names Each platform MXBean for a Java virtual machine has a unique
837 ObjectName(|javax.management.ObjectName|) for registration in the platform
838 MBeanServer. A Java virtual machine has a single instance of the following
839 management interfaces:
843 Management Interface ObjectName
845 (|java.lang.management.ClassLoadingMXBean|)
846 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
848 (|java.lang.management.MemoryMXBean|)
849 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
851 (|java.lang.management.ThreadMXBean|)
852 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
854 (|java.lang.management.RuntimeMXBean|)
855 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
857 (|java.lang.management.OperatingSystemMXBean|)
858 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
863 A Java virtual machine has zero or a single instance of the following
864 management interfaces.
868 Management Interface ObjectName
870 (|java.lang.management.CompilationMXBean|)
871 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
875 A Java virtual machine may have one or more instances of the following
876 management interfaces.
880 Management Interface ObjectName
882 (|java.lang.management.GarbageCollectorMXBean|)
883 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
884 ,name=collector's name
886 (|java.lang.management.MemoryManagerMXBean|)
887 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
890 (|java.lang.management.MemoryPoolMXBean|)
891 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
897 *java.lang.String_java.lang.management.ManagementFactory.MEMORY_MXBEAN_NAME*
899 The ManagementFactory class is a factory class for getting managed beans for
900 the Java platform. This class consists of static methods each of which returns
901 one or more platform MXBean(s) representing the management interface of a
902 component of the Java virtual machine.
904 An application can access a platform MXBean in the following ways:
906 Direct access to an MXBean interface
908 Get the MXBean instance through the static factory method and access the MXBean
909 locally of the running virtual machine.
911 Construct an MXBean proxy instance that forwards the method calls to a given
912 MBeanServer(|javax.management.MBeanServer|) by calling
913 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
914 typically constructed to remotely access an MXBean of another running virtual
917 Indirect access to an MXBean interface via MBeanServer
919 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
920 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
921 remotely. The attributes and operations of an MXBean use only JMX open types
922 which include basic data types,
923 CompositeData(|javax.management.openmbean.CompositeData|) , and
924 TabularData(|javax.management.openmbean.TabularData|) defined in
925 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
930 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
931 Instrumentation Specification and only uses a set of basic data types described
932 below. A JMX management application and the platform MBeanServer can
933 interoperate without requiring classes for MXBean specific data types. The data
934 types being transmitted between the JMX connector server and the connector
935 client are open types(|javax.management.openmbean.OpenType|) and this allows
936 interoperation across versions.
938 The platform MXBean interfaces use only the following data types:
940 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
941 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
942 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
943 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
944 define a static from method with a
945 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
946 from an input CompositeData to an instance of that class
948 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
949 an enum class, or a class supporting conversion from a CompositeData to its
952 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
953 class, an enum class, or a class supporting conversion from a CompositeData to
958 When an attribute or operation of a platform MXBean is accessed via an
959 MBeanServer, the data types are mapped as follows:
961 A primitive type or a wrapper class is mapped to the same type.
963 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
964 constant. A class that defines only getter methods and a static from method
965 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
966 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
968 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
969 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
970 with two items whose names are "key" and "value" and the item types are the
971 corresponding mapped type of K and V respectively and the "key" is the index.
973 List<E> is mapped to an array with the mapped type of E as the element type.
975 An array of element type E is mapped to an array of the same dimenions with the
976 mapped type of E as the element type.
978 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
979 data types of the attributes and operations as primitive or open types mapped
982 For example, the (|java.lang.management.MemoryMXBean|) interface has the
983 following getter and setter methods:
987 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
988 void setVerbose(boolean value);
990 These attributes in the MBeanInfo of the MemoryMXBean have the following names
997 HeapMemoryUsage CompositeData representing
998 MemoryUsage(|java.lang.management.MemoryUsage|)
1004 Implementation Note: The mapping specified above could be done in the
1005 implementation of each platform MXBean. One good implementation choice is to
1006 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
1008 MXBean Names Each platform MXBean for a Java virtual machine has a unique
1009 ObjectName(|javax.management.ObjectName|) for registration in the platform
1010 MBeanServer. A Java virtual machine has a single instance of the following
1011 management interfaces:
1015 Management Interface ObjectName
1017 (|java.lang.management.ClassLoadingMXBean|)
1018 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
1020 (|java.lang.management.MemoryMXBean|)
1021 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
1023 (|java.lang.management.ThreadMXBean|)
1024 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
1026 (|java.lang.management.RuntimeMXBean|)
1027 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
1029 (|java.lang.management.OperatingSystemMXBean|)
1030 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
1035 A Java virtual machine has zero or a single instance of the following
1036 management interfaces.
1040 Management Interface ObjectName
1042 (|java.lang.management.CompilationMXBean|)
1043 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
1047 A Java virtual machine may have one or more instances of the following
1048 management interfaces.
1052 Management Interface ObjectName
1054 (|java.lang.management.GarbageCollectorMXBean|)
1055 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
1056 ,name=collector's name
1058 (|java.lang.management.MemoryManagerMXBean|)
1059 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
1060 ,name=manager's name
1062 (|java.lang.management.MemoryPoolMXBean|)
1063 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
1069 *java.lang.String_java.lang.management.ManagementFactory.MEMORY_POOL_MXBEAN_DOMAIN_TYPE*
1071 The ManagementFactory class is a factory class for getting managed beans for
1072 the Java platform. This class consists of static methods each of which returns
1073 one or more platform MXBean(s) representing the management interface of a
1074 component of the Java virtual machine.
1076 An application can access a platform MXBean in the following ways:
1078 Direct access to an MXBean interface
1080 Get the MXBean instance through the static factory method and access the MXBean
1081 locally of the running virtual machine.
1083 Construct an MXBean proxy instance that forwards the method calls to a given
1084 MBeanServer(|javax.management.MBeanServer|) by calling
1085 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
1086 typically constructed to remotely access an MXBean of another running virtual
1089 Indirect access to an MXBean interface via MBeanServer
1091 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
1092 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
1093 remotely. The attributes and operations of an MXBean use only JMX open types
1094 which include basic data types,
1095 CompositeData(|javax.management.openmbean.CompositeData|) , and
1096 TabularData(|javax.management.openmbean.TabularData|) defined in
1097 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
1102 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
1103 Instrumentation Specification and only uses a set of basic data types described
1104 below. A JMX management application and the platform MBeanServer can
1105 interoperate without requiring classes for MXBean specific data types. The data
1106 types being transmitted between the JMX connector server and the connector
1107 client are open types(|javax.management.openmbean.OpenType|) and this allows
1108 interoperation across versions.
1110 The platform MXBean interfaces use only the following data types:
1112 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
1113 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
1114 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
1115 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
1116 define a static from method with a
1117 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
1118 from an input CompositeData to an instance of that class
1120 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
1121 an enum class, or a class supporting conversion from a CompositeData to its
1124 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
1125 class, an enum class, or a class supporting conversion from a CompositeData to
1130 When an attribute or operation of a platform MXBean is accessed via an
1131 MBeanServer, the data types are mapped as follows:
1133 A primitive type or a wrapper class is mapped to the same type.
1135 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
1136 constant. A class that defines only getter methods and a static from method
1137 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
1138 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
1140 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
1141 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
1142 with two items whose names are "key" and "value" and the item types are the
1143 corresponding mapped type of K and V respectively and the "key" is the index.
1145 List<E> is mapped to an array with the mapped type of E as the element type.
1147 An array of element type E is mapped to an array of the same dimenions with the
1148 mapped type of E as the element type.
1150 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
1151 data types of the attributes and operations as primitive or open types mapped
1154 For example, the (|java.lang.management.MemoryMXBean|) interface has the
1155 following getter and setter methods:
1159 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
1160 void setVerbose(boolean value);
1162 These attributes in the MBeanInfo of the MemoryMXBean have the following names
1169 HeapMemoryUsage CompositeData representing
1170 MemoryUsage(|java.lang.management.MemoryUsage|)
1176 Implementation Note: The mapping specified above could be done in the
1177 implementation of each platform MXBean. One good implementation choice is to
1178 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
1180 MXBean Names Each platform MXBean for a Java virtual machine has a unique
1181 ObjectName(|javax.management.ObjectName|) for registration in the platform
1182 MBeanServer. A Java virtual machine has a single instance of the following
1183 management interfaces:
1187 Management Interface ObjectName
1189 (|java.lang.management.ClassLoadingMXBean|)
1190 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
1192 (|java.lang.management.MemoryMXBean|)
1193 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
1195 (|java.lang.management.ThreadMXBean|)
1196 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
1198 (|java.lang.management.RuntimeMXBean|)
1199 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
1201 (|java.lang.management.OperatingSystemMXBean|)
1202 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
1207 A Java virtual machine has zero or a single instance of the following
1208 management interfaces.
1212 Management Interface ObjectName
1214 (|java.lang.management.CompilationMXBean|)
1215 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
1219 A Java virtual machine may have one or more instances of the following
1220 management interfaces.
1224 Management Interface ObjectName
1226 (|java.lang.management.GarbageCollectorMXBean|)
1227 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
1228 ,name=collector's name
1230 (|java.lang.management.MemoryManagerMXBean|)
1231 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
1232 ,name=manager's name
1234 (|java.lang.management.MemoryPoolMXBean|)
1235 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
1241 *java.lang.String_java.lang.management.ManagementFactory.OPERATING_SYSTEM_MXBEAN_NAME*
1243 The ManagementFactory class is a factory class for getting managed beans for
1244 the Java platform. This class consists of static methods each of which returns
1245 one or more platform MXBean(s) representing the management interface of a
1246 component of the Java virtual machine.
1248 An application can access a platform MXBean in the following ways:
1250 Direct access to an MXBean interface
1252 Get the MXBean instance through the static factory method and access the MXBean
1253 locally of the running virtual machine.
1255 Construct an MXBean proxy instance that forwards the method calls to a given
1256 MBeanServer(|javax.management.MBeanServer|) by calling
1257 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
1258 typically constructed to remotely access an MXBean of another running virtual
1261 Indirect access to an MXBean interface via MBeanServer
1263 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
1264 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
1265 remotely. The attributes and operations of an MXBean use only JMX open types
1266 which include basic data types,
1267 CompositeData(|javax.management.openmbean.CompositeData|) , and
1268 TabularData(|javax.management.openmbean.TabularData|) defined in
1269 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
1274 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
1275 Instrumentation Specification and only uses a set of basic data types described
1276 below. A JMX management application and the platform MBeanServer can
1277 interoperate without requiring classes for MXBean specific data types. The data
1278 types being transmitted between the JMX connector server and the connector
1279 client are open types(|javax.management.openmbean.OpenType|) and this allows
1280 interoperation across versions.
1282 The platform MXBean interfaces use only the following data types:
1284 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
1285 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
1286 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
1287 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
1288 define a static from method with a
1289 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
1290 from an input CompositeData to an instance of that class
1292 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
1293 an enum class, or a class supporting conversion from a CompositeData to its
1296 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
1297 class, an enum class, or a class supporting conversion from a CompositeData to
1302 When an attribute or operation of a platform MXBean is accessed via an
1303 MBeanServer, the data types are mapped as follows:
1305 A primitive type or a wrapper class is mapped to the same type.
1307 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
1308 constant. A class that defines only getter methods and a static from method
1309 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
1310 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
1312 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
1313 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
1314 with two items whose names are "key" and "value" and the item types are the
1315 corresponding mapped type of K and V respectively and the "key" is the index.
1317 List<E> is mapped to an array with the mapped type of E as the element type.
1319 An array of element type E is mapped to an array of the same dimenions with the
1320 mapped type of E as the element type.
1322 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
1323 data types of the attributes and operations as primitive or open types mapped
1326 For example, the (|java.lang.management.MemoryMXBean|) interface has the
1327 following getter and setter methods:
1331 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
1332 void setVerbose(boolean value);
1334 These attributes in the MBeanInfo of the MemoryMXBean have the following names
1341 HeapMemoryUsage CompositeData representing
1342 MemoryUsage(|java.lang.management.MemoryUsage|)
1348 Implementation Note: The mapping specified above could be done in the
1349 implementation of each platform MXBean. One good implementation choice is to
1350 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
1352 MXBean Names Each platform MXBean for a Java virtual machine has a unique
1353 ObjectName(|javax.management.ObjectName|) for registration in the platform
1354 MBeanServer. A Java virtual machine has a single instance of the following
1355 management interfaces:
1359 Management Interface ObjectName
1361 (|java.lang.management.ClassLoadingMXBean|)
1362 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
1364 (|java.lang.management.MemoryMXBean|)
1365 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
1367 (|java.lang.management.ThreadMXBean|)
1368 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
1370 (|java.lang.management.RuntimeMXBean|)
1371 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
1373 (|java.lang.management.OperatingSystemMXBean|)
1374 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
1379 A Java virtual machine has zero or a single instance of the following
1380 management interfaces.
1384 Management Interface ObjectName
1386 (|java.lang.management.CompilationMXBean|)
1387 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
1391 A Java virtual machine may have one or more instances of the following
1392 management interfaces.
1396 Management Interface ObjectName
1398 (|java.lang.management.GarbageCollectorMXBean|)
1399 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
1400 ,name=collector's name
1402 (|java.lang.management.MemoryManagerMXBean|)
1403 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
1404 ,name=manager's name
1406 (|java.lang.management.MemoryPoolMXBean|)
1407 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
1413 *java.lang.String_java.lang.management.ManagementFactory.RUNTIME_MXBEAN_NAME*
1415 The ManagementFactory class is a factory class for getting managed beans for
1416 the Java platform. This class consists of static methods each of which returns
1417 one or more platform MXBean(s) representing the management interface of a
1418 component of the Java virtual machine.
1420 An application can access a platform MXBean in the following ways:
1422 Direct access to an MXBean interface
1424 Get the MXBean instance through the static factory method and access the MXBean
1425 locally of the running virtual machine.
1427 Construct an MXBean proxy instance that forwards the method calls to a given
1428 MBeanServer(|javax.management.MBeanServer|) by calling
1429 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
1430 typically constructed to remotely access an MXBean of another running virtual
1433 Indirect access to an MXBean interface via MBeanServer
1435 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
1436 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
1437 remotely. The attributes and operations of an MXBean use only JMX open types
1438 which include basic data types,
1439 CompositeData(|javax.management.openmbean.CompositeData|) , and
1440 TabularData(|javax.management.openmbean.TabularData|) defined in
1441 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
1446 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
1447 Instrumentation Specification and only uses a set of basic data types described
1448 below. A JMX management application and the platform MBeanServer can
1449 interoperate without requiring classes for MXBean specific data types. The data
1450 types being transmitted between the JMX connector server and the connector
1451 client are open types(|javax.management.openmbean.OpenType|) and this allows
1452 interoperation across versions.
1454 The platform MXBean interfaces use only the following data types:
1456 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
1457 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
1458 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
1459 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
1460 define a static from method with a
1461 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
1462 from an input CompositeData to an instance of that class
1464 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
1465 an enum class, or a class supporting conversion from a CompositeData to its
1468 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
1469 class, an enum class, or a class supporting conversion from a CompositeData to
1474 When an attribute or operation of a platform MXBean is accessed via an
1475 MBeanServer, the data types are mapped as follows:
1477 A primitive type or a wrapper class is mapped to the same type.
1479 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
1480 constant. A class that defines only getter methods and a static from method
1481 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
1482 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
1484 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
1485 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
1486 with two items whose names are "key" and "value" and the item types are the
1487 corresponding mapped type of K and V respectively and the "key" is the index.
1489 List<E> is mapped to an array with the mapped type of E as the element type.
1491 An array of element type E is mapped to an array of the same dimenions with the
1492 mapped type of E as the element type.
1494 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
1495 data types of the attributes and operations as primitive or open types mapped
1498 For example, the (|java.lang.management.MemoryMXBean|) interface has the
1499 following getter and setter methods:
1503 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
1504 void setVerbose(boolean value);
1506 These attributes in the MBeanInfo of the MemoryMXBean have the following names
1513 HeapMemoryUsage CompositeData representing
1514 MemoryUsage(|java.lang.management.MemoryUsage|)
1520 Implementation Note: The mapping specified above could be done in the
1521 implementation of each platform MXBean. One good implementation choice is to
1522 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
1524 MXBean Names Each platform MXBean for a Java virtual machine has a unique
1525 ObjectName(|javax.management.ObjectName|) for registration in the platform
1526 MBeanServer. A Java virtual machine has a single instance of the following
1527 management interfaces:
1531 Management Interface ObjectName
1533 (|java.lang.management.ClassLoadingMXBean|)
1534 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
1536 (|java.lang.management.MemoryMXBean|)
1537 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
1539 (|java.lang.management.ThreadMXBean|)
1540 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
1542 (|java.lang.management.RuntimeMXBean|)
1543 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
1545 (|java.lang.management.OperatingSystemMXBean|)
1546 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
1551 A Java virtual machine has zero or a single instance of the following
1552 management interfaces.
1556 Management Interface ObjectName
1558 (|java.lang.management.CompilationMXBean|)
1559 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
1563 A Java virtual machine may have one or more instances of the following
1564 management interfaces.
1568 Management Interface ObjectName
1570 (|java.lang.management.GarbageCollectorMXBean|)
1571 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
1572 ,name=collector's name
1574 (|java.lang.management.MemoryManagerMXBean|)
1575 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
1576 ,name=manager's name
1578 (|java.lang.management.MemoryPoolMXBean|)
1579 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
1585 *java.lang.String_java.lang.management.ManagementFactory.THREAD_MXBEAN_NAME*
1587 The ManagementFactory class is a factory class for getting managed beans for
1588 the Java platform. This class consists of static methods each of which returns
1589 one or more platform MXBean(s) representing the management interface of a
1590 component of the Java virtual machine.
1592 An application can access a platform MXBean in the following ways:
1594 Direct access to an MXBean interface
1596 Get the MXBean instance through the static factory method and access the MXBean
1597 locally of the running virtual machine.
1599 Construct an MXBean proxy instance that forwards the method calls to a given
1600 MBeanServer(|javax.management.MBeanServer|) by calling
1601 newPlatfromMXBeanProxy(|java.lang.management.ManagementFactory|) . A proxy is
1602 typically constructed to remotely access an MXBean of another running virtual
1605 Indirect access to an MXBean interface via MBeanServer
1607 Go through the platform MBeanServer(|java.lang.management.ManagementFactory|)
1608 to access MXBeans locally or a specific MBeanServerConnection to access MXBeans
1609 remotely. The attributes and operations of an MXBean use only JMX open types
1610 which include basic data types,
1611 CompositeData(|javax.management.openmbean.CompositeData|) , and
1612 TabularData(|javax.management.openmbean.TabularData|) defined in
1613 OpenType(|javax.management.openmbean.OpenType|) . The mapping is specified
1618 Platform MXBeans A platform MXBean is a managed bean that conforms to the JMX
1619 Instrumentation Specification and only uses a set of basic data types described
1620 below. A JMX management application and the platform MBeanServer can
1621 interoperate without requiring classes for MXBean specific data types. The data
1622 types being transmitted between the JMX connector server and the connector
1623 client are open types(|javax.management.openmbean.OpenType|) and this allows
1624 interoperation across versions.
1626 The platform MXBean interfaces use only the following data types:
1628 Primitive types such as int, long, boolean, etc Wrapper classes for primitive
1629 types such as Integer(|java.lang.Integer|) , Long(|java.lang.Long|) ,
1630 Boolean(|java.lang.Boolean|) , etc and String(|java.lang.String|)
1631 Enum(|java.lang.Enum|) classes Classes that define only getter methods and
1632 define a static from method with a
1633 CompositeData(|javax.management.openmbean.CompositeData|) argument to convert
1634 from an input CompositeData to an instance of that class
1636 List<E>(|java.util.List|) where E is a primitive type, a wrapper class,
1637 an enum class, or a class supporting conversion from a CompositeData to its
1640 Map<K,V>(|java.util.Map|) where K and V are a primitive type, a wrapper
1641 class, an enum class, or a class supporting conversion from a CompositeData to
1646 When an attribute or operation of a platform MXBean is accessed via an
1647 MBeanServer, the data types are mapped as follows:
1649 A primitive type or a wrapper class is mapped to the same type.
1651 An (|java.lang.Enum|) is mapped to String whose value is the name of the enum
1652 constant. A class that defines only getter methods and a static from method
1653 with a CompositeData(|javax.management.openmbean.CompositeData|) argument is
1654 mapped to CompositeData(|javax.management.openmbean.CompositeData|) .
1656 Map<K,V> is mapped to TabularData(|javax.management.openmbean.TabularData|)
1657 whose row type is a CompositeType(|javax.management.openmbean.CompositeType|)
1658 with two items whose names are "key" and "value" and the item types are the
1659 corresponding mapped type of K and V respectively and the "key" is the index.
1661 List<E> is mapped to an array with the mapped type of E as the element type.
1663 An array of element type E is mapped to an array of the same dimenions with the
1664 mapped type of E as the element type.
1666 The MBeanInfo(|javax.management.MBeanInfo|) for a platform MXBean describes the
1667 data types of the attributes and operations as primitive or open types mapped
1670 For example, the (|java.lang.management.MemoryMXBean|) interface has the
1671 following getter and setter methods:
1675 public MemoryUsage getHeapMemoryUsage(); public boolean isVerbose(); public
1676 void setVerbose(boolean value);
1678 These attributes in the MBeanInfo of the MemoryMXBean have the following names
1685 HeapMemoryUsage CompositeData representing
1686 MemoryUsage(|java.lang.management.MemoryUsage|)
1692 Implementation Note: The mapping specified above could be done in the
1693 implementation of each platform MXBean. One good implementation choice is to
1694 implement a MXBean as a dynamic MBean(|javax.management.DynamicMBean|) .
1696 MXBean Names Each platform MXBean for a Java virtual machine has a unique
1697 ObjectName(|javax.management.ObjectName|) for registration in the platform
1698 MBeanServer. A Java virtual machine has a single instance of the following
1699 management interfaces:
1703 Management Interface ObjectName
1705 (|java.lang.management.ClassLoadingMXBean|)
1706 <tt>java.lang:type=ClassLoading</tt>(|java.lang.management.ManagementFactory|)
1708 (|java.lang.management.MemoryMXBean|)
1709 <tt>java.lang:type=Memory</tt>(|java.lang.management.ManagementFactory|)
1711 (|java.lang.management.ThreadMXBean|)
1712 <tt>java.lang:type=Threading</tt>(|java.lang.management.ManagementFactory|)
1714 (|java.lang.management.RuntimeMXBean|)
1715 <tt>java.lang:type=Runtime</tt>(|java.lang.management.ManagementFactory|)
1717 (|java.lang.management.OperatingSystemMXBean|)
1718 <tt>java.lang:type=OperatingSystem</tt>(|java.lang.management.ManagementFactory|)
1723 A Java virtual machine has zero or a single instance of the following
1724 management interfaces.
1728 Management Interface ObjectName
1730 (|java.lang.management.CompilationMXBean|)
1731 <tt>java.lang:type=Compilation</tt>(|java.lang.management.ManagementFactory|)
1735 A Java virtual machine may have one or more instances of the following
1736 management interfaces.
1740 Management Interface ObjectName
1742 (|java.lang.management.GarbageCollectorMXBean|)
1743 <tt>java.lang:type=GarbageCollector</tt>(|java.lang.management.ManagementFactory|)
1744 ,name=collector's name
1746 (|java.lang.management.MemoryManagerMXBean|)
1747 <tt>java.lang:type=MemoryManager</tt>(|java.lang.management.ManagementFactory|)
1748 ,name=manager's name
1750 (|java.lang.management.MemoryPoolMXBean|)
1751 <tt>java.lang:type=MemoryPool</tt>(|java.lang.management.ManagementFactory|)
1758 *java.lang.management.ManagementFactory.getClassLoadingMXBean()*
1760 public static |java.lang.management.ClassLoadingMXBean| getClassLoadingMXBean()
1762 Returns the managed bean for the class loading system of the Java virtual
1766 Returns: a {@link ClassLoadingMXBean} object for the Java virtual machine.
1767 *java.lang.management.ManagementFactory.getCompilationMXBean()*
1769 public static |java.lang.management.CompilationMXBean| getCompilationMXBean()
1771 Returns the managed bean for the compilation system of the Java virtual
1772 machine. This method returns null if the Java virtual machine has no
1776 Returns: a {@link CompilationMXBean} object for the Java virtual machine or null if the
1777 Java virtual machine has no compilation system.
1778 *java.lang.management.ManagementFactory.getGarbageCollectorMXBeans()*
1780 public static |java.util.List| getGarbageCollectorMXBeans()
1782 Returns a list of (|java.lang.management.GarbageCollectorMXBean|) objects in
1783 the Java virtual machine. The Java virtual machine may have one or more
1784 GarbageCollectorMXBean objects. It may add or remove GarbageCollectorMXBean
1788 Returns: a list of GarbageCollectorMXBean objects.
1789 *java.lang.management.ManagementFactory.getMemoryManagerMXBeans()*
1791 public static |java.util.List| getMemoryManagerMXBeans()
1793 Returns a list of (|java.lang.management.MemoryManagerMXBean|) objects in the
1794 Java virtual machine. The Java virtual machine can have one or more memory
1795 managers. It may add or remove memory managers during execution.
1798 Returns: a list of MemoryManagerMXBean objects.
1799 *java.lang.management.ManagementFactory.getMemoryMXBean()*
1801 public static |java.lang.management.MemoryMXBean| getMemoryMXBean()
1803 Returns the managed bean for the memory system of the Java virtual machine.
1806 Returns: a {@link MemoryMXBean} object for the Java virtual machine.
1807 *java.lang.management.ManagementFactory.getMemoryPoolMXBeans()*
1809 public static |java.util.List| getMemoryPoolMXBeans()
1811 Returns a list of (|java.lang.management.MemoryPoolMXBean|) objects in the Java
1812 virtual machine. The Java virtual machine can have one or more memory pools. It
1813 may add or remove memory pools during execution.
1816 Returns: a list of MemoryPoolMXBean objects.
1817 *java.lang.management.ManagementFactory.getOperatingSystemMXBean()*
1819 public static |java.lang.management.OperatingSystemMXBean| getOperatingSystemMXBean()
1821 Returns the managed bean for the operating system on which the Java virtual
1825 Returns: an {@link OperatingSystemMXBean} object for the Java virtual machine.
1826 *java.lang.management.ManagementFactory.getPlatformMBeanServer()*
1828 public static synchronized |javax.management.MBeanServer| getPlatformMBeanServer()
1830 Returns the platform MBeanServer(|javax.management.MBeanServer|) . On the first
1831 call to this method, it first creates the platform MBeanServer by calling the
1832 (|javax.management.MBeanServerFactory|) method and registers the platform
1833 MXBeans in this platform MBeanServer using the MXBean names defined in the
1834 class description. This method, in subsequent calls, will simply return the
1835 initially created platform MBeanServer.
1837 MXBeans that get created and destroyed dynamically, for example, memory
1838 pools(|java.lang.management.MemoryPoolMXBean|) and
1839 managers(|java.lang.management.MemoryManagerMXBean|) , will automatically be
1840 registered and deregistered into the platform MBeanServer.
1842 If the system property javax.management.builder.initial is set, the platform
1843 MBeanServer creation will be done by the specified
1844 (|javax.management.MBeanServerBuilder|) .
1846 It is recommended that this platform MBeanServer also be used to register other
1847 application managed beans besides the platform MXBeans. This will allow all
1848 MBeans to be published through the same MBeanServer and hence allow for easier
1849 network publishing and discovery. Name conflicts with the platform MXBeans
1853 Returns: the platform MBeanServer; the platform MXBeans are registered into the platform
1854 MBeanServer at the first time this method is called.
1855 *java.lang.management.ManagementFactory.getRuntimeMXBean()*
1857 public static |java.lang.management.RuntimeMXBean| getRuntimeMXBean()
1859 Returns the managed bean for the runtime system of the Java virtual machine.
1862 Returns: a {@link RuntimeMXBean} object for the Java virtual machine.
1863 *java.lang.management.ManagementFactory.getThreadMXBean()*
1865 public static |java.lang.management.ThreadMXBean| getThreadMXBean()
1867 Returns the managed bean for the thread system of the Java virtual machine.
1870 Returns: a {@link ThreadMXBean} object for the Java virtual machine.
1871 *java.lang.management.ManagementFactory.newPlatformMXBeanProxy(MBeanServerConnection,String,Class)*
1873 public static |java.lang.Object| newPlatformMXBeanProxy(
1874 javax.management.MBeanServerConnection connection,
1875 java.lang.String mxbeanName,
1876 java.lang.Class mxbeanInterface)
1877 throws |java.io.IOException|
1879 Returns a proxy for a platform MXBean interface of a given MXBean name that
1880 forwards its method calls through the given MBeanServerConnection.
1882 This method is equivalent to: Proxy.newProxyInstance(|java.lang.reflect.Proxy|)
1883 (mxbeanInterface.getClassLoader(), new Class[] { mxbeanInterface }, handler)
1885 where handler is an InvocationHandler(|java.lang.reflect.InvocationHandler|) to
1886 which method invocations to the MXBean interface are dispatched. This handler
1887 converts an input parameter from an MXBean data type to its mapped open type
1888 before forwarding to the MBeanServer and converts a return value from an MXBean
1889 method call through the MBeanServer from an open type to the corresponding
1890 return type declared in the MXBean interface.
1892 If the MXBean is a notification emitter (i.e., it implements
1893 NotificationEmitter(|javax.management.NotificationEmitter|) ), both the
1894 mxbeanInterface and NotificationEmitter will be implemented by this proxy.
1898 Using an MXBean proxy is a convenience remote access to a platform MXBean of a
1899 running virtual machine. All method calls to the MXBean proxy are forwarded to
1900 an MBeanServerConnection where IOException(|java.io.IOException|) may be thrown
1901 when the communication problem occurs with the connector server. An application
1902 remotely accesses the platform MXBeans using proxy should prepare to catch
1903 IOException as if accessing with the MBeanServerConnector interface.
1905 When a client application is designed to remotely access MXBeans for a running
1906 virtual machine whose version is different than the version on which the
1907 application is running, it should prepare to catch
1908 InvalidObjectException(|java.io.InvalidObjectException|) which is thrown when
1909 an MXBean proxy receives a name of an enum constant which is missing in the
1910 enum class loaded in the client application.
1912 MBeanServerInvocationHandler(|javax.management.MBeanServerInvocationHandler|)
1913 or its newProxyInstance(|javax.management.MBeanServerInvocationHandler|) method
1914 cannot be used to create a proxy for a platform MXBean. The proxy object
1915 created by MBeanServerInvocationHandler does not handle the properties of the
1916 platform MXBeans described in the class specification.
1920 connection - the MBeanServerConnection to forward to.
1921 mxbeanName - the name of a platform MXBean within connection to forward to. mxbeanName must
1922 be in the format of {@link ObjectName ObjectName}.
1923 mxbeanInterface - the MXBean interface to be implemented by the proxy.