org.spf4j.base

Interface ExecutionContext

All Superinterfaces:

AutoCloseable, JsonWriteable, Writeable

All Known Implementing Classes:

BasicExecutionContext

@CleanupObligation
 @ParametersAreNonnullByDefault
public interface ExecutionContext
extends AutoCloseable, JsonWriteable

Execution context information encapsulated a place to store execution related information:

• deadline/timeout
• context logs/overrides
• tagged attachments (profiling info, etc..)

Author:

Zoltan Farkas

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExecutionContext.Relation
static interface	ExecutionContext.SimpleTag<T>
static interface	ExecutionContext.Tag<T,A>

Method Summary

Modifier and Type	Method and Description
default <T> void	accumulate(ExecutionContext.Tag<T,?> tag, T data)
default <T,A> void	accumulateComponent(ExecutionContext.Tag<T,A> tag, A data)
void	add(StackSamples samples)
void	add(StackTraceElement[] sample)
void	addCloseable(AutoCloseable closeable) Attach a AutoCloseable to execution context.
void	addLog(Slf4jLogRecord log)
void	addLogs(Collection<Slf4jLogRecord> log)
default <T> List<T>	addToRootParent(ExecutionContext.Tag<List<T>,T> tag, T data)
void	attach() Attach execution context to the current thread.
void	close()
default <T> void	combine(ExecutionContext.Tag<T,?> tag, T data) Deprecated. use accumulate.
<V,A> V	compute(ExecutionContext.Tag<V,A> key, BiFunction<ExecutionContext.Tag<V,A>,V,V> compute) Compute context associated data.
void	detach() Detach this execution context from the current Thread.
default ExecutionContext	detachedChild(String operationName)
default ExecutionContext	detachedChild(String operationName, long timeout, TimeUnit tu)
<T> T	get(ExecutionContext.Tag<T,?> key) Method to get context associated data.
StackSamples	getAndClearStackSamples()
default Level	getBackendMinLogLevel()
Level	getBackendMinLogLevel(String loggerName) The minimum log level overwrite.
<T> ContextValue<T>	getContextAndValue(ExecutionContext.Tag<T,?> key) Method to get context associated data.
default Level	getContextMinLogLevel()
Level	getContextMinLogLevel(String loggerName) The minimum log level accepted by this execution context; The logs that we will store in this context.
long	getDeadlineNanos()
default org.spf4j.base.avro.DebugDetail	getDebugDetail(String origin, Throwable throwable)
default org.spf4j.base.avro.DebugDetail	getDebugDetail(String origin, Throwable throwable, boolean addStackSamples)
default org.spf4j.base.avro.DebugDetail	getDebugDetail(String origin, Throwable throwable, boolean addStackSamples, int maxNrLogs)
CharSequence	getId()
<T> T	getLocal(ExecutionContext.Tag<T,?> key) Method to get context associated data.
default long	getMillisToDeadline()
String	getName()
default ExecutionContext	getNotClosedParent()
ExecutionContext.Relation	getRelationToSource()
default ExecutionContext	getRoot()
default ExecutionContext	getRootParent()
default int	getSecondsToDeadline()
ExecutionContext	getSource()
StackSamples	getStackSamples()
long	getStartTimeNanos()
default long	getTimeRelativeToDeadline(TimeUnit unit)
default long	getTimeToDeadline(TimeUnit unit)
default long	getUncheckedTimeToDeadline(TimeUnit unit)
boolean	isAttached()
boolean	isClosed()
long	nextChildId()
<T> T	put(ExecutionContext.Tag<T,?> tag, T data) Method to put context associated data.
default <T> T	putToRootParent(ExecutionContext.Tag<T,?> key, T data) Method to put context associated data to the root context.
default Level	setBackendMinLogLevel(Level level)
Level	setBackendMinLogLevel(String loggerName, Level level)
default ExecutionContext	startChild(String operationName)
default ExecutionContext	startChild(String operationName, long timeout, TimeUnit tu)
void	streamLogs(Consumer<Slf4jLogRecord> to)
void	streamLogs(Consumer<Slf4jLogRecord> to, int nrLogs)

Methods inherited from interface org.spf4j.base.JsonWriteable

writeJsonTo, writeJsonTo, writeTo

Methods inherited from interface org.spf4j.base.Writeable

writeTo

Method Detail

close

@DischargesObligation
void close()

Specified by:

close in interface AutoCloseable

getName

@Nonnull
String getName()

getId

CharSequence getId()

getStartTimeNanos

long getStartTimeNanos()

getDeadlineNanos

long getDeadlineNanos()

getSource

@Nullable
ExecutionContext getSource()

getRoot

default ExecutionContext getRoot()

Returns:

the top source. will return this is current is root. will follow all relationship types.

getRootParent

default ExecutionContext getRootParent()

Returns:

Adam of this current context. will return this is current is Adam. follows only CHILD_OF relationships.

getNotClosedParent

@Nullable
default ExecutionContext getNotClosedParent()

Returns:

will return the first not closed parent. null if no parent is available.

addLog

@Beta
void addLog(Slf4jLogRecord log)

addLogs

@Beta
void addLogs(Collection<Slf4jLogRecord> log)

addCloseable

@Beta
void addCloseable(AutoCloseable closeable)

Attach a AutoCloseable to execution context. All of them will be closed when context is closed, in reverse registration order.

Parameters:

closeable -

getContextMinLogLevel

@Beta
Level getContextMinLogLevel(String loggerName)

