com.tsgrp.opencontent.universal.action.executer

Class SendFolderEmailActionExecuter

java.lang.Object

com.tsgrp.opencontent.core.action.ItemExecuterAbstractBase

com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

com.tsgrp.opencontent.universal.action.executer.SendFolderEmailActionExecuter

All Implemented Interfaces:

ActionExecuter, ItemExecuter

public class SendFolderEmailActionExecuter
extends AbstractActionExecuter

Executes an email action on a folder. Folder email actions will:

• Create and send an email to the recipients
• Create the email object in the repository in the correct location based on parameters
• Relate the email to any attachments
• Update or create the folder address book

The following parameters are required on this action:

• PARAM_TO - String[]
• PARAM_FROM - String - note this should be the user's ID, not their email address. Also note that the configured SMTP server may not allow OC to overwrite the from address. For example, TSG's SMTP server always sets the from address to a pre-determined email.
• PARAM_SUBJECT - String
• PARAM_EMAIL_BODY - String
• PARAM_EMAIL_REL_TYPE - String - required only when passing in attachments

The following parameters are not required:

• PARAM_CC - String[]
• PARAM_BCC - String
• PARAM_ATTACHMENT_IDS - String[]
• PARAM_EMAIL_FOLDER_NAME - String
• PARAM_EMAIL_BEAN_NAME - String. If this parameter is not supplied, UniversalConstants.OBJECT_TYPE_EMAIL_DEFAULT will be used instead

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL_FTL
static java.lang.String	HTML_MIME_TYPE
static java.lang.String	PARAM_ANNOTATION_INFO
static java.lang.String	PARAM_ATTACHMENT_IDS
static java.lang.String	PARAM_BCC
static java.lang.String	PARAM_CC
static java.lang.String	PARAM_CLOUD_SEND
static java.lang.String	PARAM_EMAIL_BEAN_NAME
static java.lang.String	PARAM_EMAIL_BODY
static java.lang.String	PARAM_EMAIL_FOLDER_NAME
static java.lang.String	PARAM_EMAIL_REL_TYPE
static java.lang.String	PARAM_FOLDER_ID
static java.lang.String	PARAM_FOLDER_TAGS
static java.lang.String	PARAM_FROM
static java.lang.String	PARAM_IS_COMBINED_COLLECTION
static java.lang.String	PARAM_SELECTED_VERSION_IDS
static java.lang.String	PARAM_SUBJECT
static java.lang.String	PARAM_TO
static java.lang.String	REPO_FTL

Fields inherited from class com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

group, groupedConditionEvaluatorList, indexImage, nonRequiredConditionEvaluatorList, requiredConditionEvaluatorList

Constructor Summary

Constructors

Constructor and Description
SendFolderEmailActionExecuter()

Method Summary

Modifier and Type	Method and Description
protected void	addMandatoryParameters(java.util.List<java.lang.String> mandatoryProperties) A hook method for actions to add mandatory parameters to the provided list.
protected void	buildAndSetCombinedCollectionAttachment(Email email, java.util.Map<java.lang.String,java.lang.Object> params) Sets up the combined collection attachments
protected java.lang.String	createEmailObject(java.lang.String ticket, java.lang.String folderId, Email email, java.util.Map<java.lang.String,java.lang.Object> actionParams) Creates the email object in the repository
void	executeImpl(java.lang.String ticket, Action action) Executes the SendFolderEmailAction
java.lang.String	generateShareFileFolderName(java.lang.String ticket, java.lang.String folderId) Hotspot function for getting a unique Cloud Provider folder name.
protected java.lang.String	getEmailFolderId(java.lang.String ticket, java.lang.String folderId, java.util.Map<java.lang.String,java.lang.Object> actionParams) Gets the of the folder to store the email in.
java.lang.String	getTagAttr()
protected java.lang.String	getTemplateName() Gets the freemarker template file name to use for the email body.
void	setTagAttr(java.lang.String tagAttr)
protected Email	setupEmail(java.lang.String ticket, java.util.Map<java.lang.String,java.lang.Object> actionParams) Sends the email
protected void	updateFolderAddressBook(java.lang.String ticket, java.lang.String folderId, Email email) Updates the folder address book based on the newly sent email.

Methods inherited from class com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

evaluateAndExecute, execute, getActionDefinition, getDescription, getGroupedConditionEvaluatorList, getIndexImage, getNonRequiredConditionEvaluatorList, getRequiredConditionEvaluatorList, getShouldPoolAction, isGroup, setActionExecutionThreadManager, setDescription, setGroup, setGroupedConditionEvaluatorList, setIndexImage, setNonRequiredConditionEvaluatorList, setRequiredConditionEvaluatorList, setShouldPoolAction

Methods inherited from class com.tsgrp.opencontent.core.action.ItemExecuterAbstractBase

checkParameters

Methods inherited from class java.lang.Object

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

Field Detail

HTML_MIME_TYPE

public static final java.lang.String HTML_MIME_TYPE

See Also:

Constant Field Values

PARAM_TO

public static final java.lang.String PARAM_TO

See Also:

Constant Field Values

PARAM_FROM

public static final java.lang.String PARAM_FROM

See Also:

Constant Field Values

PARAM_CC

public static final java.lang.String PARAM_CC

See Also:

Constant Field Values

PARAM_BCC

public static final java.lang.String PARAM_BCC

