/* * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.sun.management; import java.util.List; import java.lang.management.PlatformManagedObject; /** * Diagnostic management interface for the HotSpot Virtual Machine. * *
The diagnostic MBean is registered to the platform MBeanServer * as are other platform MBeans. * *
The ObjectName for uniquely identifying the diagnostic * MXBean within an MBeanServer is: *
* com.sun.management:type=HotSpotDiagnostic *.* * It can be obtained by calling the * {@link PlatformManagedObject#getObjectName} method. * * All methods throw a {@code NullPointerException} if any input argument is * {@code null} unless it's stated otherwise. * * @see ManagementFactory#getPlatformMXBeans(Class) */ public interface HotSpotDiagnosticMXBean extends PlatformManagedObject { /** * Dumps the heap to the outputFile file in the same * format as the hprof heap dump. *
* If this method is called remotely from another process,
* the heap dump output is written to a file named outputFile
* on the machine where the target VM is running. If outputFile is
* a relative path, it is relative to the working directory where
* the target VM was started.
*
* @param outputFile the system-dependent filename
* @param live if true dump only live objects
* i.e. objects that are reachable from others
* @throws IOException if the outputFile
* cannot be created, opened, or written to.
* @throws UnsupportedOperationException if this operation is not supported.
* @throws NullPointerException if outputFile is null.
*/
public void dumpHeap(String outputFile, boolean live) throws java.io.IOException;
/**
* Returns a list of VMOption objects for all diagnostic options.
* A diagnostic option is a {@link VMOption#isWriteable writeable}
* VM option that can be set dynamically mainly for troubleshooting
* and diagnosis.
*
* @return a list of VMOption objects for all diagnostic options.
*/
public java.util.List