Package com.evolveum.midpoint.model.impl.scripting

Interface ActionExecutor

All Known Implementing Classes:

AddExecutor, ApplyDefinitionExecutor, AssignExecutor, BaseActionExecutor, DeleteExecutor, DiscoverConnectorsExecutor, EnableDisableExecutor, EvaluateExpressionExecutor, ExecuteScriptExecutor, GenerateValueExecutor, LogExecutor, ModifyExecutor, NotifyExecutor, PurgeSchemaExecutor, RecomputeExecutor, ReencryptExecutor, ResolveExecutor, ResumeTaskExecutor, SearchExecutor, TestResourceExecutor, UnassignExecutor, ValidateExecutor

public interface ActionExecutor

Executes an action of a given type. Instances of this type must be registered with BulkActionsExecutor.

Method Summary

Modifier and Type	Method	Description
void	checkExecutionAllowed(ExecutionContext context, OperationResult result)	Checks if the execution is allowed: both expression profile and authorizations are checked.
default PipelineData	execute(AbstractActionExpressionType command, PipelineData input, ExecutionContext context, OperationResult globalResult)	To be used only if the "dynamic" version is not supported.
PipelineData	execute(ActionExpressionType command, PipelineData input, ExecutionContext context, OperationResult globalResult)	Executes given action command.
@NotNull BulkAction	getActionType()	Returns the type of action supported by this executor.

Method Details

getActionType

@NotNull
@NotNull BulkAction getActionType()

Returns the type of action supported by this executor.

checkExecutionAllowed

void checkExecutionAllowed(ExecutionContext context,
 OperationResult result)
                    throws SecurityViolationException,
SchemaException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException,
ObjectNotFoundException

Checks if the execution is allowed: both expression profile and authorizations are checked. We may put this inside the execute(AbstractActionExpressionType, PipelineData, ExecutionContext, OperationResult) method later, if needed.

Throws:

SecurityViolationException

SchemaException

ExpressionEvaluationException

CommunicationException

ConfigurationException

ObjectNotFoundException

execute

PipelineData execute(ActionExpressionType command,
 PipelineData input,
 ExecutionContext context,
 OperationResult globalResult)
              throws SchemaException,
ObjectNotFoundException,
ObjectAlreadyExistsException,
SecurityViolationException,
PolicyViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

Executes given action command.

Parameters:

command - Command to be executed. Its parameters can be defined statically (using "new" specific subclasses in the schema) or dynamically (using "old fashioned" dynamic name-value parameters) or in a mixed style, where dynamic definitions take precedence.

input - Input data (pipeline) that the action has to be executed on.

context - Overall execution context.

globalResult - Global operation result. This is the parent result that receives subresults related to actions executions. (But individual results are stored also into the pipeline, to indicate success/failure of individual pipeline items processing.)

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException

SecurityViolationException

PolicyViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

execute

default PipelineData execute(AbstractActionExpressionType command,
 PipelineData input,
 ExecutionContext context,
 OperationResult globalResult)
                      throws SchemaException,
ObjectNotFoundException,
ObjectAlreadyExistsException,
SecurityViolationException,
PolicyViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

To be used only if the "dynamic" version is not supported.

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException

SecurityViolationException

PolicyViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException