Package org.apache.syncope.core.provisioning.java.job.report

Class AbstractReportJobDelegate

java.lang.Object

org.apache.syncope.core.provisioning.java.job.report.AbstractReportJobDelegate

All Implemented Interfaces:

JobDelegate, ReportJobDelegate

Direct Known Subclasses:

SampleReportJobDelegate

public abstract class AbstractReportJobDelegate
extends Object
implements ReportJobDelegate

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditManager	auditManager	Audit manager.
protected ReportConf	conf
protected EntityFactory	entityFactory
protected boolean	interrupt
protected boolean	interrupted
protected static Logger	LOG
protected NotificationManager	notificationManager	Notification manager.
protected ApplicationEventPublisher	publisher
protected Report	report	The actual report to be executed.
protected ReportDAO	reportDAO	Report DAO.
protected ReportDataBinder	reportDataBinder
protected SecurityProperties	securityProperties

Fields inherited from interface org.apache.syncope.core.provisioning.api.job.JobDelegate

OPERATION_ID

Constructor Summary

Constructors

Constructor	Description
AbstractReportJobDelegate()

Method Summary

Modifier and Type	Method	Description
protected abstract String	doExecute(boolean dryRun, OutputStream os, String executor, org.quartz.JobExecutionContext context)	The actual execution, delegated to child classes.
void	execute(String reportKey, boolean dryRun, org.quartz.JobExecutionContext context)	Executes a Quartz Job to run the given Report.
void	interrupt()
boolean	isInterrupted()
void	setConf(ReportConf conf)	Optional configuration.
protected void	setStatus(String status)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

securityProperties

@Autowired
protected SecurityProperties securityProperties

report

protected Report report

The actual report to be executed.

conf

protected ReportConf conf

reportDAO

@Autowired
protected ReportDAO reportDAO

Report DAO.

entityFactory

@Autowired
protected EntityFactory entityFactory

reportDataBinder

@Autowired
protected ReportDataBinder reportDataBinder

notificationManager

@Autowired
protected NotificationManager notificationManager

Notification manager.

auditManager

@Autowired
protected AuditManager auditManager

Audit manager.

publisher

@Autowired
protected ApplicationEventPublisher publisher

interrupt

protected boolean interrupt

interrupted

protected boolean interrupted

Constructor Detail

AbstractReportJobDelegate

public AbstractReportJobDelegate()

Method Detail

setConf

public void setConf(ReportConf conf)

Description copied from interface: ReportJobDelegate

Optional configuration.

Specified by:

setConf in interface ReportJobDelegate

Parameters:

conf - configuration

setStatus

protected void setStatus(String status)

interrupt

public void interrupt()

Specified by:

interrupt in interface JobDelegate

isInterrupted

public boolean isInterrupted()

Specified by:

isInterrupted in interface JobDelegate

execute

@Transactional
public void execute(String reportKey,
                    boolean dryRun,
                    org.quartz.JobExecutionContext context)
             throws org.quartz.JobExecutionException

Description copied from interface: ReportJobDelegate

Executes a Quartz Job to run the given Report.

Specified by:

execute in interface ReportJobDelegate

Parameters:

reportKey - Report key to run

dryRun - indicates if execution shall be simulated with no actual changes

context - Quartz' execution context, can be used to pass parameters to the job

Throws:

org.quartz.JobExecutionException - if anything goes wrong

doExecute

protected abstract String doExecute(boolean dryRun,
                                    OutputStream os,
                                    String executor,
                                    org.quartz.JobExecutionContext context)
                             throws org.quartz.JobExecutionException

The actual execution, delegated to child classes.

Parameters:

dryRun - whether to actually touch the data

os - where to stream report execution's data

executor - the user executing this report

context - Quartz' execution context, can be used to pass parameters to the job

Returns:

the report execution status to be set

Throws:

org.quartz.JobExecutionException - if anything goes wrong