com.hubspot.slack.client.concurrency

Enum ThreadContextHook

java.lang.Object

java.lang.Enum<ThreadContextHook>

com.hubspot.slack.client.concurrency.ThreadContextHook

All Implemented Interfaces:

Serializable, Comparable<ThreadContextHook>

public enum ThreadContextHook
extends Enum<ThreadContextHook>

A helper to automatically follow threadlocal contexts across thread boundaries where they make sense.

Writing a new context hook:

1) Create an implementation of the interface ThreadContextFollower 2) Create a file in /resources/META-INF/services called "com.hubspot.java.thread.ThreadContextFollower" 3) Add a line containing the full class name of your implementation. 4) Profit!

Adding a new place to thread the context:

1) Save ThreadContextHook.Context currentContext = ThreadContextHook.INSTANCE.buildThreadContext(namePrefix) when about to leave the current thread.

2) In the other thread, call ThreadContextHook.INSTANCE.initializeThreadContext(namePrefix, currentContext) to hydreate the old context in the current thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThreadContextHook.Context

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
ThreadContextHook.Context	buildThreadContext()
ThreadContextHook.Context	buildThreadContext(String namePrefix)
void	clearThreadContext(String namePrefix, ThreadContextHook.Context context)
void	clearThreadContext(ThreadContextHook.Context context)
ThreadContextHook.Context	initializeThreadContext(String namePrefix, ThreadContextHook.Context context)
ThreadContextHook.Context	initializeThreadContext(ThreadContextHook.Context context)
static ThreadContextHook	valueOf(String name) Returns the enum constant of this type with the specified name.
static ThreadContextHook[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ThreadContextHook INSTANCE

Method Detail

values

public static ThreadContextHook[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ThreadContextHook c : ThreadContextHook.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ThreadContextHook valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

buildThreadContext

public ThreadContextHook.Context buildThreadContext(String namePrefix)

initializeThreadContext

public ThreadContextHook.Context initializeThreadContext(String namePrefix,
                                                         ThreadContextHook.Context context)

clearThreadContext

public void clearThreadContext(String namePrefix,
                               ThreadContextHook.Context context)

buildThreadContext

public ThreadContextHook.Context buildThreadContext()

clearThreadContext

public void clearThreadContext(ThreadContextHook.Context context)

initializeThreadContext

public ThreadContextHook.Context initializeThreadContext(ThreadContextHook.Context context)