org.jboss.threads

Class JBossThread

java.lang.Object

java.lang.Thread

org.jboss.threads.JBossThread

All Implemented Interfaces:

java.lang.Runnable

public final class JBossThread
extends java.lang.Thread

A JBoss thread. Supports logging and extra operations.

Nested Class Summary

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

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private static org.jboss.logging.Logger	ihlog
private java.util.concurrent.atomic.AtomicInteger	intCnt
private InterruptHandler	interruptHandler
private static org.jboss.logging.Logger	log
private ThreadNameInfo	threadNameInfo

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
JBossThread(java.lang.Runnable target) Construct a new instance.
JBossThread(java.lang.Runnable target, java.lang.String name) Construct a new instance.
JBossThread(java.lang.ThreadGroup group, java.lang.Runnable target) Construct a new instance.
JBossThread(java.lang.ThreadGroup group, java.lang.Runnable target, java.lang.String name) Construct a new instance.
JBossThread(java.lang.ThreadGroup group, java.lang.Runnable target, java.lang.String name, long stackSize) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static JBossThread	currentThread() Get the current JBossThread, or null if the current thread is not a JBossThread.
private void	doInterrupt()
static <T> T	executeWithInterruptDeferred(java.util.concurrent.Callable<T> action) Defer interrupts for the duration of some task.
static void	executeWithInterruptDeferred(DirectExecutor directExecutor, java.lang.Runnable task) Defer interrupts for the duration of some task.
static <T> T	executeWithInterruptDeferred(java.security.PrivilegedAction<T> action) Defer interrupts for the duration of some task.
static <T> T	executeWithInterruptDeferred(java.security.PrivilegedExceptionAction<T> action) Defer interrupts for the duration of some task.
static void	executeWithInterruptDeferred(java.lang.Runnable task) Defer interrupts for the duration of some task.
static InterruptHandler	getAndSetInterruptHandler(InterruptHandler newInterruptHandler) Swap the current thread's active interrupt handler.
(package private) ThreadNameInfo	getThreadNameInfo() Get the thread name information.
void	interrupt() Interrupt this thread.
boolean	isInterrupted()
private static boolean	registerDeferral(JBossThread thread)
void	run() Execute the thread's Runnable.
(package private) void	setThreadNameInfo(ThreadNameInfo threadNameInfo) Set the thread name information.
void	setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler eh) Change the uncaught exception handler for this thread.
void	start() Start the thread.
private static void	unregisterDeferral(boolean intr, JBossThread thread)

Methods inherited from class java.lang.Thread

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

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.jboss.logging.Logger log

ihlog

private static final org.jboss.logging.Logger ihlog

interruptHandler

private volatile InterruptHandler interruptHandler

threadNameInfo

private ThreadNameInfo threadNameInfo

intCnt

private final java.util.concurrent.atomic.AtomicInteger intCnt

Constructor Detail

JBossThread

public JBossThread(java.lang.Runnable target)

Construct a new instance.

Parameters:

target - the runnable target

See Also:

#Thread(Runnable)

JBossThread

public JBossThread(java.lang.Runnable target,
                   java.lang.String name)

Construct a new instance.

Parameters:

target - the runnable target

name - the initial thread name

See Also:

#Thread(Runnable, String)

JBossThread

public JBossThread(java.lang.ThreadGroup group,
                   java.lang.Runnable target)
            throws java.lang.SecurityException

Construct a new instance.

Parameters:

group - the parent thread group

target - the runnable target

Throws:

java.lang.SecurityException - if the current thread cannot create a thread in the specified thread group

See Also:

#Thread(ThreadGroup, Runnable)

JBossThread

public JBossThread(java.lang.ThreadGroup group,
                   java.lang.Runnable target,
                   java.lang.String name)
            throws java.lang.SecurityException

Construct a new instance.

Parameters:

group - the parent thread group

target - the runnable target

name - the initial thread name

Throws:

java.lang.SecurityException - if the current thread cannot create a thread in the specified thread group

See Also:

#Thread(ThreadGroup,Runnable,String)

JBossThread

public JBossThread(java.lang.ThreadGroup group,
                   java.lang.Runnable target,
                   java.lang.String name,
                   long stackSize)
            throws java.lang.SecurityException

Construct a new instance.

Parameters:

group - the parent thread group

target - the runnable target

name - the initial thread name

Throws:

java.lang.SecurityException - if the current thread cannot create a thread in the specified thread group

See Also:

#Thread(ThreadGroup,Runnable,String,long)

Method Detail

