org.flowable.common.engine.impl.scripting

Class DefaultScriptTrace

java.lang.Object

org.flowable.common.engine.impl.scripting.DefaultScriptTrace

All Implemented Interfaces:

ScriptTrace, ScriptTraceEnhancer.ScriptTraceContext

public class DefaultScriptTrace
extends Object
implements ScriptTrace, ScriptTraceEnhancer.ScriptTraceContext

Field Summary

Fields

Modifier and Type	Field and Description
protected Duration	duration
protected Throwable	exception
protected ScriptEngineRequest	request
protected Map<String,String>	traceTags

Constructor Summary

Constructors

Constructor and Description
DefaultScriptTrace(Duration duration, ScriptEngineRequest request, Throwable caughtException)

Method Summary

Modifier and Type	Method and Description
ScriptTraceEnhancer.ScriptTraceContext	addTraceTag(String tag, String value) Adds a tracing tag to this script trace.
static DefaultScriptTrace	errorTrace(Duration duration, ScriptEngineRequest request, Throwable caughtException)
Duration	getDuration()
Throwable	getException()
ScriptEngineRequest	getRequest()
Map<String,String>	getTraceTags()
static DefaultScriptTrace	successTrace(Duration duration, ScriptEngineRequest request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.common.engine.impl.scripting.ScriptTrace

hasException, isSuccess

Methods inherited from interface org.flowable.common.engine.impl.scripting.ScriptTraceEnhancer.ScriptTraceContext

getVariableContainer

Field Detail

duration

protected Duration duration

request

protected ScriptEngineRequest request

exception

protected Throwable exception

traceTags

protected Map<String,String> traceTags

Constructor Detail

DefaultScriptTrace

public DefaultScriptTrace(Duration duration,
                          ScriptEngineRequest request,
                          Throwable caughtException)

Method Detail

successTrace

public static DefaultScriptTrace successTrace(Duration duration,
                                              ScriptEngineRequest request)

errorTrace

public static DefaultScriptTrace errorTrace(Duration duration,
                                            ScriptEngineRequest request,
                                            Throwable caughtException)

addTraceTag

public ScriptTraceEnhancer.ScriptTraceContext addTraceTag(String tag,
                                                          String value)

Description copied from interface: ScriptTraceEnhancer.ScriptTraceContext

Adds a tracing tag to this script trace. Tags are used to identify the origin of a script invocation and can also be used to classify script invocations e.g. to distinguish different use-cases etc.

Specified by:

addTraceTag in interface ScriptTraceEnhancer.ScriptTraceContext

getRequest

public ScriptEngineRequest getRequest()

Specified by:

getRequest in interface ScriptTrace

Specified by:

getRequest in interface ScriptTraceEnhancer.ScriptTraceContext

Returns:

the processed request which lead to this script trace.

getException

public Throwable getException()

Specified by:

getException in interface ScriptTrace

Specified by:

getException in interface ScriptTraceEnhancer.ScriptTraceContext

Returns:

the exception (if the request ended in an error). Or null if the request was successful.

getTraceTags

public Map<String,String> getTraceTags()

Specified by:

getTraceTags in interface ScriptTrace

getDuration

public Duration getDuration()

Specified by:

getDuration in interface ScriptTrace