/* 
 * Copyright 2005 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 4457683
 * @summary After all of the remote objects (including a registry, if
 * applicable) that had been exported with a given
 * RMIServerSocketFactory value (including null) have been unexported,
 * the server socket created for the exports should be closed (so that
 * the local port is released).
 * @author Peter Jones
 *
 * @build CloseServerSocket
 * @run main/othervm CloseServerSocket
 */

import java.io.IOException;
import java.net.BindException;
import java.net.ServerSocket;
import java.rmi.Remote;
import java.rmi.registry.LocateRegistry;
import java.rmi.registry.Registry;
import java.rmi.server.RMIServerSocketFactory;
import java.rmi.server.UnicastRemoteObject;

public class CloseServerSocket implements Remote {

    private static final int PORT = 2020;

    private CloseServerSocket() { }

    public static void main(String[] args) throws Exception {
	System.err.println("\nRegression test for bug 4457683\n");

	verifyPortFree(PORT);
	Registry registry = LocateRegistry.createRegistry(PORT);
	System.err.println("- exported registry: " + registry);
	verifyPortInUse(PORT);
	UnicastRemoteObject.unexportObject(registry, true);
	System.err.println("- unexported registry");
	Thread.sleep(1);	// work around BindException (bug?)
	verifyPortFree(PORT);

	/*
	 * The follow portion of this test is disabled temporarily
	 * because 4457683 was partially backed out because of
	 * 6269166; for now, only server sockets originally opened for
	 * exports on non-anonymous ports will be closed when all of
	 * the corresponding remote objects have been exported.  A
	 * separate bug will be filed to represent the remainder of
	 * 4457683 for anonymous-port exports.
	 */

//	SSF ssf = new SSF();
//	Remote impl = new CloseServerSocket();
//	Remote stub = UnicastRemoteObject.exportObject(impl, 0, null, ssf);
//	System.err.println("- exported object: " + stub);
//	UnicastRemoteObject.unexportObject(impl, true);
//	System.err.println("- unexported object");
//	synchronized (ssf) {
//	    if (!ssf.serverSocketClosed) {
//		throw new RuntimeException("TEST FAILED: " +
//					   "server socket not closed");
//	    }
//	}

	System.err.println("TEST PASSED");
    }

    private static void verifyPortFree(int port) throws IOException {
	ServerSocket ss = new ServerSocket(PORT);
	ss.close();
	System.err.println("- port " + port + " is free");
    }

    private static void verifyPortInUse(int port) throws IOException {
	try {
	    verifyPortFree(port);
	} catch (BindException e) {
	    System.err.println("- port " + port + " is in use");
	    return;
	}
    }

    private static class SSF implements RMIServerSocketFactory {
	boolean serverSocketClosed = false;
	SSF() { };

	public ServerSocket createServerSocket(int port) throws IOException {
	    return new SS(port);
	}

	private class SS extends ServerSocket {
	    SS(int port) throws IOException {
		super(port);
		System.err.println("- created server socket: " + this);
	    };

	    public void close() throws IOException {
		synchronized (SSF.this) {
		    serverSocketClosed = true;
		    SSF.this.notifyAll();
		}
		System.err.println("- closing server socket: " + this);
		super.close();
	    }
	}
    }
}