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

Class AbstractSchedTaskJobDelegate<T extends SchedTask>

java.lang.Object

org.apache.syncope.core.provisioning.java.job.AbstractSchedTaskJobDelegate<T>

All Implemented Interfaces:

SchedTaskJobDelegate

Direct Known Subclasses:

AbstractProvisioningJobDelegate, ElasticsearchReindex, ExpiredAccessTokenCleanup, ExpiredBatchCleanup, GroupMemberProvisionTaskJobDelegate, MacroJobDelegate, OpenFGAReinit, OpenSearchReindex, TestSampleJobDelegate

public abstract class AbstractSchedTaskJobDelegate<T extends SchedTask>
extends Object
implements SchedTaskJobDelegate

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditManager	auditManager	Audit manager.
protected String	executor
protected static final Logger	LOG
protected boolean	manageOperationId
protected NotificationManager	notificationManager	Notification manager.
protected ApplicationEventPublisher	publisher
protected SecurityProperties	securityProperties
protected T	task	The actual task to be executed.
protected TaskDAO	taskDAO	Task DAO.
protected TaskExecDAO	taskExecDAO	Task execution DAO.
protected TaskType	taskType
protected TaskUtilsFactory	taskUtilsFactory

Constructor Summary

Constructors

Constructor	Description
AbstractSchedTaskJobDelegate()

Method Summary

Modifier and Type	Method	Description
protected abstract String	doExecute(JobExecutionContext context)	The actual execution, delegated to child classes.
protected void	end()
protected void	endExecution(TaskExec<SchedTask> execution, String message, String status, OpEvent.Outcome result)
void	execute(TaskType taskType, String taskKey, JobExecutionContext context)	Executes a Job to run the given Task.
protected boolean	hasToBeRegistered(TaskExec<?> execution)	Template method to determine whether this job's task execution has to be persisted or not.
protected void	init(TaskType taskType, String taskKey, JobExecutionContext context)
protected TaskExec<SchedTask>	initExecution()
protected void	register(TaskExec<?> execution)
protected void	setStatus(String status)

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

taskType

protected TaskType taskType

task

protected T extends SchedTask task

The actual task to be executed.

taskExecDAO

@Autowired
protected TaskExecDAO taskExecDAO

Task execution DAO.

taskDAO

@Autowired
protected TaskDAO taskDAO

Task DAO.

taskUtilsFactory

@Autowired
protected TaskUtilsFactory taskUtilsFactory

notificationManager

@Autowired
protected NotificationManager notificationManager

Notification manager.

auditManager

@Autowired
protected AuditManager auditManager

Audit manager.

publisher

@Autowired
protected ApplicationEventPublisher publisher

manageOperationId

protected boolean manageOperationId

executor

protected String executor

Constructor Details

AbstractSchedTaskJobDelegate

public AbstractSchedTaskJobDelegate()

Method Details

setStatus

protected void setStatus(String status)

init

protected void init(TaskType taskType,
 String taskKey,
 JobExecutionContext context)
             throws JobExecutionException

Throws:

JobExecutionException

initExecution

protected TaskExec<SchedTask> initExecution()

endExecution

protected void endExecution(TaskExec<SchedTask> execution,
 String message,
 String status,
 OpEvent.Outcome result)

end

protected void end()

execute

@Transactional
public void execute(TaskType taskType,
 String taskKey,
 JobExecutionContext context)
             throws JobExecutionException

Description copied from interface: SchedTaskJobDelegate

Executes a Job to run the given Task.

Specified by:

execute in interface SchedTaskJobDelegate

Parameters:

taskType - Type of task to run

taskKey - Task 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(JobExecutionContext context)
                             throws JobExecutionException

The actual execution, delegated to child classes.

Parameters:

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

Returns:

the task execution status to be set

Throws:

JobExecutionException - if anything goes wrong

hasToBeRegistered

protected boolean hasToBeRegistered(TaskExec<?> execution)

Template method to determine whether this job's task execution has to be persisted or not.

Parameters:

execution - task execution

Returns:

whether to persist or not

register

protected void register(TaskExec<?> execution)