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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2014-2015 ForgeRock AS
026 */
027package org.opends.server.tasks;
028import org.forgerock.i18n.LocalizableMessage;
029
030
031
032import org.opends.server.api.DirectoryThread;
033import org.opends.server.core.DirectoryServer;
034
035
036
037
038/**
039 * This class defines a thread that will be spawned to invoke the Directory
040 * Server shutdown process.  This needs to be a separate thread because the task
041 * that creates it has to complete before the server can really shut down.
042 */
043public class ShutdownTaskThread
044       extends DirectoryThread
045{
046  /**
047   * The fully-qualified name of this class.
048   */
049  private static final String CLASS_NAME =
050       "org.opends.server.tasks.ShutdownTaskThread";
051
052
053
054  /** The shutdown message that will be used. */
055  private LocalizableMessage shutdownMessage;
056
057
058
059  /**
060   * Creates a new instance of this shutdown task thread with the provided
061   * message.
062   *
063   * @param  shutdownMessage  The shutdown message that will be used.
064   */
065  public ShutdownTaskThread(LocalizableMessage shutdownMessage)
066  {
067    super("Shutdown Task Thread");
068
069
070    this.shutdownMessage = shutdownMessage;
071
072    setDaemon(true);
073  }
074
075
076
077  /**
078   * Invokes the Directory Server shutdown process.
079   */
080  public void run()
081  {
082    DirectoryServer.shutDown(CLASS_NAME, shutdownMessage);
083  }
084}
085