Package org.ametys.plugins.forms.workflow

Class FormSendMailFunction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.forms.workflow.FormSendMailFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, Component, LogEnabled, Serviceable

public class FormSendMailFunction
extends AbstractLogEnabled
implements Component, com.opensymphony.workflow.FunctionProvider, Serviceable

OS workflow function to send mail after an action is triggered. The author of a form entry is also notified if the receipt is set

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected FormDAO	_formDAO	The form DAO
protected I18nUtils	_i18nUtils	I18nUtils
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SiteManager	_siteManager	The site manager
protected SourceResolver	_sourceResolver	The source resolver.
protected UserManager	_userManager	The user manager
protected WorkflowFormMailExtensionPoint	_workflowFormMailEP	The workflow form mail EP
static final String	ARG_BODY_KEY	Body key argument of the email
static final String	ARG_BODY_XSL	Body xsl argument of the email
static final String	ARG_COMMENT	Comment argument of the email
static final String	ARG_RECIPIENT	Recipient argument of the email
static final String	ARG_RECIPIENT_ROLE	Recipient role argument of the email
static final String	ARG_SEND_IF_COMMENT	Send if comment argument of the email
static final String	ARG_SENDER	Sender argument of the email
static final String	ARG_SENDER_ROLE	Sender role argument of the email
static final String	ARG_SUBJECT_KEY	Subject key argument of the email

Constructor Summary

Constructors

Constructor	Description
FormSendMailFunction()

Method Summary

Modifier and Type	Method	Description
protected String	_getBody(FormEntry formEntry, Map transientVars, Map args)	Get the mail body First look at the configured xsl in mail-xsl Then look at the configured body i18n key in body-key Then take the default i18n key
protected String	_getBodyFromI18nKey(FormEntry formEntry, Map transientVars, Map args, String lang)	Get the mail body from i18n key First look at the configured body i18n key in body-key Then take the default i18n key
protected List<String>	_getBodyI18nParams(FormEntry formEntry)	Get the i18n parameters of mail body text
protected String	_getMail(String resource, FormEntry entry, String xslPath, String comment)	Get a mail pipeline's content.
protected List<String>	_getRecipients(FormEntry formEntry, Map transientVars, Map args)	Get the list of recipients to send the mail First look at the configured recipient role in recipient-role Then look at the configured recipient in recipient Then take the entry user
protected String	_getSender(FormEntry formEntry, Map transientVars, Map args)	Get the sender of the mail First look at the configured sender role in sender-role Then look at the configured sender in sender Then take the current user Then take the sender in admin configuration
protected String	_getSubject(FormEntry formEntry, Map transientVars, Map args)	Get the mail subject First look at the configured subject i18n key in subject-key Then take the default i18n key
protected List<String>	_getSubjectI18nParams(FormEntry formEntry)	Get the i18n parameters of mail subject
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ARG_SENDER

public static final String ARG_SENDER

Sender argument of the email

See Also:

• Constant Field Values

ARG_SENDER_ROLE

public static final String ARG_SENDER_ROLE

Sender role argument of the email

See Also:

• Constant Field Values

ARG_RECIPIENT

public static final String ARG_RECIPIENT

Recipient argument of the email

See Also:

• Constant Field Values

ARG_RECIPIENT_ROLE

public static final String ARG_RECIPIENT_ROLE

Recipient role argument of the email

See Also:

• Constant Field Values

ARG_SUBJECT_KEY

public static final String ARG_SUBJECT_KEY

Subject key argument of the email

See Also:

• Constant Field Values

ARG_BODY_KEY

public static final String ARG_BODY_KEY

Body key argument of the email

See Also:

• Constant Field Values

ARG_BODY_XSL

public static final String ARG_BODY_XSL

Body xsl argument of the email

See Also:

• Constant Field Values

ARG_COMMENT

public static final String ARG_COMMENT

Comment argument of the email

See Also:

• Constant Field Values

ARG_SEND_IF_COMMENT

public static final String ARG_SEND_IF_COMMENT

Send if comment argument of the email

See Also:

• Constant Field Values

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userManager

protected UserManager _userManager

The user manager

_sourceResolver

protected SourceResolver _sourceResolver

The source resolver.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_formDAO

protected FormDAO _formDAO

The form DAO

_i18nUtils

protected I18nUtils _i18nUtils

I18nUtils

_workflowFormMailEP

protected WorkflowFormMailExtensionPoint _workflowFormMailEP

The workflow form mail EP

_siteManager

protected SiteManager _siteManager

The site manager

Constructor Details

FormSendMailFunction

public FormSendMailFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

execute

public void execute(Map transientVars,
 Map args,
 com.opensymphony.module.propertyset.PropertySet ps)
             throws com.opensymphony.workflow.WorkflowException

Specified by:

execute in interface com.opensymphony.workflow.FunctionProvider

Throws:

com.opensymphony.workflow.WorkflowException

_getSender

protected String _getSender(FormEntry formEntry,
 Map transientVars,
 Map args)

Get the sender of the mail First look at the configured sender role in sender-role Then look at the configured sender in sender Then take the current user Then take the sender in admin configuration

Parameters:

formEntry - the form entry

transientVars - the workflow transient vars

args - the workflow args

Returns:

the mail subject as string

_getRecipients

protected List<String> _getRecipients(FormEntry formEntry,
 Map transientVars,
 Map args)

Get the list of recipients to send the mail First look at the configured recipient role in recipient-role Then look at the configured recipient in recipient Then take the entry user

Parameters:

formEntry - the form entry

transientVars - the workflow transient vars

args - the workflow args

Returns:

the mail subject as string

_getSubject

protected String _getSubject(FormEntry formEntry,
 Map transientVars,
 Map args)

Get the mail subject First look at the configured subject i18n key in subject-key Then take the default i18n key

Parameters:

formEntry - the form entry

transientVars - the workflow transient vars

args - the workflow args

Returns:

the mail subject as string

_getBody

protected String _getBody(FormEntry formEntry,
 Map transientVars,
 Map args)
                   throws IOException

Get the mail body First look at the configured xsl in mail-xsl Then look at the configured body i18n key in body-key Then take the default i18n key

Parameters:

formEntry - the form entry

transientVars - the workflow transient vars

args - the workflow args

Returns:

the mail body as string

Throws:

IOException - if an error occurred

_getBodyFromI18nKey

protected String _getBodyFromI18nKey(FormEntry formEntry,
 Map transientVars,
 Map args,
 String lang)

Get the mail body from i18n key First look at the configured body i18n key in body-key Then take the default i18n key

Parameters:

formEntry - the form entry

transientVars - the workflow transient vars

args - the workflow args

lang - the language

Returns:

the mail body as string

_getSubjectI18nParams

protected List<String> _getSubjectI18nParams(FormEntry formEntry)

Get the i18n parameters of mail subject

Parameters:

formEntry - the form entry

Returns:

the i18n parameters

_getBodyI18nParams

protected List<String> _getBodyI18nParams(FormEntry formEntry)

Get the i18n parameters of mail body text

Parameters:

formEntry - the form entry

Returns:

the i18n parameters

_getMail

protected String _getMail(String resource,
 FormEntry entry,
 String xslPath,
 String comment)
                   throws IOException

Get a mail pipeline's content.

Parameters:

resource - the mail resource pipeline

entry - the user input.

xslPath - the xsl path

comment - the comment

Returns:

the mail content.

Throws:

IOException - if an error occurs.