com.unboundid.ldap.sdk.unboundidds.monitors
Class StackTraceMonitorEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.StackTraceMonitorEntry
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class StackTraceMonitorEntry
extends MonitorEntry

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a monitor entry that provides access to the Directory Server stack trace information. The information that is available through this monitor is roughly the equivalent of what can be accessed using the Thread.getAllStackTraces() method. See the ThreadStackTrace class for more information about what is available in each stack trace.

The server should present at most one stack trace monitor entry. It can be retrieved using the MonitorManager.getStackTraceMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection) method. The getStackTraces() method can be used to retrieve the stack traces for each thread. Alternately, this information may be accessed using the generic API (although in this case, only the string representations of each stack trace frame are available). See the MonitorManager class documentation for an example that demonstrates the use of the generic API for accessing monitor data.

See Also:
Serialized Form

Constructor Summary
StackTraceMonitorEntry(Entry entry)
          Creates a new stack trace monitor entry from the provided entry.
 
Method Summary
 java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
          Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.
 java.lang.String getMonitorDescription()
          Retrieves a human-readable description name for this monitor entry.
 java.lang.String getMonitorDisplayName()
          Retrieves a human-readable display name for this monitor entry.
 java.util.List<ThreadStackTrace> getStackTraces()
          Retrieves the list of thread stack traces.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StackTraceMonitorEntry

public StackTraceMonitorEntry(Entry entry)
Creates a new stack trace monitor entry from the provided entry.

Parameters:
entry - The entry to be parsed as a stack trace monitor entry. It must not be null.
Method Detail

getStackTraces

public java.util.List<ThreadStackTrace> getStackTraces()
Retrieves the list of thread stack traces.

Returns:
The list of thread stack traces, or an empty list if it was not included in the monitor entry or a problem occurs while decoding the stack traces.

getMonitorDisplayName

public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.

Overrides:
getMonitorDisplayName in class MonitorEntry
Returns:
A human-readable display name for this monitor entry.

getMonitorDescription

public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.

Overrides:
getMonitorDescription in class MonitorEntry
Returns:
A human-readable description name for this monitor entry.

getMonitorAttributes

public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.

Overrides:
getMonitorAttributes in class MonitorEntry
Returns:
The set of parsed monitor attributes for this monitor entry.