Transmittable ThreadLocal

https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/
Admin
TransmittableThreadLocal (TTL) is a Java library that provides an enhanced InheritableThreadLocal...
Tokens:35,002
Snippets:217
Trust Score:9.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Configure TTL Agent via JVM Arguments

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/threadpool/agent/TtlAgent.html

Examples of passing configuration keys to the TTL agent using the -javaagent flag.

```bash
-javaagent:/path/to/transmittable-thread-local-2.x.y.jar=ttl.agent.disable.inheritable.for.thread.pool:true
```

```bash
-javaagent:/path/to/transmittable-thread-local-2.x.y.jar
```

```bash
-javaagent:/path/to/transmittable-thread-local-2.x.y.jar=ttl.agent.logger:STDOUT
```

```bash
-javaagent:/path/to/transmittable-thread-local-2.x.y.jar=ttl.agent.enable.timer.task:false
```

```bash
-javaagent:/path/to/transmittable-thread-local-2.x.y.jar=ttl.agent.enable.timer.task:true
```

```bash
-javaagent:/path/to/transmittable-thread-local-2.x.y.jar=ttl.agent.logger:STDOUT,ttl.agent.disable.inheritable.for.thread.pool:true
```

```bash
-Xbootclasspath/a:path/to/ttl-foo-name-changed.jar
```

--------------------------------

### TtlRunnable Gets Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Factory methods to wrap a Collection of Runnables with TtlRunnable.

```APIDOC
## POST TtlRunnable.gets(Collection<? extends Runnable>)

### Description
Factory method to wrap an input `Runnable` Collection to a `TtlRunnable` Collection. Ensures `TransmittableThreadLocal` values are propagated.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **runnables** (Collection<? extends Runnable>) - Required - The collection of Runnables to wrap.

### Request Example
```json
{
  "runnables": ["Runnable object 1", "Runnable object 2"]
}
```

### Response
#### Success Response (200)
- **ttlRunnables** (Collection<TtlRunnable>) - A collection of wrapped TtlRunnable instances.

#### Response Example
```json
{
  "ttlRunnables": ["TtlRunnable object 1", "TtlRunnable object 2"]
}
```

## POST TtlRunnable.gets(Collection<? extends Runnable>, boolean)

### Description
Factory method to wrap an input `Runnable` Collection to a `TtlRunnable` Collection. Allows configuration of inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **runnables** (Collection<? extends Runnable>) - Required - The collection of Runnables to wrap.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.

### Request Example
```json
{
  "runnables": ["Runnable object 1", "Runnable object 2"],
  "disableInheritable": true
}
```

### Response
#### Success Response (200)
- **ttlRunnables** (Collection<TtlRunnable>) - A collection of wrapped TtlRunnable instances.

#### Response Example
```json
{
  "ttlRunnables": ["TtlRunnable object 1", "TtlRunnable object 2"]
}
```

## POST TtlRunnable.gets(Collection<? extends Runnable>, boolean, boolean)

### Description
Factory method to wrap an input `Runnable` Collection to a `TtlRunnable` Collection. Provides fine-grained control over inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **runnables** (Collection<? extends Runnable>) - Required - The collection of Runnables to wrap.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.
- **closeable** (boolean) - Optional - Indicates if the TtlRunnable should be closeable.

### Request Example
```json
{
  "runnables": ["Runnable object 1", "Runnable object 2"],
  "disableInheritable": true,
  "closeable": false
}
```

### Response
#### Success Response (200)
- **ttlRunnables** (Collection<TtlRunnable>) - A collection of wrapped TtlRunnable instances.

#### Response Example
```json
{
  "ttlRunnables": ["TtlRunnable object 1", "TtlRunnable object 2"]
}
```
```

--------------------------------

### TtlCallable Gets Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Factory methods to wrap a Collection of Callables with TtlCallable.

```APIDOC
## POST TtlCallable.gets(Collection<? extends Callable<T>>)

### Description
Factory method to wrap an input `Callable` Collection to a `TtlCallable` Collection. Ensures `TransmittableThreadLocal` values are propagated.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **callables** (Collection<? extends Callable<T>>) - Required - The collection of Callables to wrap.

### Request Example
```json
{
  "callables": ["Callable object 1", "Callable object 2"]
}
```

### Response
#### Success Response (200)
- **ttlCallables** (Collection<TtlCallable<T>>) - A collection of wrapped TtlCallable instances.

#### Response Example
```json
{
  "ttlCallables": ["TtlCallable object 1", "TtlCallable object 2"]
}
```

## POST TtlCallable.gets(Collection<? extends Callable<T>>, boolean)

### Description
Factory method to wrap an input `Callable` Collection to a `TtlCallable` Collection. Allows configuration of inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **callables** (Collection<? extends Callable<T>>) - Required - The collection of Callables to wrap.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.

### Request Example
```json
{
  "callables": ["Callable object 1", "Callable object 2"],
  "disableInheritable": true
}
```

### Response
#### Success Response (200)
- **ttlCallables** (Collection<TtlCallable<T>>) - A collection of wrapped TtlCallable instances.

#### Response Example
```json
{
  "ttlCallables": ["TtlCallable object 1", "TtlCallable object 2"]
}
```

## POST TtlCallable.gets(Collection<? extends Callable<T>>, boolean, boolean)

### Description
Factory method to wrap an input `Callable` Collection to a `TtlCallable` Collection. Provides fine-grained control over inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **callables** (Collection<? extends Callable<T>>) - Required - The collection of Callables to wrap.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.
- **closeable** (boolean) - Optional - Indicates if the TtlCallable should be closeable.

### Request Example
```json
{
  "callables": ["Callable object 1", "Callable object 2"],
  "disableInheritable": true,
  "closeable": false
}
```

### Response
#### Success Response (200)
- **ttlCallables** (Collection<TtlCallable<T>>) - A collection of wrapped TtlCallable instances.

#### Response Example
```json
{
  "ttlCallables": ["TtlCallable object 1", "TtlCallable object 2"]
}
```
```

