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

Class MacroJobDelegate

java.lang.Object

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

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

All Implemented Interfaces:

JobDelegate, SchedTaskJobDelegate, StoppableJobDelegate

public class MacroJobDelegate
extends AbstractSchedTaskJobDelegate<MacroTask>
implements StoppableJobDelegate

Field Summary

Fields

Modifier and Type	Field	Description
protected ImplementationDAO	implementationDAO
protected JexlTools	jexlTools
static final String	MACRO_TASK_FORM_JOBDETAIL_KEY
protected final Map<String,MacroActions>	perContextActions
protected final Map<String,Command<?>>	perContextCommands
protected boolean	stopRequested
protected AsyncTaskExecutor	taskExecutor
protected Validator	validator

Fields inherited from class org.apache.syncope.core.provisioning.java.job.AbstractSchedTaskJobDelegate

auditManager, executor, LOG, manageOperationId, notificationManager, publisher, securityProperties, task, taskDAO, taskExecDAO, taskType, taskUtilsFactory

Constructor Summary

Constructors

Constructor	Description
MacroJobDelegate()

Method Summary

Modifier and Type	Method	Description
protected Optional<JexlContext>	check(SyncopeForm macroTaskForm, Optional<MacroActions> actions, StringBuilder output)
protected String	doExecute(JobExecutionContext context)	The actual execution, delegated to child classes.
protected boolean	hasToBeRegistered(TaskExec<?> execution)	Template method to determine whether this job's task execution has to be persisted or not.
protected void	run(List<Pair<Command<CommandArgs>,CommandArgs>> commands, Optional<MacroActions> actions, Map<String,Serializable> ctx, StringBuilder output, boolean dryRun)
void	stop()	Request the current Job to stop the execution.

Methods inherited from class org.apache.syncope.core.provisioning.java.job.AbstractSchedTaskJobDelegate

end, endExecution, execute, init, initExecution, register, setStatus

Methods inherited from class java.lang.Object

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

Field Details

MACRO_TASK_FORM_JOBDETAIL_KEY

public static final String MACRO_TASK_FORM_JOBDETAIL_KEY

See Also:

• Constant Field Values

implementationDAO

@Autowired
protected ImplementationDAO implementationDAO

validator

@Autowired
protected Validator validator

taskExecutor

protected AsyncTaskExecutor taskExecutor

jexlTools

@Autowired
protected JexlTools jexlTools

stopRequested

protected volatile boolean stopRequested

perContextActions

protected final Map<String,MacroActions> perContextActions

perContextCommands

protected final Map<String,Command<?>> perContextCommands

Constructor Details

MacroJobDelegate

public MacroJobDelegate()

Method Details

check

protected Optional<JexlContext> check(SyncopeForm macroTaskForm,
 Optional<MacroActions> actions,
 StringBuilder output)
                               throws JobExecutionException

Throws:

JobExecutionException

run

protected void run(List<Pair<Command<CommandArgs>,CommandArgs>> commands,
 Optional<MacroActions> actions,
 Map<String,Serializable> ctx,
 StringBuilder output,
 boolean dryRun)
            throws JobExecutionException

Throws:

JobExecutionException

stop

public void stop()

Description copied from interface: StoppableJobDelegate

Request the current Job to stop the execution.

Specified by:

stop in interface StoppableJobDelegate

doExecute

protected String doExecute(JobExecutionContext context)
                    throws JobExecutionException

Description copied from class: AbstractSchedTaskJobDelegate

The actual execution, delegated to child classes.

Specified by:

doExecute in class AbstractSchedTaskJobDelegate<MacroTask>

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)

Description copied from class: AbstractSchedTaskJobDelegate

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

Overrides:

hasToBeRegistered in class AbstractSchedTaskJobDelegate<MacroTask>

Parameters:

execution - task execution

Returns:

whether to persist or not