001/* 002 * Copyright 2017-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2017-2020 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-2020 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.ThreadSafety; 041import com.unboundid.util.ThreadSafetyLevel; 042 043import static com.unboundid.ldap.sdk.unboundidds.tools.ToolMessages.*; 044 045 046 047/** 048 * This class provides a thread that will be registered as a JVM shutdown hook 049 * for any command-line tool for which invocation logging is to be performed. 050 * If the tool is interrupted by a JVM shutdown (for example, if the JVM 051 * receives a kill signal, if the user presses Control+C, or the tool calls 052 * System.exit) before it can complete naturally, then this shutdown hook thread 053 * will be run to try to ensure that the tool invocation log includes a record 054 * of the abnormal shutdown. 055 * <BR> 056 * <BLOCKQUOTE> 057 * <B>NOTE:</B> This class, and other classes within the 058 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 059 * supported for use against Ping Identity, UnboundID, and 060 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 061 * for proprietary functionality or for external specifications that are not 062 * considered stable or mature enough to be guaranteed to work in an 063 * interoperable way with other types of LDAP servers. 064 * </BLOCKQUOTE> 065 */ 066@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE) 067public final class ToolInvocationLogShutdownHook 068 extends Thread 069{ 070 // An object with information about the logging that should be performed. 071 private final ToolInvocationLogDetails logDetails; 072 073 074 075 /** 076 * Creates a new instance of this shutdown hook with the provided log details. 077 * 078 * @param logDetails The log details of the tool. It must not be 079 * {@code null}. 080 */ 081 public ToolInvocationLogShutdownHook( 082 final ToolInvocationLogDetails logDetails) 083 { 084 this.logDetails = logDetails; 085 } 086 087 088 089 /** 090 * Logs a completion message indicating that tool processing was interrupted 091 * by a JVM shutdown. 092 */ 093 @Override() 094 public void run() 095 { 096 ToolInvocationLogger.logCompletionMessage(logDetails, null, 097 INFO_TOOL_INTERRUPTED_BY_JVM_SHUTDOWN.get()); 098 } 099}