--------------------------------

### TtlAttachments Get TtlAttachment Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Methods to retrieve TTL attachments from TtlAttachments instances.

```APIDOC
## GET TtlAttachments.getTtlAttachment(String)

### Description
Retrieves the TTL attachment for TTL tasks using a key.

### Method
GET

### Endpoint
N/A (Instance method on TtlAttachments interface)

### Parameters
#### Query Parameters
- **key** (String) - Required - The key to identify the TTL attachment.

### Request Example
None (typically called on an instance)

### Response
#### Success Response (200)
- **attachmentValue** (Object) - The value of the TTL attachment.

#### Response Example
```json
{
  "attachmentValue": "attachment_data"
}
```

## GET TtlAttachmentsDelegate.getTtlAttachment(String)

### Description
Retrieves the TTL attachment for TTL tasks using a key from a delegate.

### Method
GET

### Endpoint
N/A (Instance method on TtlAttachmentsDelegate class)

### Parameters
#### Query Parameters
- **key** (String) - Required - The key to identify the TTL attachment.

### Request Example
None (typically called on an instance)

### Response
#### Success Response (200)
- **attachmentValue** (Object) - The value of the TTL attachment.

#### Response Example
```json
{
  "attachmentValue": "attachment_data"
}
```

## GET TtlCallable.getTtlAttachment(String)

### Description
Retrieves the TTL attachment for TTL tasks using a key from a TtlCallable.

### Method
GET

### Endpoint
N/A (Instance method on TtlCallable class)

### Parameters
#### Query Parameters
- **key** (String) - Required - The key to identify the TTL attachment.

### Request Example
None (typically called on an instance)

### Response
#### Success Response (200)
- **attachmentValue** (Object) - The value of the TTL attachment.

#### Response Example
```json
{
  "attachmentValue": "attachment_data"
}
```

## GET TtlRunnable.getTtlAttachment(String)

### Description
Retrieves the TTL attachment for TTL tasks using a key from a TtlRunnable.

### Method
GET

### Endpoint
N/A (Instance method on TtlRunnable class)

### Parameters
#### Query Parameters
- **key** (String) - Required - The key to identify the TTL attachment.

### Request Example
None (typically called on an instance)

### Response
#### Success Response (200)
- **attachmentValue** (Object) - The value of the TTL attachment.

#### Response Example
```json
{
  "attachmentValue": "attachment_data"
}
```
```

--------------------------------

### TtlTimerTask Get Methods (Deprecated)

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Deprecated factory methods to wrap a TimerTask with TtlTimerTask. Use with caution.

```APIDOC
## POST TtlTimerTask.get(TimerTask) (Deprecated)

### Description
Deprecated factory method to wrap an input `TimerTask` to `TtlTimerTask`. Use with caution.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **timerTask** (TimerTask) - Required - The original TimerTask to be wrapped.

### Request Example
```json
{
  "timerTask": "TimerTask object"
}
```

### Response
#### Success Response (200)
- **ttlTimerTask** (TtlTimerTask) - The wrapped TtlTimerTask instance.

#### Response Example
```json
{
  "ttlTimerTask": "TtlTimerTask object"
}
```

## POST TtlTimerTask.get(TimerTask, boolean) (Deprecated)

### Description
Deprecated factory method to wrap an input `TimerTask` to `TtlTimerTask`. Allows configuration of inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **timerTask** (TimerTask) - Required - The original TimerTask to be wrapped.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.

### Request Example
```json
{
  "timerTask": "TimerTask object",
  "disableInheritable": true
}
```

### Response
#### Success Response (200)
- **ttlTimerTask** (TtlTimerTask) - The wrapped TtlTimerTask instance.

#### Response Example
```json
{
  "ttlTimerTask": "TtlTimerTask object"
}
```

## POST TtlTimerTask.get(TimerTask, boolean, boolean) (Deprecated)

### Description
Deprecated factory method to wrap an input `TimerTask` to `TtlTimerTask`. Provides fine-grained control over inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **timerTask** (TimerTask) - Required - The original TimerTask to be wrapped.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.
- **closeable** (boolean) - Optional - Indicates if the TtlTimerTask should be closeable.

### Request Example
```json
{
  "timerTask": "TimerTask object",
  "disableInheritable": true,
  "closeable": false
}
```

### Response
#### Success Response (200)
- **ttlTimerTask** (TtlTimerTask) - The wrapped TtlTimerTask instance.

#### Response Example
```json
{
  "ttlTimerTask": "TtlTimerTask object"
}
```
```

