org.spf4j.base

Class BasicExecutionContext

java.lang.Object

org.spf4j.base.BasicExecutionContext

All Implemented Interfaces:

AutoCloseable, ExecutionContext, JsonWriteable, Writeable

@ThreadSafe
 @ParametersAreNonnullByDefault
public class BasicExecutionContext
extends Object
implements ExecutionContext

The simplest execution context possible.

Author:

Zoltan Farkas

Nested Class Summary

Nested classes/interfaces inherited from interface org.spf4j.base.ExecutionContext

ExecutionContext.Relation, ExecutionContext.SimpleTag<T>, ExecutionContext.Tag<T,A>

Constructor Summary

Constructors

Constructor and Description
BasicExecutionContext(String name, CharSequence id, ExecutionContext source, ExecutionContext.Relation relation, long startTimeNanos, long deadlineNanos)

Method Summary

Modifier and Type	Method and Description
void	add(StackSamples samples) add a bunch of samples to this context.
void	add(StackTraceElement[] sample) Add a sample to this execution context.
void	addCloseable(AutoCloseable closeable) Attach a AutoCloseable to execution context.
void	addLog(Slf4jLogRecord log)
void	addLogs(Collection<Slf4jLogRecord> pLogs)
void	attach() Attach execution context to the current thread.
void	close() Close might be overridable to close any additional stuff added in the extended class.
<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.
<T> T	get(ExecutionContext.Tag<T,?> key) Method to get context associated data.
StackSamples	getAndClearStackSamples() get the collected stack samples.
Level	getBackendMinLogLevel(String loggerName) Overwrite for more configurable implementation.
<T> ContextValue<T>	getContextAndValue(ExecutionContext.Tag<T,?> key) Method to get context associated data.
Level	getContextMinLogLevel(String loggerName) Overwrite for more configurable implementation.
long	getDeadlineNanos()
CharSequence	getId()
<T> T	getLocal(ExecutionContext.Tag<T,?> key) Method to get context associated data.
String	getName()
ExecutionContext.Relation	getRelationToSource()
ExecutionContext	getSource()
StackSamples	getStackSamples() overwrite in a context that supports this functionality.
long	getStartTimeNanos()
boolean	isAttached()
boolean	isClosed()
long	nextChildId()
<T> T	put(ExecutionContext.Tag<T,?> key, T data) Method to put context associated data.
Level	setBackendMinLogLevel(String loggerName, Level level) Overwrite for more configurable implementation.
void	streamLogs(Consumer<Slf4jLogRecord> to)
void	streamLogs(Consumer<Slf4jLogRecord> to, int maxNr)
String	toString() Overwrite as needed for debug string.
void	writeJsonTo(Appendable appendable) Overwrite this method to change default json format.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spf4j.base.ExecutionContext

accumulate, accumulateComponent, addToRootParent, combine, detachedChild, detachedChild, getBackendMinLogLevel, getContextMinLogLevel, getDebugDetail, getDebugDetail, getDebugDetail, getMillisToDeadline, getNotClosedParent, getRoot, getRootParent, getSecondsToDeadline, getTimeRelativeToDeadline, getTimeToDeadline, getUncheckedTimeToDeadline, putToRootParent, setBackendMinLogLevel, startChild, startChild

Methods inherited from interface org.spf4j.base.JsonWriteable

writeJsonTo, writeTo

Methods inherited from interface org.spf4j.base.Writeable

writeTo

Constructor Detail

BasicExecutionContext

public BasicExecutionContext(String name,
                             @Nullable
                             CharSequence id,
                             @Nullable
                             ExecutionContext source,
                             ExecutionContext.Relation relation,
                             long startTimeNanos,
                             long deadlineNanos)

Method Detail

getName

public final String getName()

Specified by:

getName in interface ExecutionContext

getDeadlineNanos

public final long getDeadlineNanos()

Specified by:

getDeadlineNanos in interface ExecutionContext

getStartTimeNanos

public final long getStartTimeNanos()

Specified by:

getStartTimeNanos in interface ExecutionContext

put

@Nullable
 @Beta
public final <T> T put(@Nonnull
                                        ExecutionContext.Tag<T,?> key,
                                        @Nonnull
                                        T data)

Description copied from interface: ExecutionContext

Method to put context associated data.

Specified by:

put in interface ExecutionContext

Type Parameters:

T - type of data.

data - the data.

Returns:

existing data if there.

get

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

Description copied from interface: ExecutionContext

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.

Specified by:

get in interface ExecutionContext

