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, StoppableJobDelegate

Direct Known Subclasses:

SampleReportJobDelegate

public abstract class AbstractReportJobDelegate
extends Object
implements ReportJobDelegate, StoppableJobDelegate

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditManager	auditManager	Audit manager.
protected ReportConf	conf
protected EntityFactory	entityFactory
protected static final 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 SecurityProperties	securityProperties
protected boolean	stopRequested

Constructor Summary

Constructors

Constructor	Description
AbstractReportJobDelegate()

Method Summary

Modifier and Type	Method	Description
protected abstract String	doExecute(OutputStream os, JobExecutionContext context)	The actual execution, delegated to child classes.
void	execute(String reportKey, JobExecutionContext context)	Executes a Job to run the given Report.
void	setConf(ReportConf conf)	Optional configuration.
protected void	setStatus(String status)
void	stop()	Request the current Job to stop the execution.

Methods inherited from class java.lang.Object

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

Field Details

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

notificationManager

@Autowired
protected NotificationManager notificationManager

Notification manager.

auditManager

@Autowired
protected AuditManager auditManager

Audit manager.

publisher

@Autowired
protected ApplicationEventPublisher publisher

stopRequested

protected volatile boolean stopRequested

Constructor Details

AbstractReportJobDelegate

public AbstractReportJobDelegate()

Method Details

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)

stop

public void stop()

Description copied from interface: StoppableJobDelegate

Request the current Job to stop the execution.

Specified by:

stop in interface StoppableJobDelegate

execute

@Transactional
public void execute(String reportKey,
 JobExecutionContext context)
             throws JobExecutionException

Description copied from interface: ReportJobDelegate

Executes a Job to run the given Report.

Specified by:

execute in interface ReportJobDelegate

Parameters:

reportKey - Report key to run

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

Throws:

JobExecutionException - if anything goes wrong

doExecute

protected abstract String doExecute(OutputStream os,
 JobExecutionContext context)
                             throws JobExecutionException

The actual execution, delegated to child classes.

Parameters:

os - where to stream report execution's data

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

Returns:

the report execution status to be set

Throws:

JobExecutionException - if anything goes wrong