--------------------------------

### TtlCallable Get Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Factory methods to wrap a Callable with TtlCallable, enabling transmission of TransmittableThreadLocal values.

```APIDOC
## POST TtlCallable.get(Callable<T>)

### Description
Factory method to wrap an input `Callable` to `TtlCallable`. This ensures that `TransmittableThreadLocal` values are correctly propagated.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **callable** (Callable<T>) - Required - The original Callable to be wrapped.

### Request Example
```json
{
  "callable": "Callable object"
}
```

### Response
#### Success Response (200)
- **ttlCallable** (TtlCallable<T>) - The wrapped TtlCallable instance.

#### Response Example
```json
{
  "ttlCallable": "TtlCallable object"
}
```

## POST TtlCallable.get(Callable<T>, boolean)

### Description
Factory method to wrap an input `Callable` to `TtlCallable`. Allows configuration of inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **callable** (Callable<T>) - Required - The original Callable to be wrapped.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.

### Request Example
```json
{
  "callable": "Callable object",
  "disableInheritable": true
}
```

### Response
#### Success Response (200)
- **ttlCallable** (TtlCallable<T>) - The wrapped TtlCallable instance.

#### Response Example
```json
{
  "ttlCallable": "TtlCallable object"
}
```

## POST TtlCallable.get(Callable<T>, boolean, boolean)

### Description
Factory method to wrap an input `Callable` to `TtlCallable`. Provides fine-grained control over inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **callable** (Callable<T>) - Required - The original Callable to be wrapped.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.
- **closeable** (boolean) - Optional - Indicates if the TtlCallable should be closeable.

### Request Example
```json
{
  "callable": "Callable object",
  "disableInheritable": true,
  "closeable": false
}
```

### Response
#### Success Response (200)
- **ttlCallable** (TtlCallable<T>) - The wrapped TtlCallable instance.

#### Response Example
```json
{
  "ttlCallable": "TtlCallable object"
}
```
```

--------------------------------

### TtlForkJoinPoolHelper Get Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Methods to obtain default or custom ThreadFactory wrappers that disable inheritable behavior for ForkJoinWorkerThreads.

```APIDOC
## GET TtlForkJoinPoolHelper.getDefaultDisableInheritableForkJoinWorkerThreadFactory()

### Description
Wrapper of `ForkJoinPool.defaultForkJoinWorkerThreadFactory`, disables inheritable behavior for TransmittableThreadLocal.

### Method
GET

### Endpoint
N/A (Static method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **threadFactory** (ForkJoinPool.ForkJoinWorkerThreadFactory) - A ThreadFactory that disables inheritable behavior.

#### Response Example
```json
{
  "threadFactory": "ForkJoinWorkerThreadFactory object"
}
```

## POST TtlForkJoinPoolHelper.getDisableInheritableForkJoinWorkerThreadFactory(ForkJoinPool.ForkJoinWorkerThreadFactory)

### Description
Wrapper of a provided `ForkJoinPool.ForkJoinWorkerThreadFactory`, disables inheritable behavior for TransmittableThreadLocal.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **originalFactory** (ForkJoinPool.ForkJoinWorkerThreadFactory) - Required - The original ThreadFactory to wrap.

### Request Example
```json
{
  "originalFactory": "ForkJoinWorkerThreadFactory object"
}
```

### Response
#### Success Response (200)
- **wrappedFactory** (ForkJoinPool.ForkJoinWorkerThreadFactory) - A ThreadFactory that disables inheritable behavior.

#### Response Example
```json
{
  "wrappedFactory": "ForkJoinWorkerThreadFactory object"
}
```
```

--------------------------------

### Capture, Replay, and Restore ThreadLocal Values

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TransmittableThreadLocal.Transmitter.html

Use Transmitter.capture() to get current thread's TransmittableThreadLocal values. Then, in another thread, use Transmitter.replay() to apply these values and Transmitter.restore() to revert changes.

```java
///////////////////////////////////////////////////////////////////////////
// in thread A, capture all TransmittableThreadLocal values of thread A
///////////////////////////////////////////////////////////////////////////

Object captured = Transmitter.capture(); // (1)

///////////////////////////////////////////////////////////////////////////
// in thread B
///////////////////////////////////////////////////////////////////////////

// replay all TransmittableThreadLocal values from thread A
Object backup = Transmitter.replay(captured); // (2)
try {
    // your biz logic, run with the TransmittableThreadLocal values of thread B
    System.out.println("Hello");
    // ...
    return "World";
} finally {
    // restore the TransmittableThreadLocal of thread B when replay
    Transmitter.restore(backup); // (3)
}
```

--------------------------------

### GET /getTtlAttachment

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlRunnable.html

Retrieves a TTL attachment value by its key.

```APIDOC
## GET /getTtlAttachment

### Description
Retrieves the value associated with the specified TTL attachment key.

### Method
GET

### Endpoint
/getTtlAttachment

### Parameters
#### Query Parameters
- **key** (String) - Required - The attachment key to retrieve.

### Response
#### Success Response (200)
- **value** (T) - The value associated with the key.
```

