1 /*
2 * Copyright (c) 2005, 2008, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.management;
27
28 import java.lang.management.PlatformManagedObject;
29
30 /**
31 * Diagnostic management interface for the HotSpot Virtual Machine.
32 * The diagnostic MBean is registered to the platform MBeanServer
33 * as are other platform MBeans.
34 *
35 * <p>The <tt>ObjectName</tt> for uniquely identifying the diagnostic
36 * MXBean within an MBeanServer is:
37 * <blockquote>
38 * <tt>com.sun.management:type=HotSpotDiagnostic</tt>
39 * </blockquote>
40 .*
41 * It can be obtained by calling the
42 * {@link PlatformManagedObject#getObjectName} method.
43 *
44 * @see ManagementFactory#getPlatformMXBeans(Class)
45 */
46 public interface HotSpotDiagnosticMXBean extends PlatformManagedObject {
47 /**
48 * Dumps the heap to the <tt>outputFile</tt> file in the same
49 * format as the hprof heap dump.
50 * <p>
51 * If this method is called remotely from another process,
52 * the heap dump output is written to a file named <tt>outputFile</tt>
53 * on the machine where the target VM is running. If outputFile is
54 * a relative path, it is relative to the working directory where
55 * the target VM was started.
56 *
57 * @param outputFile the system-dependent filename
58 * @param live if <tt>true</tt> dump only <i>live</i> objects
59 * i.e. objects that are reachable from others
60 * @throws IOException if the <tt>outputFile</tt>
61 * cannot be created, opened, or written to.
62 * @throws UnsupportedOperationException if this operation is not supported.
63 * @throws NullPointerException if <tt>outputFile</tt> is <tt>null</tt>.
64 */
65 public void dumpHeap(String outputFile, boolean live) throws java.io.IOException;
66
67 /**
68 * Returns a list of <tt>VMOption</tt> objects for all diagnostic options.
69 * A diagnostic option is a {@link VMOption#isWriteable writeable}
70 * VM option that can be set dynamically mainly for troubleshooting
71 * and diagnosis.
72 *
73 * @return a list of <tt>VMOption</tt> objects for all diagnostic options.
74 */
75 public java.util.List<VMOption> getDiagnosticOptions();
76
77 /**
78 * Returns a <tt>VMOption</tt> object for a VM option of the given
79 * name.
80 *
81 * @return a <tt>VMOption</tt> object for a VM option of the given name.
82 * @throws NullPointerException if name is <tt>null</tt>.
83 * @throws IllegalArgumentException if a VM option of the given name
84 * does not exist.
85 */
86 public VMOption getVMOption(String name);
87
88 /**
89 * Sets a VM option of the given name to the specified value.
90 * The new value will be reflected in a new <tt>VMOption</tt>
91 * object returned by the {@link #getVMOption} method or
92 * the {@link #getDiagnosticOptions} method. This method does
93 * not change the value of this <tt>VMOption</tt> object.
94 *
95 * @param name Name of a VM option
96 * @param value New value of the VM option to be set
97 *
98 * @throws IllegalArgumentException if the VM option of the given name
99 * does not exist.
100 * @throws IllegalArgumentException if the new value is invalid.
101 * @throws IllegalArgumentException if the VM option is not writeable.
102 * @throws NullPointerException if name or value is <tt>null</tt>.
103 *
104 * @throws java.security.SecurityException
105 * if a security manager exists and the caller does not have
106 * ManagementPermission("control").
107 */
108 public void setVMOption(String name, String value);
109 }