com.tsgrp.opencontent.core.action.executer

Class AddDocumentActionExecuter

java.lang.Object

com.tsgrp.opencontent.core.action.ItemExecuterAbstractBase

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

com.tsgrp.opencontent.core.action.executer.AddDocumentActionExecuter

All Implemented Interfaces:

ActionExecuter, ItemExecuter

public class AddDocumentActionExecuter
extends AbstractActionExecuter

AddDocumentActionExecuter attempts to add a document to the repository, putting the document in the parameterized parentFolderId folder and setting any parameterized properties onto the new document. It also honors requests to add / remove file extensions from the uploaded document names'. It supports addding a cover page with a generated barcode off an attribute specified in a parameter. It also supports adding MSG files and parsing and creating their attachments. It also supports creating documents from links parsed from MSG files.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COVER_PAGE_ATTRIBUTE_DATE_FORMAT The date format for cover page attributes that are dates.
protected static java.lang.String	PARAM_BARCODE_ATTRIBUTE The attribute to use for generating the barcode for the generated cover page.
protected static java.lang.String	PARAM_CLOUD_LINK_AUTH_TOKEN The authorization token for the cloud service that will be used to download the cloud content of a document to create.
protected static java.lang.String	PARAM_CLOUD_LINK_BYTE_ARRAY This will exist for box documents or cloud content that has been shared via share link.
protected static java.lang.String	PARAM_CLOUD_LINK_MIME_TYPE The passed in mime type for a cloud link document that is to be created (I think this is actually a file extension and the author of this misnamed it as "mimeType").
protected static java.lang.String	PARAM_COVER_PAGE_ATTRIBUTES The attributes to list on the generated cover page.
protected static java.lang.String	PARAM_COVER_PAGE_TITLE The title to put on the top of the generated PDF cover page.
protected static java.lang.String	PARAM_CREATE_EMAIL Whether or not we're actually creating the email object.
protected static java.lang.String	PARAM_CREATE_PDF_RENDITION Whether to create a PDF rendition for uploaded MSG files or to let the repository create a rendition.
protected static java.lang.String	PARAM_EMAIL_ATTACHMENT_PROPERTIES The properties to set on the email attachment objects we create.
protected static java.lang.String	PARAM_EMAIL_RELATION_TYPE The relation type to use when relating the email attachments to the email.
protected static java.lang.String	PARAM_EXISTING_REPO_ID This is the parameter passed in if we are creating an object from a template (the template content is in the repository already)
protected static java.lang.String	PARAM_GMAIL_AUTH_TOKEN This is a parameter passed in if we are creating an object from a gmail message or attachment
protected static java.lang.String	PARAM_GMAIL_ID This is a parameter passed in if we are creating an object from a gmail message
protected static java.lang.String	PARAM_GMAIL_USER This parameter is the user's gmail user id
protected static java.lang.String	PARAM_HIDE_FILE_EXTENSION A bulk upload HPI configuration of whether or not to hide the file extensions in the object names of newly created objects.
protected static java.lang.String	PARAM_OBJECT_ID The parent folder ID for the folder to upload this document to.
protected static java.lang.String	PARAM_OBJECT_TYPE The object type to use for this new document.
protected static java.lang.String	PARAM_PARTS The parameter representing the file that is being uploaded.
protected static java.lang.String	PARAM_PROCESS_REQUIRED_DOCS This is a parameter passed in that determines whether required documents should be required or not
protected static java.lang.String	PARAM_PROPERTIES The properties to set on this new document.
protected static java.lang.String	PARAM_SELECTED_DOCUMENT This is a parameter passed in if we are creating a new version of an existing doc, not a new object
protected static java.lang.String	UNDEFINED_COVER_PAGE_ATTRIBUTE The value to display for cover page attributes that are null in the object's properties map.

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

group, groupedConditionEvaluatorList, indexImage, nonRequiredConditionEvaluatorList, requiredConditionEvaluatorList

Constructor Summary

Constructors

Constructor and Description
AddDocumentActionExecuter()

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 static org.apache.commons.collections.map.LinkedMap	createEmailAttachments(java.lang.String ticket, java.lang.String newObjectId, boolean createEmail, byte[] emailBytes, java.lang.String tempEmailObjectId, java.lang.String parentFolderId, boolean showFileExtensions, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> emailAttachmentProperties, java.util.Map<java.lang.String,java.lang.Object> actionParams) Parses an MSG file to create any attachments as objects in the repository.
protected void	doUpload(java.lang.String ticket, Action action, java.lang.String parentFolderId) Actually execute the upload of the content and set its various properties.
static com.itextpdf.text.Image	encodeToQrCode(java.lang.String data, int width, int height)
void	executeImpl(java.lang.String ticket, Action action) The implementation of the action.
protected static java.io.InputStream	generateCloudDocumentContent(java.lang.String ticket, java.lang.String newObjectId, java.lang.String downloadUrl, java.util.Map<java.lang.String,java.lang.Object> actionParams) Generates the input stream for the content of the cloud document we're creating.
protected static byte[]	generateCoverPageContent(java.lang.String ticket, java.lang.String newObjectId, java.lang.String barcodeAttribute, java.util.Map<java.lang.String,java.lang.Object> actionParams) Generates the content for the cover page we're creating.

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

