001/*
002 * Copyright 2017-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2017-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2017-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds.tools;
037
038
039
040import com.unboundid.util.NotNull;
041import com.unboundid.util.ThreadSafety;
042import com.unboundid.util.ThreadSafetyLevel;
043
044import static com.unboundid.ldap.sdk.unboundidds.tools.ToolMessages.*;
045
046
047
048/**
049 * This class provides a thread that will be registered as a JVM shutdown hook
050 * for any command-line tool for which invocation logging is to be performed.
051 * If the tool is interrupted by a JVM shutdown (for example, if the JVM
052 * receives a kill signal, if the user presses Control+C, or the tool calls
053 * System.exit) before it can complete naturally, then this shutdown hook thread
054 * will be run to try to ensure that the tool invocation log includes a record
055 * of the abnormal shutdown.
056 * <BR>
057 * <BLOCKQUOTE>
058 *   <B>NOTE:</B>  This class, and other classes within the
059 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
060 *   supported for use against Ping Identity, UnboundID, and
061 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
062 *   for proprietary functionality or for external specifications that are not
063 *   considered stable or mature enough to be guaranteed to work in an
064 *   interoperable way with other types of LDAP servers.
065 * </BLOCKQUOTE>
066 */
067@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
068public final class ToolInvocationLogShutdownHook
069       extends Thread
070{
071  // An object with information about the logging that should be performed.
072  @NotNull private final ToolInvocationLogDetails logDetails;
073
074
075
076  /**
077   * Creates a new instance of this shutdown hook with the provided log details.
078   *
079   * @param  logDetails  The log details of the tool.  It must not be
080   *                     {@code null}.
081   */
082  public ToolInvocationLogShutdownHook(
083              @NotNull final ToolInvocationLogDetails logDetails)
084  {
085    this.logDetails = logDetails;
086  }
087
088
089
090  /**
091   * Logs a completion message indicating that tool processing was interrupted
092   * by a JVM shutdown.
093   */
094  @Override()
095  public void run()
096  {
097    ToolInvocationLogger.logCompletionMessage(logDetails, null,
098         INFO_TOOL_INTERRUPTED_BY_JVM_SHUTDOWN.get());
099  }
100}