See Also:

Constant Field Values

PARAM_SUBJECT

public static final java.lang.String PARAM_SUBJECT

See Also:

Constant Field Values

PARAM_EMAIL_BODY

public static final java.lang.String PARAM_EMAIL_BODY

See Also:

Constant Field Values

PARAM_ATTACHMENT_IDS

public static final java.lang.String PARAM_ATTACHMENT_IDS

See Also:

Constant Field Values

PARAM_ANNOTATION_INFO

public static final java.lang.String PARAM_ANNOTATION_INFO

See Also:

Constant Field Values

PARAM_EMAIL_FOLDER_NAME

public static final java.lang.String PARAM_EMAIL_FOLDER_NAME

See Also:

Constant Field Values

PARAM_EMAIL_BEAN_NAME

public static final java.lang.String PARAM_EMAIL_BEAN_NAME

See Also:

Constant Field Values

PARAM_EMAIL_REL_TYPE

public static final java.lang.String PARAM_EMAIL_REL_TYPE

See Also:

Constant Field Values

PARAM_FOLDER_TAGS

public static final java.lang.String PARAM_FOLDER_TAGS

See Also:

Constant Field Values

PARAM_FOLDER_ID

public static final java.lang.String PARAM_FOLDER_ID

See Also:

Constant Field Values

EMAIL_FTL

public static final java.lang.String EMAIL_FTL

See Also:

Constant Field Values

REPO_FTL

public static final java.lang.String REPO_FTL

See Also:

Constant Field Values

PARAM_CLOUD_SEND

public static final java.lang.String PARAM_CLOUD_SEND

See Also:

Constant Field Values

PARAM_SELECTED_VERSION_IDS

public static final java.lang.String PARAM_SELECTED_VERSION_IDS

See Also:

Constant Field Values

PARAM_IS_COMBINED_COLLECTION

public static final java.lang.String PARAM_IS_COMBINED_COLLECTION

See Also:

Constant Field Values

Constructor Detail

SendFolderEmailActionExecuter

public SendFolderEmailActionExecuter()

Method Detail

setTagAttr

public void setTagAttr(java.lang.String tagAttr)

getTagAttr

public java.lang.String getTagAttr()

addMandatoryParameters

protected void addMandatoryParameters(java.util.List<java.lang.String> mandatoryProperties)

Description copied from class: AbstractActionExecuter

A hook method for actions to add mandatory parameters to the provided list. If a specified parameter is not present when the action executer is invoked, an error will be thrown.

Specified by:

addMandatoryParameters in class AbstractActionExecuter

Parameters:

mandatoryProperties - a list of mandatory parameters that must be provided to the action executer when executed.

executeImpl

public void executeImpl(java.lang.String ticket,
                        Action action)

Executes the SendFolderEmailAction

Specified by:

executeImpl in interface ActionExecuter

Specified by:

executeImpl in class AbstractActionExecuter

Parameters:

ticket - authentication ticket

action - the action object

See Also:

ActionExecuter.executeImpl(String, Action)

buildAndSetCombinedCollectionAttachment

protected void buildAndSetCombinedCollectionAttachment(Email email,
                                                       java.util.Map<java.lang.String,java.lang.Object> params)

Sets up the combined collection attachments

Parameters:

email -

params -

setupEmail

protected Email setupEmail(java.lang.String ticket,
                           java.util.Map<java.lang.String,java.lang.Object> actionParams)

Sends the email

Parameters:

ticket -

actionParams -

getTemplateName

protected java.lang.String getTemplateName()

Gets the freemarker template file name to use for the email body. This default implementation returns 'oc-folder-email.html.ftl'

Returns:

the template name

createEmailObject

protected java.lang.String createEmailObject(java.lang.String ticket,
                                             java.lang.String folderId,
                                             Email email,
                                             java.util.Map<java.lang.String,java.lang.Object> actionParams)

Creates the email object in the repository

Parameters:

ticket - authentication ticket

folderId - the folder id

email - the email to create

actionParams - the action parameter map

Returns:

the object ID of the new email object

getEmailFolderId

protected java.lang.String getEmailFolderId(java.lang.String ticket,
                                            java.lang.String folderId,
                                            java.util.Map<java.lang.String,java.lang.Object> actionParams)

Gets the of the folder to store the email in. This is based on the PARAM_EMAIL_FOLDER_NAME value, which corresponds to a subfolder name. If the email folder name is null or empty, the email will be created in the parent folder. If the value is populated is populated, but the folder doesn't actually exist, the folder will be created.

Parameters:

ticket - authentication ticket

folderId - the folder ID for this action

actionParams - the action parameter map

Returns:

the id of the folder to store the email in

updateFolderAddressBook

protected void updateFolderAddressBook(java.lang.String ticket,
                                       java.lang.String folderId,
                                       Email email)

Updates the folder address book based on the newly sent email. If the email does not contain any new addresses, this method does nothing.

Parameters:

ticket - authentication ticket

folderId - the folder ID

email - the email that was sent

generateShareFileFolderName

public java.lang.String generateShareFileFolderName(java.lang.String ticket,
                                                    java.lang.String folderId)

Hotspot function for getting a unique Cloud Provider folder name.

Parameters:

ticket - OC ticket

folderId - the folder ID in the ECM repo

Returns:

name of the folder in the cloud provider