| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2004 Sun Microsystems, Inc. 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. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package sun.jvmstat.monitor.remote; |
| 27 | |
| 28 | import java.rmi.Remote; |
| 29 | import java.rmi.RemoteException; |
| 30 | |
| 31 | /** |
| 32 | * Interface for accessing the instrumentation exported by a |
| 33 | * Java Virtual Machine running on a remote host. |
| 34 | * |
| 35 | * @author Brian Doherty |
| 36 | * @since 1.5 |
| 37 | */ |
| 38 | public interface RemoteVm extends Remote { |
| 39 | |
| 40 | /** |
| 41 | * Interface to get the bytes associated with the instrumentation |
| 42 | * for the remote Java Virtual Machine. |
| 43 | * |
| 44 | * @return byte[] - a byte array containing the current bytes |
| 45 | * for the instrumentation exported by the |
| 46 | * remote Java Virtual Machine. |
| 47 | * @throws RemoteException Thrown on any communication error |
| 48 | */ |
| 49 | byte[] getBytes() throws RemoteException; |
| 50 | |
| 51 | /** |
| 52 | * Interface to get the the size of the instrumentation buffer |
| 53 | * for the target Java Virtual Machine. |
| 54 | * |
| 55 | * @return int - the size of the instrumentation buffer for the |
| 56 | * remote Java Virtual Machine. |
| 57 | * @throws RemoteException Thrown on any communication error |
| 58 | */ |
| 59 | int getCapacity() throws RemoteException; |
| 60 | |
| 61 | /** |
| 62 | * Interface to return the Local Virtual Machine Identifier for |
| 63 | * the remote Java Virtual Machine. The Local Virtual Machine |
| 64 | * Identifier is also know as the <em>lvmid</em>. |
| 65 | * |
| 66 | * @throws RemoteException Thrown on any communication error |
| 67 | */ |
| 68 | int getLocalVmId() throws RemoteException; |
| 69 | |
| 70 | /** |
| 71 | * Interface to detach from the remote Java Virtual Machine. |
| 72 | * |
| 73 | * @throws RemoteException Thrown on any communication error |
| 74 | */ |
| 75 | void detach() throws RemoteException; |
| 76 | } |