Class BuildScriptLogAndScriptLogLineExecutionLogger

java.lang.Object

com.kingsrook.qqq.backend.core.actions.scripts.logging.BuildScriptLogAndScriptLogLineExecutionLogger

All Implemented Interfaces:

QCodeExecutionLoggerInterface, ScriptExecutionLoggerInterface, Serializable

Direct Known Subclasses:

AccumulatingBuildScriptLogAndScriptLogLineExecutionLogger, StoreScriptLogAndScriptLogLineExecutionLogger

public class BuildScriptLogAndScriptLogLineExecutionLogger
extends Object
implements QCodeExecutionLoggerInterface, ScriptExecutionLoggerInterface

Implementation of a code execution logger that builds a scriptLog and 0 or more scriptLogLine records - but doesn't insert them. e.g., useful for testing (both in junit, and for users in-app).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ExecuteCodeInput	executeCodeInput

Constructor Summary

Constructors

Constructor	Description
BuildScriptLogAndScriptLogLineExecutionLogger()	Constructor
BuildScriptLogAndScriptLogLineExecutionLogger(Serializable scriptId, Serializable scriptRevisionId)	Constructor

Method Summary

Modifier and Type	Method	Description
void	acceptException(Exception exception)	Called if the script fails with an exception.
void	acceptExecutionEnd(Serializable output)	Called if the script completes without exception.
void	acceptExecutionStart(ExecuteCodeInput executeCodeInput)	Called when the execution starts - takes the execution's input object.
void	acceptLogLine(String logLine)	Called to log a line, a message.
protected QRecord	buildDetailLogRecord(String logLine)
QRecord	getScriptLog()	Getter for scriptLog
List<QRecord>	getScriptLogLines()	Getter for scriptLogLines
void	setScriptId(Integer scriptId)
protected void	setScriptLog(QRecord scriptLog)	Setter for scriptLog
protected void	setScriptLogLines(List<QRecord> scriptLogLines)	Setter for scriptLogLines
void	setScriptRevisionId(Integer scriptRevisionId)
protected void	updateHeaderAtEnd(Serializable output, Exception exception)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.actions.scripts.logging.QCodeExecutionLoggerInterface

log

Field Details

executeCodeInput

protected ExecuteCodeInput executeCodeInput

Constructor Details

BuildScriptLogAndScriptLogLineExecutionLogger

public BuildScriptLogAndScriptLogLineExecutionLogger()

Constructor

BuildScriptLogAndScriptLogLineExecutionLogger

public BuildScriptLogAndScriptLogLineExecutionLogger(Serializable scriptId,
 Serializable scriptRevisionId)

Constructor

Method Details

buildDetailLogRecord

protected QRecord buildDetailLogRecord(String logLine)

updateHeaderAtEnd

protected void updateHeaderAtEnd(Serializable output,
 Exception exception)

acceptExecutionStart

public void acceptExecutionStart(ExecuteCodeInput executeCodeInput)

Description copied from interface: QCodeExecutionLoggerInterface

Called when the execution starts - takes the execution's input object.

Specified by:

acceptExecutionStart in interface QCodeExecutionLoggerInterface

acceptLogLine

public void acceptLogLine(String logLine)

Description copied from interface: QCodeExecutionLoggerInterface

Called to log a line, a message.

Specified by:

acceptLogLine in interface QCodeExecutionLoggerInterface

acceptException

public void acceptException(Exception exception)

Description copied from interface: QCodeExecutionLoggerInterface

Called if the script fails with an exception.

Specified by:

acceptException in interface QCodeExecutionLoggerInterface

acceptExecutionEnd

public void acceptExecutionEnd(Serializable output)

Description copied from interface: QCodeExecutionLoggerInterface

Called if the script completes without exception.

Specified by:

acceptExecutionEnd in interface QCodeExecutionLoggerInterface

getScriptLog

public QRecord getScriptLog()

Getter for scriptLog

getScriptLogLines

public List<QRecord> getScriptLogLines()

Getter for scriptLogLines

setScriptLog

protected void setScriptLog(QRecord scriptLog)

Setter for scriptLog

setScriptLogLines

protected void setScriptLogLines(List<QRecord> scriptLogLines)

Setter for scriptLogLines

setScriptId

public void setScriptId(Integer scriptId)

Specified by:

setScriptId in interface ScriptExecutionLoggerInterface

setScriptRevisionId

public void setScriptRevisionId(Integer scriptRevisionId)

Specified by:

setScriptRevisionId in interface ScriptExecutionLoggerInterface