--------------------------------

### TtlTimerTask Instance Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlTimerTask.html

Documentation for instance methods of TtlTimerTask, including running the task and accessing the original TimerTask.

```APIDOC
## Instance Methods

### `void run()`

**Deprecated.**
Wraps the `TimerTask.run()` method to handle `TransmittableThreadLocal` values.

### `TimerTask getTimerTask()`

**Deprecated.**
Returns the original, unwrapped `TimerTask`.

### `TimerTask unwrap()`

**Deprecated.**
Unwraps the `TtlTimerTask` to return the original `TimerTask`.
```

--------------------------------

### TtlTimerTask Static Utility Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlTimerTask.html

Details static utility methods for unwrapping TtlTimerTask instances.

```APIDOC
## Static Utility Methods

### `static TimerTask unwrap(TimerTask timerTask)`

**Deprecated.**
Unwraps a `TtlTimerTask` to return the original `TimerTask`.

### `static List<TimerTask> unwraps(Collection<? extends TimerTask> tasks)`

**Deprecated.**
Unwraps a collection of `TtlTimerTask` instances to return a list of their original `TimerTask` counterparts.
```

--------------------------------

### TtlRunnable Get Runnable Method

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Retrieves the original/unwrapped Runnable from a TtlRunnable instance.

```APIDOC
## GET TtlRunnable.getRunnable()

### Description
Retrieves the original/unwrapped `Runnable` from a `TtlRunnable` instance.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **originalRunnable** (Runnable) - The original Runnable object.

#### Response Example
```json
{
  "originalRunnable": "Runnable object"
}
```
```

--------------------------------

### Static Factory Methods for TtlTimerTask

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlTimerTask.html

These static methods provide convenient ways to create and manage TtlTimerTask instances, including wrapping existing TimerTasks and unwrapping TtlTimerTasks.

```APIDOC
## Static Factory Methods for TtlTimerTask

### get
`@Nullable public static TtlTimerTask get(@Nullable TimerTask timerTask)`
Deprecated.
Factory method, wrap input `TimerTask` to `TtlTimerTask`.
This method is idempotent.

Parameters:
`timerTask` - input `TimerTask`

Returns:
Wrapped `TimerTask`

### get
`@Nullable public static TtlTimerTask get(@Nullable TimerTask timerTask, boolean releaseTtlValueReferenceAfterRun)`
Deprecated.
Factory method, wrap input `TimerTask` to `TtlTimerTask`.
This method is idempotent.

Parameters:
`timerTask` - input `TimerTask`
`releaseTtlValueReferenceAfterRun` - release TTL value reference after run, avoid memory leak even if `TtlTimerTask` is referred.

Returns:
Wrapped `TimerTask`

### get
`@Nullable public static TtlTimerTask get(@Nullable TimerTask timerTask, boolean releaseTtlValueReferenceAfterRun, boolean idempotent)`
Deprecated.
Factory method, wrap input `TimerTask` to `TtlTimerTask`.
This method is idempotent.

Parameters:
`timerTask` - input `TimerTask`
`releaseTtlValueReferenceAfterRun` - release TTL value reference after run, avoid memory leak even if `TtlTimerTask` is referred.
`idempotent` - is idempotent or not. `true` will cover up bugs! **DO NOT** set, only when you know why.

Returns:
Wrapped `TimerTask`

### unwrap
`@Nullable public static TimerTask unwrap(@Nullable TimerTask timerTask)`
Deprecated.
Unwrap `TtlTimerTask` to the original/underneath one.
this method is `null`-safe, when input `TimerTask` parameter is `null`, return `null`; if input `TimerTask` parameter is not a `TtlTimerTask` just return input `TimerTask`.

Since:
2.10.2

See Also:
* `get(TimerTask)`

### unwraps
`@NonNull public static List<TimerTask> unwraps(@Nullable Collection<? extends TimerTask> tasks)`
Deprecated.
Unwrap `TtlTimerTask` to the original/underneath one.
Invoke `unwrap(TimerTask)` for each element in input collection.
This method is `null`-safe, when input `TimerTask` parameter is `null`, return a empty list.

Since:
2.10.2

See Also:
* `unwrap(TimerTask)`
```

--------------------------------

### TtlCallable Get Callable Method

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Retrieves the original/underlying Callable from a TtlCallable instance.

```APIDOC
## GET TtlCallable.getCallable()

### Description
Retrieves the original/underlying `Callable` from a `TtlCallable` instance.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **originalCallable** (Callable<T>) - The original Callable object.

#### Response Example
```json
{
  "originalCallable": "Callable object"
}
```
```

--------------------------------

### Task Execution Utilities

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Utility methods for simplifying the replay and restore operations when executing Callables or Suppliers.

```APIDOC
## Execution Utilities

### Description
Simplified methods for executing tasks with captured or cleared ThreadLocal states.

### Methods
- runCallableWithCaptured(Object, Callable<R>)
- runCallableWithClear(Callable<R>)
- runSupplierWithCaptured(Object, Supplier<R>)
- runSupplierWithClear(Supplier<R>)
```

--------------------------------

### TtlCallable Utility Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlCallable.html

Methods for unwrapping and managing TtlCallable instances.

