001/* 002 * Copyright 2008-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2008-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) 2015-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.monitors; 037 038 039 040import java.io.Serializable; 041import java.util.Collections; 042import java.util.List; 043 044import com.unboundid.util.NotMutable; 045import com.unboundid.util.ThreadSafety; 046import com.unboundid.util.ThreadSafetyLevel; 047 048 049 050/** 051 * This class defines a data structure that can hold information about a thread 052 * stack trace read from the Directory Server's stack trace monitor. 053 * <BR> 054 * <BLOCKQUOTE> 055 * <B>NOTE:</B> This class, and other classes within the 056 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 057 * supported for use against Ping Identity, UnboundID, and 058 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 059 * for proprietary functionality or for external specifications that are not 060 * considered stable or mature enough to be guaranteed to work in an 061 * interoperable way with other types of LDAP servers. 062 * </BLOCKQUOTE> 063 * <BR> 064 * The information available in a thread stack trace includes: 065 * <UL> 066 * <LI>The name of the thread. This is generally a user-friendly string that 067 * indicates what that thread does within the server.</LI> 068 * <LI>The thread ID that is assigned to the thread by the JVM.</LI> 069 * <LI>The stack trace frames for that thread as a list of 070 * {@link StackTraceElement} objects.</LI> 071 * </UL> 072 * See the documentation in the {@link StackTraceMonitorEntry} class for 073 * information about accessing the Directory Server stack trace. 074 */ 075@NotMutable() 076@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 077public final class ThreadStackTrace 078 implements Serializable 079{ 080 /** 081 * The serial version UID for this serializable class. 082 */ 083 private static final long serialVersionUID = 5032934844534051999L; 084 085 086 087 // The thread ID for this thread. 088 private final int threadID; 089 090 // The list of stack trace elements for the thread. 091 private final List<StackTraceElement> stackTraceElements; 092 093 // The name for this thread. 094 private final String threadName; 095 096 097 098 /** 099 * Creates a new thread stack trace with the provided information. 100 * 101 * @param threadID The thread ID for the associated thread. 102 * @param threadName The name for the associated thread. 103 * @param stackTraceElements A list of the stack trace elements for the 104 * associated thread. It may be empty if no stack 105 * trace was available. 106 */ 107 public ThreadStackTrace(final int threadID, final String threadName, 108 final List<StackTraceElement> stackTraceElements) 109 { 110 this.threadID = threadID; 111 this.threadName = threadName; 112 this.stackTraceElements = Collections.unmodifiableList(stackTraceElements); 113 } 114 115 116 117 /** 118 * Retrieves the thread ID for the associated thread. 119 * 120 * @return The thread ID for the associated thread. 121 */ 122 public int getThreadID() 123 { 124 return threadID; 125 } 126 127 128 129 /** 130 * Retrieves the name of the associated thread. 131 * 132 * @return The name of the associated thread. 133 */ 134 public String getThreadName() 135 { 136 return threadName; 137 } 138 139 140 141 /** 142 * Retrieves the list of stack trace elements for the associated thread. 143 * 144 * @return The list of stack trace elements for the associated thread, or an 145 * empty list if no stack trace was available. 146 */ 147 public List<StackTraceElement> getStackTraceElements() 148 { 149 return stackTraceElements; 150 } 151}