The minimum log level accepted by this execution context; The logs that we will store in this context.

Returns:

getContextMinLogLevel

default Level getContextMinLogLevel()

getBackendMinLogLevel

@Beta
 @Nullable
Level getBackendMinLogLevel(String loggerName)

The minimum log level overwrite. An execution context can overwrite the backend configured log level.

Returns:

null if not specified.

getBackendMinLogLevel

@Nullable
default Level getBackendMinLogLevel()

setBackendMinLogLevel

@Beta
 @Nullable
Level setBackendMinLogLevel(String loggerName,
                                             Level level)

setBackendMinLogLevel

@Nullable
default Level setBackendMinLogLevel(Level level)

streamLogs

@Beta
void streamLogs(Consumer<Slf4jLogRecord> to)

streamLogs

@Beta
void streamLogs(Consumer<Slf4jLogRecord> to,
                      int nrLogs)

detach

void detach()

Detach this execution context from the current Thread.

attach

void attach()

Attach execution context to the current thread. A thread will typically have a stack of execution contexts attached to it.

isAttached

boolean isAttached()

Returns:

true if execution context is attached to a thread or not.

getTimeToDeadline

@Nonnegative
default long getTimeToDeadline(TimeUnit unit)
                                     throws TimeoutException

Throws:

TimeoutException

getUncheckedTimeToDeadline

@Nonnegative
default long getUncheckedTimeToDeadline(TimeUnit unit)

getTimeRelativeToDeadline

@Signed
default long getTimeRelativeToDeadline(TimeUnit unit)

getMillisToDeadline

@Nonnegative
default long getMillisToDeadline()
                                       throws TimeoutException

Throws:

TimeoutException

getSecondsToDeadline

@Nonnegative
default int getSecondsToDeadline()
                                       throws TimeoutException

Throws:

TimeoutException

get

@Nullable
 @Beta
<T> T get(ExecutionContext.Tag<T,?> key)

Method to get context associated data. if current context does not have baggage, the parent context is queried if tag is inherited. This is done recursively.

Type Parameters:

T - type of data.

Parameters:

key - key of data.

Returns:

the data

getContextAndValue

@Nullable
 @Beta
<T> ContextValue<T> getContextAndValue(ExecutionContext.Tag<T,?> key)

Method to get context associated data. if current context does not have baggage, the parent context is queried if tag is inherited. This is done recursively, and both the context and the value are returned.

Type Parameters:

T - type of data.

Parameters:

key - key of data.

Returns:

the data

getLocal

@Nullable
 @Beta
<T> T getLocal(ExecutionContext.Tag<T,?> key)

Method to get context associated data. will ignore inheritance tag attribute.

Type Parameters:

T - type of data.

Parameters:

key - key of data.

Returns:

the data

put

@Nullable
 @Beta
<T> T put(ExecutionContext.Tag<T,?> tag,
                           T data)

Method to put context associated data.

Type Parameters:

T - type of data.

Parameters:

key - the key of data.

data - the data.

Returns:

existing data if there.

combine

@Deprecated
default <T> void combine(ExecutionContext.Tag<T,?> tag,
                                     T data)

Deprecated. use accumulate.

accumulate

@Beta
default <T> void accumulate(ExecutionContext.Tag<T,?> tag,
                                  T data)

accumulateComponent

@Beta
default <T,A> void accumulateComponent(ExecutionContext.Tag<T,A> tag,
                                             A data)

putToRootParent

@Nullable
 @Beta
default <T> T putToRootParent(ExecutionContext.Tag<T,?> key,
                                               T data)

Method to put context associated data to the root context.

Type Parameters:

T - type of data.

Parameters:

key - the key of data.

data - the data.

Returns:

existing data if there.

compute

@Beta
 @Nullable
<V,A> V compute(ExecutionContext.Tag<V,A> key,
                                 BiFunction<ExecutionContext.Tag<V,A>,V,V> compute)

Compute context associated data.

Type Parameters:

K -

V -

Parameters:

key -

compute -

Returns:

addToRootParent

@Nullable
 @Beta
default <T> List<T> addToRootParent(ExecutionContext.Tag<List<T>,T> tag,
                                                     T data)

startChild

default ExecutionContext startChild(String operationName,
                                    long timeout,
                                    TimeUnit tu)

startChild

default ExecutionContext startChild(String operationName)

detachedChild

default ExecutionContext detachedChild(String operationName,
                                       long timeout,
                                       TimeUnit tu)

detachedChild

default ExecutionContext detachedChild(String operationName)

nextChildId

long nextChildId()

add

void add(StackTraceElement[] sample)

add

void add(StackSamples samples)

getAndClearStackSamples

@Nullable
StackSamples getAndClearStackSamples()

getStackSamples

@Nullable
StackSamples getStackSamples()

isClosed

boolean isClosed()

getRelationToSource

ExecutionContext.Relation getRelationToSource()

getDebugDetail

default org.spf4j.base.avro.DebugDetail getDebugDetail(String origin,
                                                       @Nullable
                                                       Throwable throwable)

getDebugDetail

default org.spf4j.base.avro.DebugDetail getDebugDetail(String origin,
                                                       @Nullable
                                                       Throwable throwable,
                                                       boolean addStackSamples)

getDebugDetail

default org.spf4j.base.avro.DebugDetail getDebugDetail(String origin,
                                                       @Nullable
                                                       Throwable throwable,
                                                       boolean addStackSamples,
                                                       int maxNrLogs)