java.lang.Object
- org.pipecraft.infra.concurrent.FutureCompletionHandler<Object>
- - org.pipecraft.infra.concurrent.FutureCompletionLogger

All Implemented Interfaces:

Runnable
```
public class FutureCompletionLogger
extends FutureCompletionHandler<Object>
```
To be set as a listener on ListenableFutures. This is useful in order to capture their termination results(either result object on success or exception in case of failure), and log accordingly. Specially useful for tracking success/failure on futures which no thread block on (fire and forget scenarios).

Author:

Eyal Schneider

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`FutureCompletionLogger(org.slf4j.Logger logger, org.slf4j.event.Level successLevel, org.slf4j.event.Level errLevel, String actionName, Future<?> future)`	Constructor

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static <T> void`	`listenTo(com.google.common.util.concurrent.ListenableFuture<T> future, org.slf4j.Logger logger, org.slf4j.event.Level successLevel, org.slf4j.event.Level errLevel, String actionName)`	Adds a logging listener (SLF4J) to a given `ListenableFuture`.
`static <T> void`	`listenToError(com.google.common.util.concurrent.ListenableFuture<T> future, org.slf4j.Logger logger, org.slf4j.event.Level level, String actionName)`	Adds a logging listener (SLF4J) on error events to a given `ListenableFuture`.

Methods inherited from class org.pipecraft.infra.concurrent.FutureCompletionHandler
listenTo, listenTo, listenToError, listenToError, listenToSuccess, listenToSuccess, run

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FutureCompletionLogger

protected FutureCompletionLogger(org.slf4j.Logger logger,
                                 org.slf4j.event.Level successLevel,
                                 org.slf4j.event.Level errLevel,
                                 String actionName,
                                 Future<?> future)

Constructor

Parameters:: logger - The logger to write to; successLevel - The logging level to use when logging successful completion. Use null for no logging.; errLevel - The logging level to use when logging failed completion. Use null for no logging.; actionName - The name of the action; future - The future object to test for errors.

Method Detail

listenTo

public static <T> void listenTo(com.google.common.util.concurrent.ListenableFuture<T> future,
                                org.slf4j.Logger logger,
                                org.slf4j.event.Level successLevel,
                                org.slf4j.event.Level errLevel,
                                String actionName)

Adds a logging listener (SLF4J) to a given ListenableFuture. The logging occurs in the producer thread.

Parameters:: future - The future to listen to; logger - The logger to write to; successLevel - The logging level to use when logging successful completion; errLevel - The logging level to use when logging failed completion; actionName - The name of the action

listenToError

public static <T> void listenToError(com.google.common.util.concurrent.ListenableFuture<T> future,
                                     org.slf4j.Logger logger,
                                     org.slf4j.event.Level level,
                                     String actionName)

Adds a logging listener (SLF4J) on error events to a given ListenableFuture. The logging occurs in the producer thread.

Parameters:: future - The future to listen to; logger - The logger to write to; level - The logging level to use when logging failed completion; actionName - The name of the action

Class FutureCompletionLogger