```APIDOC
## static <T> Callable<T> unwrap(Callable<T> callable)

### Description
Unwraps a TtlCallable back to the original underlying Callable.

### Parameters
#### Request Body
- **callable** (Callable<T>) - Required - The TtlCallable instance to unwrap.

### Response
#### Success Response (200)
- **Callable<T>** - The original underlying Callable.

---

## Callable<V> getCallable()

### Description
Returns the original/underneath Callable instance.

### Response
#### Success Response (200)
- **Callable<V>** - The original Callable.
```

--------------------------------

### TtlRunnable and TtlCallable Usage

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/spi/class-use/TtlEnhanced.html

Documentation for the core decoration classes used to transmit thread local values to thread pools.

```APIDOC
## TtlRunnable and TtlCallable

### Description
These classes decorate standard Runnable and Callable objects to capture TransmittableThreadLocal values and transmit them to the time of execution, which is essential when submitting tasks to thread pools.

### Classes
- **TtlRunnable**: Decorates a Runnable to transmit thread local values.
- **TtlCallable<V>**: Decorates a Callable to transmit thread local values.

### Usage
Wrap your existing Runnable or Callable instances with these classes before passing them to an ExecutorService.
```

--------------------------------

### TtlRecursiveTask Get Raw Result Method

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Retrieves the raw result from a TtlRecursiveTask, similar to ForkJoinTask.getRawResult().

```APIDOC
## GET TtlRecursiveTask.getRawResult()

### Description
Retrieves the raw result from a `TtlRecursiveTask`. This method is analogous to `ForkJoinTask.getRawResult()`.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **rawResult** (Object) - The raw result of the recursive task.

#### Response Example
```json
{
  "rawResult": "some_result"
}
```
```

--------------------------------

### TtlRunnable Get Raw Result Method

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Retrieves the raw result from a TtlRecursiveAction, similar to ForkJoinTask.getRawResult().

```APIDOC
## GET TtlRecursiveAction.getRawResult()

### Description
Retrieves the raw result from a `TtlRecursiveAction`. This method is analogous to `ForkJoinTask.getRawResult()`.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **rawResult** (Object) - The raw result of the recursive action.

#### Response Example
```json
{
  "rawResult": "some_result"
}
```
```

--------------------------------

### Library Versions

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/threadpool/agent/package-tree.html

Provides links to the latest version and specific versions of the com.alibaba:transmittable-thread-local library.

```APIDOC
## Library Versions

### Description

Access information and documentation for different versions of the com.alibaba:transmittable-thread-local library.

### Latest Version

*   **URL:** `https://javadoc.io/doc/com.alibaba/transmittable-thread-local`
*   **Version:** 2.14.5
*   **Specific Version URL:** `https://javadoc.io/doc/com.alibaba/transmittable-thread-local/2.14.5`
*   **Package List URL:** `https://javadoc.io/doc/com.alibaba/transmittable-thread-local/2.14.5/package-list`
```

--------------------------------

### TtlTimerTask Get TimerTask Method (Deprecated)

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Deprecated method to retrieve the original/unwrapped TimerTask from a TtlTimerTask instance.

```APIDOC
## GET TtlTimerTask.getTimerTask() (Deprecated)

### Description
Deprecated method to retrieve the original/unwrapped `TimerTask` from a `TtlTimerTask` instance. Use with caution.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **originalTimerTask** (TimerTask) - The original TimerTask object.

#### Response Example
```json
{
  "originalTimerTask": "TimerTask object"
}
```
```

--------------------------------

### TtlForkJoinPoolHelper Utilities

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Utilities for managing `ForkJoinPool` with TTL.

```APIDOC
## GET /api/ttlForkJoinPoolHelper/isDisableInheritableForkJoinWorkerThreadFactory

### Description
Checks if a `ForkJoinPool.ForkJoinWorkerThreadFactory` is a `DisableInheritableForkJoinWorkerThreadFactory`.

### Method
GET

### Endpoint
/api/ttlForkJoinPoolHelper/isDisableInheritableForkJoinWorkerThreadFactory

### Parameters
#### Query Parameters
- **factory** (ForkJoinPool.ForkJoinWorkerThreadFactory) - Required - The `ForkJoinWorkerThreadFactory` to check.

### Request Example
None

### Response
#### Success Response (200)
- **isDisable** (boolean) - True if the factory is `DisableInheritableForkJoinWorkerThreadFactory`, false otherwise.

#### Response Example
```json
{
  "isDisable": true
}
```
```

--------------------------------

### TtlCallable Instance Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlCallable.html

Methods available on TtlCallable instances for lifecycle and attachment management.

```APIDOC
## TtlCallable Instance Methods

### Methods
- **call()**: Executes the wrapped Callable.
- **getCallable()**: Returns the original underlying Callable.
- **unwrap()**: Unwraps the TtlCallable to the original Callable.
- **setTtlAttachment(String key, Object value)**: Sets a TTL attachment on the task.
- **getTtlAttachment(String key)**: Retrieves a TTL attachment.
```

--------------------------------

### Transmittable Thread Local API Packages

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/allpackages-index.html

Overview of the main packages within the Transmittable Thread Local library.

```APIDOC
## Package Summary

