001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.core;
028    
029    
030    import org.opends.server.api.DirectoryThread;
031    
032    import static org.opends.server.loggers.debug.DebugLogger.*;
033    import org.opends.server.loggers.debug.DebugTracer;
034    import static org.opends.messages.CoreMessages.*;
035    /**
036     * This class defines a shutdown hook that will be invoked automatically when
037     * the JVM is shutting down.  It may be able to detect certain kinds of shutdown
038     * events that are not invoked by the Directory Server itself (e.g., an
039     * administrator killing the Java process).
040     */
041    public class DirectoryServerShutdownHook
042           extends DirectoryThread
043    {
044      /**
045       * The tracer object for the debug logger.
046       */
047      private static final DebugTracer TRACER = getTracer();
048    
049      /**
050       * The fully-qualified name of this class.
051       */
052      private static final String CLASS_NAME =
053           "org.opends.server.core.DirectoryServerShutdownHook";
054    
055    
056    
057      /**
058       * Creates a new shutdown hook that will stop the Directory Server when it is
059       * determined that the JVM is shutting down.
060       */
061      public DirectoryServerShutdownHook()
062      {
063        super("Directory Server Shutdown Hook");
064    
065      }
066    
067    
068    
069      /**
070       * Invokes the shutdown hook to signal the Directory Server to stop running.
071       */
072      public void run()
073      {
074        TRACER.debugInfo(
075            "Directory Server shutdown hook has been invoked.");
076    
077        DirectoryServer.shutDown(CLASS_NAME,
078                                 ERR_SHUTDOWN_DUE_TO_SHUTDOWN_HOOK.get());
079      }
080    }
081