jdk/test/java/rmi/server/UnicastRemoteObject/keepAliveDuringCall/KeepAliveDuringCall.java

/* 
 * Copyright 2001 Sun Microsystems, Inc.  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.
 *
 * 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

/* @test
 * @bug 4308492
 * @summary In addition to keeping the VM alive (with a non-daeman thread)
 * while there are remote objects exported, the RMI runtime should also
 * keep it alive while there remain calls in progress (to remote objects
 * the have presumably been unexported), so that a remote object can more
 * conveniently implement a graceful remote shutdown method (that unexports
 * the object).
 * @author Peter Jones
 *
 * @library ../../../testlibrary
 * @build TestLibrary
 * @build JavaVM
 * @build KeepAliveDuringCall
 * @build KeepAliveDuringCall_Stub
 * @build ShutdownMonitor
 * @build Shutdown
 * @build ShutdownImpl
 * @build ShutdownImpl_Stub
 * @run main/othervm KeepAliveDuringCall
 */

import java.rmi.Remote;
import java.rmi.RemoteException;
import java.rmi.registry.LocateRegistry;
import java.rmi.registry.Registry;
import java.rmi.server.UnicastRemoteObject;

public class KeepAliveDuringCall implements ShutdownMonitor {

    public static final String BINDING = "KeepAliveDuringCall";
    private static final int TIMEOUT = 20000;

    private Object lock = new Object();
    private Shutdown shutdown = null;
    private boolean stillAlive = false;

    public void submitShutdown(Shutdown shutdown) {
	synchronized (lock) {
	    this.shutdown = shutdown;
	    lock.notifyAll();
	}
    }

    public void declareStillAlive() {
	synchronized (lock) {
	    stillAlive = true;
	    lock.notifyAll();
	}
    }

    public static void main(String[] args) {

	System.err.println("\nRegression test for bug 4308492\n");

	KeepAliveDuringCall obj = new KeepAliveDuringCall();

	try {
	    UnicastRemoteObject.exportObject(obj);
	    System.err.println("exported shutdown monitor");

	    Registry localRegistry =
		LocateRegistry.createRegistry(TestLibrary.REGISTRY_PORT);
	    System.err.println("created local registry");

	    localRegistry.bind(BINDING, obj);
	    System.err.println("bound shutdown monitor in local registry");

	    System.err.println("starting remote ShutdownImpl VM...");
	    (new JavaVM("ShutdownImpl")).start();

	    Shutdown s;
	    synchronized (obj.lock) {
		System.err.println(
		    "waiting for submission of object to shutdown...");
		while ((s = obj.shutdown) == null) {
		    obj.lock.wait(TIMEOUT);
		}
		if (s == null) {
		    throw new RuntimeException(
			"TEST FAILED: timeout waiting for shutdown object " +
			"to make initial contact");
		}
		System.err.println("shutdown object submitted: " + s);
	    }

	    try {
		s.shutdown();
	    } catch (RemoteException e) {
		throw new RuntimeException(
		    "TEST FAILED: shutdown method threw remote exception", e);
	    }

	    synchronized (obj.lock) {
		if (!obj.stillAlive) {
		    throw new RuntimeException("TEST FAILED: " +
			"shutdown object not detected alive after unexport");
		}
	    }

	    System.err.println("TEST PASSED: " +
		"shutdown object detected still alive after unexport");

	} catch (Exception e) {
	    if (e instanceof RuntimeException) {
		throw (RuntimeException) e;
	    } else {
		throw new RuntimeException(
		    "TEST FAILED: unexpected exception", e);
	    }
	} finally {
	    try {
		UnicastRemoteObject.unexportObject(obj, true);
	    } catch (RemoteException e) {
	    }
	}
    }
}