### com.alibaba.ttl

**Description:** TTL API.

### com.alibaba.ttl.spi

**Description:** TTL SPI

### com.alibaba.ttl.threadpool

**Description:** Thread pool wrap/decoration utils.

### com.alibaba.ttl.threadpool.agent

**Description:** TTL Agent.
```

--------------------------------

### Transmitter Registration Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Methods for registering ThreadLocal instances to enhance their transmittable capabilities.

```APIDOC
## registerThreadLocal

### Description
Register ThreadLocal (including InheritableThreadLocal) instances to enhance the Transmittable ability.

### Methods
- registerThreadLocal(ThreadLocal<T>, TtlCopier<T>)
- registerThreadLocal(ThreadLocal<T>, TtlCopier<T>, boolean)
- registerThreadLocalWithShadowCopier(ThreadLocal<T>)
- registerThreadLocalWithShadowCopier(ThreadLocal<T>, boolean)

### Parameters
- **threadLocal** (ThreadLocal<T>) - The ThreadLocal instance to register.
- **copier** (TtlCopier<T>) - The copier instance for the ThreadLocal.
- **captureNullValue** (boolean) - Whether to capture null values.
```

--------------------------------

### TtlRunnable Get Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Factory methods to wrap a Runnable with TtlRunnable, enabling transmission of TransmittableThreadLocal values.

```APIDOC
## POST TtlRunnable.get(Runnable)

### Description
Factory method to wrap an input `Runnable` to `TtlRunnable`. This ensures that `TransmittableThreadLocal` values are correctly propagated.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **runnable** (Runnable) - Required - The original Runnable to be wrapped.

### Request Example
```json
{
  "runnable": "Runnable object"
}
```

### Response
#### Success Response (200)
- **ttlRunnable** (TtlRunnable) - The wrapped TtlRunnable instance.

#### Response Example
```json
{
  "ttlRunnable": "TtlRunnable object"
}
```

## POST TtlRunnable.get(Runnable, boolean)

### Description
Factory method to wrap an input `Runnable` to `TtlRunnable`. Allows configuration of inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **runnable** (Runnable) - Required - The original Runnable to be wrapped.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.

### Request Example
```json
{
  "runnable": "Runnable object",
  "disableInheritable": true
}
```

### Response
#### Success Response (200)
- **ttlRunnable** (TtlRunnable) - The wrapped TtlRunnable instance.

#### Response Example
```json
{
  "ttlRunnable": "TtlRunnable object"
}
```

## POST TtlRunnable.get(Runnable, boolean, boolean)

### Description
Factory method to wrap an input `Runnable` to `TtlRunnable`. Provides fine-grained control over inheritable behavior.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **runnable** (Runnable) - Required - The original Runnable to be wrapped.
- **disableInheritable** (boolean) - Optional - If true, disables inheritable behavior for TransmittableThreadLocal.
- **closeable** (boolean) - Optional - Indicates if the TtlRunnable should be closeable.

### Request Example
```json
{
  "runnable": "Runnable object",
  "disableInheritable": true,
  "closeable": false
}
```

### Response
#### Success Response (200)
- **ttlRunnable** (TtlRunnable) - The wrapped TtlRunnable instance.

#### Response Example
```json
{
  "ttlRunnable": "TtlRunnable object"
}
```
```

--------------------------------

### TtlCallable.gets

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/class-use/TtlCallable.html

Factory methods to wrap a collection of Callable tasks into a list of TtlCallable instances.

```APIDOC
## TtlCallable.gets

### Description
Wraps a collection of Callable tasks into a list of TtlCallable instances.

### Parameters
- **tasks** (Collection<? extends Callable<T>>) - Required - The collection of tasks to wrap.
- **releaseTtlValueReferenceAfterCall** (boolean) - Optional - Whether to release the TTL value reference after execution.
- **idempotent** (boolean) - Optional - Whether the tasks are idempotent.

### Response
- **List<TtlCallable<T>>** - A list of wrapped callable instances.
```

--------------------------------

### TransmittableThreadLocal Get Method

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Retrieves the current value of this thread-local variable. This method is part of the TransmittableThreadLocal class itself.

```APIDOC
## GET TransmittableThreadLocal.get()

### Description
Retrieves the current value of this thread-local variable.

### Method
GET