interrupt

public void interrupt()

Interrupt this thread. Logs a trace message and calls the current interrupt handler, if any. The interrupt handler is called from the calling thread, not the thread being interrupted.

Overrides:

interrupt in class java.lang.Thread

doInterrupt

private void doInterrupt()

isInterrupted

public boolean isInterrupted()

Overrides:

isInterrupted in class java.lang.Thread

executeWithInterruptDeferred

public static void executeWithInterruptDeferred(java.lang.Runnable task)

Defer interrupts for the duration of some task. Once the task is complete, any deferred interrupt will be delivered to the thread, thus the thread interrupt status should be checked upon return. If the current thread is not a JBossThread, the task is simply run as-is.

Parameters:

task - the task to run

executeWithInterruptDeferred

public static void executeWithInterruptDeferred(DirectExecutor directExecutor,
                                                java.lang.Runnable task)

Defer interrupts for the duration of some task. Once the task is complete, any deferred interrupt will be delivered to the thread, thus the thread interrupt status should be checked upon return. If the current thread is not a JBossThread, the task is simply run as-is.

Parameters:

directExecutor - the task executor to use

task - the task to run

executeWithInterruptDeferred

public static <T> T executeWithInterruptDeferred(java.util.concurrent.Callable<T> action)
                                          throws java.lang.Exception

Defer interrupts for the duration of some task. Once the task is complete, any deferred interrupt will be delivered to the thread, thus the thread interrupt status should be checked upon return. If the current thread is not a JBossThread, the task is simply run as-is.

Type Parameters:

T - the callable's return type

Parameters:

action - the task to run

T - the value returned from the callable

Throws:

java.lang.Exception - if the action throws an exception

executeWithInterruptDeferred

public static <T> T executeWithInterruptDeferred(java.security.PrivilegedAction<T> action)

Defer interrupts for the duration of some task. Once the task is complete, any deferred interrupt will be delivered to the thread, thus the thread interrupt status should be checked upon return. If the current thread is not a JBossThread, the task is simply run as-is.

Type Parameters:

T - the action's return type

Parameters:

action - the task to run

T - the value returned from the callable

executeWithInterruptDeferred

public static <T> T executeWithInterruptDeferred(java.security.PrivilegedExceptionAction<T> action)
                                          throws java.lang.Exception

Defer interrupts for the duration of some task. Once the task is complete, any deferred interrupt will be delivered to the thread, thus the thread interrupt status should be checked upon return. If the current thread is not a JBossThread, the task is simply run as-is.

Type Parameters:

T - the action's return type

Parameters:

action - the task to run

T - the value returned from the callable

Throws:

java.lang.Exception - if the action throws an exception

unregisterDeferral

private static void unregisterDeferral(boolean intr,
                                       JBossThread thread)

registerDeferral

private static boolean registerDeferral(JBossThread thread)

run

public void run()

Execute the thread's Runnable. Logs a trace message at the start and end of execution.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

currentThread

public static JBossThread currentThread()

Get the current JBossThread, or null if the current thread is not a JBossThread.

Returns:

the current thread, or null

start

public void start()

Start the thread.

Overrides:

start in class java.lang.Thread

Throws:

java.lang.IllegalThreadStateException - if the thread was already started.

setUncaughtExceptionHandler

public void setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler eh)

Change the uncaught exception handler for this thread.

Overrides:

setUncaughtExceptionHandler in class java.lang.Thread

Parameters:

eh - the new handler

getAndSetInterruptHandler

public static InterruptHandler getAndSetInterruptHandler(InterruptHandler newInterruptHandler)

Swap the current thread's active interrupt handler. Most callers should restore the old handler in a finally block like this:

 InterruptHandler oldHandler = JBossThread.getAndSetInterruptHandler(newHandler);
 try {
     ...execute interrupt-sensitive operation...
 } finally {
     JBossThread.getAndSetInterruptHandler(oldHandler);
 }
 

Parameters:

newInterruptHandler - the new interrupt handler

Returns:

the old interrupt handler

getThreadNameInfo

ThreadNameInfo getThreadNameInfo()

Get the thread name information. This includes information about the thread's sequence number and so forth.

Returns:

the thread name info

setThreadNameInfo

void setThreadNameInfo(ThreadNameInfo threadNameInfo)
                throws java.lang.SecurityException

Set the thread name information. This includes information about the thread's sequence number and so forth.

Parameters:

threadNameInfo - the new thread name info

Throws:

java.lang.SecurityException - if the calling thread is not allowed to modify this thread