Package org.opends.server.api

Class DirectoryThread

java.lang.Object

java.lang.Thread

org.opends.server.api.DirectoryThread

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ChangeNumberIndexer, DirectoryServerShutdownHook, HeartbeatThread, IdleTimeLimitThread, MonitoringPublisher, PeerServerReader, ReplicationServerConnectThread, ReplicationServerListenThread, TaskScheduler

@PublicAPI(stability=VOLATILE,
           mayInstantiate=true,
           mayExtend=true,
           mayInvoke=true)
public class DirectoryThread
extends Thread

This class defines a generic thread that should be the superclass for all threads created by the Directory Server. That is, instead of having a class that "extends Thread", you should make it "extends DirectoryThread". This provides various value-added capabilities, including:

• It helps make sure that all threads have a human-readable name so they are easier to identify in stack traces.
• It can capture a stack trace from the time that this thread was created that could be useful for debugging purposes.
• It plays an important role in ensuring that log messages generated as part of the processing for Directory Server tasks are properly captured and made available as part of that task.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
static org.opends.server.api.DirectoryThread.DirectoryThreadGroup	DIRECTORY_THREAD_GROUP	The directory thread group that all directory threads will be a member of.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor	Description
	DirectoryThread(Runnable target, String threadName)	Creates a new instance of this directory thread with the specified name and with the specified target as its run object.
protected	DirectoryThread(String threadName)	Creates a new instance of this directory thread with the specified name.

Method Summary

Modifier and Type	Method	Description
Task	getAssociatedTask()	Retrieves the task with which this thread is associated.
Map<String,String>	getDebugProperties()	Retrieves any relevant debug information with which this tread is associated so they can be included in debug messages.
void	initiateShutdown()	Instructs the current thread to initiate the shutdown process.
boolean	isShutdownInitiated()	Returns whether the shutdown process has been initiated on the current thread.
boolean	isStarted()	Returns true if this thread has been started.
boolean	isStarting()	Returns true if this thread is waiting to be started.
protected void	setAssociatedTask(Task task)	Sets the task with which this thread is associated.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DIRECTORY_THREAD_GROUP

public static final org.opends.server.api.DirectoryThread.DirectoryThreadGroup DIRECTORY_THREAD_GROUP

The directory thread group that all directory threads will be a member of.

Constructor Detail

DirectoryThread

protected DirectoryThread(String threadName)

Creates a new instance of this directory thread with the specified name.

Parameters:

threadName - The human-readable name to use for this thread for debugging purposes.

DirectoryThread

public DirectoryThread(Runnable target,
                       String threadName)

Creates a new instance of this directory thread with the specified name and with the specified target as its run object.

Parameters:

target - The target runnable object.

threadName - The human-readable name to use for this thread for debugging purposes.

Method Detail

getAssociatedTask

public Task getAssociatedTask()

Retrieves the task with which this thread is associated. This will only be available for threads that are used in the process of running a task.

Returns:

The task with which this thread is associated, or null if there is none.

setAssociatedTask

protected void setAssociatedTask(Task task)

Sets the task with which this thread is associated. It may be null to indicate that it is not associated with any task.

Parameters:

task - The task with which this thread is associated.

getDebugProperties

public Map<String,String> getDebugProperties()

Retrieves any relevant debug information with which this tread is associated so they can be included in debug messages.

Returns:

debug information about this thread as a string.

isStarting

public boolean isStarting()

Returns true if this thread is waiting to be started.

Returns:

true if this thread is waiting to be started.

isStarted

public boolean isStarted()

Returns true if this thread has been started.

Returns:

true if this thread has been started.

isShutdownInitiated

public boolean isShutdownInitiated()

Returns whether the shutdown process has been initiated on the current thread. It also returns true when the thread is actually terminated.

Waiting for the thread to terminate should be done by invoking one of the Thread.join() methods.

Returns:

true if the shutdown process has been initiated on the current thread, false otherwise.

initiateShutdown

public void initiateShutdown()

Instructs the current thread to initiate the shutdown process. The actual shutdown of the thread is a best effort and is dependent on the implementation of the Thread.run() method.