### Endpoint
N/A (Instance method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **value** (Object) - The current value of the thread-local variable.

#### Response Example
```json
{
  "value": "some_value"
}
```
```

--------------------------------

### TtlExecutors Get Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Methods to obtain default or custom ThreadFactory wrappers and Executor/ExecutorService wrappers that support TransmittableThreadLocal.

```APIDOC
## GET TtlExecutors.getDefaultDisableInheritableThreadFactory()

### Description
Wrapper of `Executors.defaultThreadFactory()`, disables inheritable behavior for TransmittableThreadLocal.

### Method
GET

### Endpoint
N/A (Static method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **threadFactory** (ThreadFactory) - A ThreadFactory that disables inheritable behavior.

#### Response Example
```json
{
  "threadFactory": "ThreadFactory object"
}
```

## POST TtlExecutors.getDisableInheritableThreadFactory(ThreadFactory)

### Description
Wrapper of a provided `ThreadFactory`, disables inheritable behavior for TransmittableThreadLocal.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **originalFactory** (ThreadFactory) - Required - The original ThreadFactory to wrap.

### Request Example
```json
{
  "originalFactory": "ThreadFactory object"
}
```

### Response
#### Success Response (200)
- **wrappedFactory** (ThreadFactory) - A ThreadFactory that disables inheritable behavior.

#### Response Example
```json
{
  "wrappedFactory": "ThreadFactory object"
}
```

## POST TtlExecutors.getTtlExecutor(Executor)

### Description
`TransmittableThreadLocal` Wrapper of `Executor`. Transmits `TransmittableThreadLocal` from the task submit time of `Runnable` to the execution time of `Runnable`.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **executor** (Executor) - Required - The original Executor to wrap.

### Request Example
```json
{
  "executor": "Executor object"
}
```

### Response
#### Success Response (200)
- **ttlExecutor** (Executor) - The wrapped Executor that supports TTL transmission.

#### Response Example
```json
{
  "ttlExecutor": "Executor object"
}
```

## POST TtlExecutors.getTtlExecutorService(ExecutorService)

### Description
`TransmittableThreadLocal` Wrapper of `ExecutorService`. Transmits `TransmittableThreadLocal` from the task submit time of `Runnable` or `Callable` to the execution time of `Runnable` or `Callable`.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **executorService** (ExecutorService) - Required - The original ExecutorService to wrap.

### Request Example
```json
{
  "executorService": "ExecutorService object"
}
```

### Response
#### Success Response (200)
- **ttlExecutorService** (ExecutorService) - The wrapped ExecutorService that supports TTL transmission.

#### Response Example
```json
{
  "ttlExecutorService": "ExecutorService object"
}
```

## POST TtlExecutors.getTtlRunnableUnwrapComparator(Comparator<Runnable>)

### Description
Provides a `Comparator<Runnable>` for unwrapping `TtlRunnable` instances.

### Method
POST

### Endpoint
N/A (Static method)

### Parameters
#### Request Body
- **comparator** (Comparator<Runnable>) - Optional - An existing comparator to combine with the unwrapping logic.

### Request Example
```json
{
  "comparator": "Comparator object"
}
```

### Response
#### Success Response (200)
- **unwrapComparator** (Comparator<Runnable>) - A comparator that can unwrap TtlRunnable.

#### Response Example
```json
{
  "unwrapComparator": "Comparator object"
}
```
```

--------------------------------

### ThreadFactory Utilities

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/threadpool/TtlExecutors.html

Utility methods for managing ThreadFactory instances with inheritable thread local settings.

```APIDOC
## getDisableInheritableThreadFactory

### Description
Wraps a ThreadFactory to disable inheritable thread local behavior.

### Parameters
#### Request Body
- **threadFactory** (ThreadFactory) - Required - The input ThreadFactory.

### Response
- **ThreadFactory** - The wrapped ThreadFactory with inheritable disabled.
```

--------------------------------

### TTL Agent Overview

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/threadpool/agent/package-summary.html

Provides an overview of the TTL Agent, its author, and related mechanisms for instrumentation.

```APIDOC
## TTL Agent Overview

### Description
This section details the TTL Agent, a Java Agent for Transmittable ThreadLocal, and its instrumentation mechanism.

### Author
Jerry Lee (oldratlee at gmail dot com)

### See Also
* `TtlAgent`
* The mechanism for instrumentation

### Related Packages
* **com.alibaba.ttl.threadpool**: Thread pool wrap/decoration utils.

### Classes
* **TtlAgent**: TTL Java Agent.
* **TtlTransformer**: TTL `ClassFileTransformer` of Java Agent.
```

--------------------------------

### TtlTimerTask Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlTimerTask.html

This section covers the various methods available in the TtlTimerTask class, including methods for running, canceling, and retrieving the original TimerTask.

```APIDOC
## TtlTimerTask Methods

### run
`public void run()`
Deprecated.
wrap method `TimerTask.run()`.

Specified by:
`run` in interface `Runnable`

Specified by:
`run` in class `TimerTask`

### cancel
`public boolean cancel()`
Deprecated.

Overrides:
`cancel` in class `TimerTask`

### getTimerTask
`@NonNull public TimerTask getTimerTask()`
Deprecated.
return original/unwrapped `TimerTask`.

### unwrap
`@NonNull public TimerTask unwrap()`
Deprecated.
unwrap to original/unwrapped `TimerTask`.

Specified by:
`unwrap` in interface `TtlWrapper<TimerTask>`

Since:
2.11.4

See Also:
* `TtlUnwrap.unwrap(Object)`

### equals
`public boolean equals(Object o)`
Deprecated.

Overrides:
`equals` in class `Object`

### hashCode
`public int hashCode()`
Deprecated.

Overrides:
`hashCode` in class `Object`

### toString
`public String toString()`
Deprecated.

Overrides:
`toString` in class `Object`
```

--------------------------------

### Simplified Replay with Lambda Expressions

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TransmittableThreadLocal.Transmitter.html

Utilize runSupplierWithCaptured for a more concise way to replay captured ThreadLocal values within a lambda expression, combining replay and restore operations.

```java
///////////////////////////////////////////////////////////////////////////
// in thread A, capture all TransmittableThreadLocal values of thread A
///////////////////////////////////////////////////////////////////////////

Object captured = Transmitter.capture(); // (1)

///////////////////////////////////////////////////////////////////////////
// in thread B
///////////////////////////////////////////////////////////////////////////

String result = runSupplierWithCaptured(captured, () -> {
     // your biz logic, run with the TransmittableThreadLocal values of thread A
     System.out.println("Hello");
     ...
     return "World";
}); // (2) + (3)
```

--------------------------------

### TtlCallable Factory Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlCallable.html

Methods for creating decorated TtlCallable instances from standard Callable objects.

```APIDOC
## static <T> TtlCallable<T> get(Callable<T> callable)

### Description
Factory method to wrap an input Callable into a TtlCallable instance.

### Parameters
#### Request Body
- **callable** (Callable<T>) - Required - The original Callable to wrap.

### Response
#### Success Response (200)
- **TtlCallable<T>** - The decorated TtlCallable instance.

---

## static <T> TtlCallable<T> get(Callable<T> callable, boolean releaseTtlValueReferenceAfterCall)

### Description
Factory method to wrap an input Callable with an option to release the TTL value reference after execution.

### Parameters
#### Request Body
- **callable** (Callable<T>) - Required - The original Callable to wrap.
- **releaseTtlValueReferenceAfterCall** (boolean) - Required - Whether to release the TTL value reference after the call.

### Response
#### Success Response (200)
- **TtlCallable<T>** - The decorated TtlCallable instance.
```

--------------------------------

### TtlRunnable Factory Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TtlRunnable.html

Methods for creating TtlRunnable instances to wrap standard Runnable tasks.

```APIDOC
## static TtlRunnable get(Runnable runnable)

### Description
Factory method to wrap an input Runnable into a TtlRunnable.

### Parameters
#### Request Body
- **runnable** (Runnable) - Required - The task to be wrapped.

### Response
#### Success Response (200)
- **TtlRunnable** - The wrapped task instance.

## static List<TtlRunnable> gets(Collection<? extends Runnable> tasks)

### Description
Factory method to wrap a collection of Runnable tasks into a collection of TtlRunnable instances.

### Parameters
#### Request Body
- **tasks** (Collection<? extends Runnable>) - Required - The collection of tasks to be wrapped.

### Response
#### Success Response (200)
- **List<TtlRunnable>** - The list of wrapped task instances.
```

--------------------------------

### TtlUnwrap Utilities

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/index-all.html

Utilities for unwrapping TTL-related objects.

```APIDOC
## GET /api/ttlUnwrap/isWrapper

### Description
Checks if the input object is a `TtlWrapper`.

### Method
GET

### Endpoint
/api/ttlUnwrap/isWrapper

### Parameters
#### Query Parameters
- **obj** (T) - Required - The object to check.

### Request Example
None

### Response
#### Success Response (200)
- **isWrapper** (boolean) - True if the object is a `TtlWrapper`, false otherwise.

#### Response Example
```json
{
  "isWrapper": true
}
```
```

--------------------------------

### Transmitter Lifecycle Methods

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TransmittableThreadLocal.Transmitter.html

Methods to capture, replay, and restore ThreadLocal values across thread boundaries.

```APIDOC
## Transmitter.capture

### Description
Capture all TransmittableThreadLocal and registered ThreadLocal values in the current thread.

## Transmitter.replay

### Description
Replay the captured values in the current thread.

### Parameters
- **captured** (Object) - Required - The captured values object.

## Transmitter.restore

### Description
Restore the backup values in the current thread.

### Parameters
- **backup** (Object) - Required - The backup values object.
```

--------------------------------

### TtlWrapper Interface

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/spi/TtlWrapper.html

Documentation for the TtlWrapper interface, including its purpose and the unwrap method.

```APIDOC
## TtlWrapper Interface

### Description
`TtlWrapper` interface is used to mark wrapper types, for example: `TtlCallable`, `TtlExecutors`, `DisableInheritableThreadFactory`.

### Method Summary

| Modifier and Type | Method   |
|-------------------|----------|
| `T`               | `unwrap()` |

### Method Details

#### unwrap

@NonNull T unwrap()

unwrap `TtlWrapper` to the original/underneath one.

See Also:
    * `TtlUnwrap.unwrap(Object)`
```

--------------------------------

### registerThreadLocalWithShadowCopier (with force)

Source: https://javadoc.io/doc/com.alibaba/transmittable-thread-local/latest/com/alibaba/ttl/TransmittableThreadLocal.Transmitter.html

Registers a ThreadLocal instance using a shadow copier with an optional force flag.

```APIDOC
## registerThreadLocalWithShadowCopier(ThreadLocal, boolean)

### Description
Registers a ThreadLocal instance using a shadow copier. If force is true, it updates the copier even if already registered.

### Parameters
- **threadLocal** (ThreadLocal<T>) - Required - The ThreadLocal instance to enhance.
- **force** (boolean) - Required - If true, updates the copier for already registered instances.

### Response
- **boolean** - Returns true if registered successfully, otherwise false.
```
Tokens:
Raw