/*
 * 
 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * The contents of this file are subject to the Sun Community Source
 * License v3.0/Jini Technology Specific Attachment v 1.0 (the
 * "License"). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 * http://wwws.sun.com/software/jini/licensing/SCSL3_JiniTSA1.html.
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Reference Code is Jini Technology Core Platform code, v2.0. The
 * Developer of the Reference Code is Sun Microsystems, Inc.
 * 
 * Contributor(s): Sun Microsystems, Inc.
 * 
 * The contents of this file comply with the Jini Technology Core
 * Platform Compatibility Kit, v2.0A.
 * 
 * Tester(s): Sun Microsystems, Inc.
 * 
 * Test Platform(s):
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Solaris(TM)SPARC/x86
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Linux (Intel x86)
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Windows (Intel Platform)
 * 
 */

package com.sun.jini.start;

import java.rmi.activation.ActivationException;
import java.rmi.RemoteException;

/**
 * The {@linkplain com.sun.jini.start service starter}
 * supported interface for shared group objects. 
 * Shared group objects are used to destroy the VM in which they are 
 * placed.
 *
 * @author Sun Microsystems, Inc.
 *
 */

public interface SharedGroup {
    /**
     * Cause the hosting VM to exit. 
     * This method should (in effect) spawn a
     * separate thread to do the actual work asynchronously, 
     * and make a reasonable attempt to let this remote call
     * return successfully. As such, a successful return from this 
     * method does not mean that the VM has been
     * destroyed. Although the service should make a reasonable 
     * attempt to let this remote call return successfully,
     * the service must not wait indefinitely for other 
     * (in-progress and subsequent) remote calls to finish before
     * proceeding to destroy its hosting VM. Once this method has been called, 
     * the service can, but need not, reject all other
     * (in-progress and subsequent) remote calls to the service. 
     *
     * @throws RemoteException if there was a problem communicating with
     *     the shared group object
     * @throws ActivationException if there was a problem creating an
     *     activatable shared group instance
     */
    public void destroyVM() throws RemoteException, ActivationException;
}
