Package org.ametys.plugins.core.ui.script

Class AsyncScriptHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.ui.script.ScriptHandler

org.ametys.plugins.core.ui.script.AsyncScriptHandler

All Implemented Interfaces:

LogEnabled, Initializable, Component, Contextualizable, Serviceable

public class AsyncScriptHandler
extends ScriptHandler
implements Initializable

Component able to execute scripts asynchronously, either from a schedulable or because the user asked to do so. Script results are sent by email.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.core.ui.script.ScriptHandler

ScriptHandler.ResultProcessor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_ROLE	Avalon role.

Fields inherited from class org.ametys.plugins.core.ui.script.ScriptHandler

_context, _currentUserProvider, _i18nUtils, _rightManager, _scriptBindingEP, RIGHT_EXECUTE_SCRIPTS, ROLE

Constructor Summary

Constructors

Constructor	Description
AsyncScriptHandler()

Method Summary

Modifier and Type	Method	Description
protected void	_initializeMailSenderProvider()	Initializes _mailSenderProvider.
protected ScriptHandler.ResultProcessor	getProcessor()	Returns the ScriptHandler.ResultProcessor used to process script result.
void	initialize()
void	sendReportMail(Map<String,Object> scriptResults, UserIdentity user, String mailRecipient, Locale locale, Logger logger)	Send a mail report from the result of a script

Methods inherited from class org.ametys.plugins.core.ui.script.ScriptHandler

_executeScript, buildExecArguments, contextualize, executeScript, executeScript, executeScript, getScriptBindingDescription, getWorkspaceName, processScriptResult, service

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

COMPONENT_ROLE

public static final String COMPONENT_ROLE

Avalon role.

Constructor Details

AsyncScriptHandler

public AsyncScriptHandler()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

_initializeMailSenderProvider

protected void _initializeMailSenderProvider()

Initializes _mailSenderProvider. The argument of the provider is the mail of the recipient (as string)

getProcessor

protected ScriptHandler.ResultProcessor getProcessor()

Description copied from class: ScriptHandler

Returns the ScriptHandler.ResultProcessor used to process script result.

Overrides:

getProcessor in class ScriptHandler

Returns:

the ScriptHandler.ResultProcessor.

sendReportMail

public void sendReportMail(Map<String,Object> scriptResults,
 UserIdentity user,
 String mailRecipient,
 Locale locale,
 Logger logger)
                    throws jakarta.mail.MessagingException,
IOException

Send a mail report from the result of a script

Parameters:

scriptResults - The result of the script

user - The user

mailRecipient - The recipient of the result mail

locale - The user locale

logger - The logger

Throws:

jakarta.mail.MessagingException - If an error occurred while preparing or sending email

IOException - If an error occurred with an attachment.