PARAM_OBJECT_ID

protected static final java.lang.String PARAM_OBJECT_ID

The parent folder ID for the folder to upload this document to.

See Also:

Constant Field Values

PARAM_PARTS

protected static final java.lang.String PARAM_PARTS

The parameter representing the file that is being uploaded. This could be null if we're generating a cover page, creating documents from cloud links, or creating an email and its attachments on IE<10.

See Also:

Constant Field Values

PARAM_OBJECT_TYPE

protected static final java.lang.String PARAM_OBJECT_TYPE

The object type to use for this new document.

See Also:

Constant Field Values

PARAM_PROPERTIES

protected static final java.lang.String PARAM_PROPERTIES

The properties to set on this new document.

See Also:

Constant Field Values

PARAM_HIDE_FILE_EXTENSION

protected static final java.lang.String PARAM_HIDE_FILE_EXTENSION

A bulk upload HPI configuration of whether or not to hide the file extensions in the object names of newly created objects.

See Also:

Constant Field Values

PARAM_BARCODE_ATTRIBUTE

protected static final java.lang.String PARAM_BARCODE_ATTRIBUTE

The attribute to use for generating the barcode for the generated cover page. Will be NULL if this is not a cover page being created.

See Also:

Constant Field Values

PARAM_COVER_PAGE_TITLE

protected static final java.lang.String PARAM_COVER_PAGE_TITLE

The title to put on the top of the generated PDF cover page. Will be NULL if this is not a cover page being created.

See Also:

Constant Field Values

PARAM_COVER_PAGE_ATTRIBUTES

protected static final java.lang.String PARAM_COVER_PAGE_ATTRIBUTES

The attributes to list on the generated cover page. Will be NULL if this is not a cover page being created.

See Also:

Constant Field Values

UNDEFINED_COVER_PAGE_ATTRIBUTE

protected static final java.lang.String UNDEFINED_COVER_PAGE_ATTRIBUTE

The value to display for cover page attributes that are null in the object's properties map. Only used when creating cover page documents.

See Also:

Constant Field Values

COVER_PAGE_ATTRIBUTE_DATE_FORMAT

protected static final java.lang.String COVER_PAGE_ATTRIBUTE_DATE_FORMAT

The date format for cover page attributes that are dates. Only used when creating cover page documents.

See Also:

Constant Field Values

PARAM_CREATE_EMAIL

protected static final java.lang.String PARAM_CREATE_EMAIL

Whether or not we're actually creating the email object. We will not be creating the email object if the user is only uploading email attachments (or we're not dealing with an email).

See Also:

Constant Field Values

PARAM_CREATE_PDF_RENDITION

protected static final java.lang.String PARAM_CREATE_PDF_RENDITION

Whether to create a PDF rendition for uploaded MSG files or to let the repository create a rendition. NOTE: Nested MSG files ALWAYS get a generated PDF rendition by OC.

See Also:

Constant Field Values

PARAM_EMAIL_RELATION_TYPE

protected static final java.lang.String PARAM_EMAIL_RELATION_TYPE

The relation type to use when relating the email attachments to the email.

See Also:

Constant Field Values

PARAM_EMAIL_ATTACHMENT_PROPERTIES

protected static final java.lang.String PARAM_EMAIL_ATTACHMENT_PROPERTIES

The properties to set on the email attachment objects we create. Will be NULL if we're not dealing with an email.

See Also:

Constant Field Values

PARAM_CLOUD_LINK_MIME_TYPE

protected static final java.lang.String PARAM_CLOUD_LINK_MIME_TYPE

The passed in mime type for a cloud link document that is to be created (I think this is actually a file extension and the author of this misnamed it as "mimeType").

See Also:

Constant Field Values

PARAM_CLOUD_LINK_BYTE_ARRAY

protected static final java.lang.String PARAM_CLOUD_LINK_BYTE_ARRAY

This will exist for box documents or cloud content that has been shared via share link. We will used this as the content of our cloud document instead of pulling the content from a download URL.

See Also:

Constant Field Values

PARAM_CLOUD_LINK_AUTH_TOKEN

protected static final java.lang.String PARAM_CLOUD_LINK_AUTH_TOKEN

The authorization token for the cloud service that will be used to download the cloud content of a document to create.

See Also:

Constant Field Values

PARAM_EXISTING_REPO_ID

protected static final java.lang.String PARAM_EXISTING_REPO_ID

This is the parameter passed in if we are creating an object from a template (the template content is in the repository already)

See Also:

Constant Field Values

PARAM_GMAIL_ID

protected static final java.lang.String PARAM_GMAIL_ID

This is a parameter passed in if we are creating an object from a gmail message

See Also:

Constant Field Values

PARAM_GMAIL_AUTH_TOKEN

protected static final java.lang.String PARAM_GMAIL_AUTH_TOKEN

