Package io.jmix.reports.impl

Class ReportExecutionHistoryRecorderImpl

java.lang.Object

io.jmix.reports.impl.ReportExecutionHistoryRecorderImpl

All Implemented Interfaces:

ReportExecutionHistoryRecorder

@Component("report_ExecutionHistoryRecorder")
public class ReportExecutionHistoryRecorderImpl
extends Object
implements ReportExecutionHistoryRecorder

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentAuthentication	currentAuthentication
protected DataManager	dataManager
protected jakarta.persistence.EntityManager	entityManager
protected EntityStates	entityStates
protected FileStorage	fileStorage
protected FileStorageLocator	fileStorageLocator
protected Metadata	metadata
protected ReportsProperties	reportsProperties
protected SystemAuthenticator	systemAuthenticator
protected TimeSource	timeSource
protected org.springframework.transaction.support.TransactionTemplate	transaction

Constructor Summary

Constructors

Constructor	Description
ReportExecutionHistoryRecorderImpl()

Method Summary

Modifier and Type	Method	Description
String	cleanupHistory()	Should be invoked as scheduled task.
protected FileStorage	getFileStorage()
protected void	handleSessionExpired(Runnable action)	It is not rare for large reports to execute for a long time.
void	markAsCancelled(ReportExecution execution)
void	markAsError(ReportExecution execution, Exception e)
void	markAsSuccess(ReportExecution execution, ReportOutputDocument document)
protected FileRef	saveDocument(ReportOutputDocument document)
protected void	setParametersString(ReportExecution reportExecution, Map<String,Object> params)
protected boolean	shouldSaveDocument(ReportExecution execution, ReportOutputDocument document)
ReportExecution	startExecution(Report report, Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Field Details

metadata

@Autowired
protected Metadata metadata

dataManager

@Autowired
protected DataManager dataManager

currentAuthentication

@Autowired
protected CurrentAuthentication currentAuthentication

timeSource

@Autowired
protected TimeSource timeSource

reportsProperties

@Autowired
protected ReportsProperties reportsProperties

transaction

@Autowired
protected org.springframework.transaction.support.TransactionTemplate transaction

entityManager

protected jakarta.persistence.EntityManager entityManager

fileStorageLocator

@Autowired
protected FileStorageLocator fileStorageLocator

entityStates

@Autowired
protected EntityStates entityStates

systemAuthenticator

@Autowired
protected SystemAuthenticator systemAuthenticator

fileStorage

protected FileStorage fileStorage

Constructor Details

ReportExecutionHistoryRecorderImpl

public ReportExecutionHistoryRecorderImpl()

Method Details

startExecution

public ReportExecution startExecution(Report report,
 Map<String,Object> params)

Specified by:

startExecution in interface ReportExecutionHistoryRecorder

markAsSuccess

public void markAsSuccess(ReportExecution execution,
 ReportOutputDocument document)

Specified by:

markAsSuccess in interface ReportExecutionHistoryRecorder

markAsCancelled

public void markAsCancelled(ReportExecution execution)

Specified by:

markAsCancelled in interface ReportExecutionHistoryRecorder

markAsError

public void markAsError(ReportExecution execution,
 Exception e)

Specified by:

markAsError in interface ReportExecutionHistoryRecorder

setParametersString

protected void setParametersString(ReportExecution reportExecution,
 Map<String,Object> params)

shouldSaveDocument

protected boolean shouldSaveDocument(ReportExecution execution,
 ReportOutputDocument document)

saveDocument

protected FileRef saveDocument(ReportOutputDocument document)
                        throws FileStorageException

Throws:

FileStorageException

handleSessionExpired

protected void handleSessionExpired(Runnable action)

It is not rare for large reports to execute for a long time. In this case when report is finished - user session is already expired and can't be used to make changes to database.

Parameters:

action - action for the execution

cleanupHistory

public String cleanupHistory()

Description copied from interface: ReportExecutionHistoryRecorder

Should be invoked as scheduled task.

Specified by:

cleanupHistory in interface ReportExecutionHistoryRecorder

Returns:

count of deleted ReportExecution entities

getFileStorage

protected FileStorage getFileStorage()