net.datenwerke.rs.incubator.service.outputformatauth.hookers

Class LargeReportExecutionVetoer

java.lang.Object

net.datenwerke.rs.incubator.service.outputformatauth.hookers.LargeReportExecutionVetoer

All Implemented Interfaces:

Hook, ReportExecutionNotificationHook

public class LargeReportExecutionVetoer
extends java.lang.Object
implements ReportExecutionNotificationHook

Constructor Summary

Constructors

Constructor and Description
LargeReportExecutionVetoer(TableReportUtils tableReportUtils, <any> configServiceProvider)

Method Summary

Modifier and Type	Method and Description
void	doVetoReportExecution(Report report, ParameterSet parameterSet, User user, java.lang.String outputFormat, ReportExecutionConfig[] configs) Called before the execution of a report and meant to allow to veto (stop) that execution.
void	notifyOfReportExecution(Report report, ParameterSet parameterSet, User user, java.lang.String outputFormat, ReportExecutionConfig[] configs) Called before a report is about to be executed.
void	notifyOfReportsSuccessfulExecution(CompiledReport compiledReport, Report report, ParameterSet parameterSet, User user, java.lang.String outputFormat, ReportExecutionConfig[] configs) Called after successful completion of a report execution.
void	notifyOfReportsUnsuccessfulExecution(ReportExecutorException e, Report report, ParameterSet parameterSet, User user, java.lang.String outputFormat, ReportExecutionConfig[] configs) Called after an unsuccessful execution of a report.

Methods inherited from class java.lang.Object

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

Constructor Detail

LargeReportExecutionVetoer

public LargeReportExecutionVetoer(TableReportUtils tableReportUtils,
                                  <any> configServiceProvider)

Method Detail

notifyOfReportExecution

public void notifyOfReportExecution(Report report,
                                    ParameterSet parameterSet,
                                    User user,
                                    java.lang.String outputFormat,
                                    ReportExecutionConfig[] configs)
                             throws ReportExecutorException

Description copied from interface: ReportExecutionNotificationHook

Called before a report is about to be executed. This method should not throw any exceptions and be used only for notifaction purposes. If you want to stop the execution of a report, use the ReportExecutionNotificationHook.doVetoReportExecution(Report, ParameterSet, User, String, ReportExecutionConfig[]) method instead.

Specified by:

notifyOfReportExecution in interface ReportExecutionNotificationHook

Throws:

ReportExecutorException

notifyOfReportsSuccessfulExecution

public void notifyOfReportsSuccessfulExecution(CompiledReport compiledReport,
                                               Report report,
                                               ParameterSet parameterSet,
                                               User user,
                                               java.lang.String outputFormat,
                                               ReportExecutionConfig[] configs)

Description copied from interface: ReportExecutionNotificationHook

Called after successful completion of a report execution.

Specified by:

notifyOfReportsSuccessfulExecution in interface ReportExecutionNotificationHook

notifyOfReportsUnsuccessfulExecution

public void notifyOfReportsUnsuccessfulExecution(ReportExecutorException e,
                                                 Report report,
                                                 ParameterSet parameterSet,
                                                 User user,
                                                 java.lang.String outputFormat,
                                                 ReportExecutionConfig[] configs)

Description copied from interface: ReportExecutionNotificationHook

Called after an unsuccessful execution of a report.

Specified by:

notifyOfReportsUnsuccessfulExecution in interface ReportExecutionNotificationHook

doVetoReportExecution

public void doVetoReportExecution(Report report,
                                  ParameterSet parameterSet,
                                  User user,
                                  java.lang.String outputFormat,
                                  ReportExecutionConfig[] configs)
                           throws ReportExecutorException

Description copied from interface: ReportExecutionNotificationHook

Called before the execution of a report and meant to allow to veto (stop) that execution. In order to stop an execution, throw a ReportExecutorException.

Specified by:

doVetoReportExecution in interface ReportExecutionNotificationHook

Throws:

ReportExecutorException