This is a parameter passed in if we are creating an object from a gmail message or attachment

See Also:

Constant Field Values

PARAM_GMAIL_USER

protected static final java.lang.String PARAM_GMAIL_USER

This parameter is the user's gmail user id

See Also:

Constant Field Values

PARAM_SELECTED_DOCUMENT

protected static final java.lang.String PARAM_SELECTED_DOCUMENT

This is a parameter passed in if we are creating a new version of an existing doc, not a new object

See Also:

Constant Field Values

PARAM_PROCESS_REQUIRED_DOCS

protected static final java.lang.String PARAM_PROCESS_REQUIRED_DOCS

This is a parameter passed in that determines whether required documents should be required or not

See Also:

Constant Field Values

Constructor Detail

AddDocumentActionExecuter

public AddDocumentActionExecuter()

Method Detail

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.

See Also:

AbstractActionExecuter.addMandatoryParameters(List)

executeImpl

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

Description copied from interface: ActionExecuter

The implementation of the action.

Specified by:

executeImpl in interface ActionExecuter

Specified by:

executeImpl in class AbstractActionExecuter

Parameters:

ticket - a valid OC ticket.

action - the action object containing the parameters sent to the action for execution.

See Also:

AbstractActionExecuter.executeImpl(String, Action)

doUpload

protected void doUpload(java.lang.String ticket,
                        Action action,
                        java.lang.String parentFolderId)

Actually execute the upload of the content and set its various properties. Generate the cover page if configured to do so.

Parameters:

ticket - a valid OC ticket.

action - the action object containing the parameters passed in.

parentFolderId - the id of the parent folder that you would like to add this item to.

generateCoverPageContent

protected static byte[] generateCoverPageContent(java.lang.String ticket,
                                                 java.lang.String newObjectId,
                                                 java.lang.String barcodeAttribute,
                                                 java.util.Map<java.lang.String,java.lang.Object> actionParams)
                                          throws com.itextpdf.text.DocumentException

Generates the content for the cover page we're creating.

Parameters:

ticket - A valid OC ticket.

newObjectId - The objectId of the document we've created that we now want to update the content with the cover page content.

barcodeAttribute - The attribute whose value we should use to generate the barcode for the cover page.

actionParams - The passed in action parameters to this action executer.

Returns:

An InputStream containing the stream of data for the generated cover page content.

Throws:

com.itextpdf.text.DocumentException - If an error occurs attempting to use iText to generate our cover page content.

encodeToQrCode

public static com.itextpdf.text.Image encodeToQrCode(java.lang.String data,
                                                     int width,
                                                     int height)
                                              throws com.itextpdf.text.BadElementException

Throws:

com.itextpdf.text.BadElementException

createEmailAttachments

protected static org.apache.commons.collections.map.LinkedMap createEmailAttachments(java.lang.String ticket,
                                                                                     java.lang.String newObjectId,
                                                                                     boolean createEmail,
                                                                                     byte[] emailBytes,
                                                                                     java.lang.String tempEmailObjectId,
                                                                                     java.lang.String parentFolderId,
                                                                                     boolean showFileExtensions,
                                                                                     java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> emailAttachmentProperties,
                                                                                     java.util.Map<java.lang.String,java.lang.Object> actionParams)

Parses an MSG file to create any attachments as objects in the repository. The attachments that get created are only ones the user chose to create. We know which ones these are if there were properties for this attachment that were passed in.

Parameters:

ticket - A valid OC ticket.

newObjectId - The objectId of the new email object we created in the repository.

createEmail - True if we're actually creating the email object, false otherwise. This could be false if the user only wanted to create the attachment objects and not the email MSG file itself.

emailBytes - The bytes of the MSG file we can use to parse the email for attachments.

tempEmailObjectId - If we had a temporary email object that we used to get the content, this is the objectId of that temporary repository email object.

parentFolderId - The objectId of the folder we're creating the MSG and attachments in.

showFileExtensions - True if we're showing file extensions on the objects we're creating, false otherwise.

emailAttachmentProperties - A map of properties for the email attachments we're going to parse and create, keyed by the name of the attachment.

actionParams - The passed in action parameters to this action executer.

Returns:

The objectId of either the TOP level MSG file we created or if we only created one attachment, the objectId of the one attachment we created.

generateCloudDocumentContent

protected static java.io.InputStream generateCloudDocumentContent(java.lang.String ticket,
                                                                  java.lang.String newObjectId,
                                                                  java.lang.String downloadUrl,
                                                                  java.util.Map<java.lang.String,java.lang.Object> actionParams)
                                                           throws java.io.UnsupportedEncodingException

Generates the input stream for the content of the cloud document we're creating.

Parameters:

ticket - A valid OC ticket.

newObjectId - The objectId of the new object we've created that we're now updating the content for.

downloadUrl - The URL of where the cloud content can be downloaded from.

actionParams - The passed in action parameters to this action executer.

Returns:

An InputStream containing the stream of data for the cloud document content.

Throws:

java.io.UnsupportedEncodingException - If an error occurs processing the passed in byte string in ISO-8859-1 encoding.