jdk/src/share/classes/java/lang/ApplicationShutdownHooks.java
author martin
Mon, 10 Mar 2008 14:32:51 -0700
changeset 48 dc5744ca15ea
parent 2 90ce3da70b43
child 2277 445a331b4a8b
permissions -rw-r--r--
4960438: (process) Need IO redirection API for subprocesses Reviewed-by: alanb, iris
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 2005-2006 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
import java.util.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * Class to track and run user level shutdown hooks registered through
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * <tt>{@link Runtime#addShutdownHook Runtime.addShutdownHook}</tt>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * @see java.lang.Runtime#addShutdownHook
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * @see java.lang.Runtime#removeShutdownHook
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
class ApplicationShutdownHooks implements Runnable {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
    private static ApplicationShutdownHooks instance = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    /* The set of registered hooks */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
    private static IdentityHashMap<Thread, Thread> hooks = new IdentityHashMap<Thread, Thread>();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
    static synchronized ApplicationShutdownHooks hook() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
        if (instance == null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
            instance = new ApplicationShutdownHooks();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
        return instance;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    private ApplicationShutdownHooks() {}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    /* Add a new shutdown hook.  Checks the shutdown state and the hook itself,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * but does not do any security checks.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    static synchronized void add(Thread hook) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
        if(hooks == null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
            throw new IllegalStateException("Shutdown in progress");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
        if (hook.isAlive())
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
            throw new IllegalArgumentException("Hook already running");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
        if (hooks.containsKey(hook))
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
            throw new IllegalArgumentException("Hook previously registered");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
        hooks.put(hook, hook);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    /* Remove a previously-registered hook.  Like the add method, this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * does not do any security checks.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    static synchronized boolean remove(Thread hook) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
        if(hooks == null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
            throw new IllegalStateException("Shutdown in progress");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
        if (hook == null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
            throw new NullPointerException();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
        return hooks.remove(hook) != null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    /* Iterates over all application hooks creating a new thread for each
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * to run in. Hooks are run concurrently and this method waits for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * them to finish.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    public void run() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
        Collection<Thread> threads;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
        synchronized(ApplicationShutdownHooks.class) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
            threads = hooks.keySet();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
            hooks = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
        for (Thread hook : threads) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
            hook.start();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
        for (Thread hook : threads) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
            try {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
                hook.join();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
            } catch (InterruptedException x) { }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
}