Package com.evolveum.midpoint.model.api

Interface ScriptingService

public interface ScriptingService

Interface of the Model subsystem that provides scripting (bulk actions) operations.

Author:

mederly

Method Summary

Modifier and Type	Method	Description
ScriptExecutionResult	evaluateExpression(@NotNull ExecuteScriptType executeScriptCommand, @NotNull VariablesMap initialVariables, boolean recordProgressAndIterationStatistics, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)
ScriptExecutionResult	evaluateExpression(ScriptingExpressionType expression, com.evolveum.midpoint.task.api.Task task, OperationResult result)	Synchronously executes any scripting expression (with no input data).
void	evaluateExpressionInBackground(ExecuteScriptType executeScriptCommand, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)
void	evaluateExpressionInBackground(ScriptingExpressionType expression, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)	Asynchronously executes any scripting expression.
void	evaluateIterativeExpressionInBackground(ExecuteScriptType executeScriptCommand, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)	Asynchronously executes any scripting expression.

Method Detail

evaluateExpressionInBackground

void evaluateExpressionInBackground(ScriptingExpressionType expression,
                                    com.evolveum.midpoint.task.api.Task task,
                                    OperationResult parentResult)
                             throws SchemaException,
                                    SecurityViolationException,
                                    ObjectNotFoundException,
                                    ExpressionEvaluationException,
                                    CommunicationException,
                                    ConfigurationException

Asynchronously executes any scripting expression.

Parameters:

expression - Expression to be executed.

task - Task in context of which the script should execute. The task should be "clean", i.e. (1) transient, (2) without any handler. This method puts the task into background, and assigns ScriptExecutionTaskHandler to it, to execute the script.

parentResult -

Throws:

SchemaException

ConfigurationException

CommunicationException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

evaluateExpressionInBackground

void evaluateExpressionInBackground(ExecuteScriptType executeScriptCommand,
                                    com.evolveum.midpoint.task.api.Task task,
                                    OperationResult parentResult)
                             throws SchemaException,
                                    SecurityViolationException,
                                    ObjectNotFoundException,
                                    ExpressionEvaluationException,
                                    CommunicationException,
                                    ConfigurationException

Throws:

SchemaException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

evaluateIterativeExpressionInBackground

void evaluateIterativeExpressionInBackground(ExecuteScriptType executeScriptCommand,
                                             com.evolveum.midpoint.task.api.Task task,
                                             OperationResult parentResult)
                                      throws SchemaException,
                                             SecurityViolationException,
                                             ObjectNotFoundException,
                                             ExpressionEvaluationException,
                                             CommunicationException,
                                             ConfigurationException

Asynchronously executes any scripting expression.

Parameters:

executeScriptCommand - ExecuteScript to be executed.

task - Task in context of which the script should execute. The task should be "clean", i.e. (1) transient, (2) without any handler. This method puts the task into background, and assigns IterativeScriptExecutionTaskHandler to it, to execute the script.

parentResult -

Throws:

SchemaException

ConfigurationException

CommunicationException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

evaluateExpression

ScriptExecutionResult evaluateExpression(ScriptingExpressionType expression,
                                         com.evolveum.midpoint.task.api.Task task,
                                         OperationResult result)
                                  throws ScriptExecutionException,
                                         SchemaException,
                                         SecurityViolationException,
                                         ObjectNotFoundException,
                                         ExpressionEvaluationException,
                                         CommunicationException,
                                         ConfigurationException

Synchronously executes any scripting expression (with no input data).

Parameters:

expression - Scripting expression to execute.

task - Task in context of which the script should execute (in foreground!)

result - Operation result

Throws:

ScriptExecutionException - TODO return ExecutionContext (requires moving the context to model api)

SchemaException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

evaluateExpression

ScriptExecutionResult evaluateExpression(@NotNull
                                         @NotNull ExecuteScriptType executeScriptCommand,
                                         @NotNull
                                         @NotNull VariablesMap initialVariables,
                                         boolean recordProgressAndIterationStatistics,
                                         @NotNull
                                         @NotNull com.evolveum.midpoint.task.api.Task task,
                                         @NotNull
                                         @NotNull OperationResult result)
                                  throws ScriptExecutionException,
                                         SchemaException,
                                         SecurityViolationException,
                                         ObjectNotFoundException,
                                         ExpressionEvaluationException,
                                         CommunicationException,
                                         ConfigurationException

Throws:

ScriptExecutionException

SchemaException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException