1 /*

     2  * Copyright (c) 2004, 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 sun.jvmstat.monitor.remote;

    27 

    28 import sun.jvmstat.monitor.*;

    29 import java.rmi.Remote;

    30 import java.rmi.RemoteException;

    31 import java.io.IOException;

    32 

    33 /**

    34  * Remote Interface for discovering and attaching to remote

    35  * monitorable Java Virtual Machines.

    36  *

    37  * @author Brian Doherty

    38  * @since 1.5

    39  */

    40 public interface RemoteHost extends Remote {

    41 

    42     /**

    43      * Remote method to attach to a remote HotSpot Java Virtual Machine

    44      * identified by <code>vmid</code>.

    45      *

    46      * @param vmid The identifier for the target virtual machine.

    47      * @return RemoteVm - A remote object for accessing the remote Java

    48      *                    Virtual Machine.

    49      *

    50      * @throws MonitorException Thrown when any other error is encountered

    51      *                          while communicating with the target virtual

    52      *                          machine.

    53      * @throws RemoteException

    54      *

    55      */

    56     RemoteVm attachVm(int vmid, String mode) throws RemoteException,

    57                                                     MonitorException;

    58 

    59     /**

    60      * Remote method to detach from a remote HotSpot Java Virtual Machine

    61      * identified by <code>vmid</code>.

    62      *

    63      * @param rvm The remote object for the target Java Virtual

    64      *            Machine.

    65      *

    66      * @throws MonitorException Thrown when any other error is encountered

    67      *                          while communicating with the target virtual

    68      *                          machine.

    69      * @throws RemoteException

    70      */

    71     void detachVm(RemoteVm rvm) throws RemoteException, MonitorException;

    72 

    73     /**

    74      * Get a list of Local Virtual Machine Identifiers for the active

    75      * Java Virtual Machine the remote system. A Local Virtual Machine

    76      * Identifier is also known as an <em>lvmid</em>.

    77      *

    78      * @return int[] - A array of <em>lvmid</em>s.

    79      * @throws MonitorException Thrown when any other error is encountered

    80      *                          while communicating with the target virtual

    81      *                          machine.

    82      * @throws RemoteException

    83      */

    84     int[] activeVms() throws RemoteException, MonitorException;

    85 }