Type Parameters:

T - type of data.

Parameters:

key - key of data.

Returns:

the data

getContextAndValue

public final <T> ContextValue<T> getContextAndValue(ExecutionContext.Tag<T,?> key)

Description copied from interface: ExecutionContext

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.

Specified by:

getContextAndValue in interface ExecutionContext

Type Parameters:

T - type of data.

Parameters:

key - key of data.

Returns:

the data

getLocal

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

Description copied from interface: ExecutionContext

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

Specified by:

getLocal in interface ExecutionContext

Type Parameters:

T - type of data.

Parameters:

key - key of data.

Returns:

the data

compute

@Nullable
public final <V,A> V compute(@Nonnull
                                       ExecutionContext.Tag<V,A> key,
                                       BiFunction<ExecutionContext.Tag<V,A>,V,V> compute)

Description copied from interface: ExecutionContext

Compute context associated data.

Specified by:

compute in interface ExecutionContext

Returns:

getSource

public final ExecutionContext getSource()

Specified by:

getSource in interface ExecutionContext

close

public void close()

Close might be overridable to close any additional stuff added in the extended class.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ExecutionContext

detach

public final void detach()

Description copied from interface: ExecutionContext

Detach this execution context from the current Thread.

Specified by:

detach in interface ExecutionContext

isAttached

public final boolean isAttached()

Specified by:

isAttached in interface ExecutionContext

Returns:

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

attach

public final void attach()

Description copied from interface: ExecutionContext

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

Specified by:

attach in interface ExecutionContext

toString

public String toString()

Overwrite as needed for debug string.

Overrides:

toString in class Object

writeJsonTo

public void writeJsonTo(Appendable appendable)
                 throws IOException

Overwrite this method to change default json format.

Specified by:

writeJsonTo in interface JsonWriteable

Parameters:

appendable -

Throws:

IOException

addLog

public final void addLog(Slf4jLogRecord log)

Specified by:

addLog in interface ExecutionContext

addCloseable

@Beta
public final void addCloseable(AutoCloseable closeable)

Description copied from interface: ExecutionContext

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

Specified by:

addCloseable in interface ExecutionContext

addLogs

public final void addLogs(Collection<Slf4jLogRecord> pLogs)

Specified by:

addLogs in interface ExecutionContext

streamLogs

public final void streamLogs(Consumer<Slf4jLogRecord> to)

Specified by:

streamLogs in interface ExecutionContext

streamLogs

public final void streamLogs(Consumer<Slf4jLogRecord> to,
                             int maxNr)

Specified by:

streamLogs in interface ExecutionContext

getContextMinLogLevel

public Level getContextMinLogLevel(String loggerName)

Overwrite for more configurable implementation.

Specified by:

getContextMinLogLevel in interface ExecutionContext

Parameters:

loggerName -

Returns:

getBackendMinLogLevel

public Level getBackendMinLogLevel(String loggerName)

Overwrite for more configurable implementation.

Specified by:

getBackendMinLogLevel in interface ExecutionContext

Parameters:

loggerName -

Returns:

setBackendMinLogLevel

public Level setBackendMinLogLevel(String loggerName,
                                   Level level)

Overwrite for more configurable implementation.

Specified by:

setBackendMinLogLevel in interface ExecutionContext

Parameters:

loggerName -

Returns:

getId

public final CharSequence getId()

Specified by:

getId in interface ExecutionContext

nextChildId

public final long nextChildId()

Specified by:

nextChildId in interface ExecutionContext

add

public void add(StackTraceElement[] sample)

Add a sample to this execution context. this implementation does not retain them.

Specified by:

add in interface ExecutionContext

Parameters:

sample -

getAndClearStackSamples

@Nullable
public StackSamples getAndClearStackSamples()

get the collected stack samples. This implementation will always return null. overwrite in a context that supports this functionality.

Specified by:

getAndClearStackSamples in interface ExecutionContext

Returns:

getStackSamples

@Nullable
public StackSamples getStackSamples()

overwrite in a context that supports this functionality.

Specified by:

getStackSamples in interface ExecutionContext

Returns:

a copy of the collected samples.

isClosed

public final boolean isClosed()

Specified by:

isClosed in interface ExecutionContext

getRelationToSource

public final ExecutionContext.Relation getRelationToSource()

Specified by:

getRelationToSource in interface ExecutionContext

add

public void add(StackSamples samples)

add a bunch of samples to this context.

Specified by:

add in interface ExecutionContext

Parameters:

samples -