com.jalios.jcms.handler

Class JcmsUploadFormHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.JcmsUploadFormHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

EditDataFormHandler

public abstract class JcmsUploadFormHandler
extends JcmsFormHandler

Field Summary

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, REVISION, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
JcmsUploadFormHandler()

Method Summary

Modifier and Type	Method and Description
protected boolean	createUploadedFileDocument(java.util.List<? extends FileDocument> fileDocuments, Member author) Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	createUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML, Member author) Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected void	doPrepareFileDocuments(FileDocument fd, java.lang.String fieldName, java.lang.String language) Prepares the new uploaded file document.
static java.lang.String	getFakeUniqueId(java.lang.Class<? extends Data> clazz)
FileDocument	getFileDocument(java.lang.String id, Member member) Returns the file document from its ID.
protected java.lang.Class<? extends FileDocument>	getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace)
protected java.util.List<? extends FileDocument>	getFileDocuments(java.lang.String fieldName) Returns the file documents from the field name.
protected java.util.List<? extends FileDocument>	getFileDocuments(java.lang.String fieldName, java.lang.String lang) Returns the file documents from the field name and the specified language.
protected java.util.Map<java.lang.String,java.util.List<? extends FileDocument>>	getFileDocumentsML(java.lang.String fieldName) Returns the file documents from the field name for all the defined languages to the site.
java.lang.String	getFormHiddenFields() Method used to add hidden fields in the form.
java.lang.String	getFormStepHiddenFields()
java.lang.String	getFormUniqueId()
static java.io.File	getTemporaryDir()
static boolean	isFakeUniqueId(java.lang.String id)
protected void	removeFileDocuments(java.lang.String fieldName) Removes file documents from the field name.
protected <E extends FileDocument> void	setFileDocuments(java.lang.String fieldName, java.lang.String[] documents, java.lang.Class<E> clazz) Sets the file documents from the field name and the default language.
protected <E extends FileDocument> void	setFileDocuments(java.lang.String fieldName, java.lang.String userLang, java.lang.String[] documents, java.lang.Class<E> clazz) Sets the file documents from the field name and the specified language.
protected <E extends FileDocument> void	setFileDocumentsML(java.lang.String fieldName, java.lang.String[] documents, java.lang.Class<E> clazz) Sets the file documents from the field name for all the defined languages to the site.
void	setFormUniqueId(java.lang.String formUniqueId)
protected boolean	validateUploadedFileDocument(java.util.List<? extends FileDocument> fileDocuments, Member author) Validates the specified fileDocuments to upload.
protected boolean	validateUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML, Member author) Validates the specified fileDocuments to upload.

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, processAction, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

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

Constructor Detail

JcmsUploadFormHandler

public JcmsUploadFormHandler()

Method Detail

setFormUniqueId

public void setFormUniqueId(java.lang.String formUniqueId)

getFormUniqueId

public java.lang.String getFormUniqueId()

getFileDocumentClass

protected java.lang.Class<? extends FileDocument> getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz,
                                                                       Member member,
                                                                       Workspace workspace)

removeFileDocuments

protected void removeFileDocuments(java.lang.String fieldName)

Removes file documents from the field name.

Parameters:

fieldName - field name

getFileDocuments

protected java.util.List<? extends FileDocument> getFileDocuments(java.lang.String fieldName)

Returns the file documents from the field name.

Parameters:

fieldName - field name

Returns:

List of FileDocument

getFileDocuments

protected java.util.List<? extends FileDocument> getFileDocuments(java.lang.String fieldName,
                                                                  java.lang.String lang)

Returns the file documents from the field name and the specified language.

Parameters:

fieldName - field name

lang - language

Returns:

List of FileDocument

getFileDocumentsML

protected java.util.Map<java.lang.String,java.util.List<? extends FileDocument>> getFileDocumentsML(java.lang.String fieldName)

Returns the file documents from the field name for all the defined languages to the site.

Parameters:

fieldName - field name

Returns:

Map of List of FileDocument by language

setFileDocuments

protected <E extends FileDocument> void setFileDocuments(java.lang.String fieldName,
                                                         java.lang.String userLang,
                                                         java.lang.String[] documents,
                                                         java.lang.Class<E> clazz)

Sets the file documents from the field name and the specified language. If link array contains value MultipartRequest.MULTIPART_UPLOAD then instantiates a new FileDocument but do NOT perform create.

Parameters:

fieldName - field name

userLang - language

documents - array of documents ids

clazz -

setFileDocuments

protected <E extends FileDocument> void setFileDocuments(java.lang.String fieldName,
                                                         java.lang.String[] documents,
                                                         java.lang.Class<E> clazz)

Sets the file documents from the field name and the default language. If link array contains value MultipartRequest.MULTIPART_UPLOAD then instantiates a new FileDocument but do NOT perform create. FormHandler.validate() should perform Create or Update.

Parameters:

fieldName - field name

documents - array of documents ids

clazz -

setFileDocumentsML

protected <E extends FileDocument> void setFileDocumentsML(java.lang.String fieldName,
                                                           java.lang.String[] documents,
                                                           java.lang.Class<E> clazz)

Sets the file documents from the field name for all the defined languages to the site. If link array contains value MultipartRequest.MULTIPART_UPLOAD then instantiates a new FileDocument but do NOT perform create.

Parameters:

fieldName - field name

documents - array of documents ids

clazz -

doPrepareFileDocuments

protected void doPrepareFileDocuments(FileDocument fd,
                                      java.lang.String fieldName,
                                      java.lang.String language)

Prepares the new uploaded file document.

Parameters:

fd - file document

fieldName - field name related to document file

language - file document language

validateUploadedFileDocument

protected boolean validateUploadedFileDocument(java.util.List<? extends FileDocument> fileDocuments,
                                               Member author)

Validates the specified fileDocuments to upload.

Parameters:

fileDocuments - a list of FileDocuments to work with

author - the author of the fileDocuments. If not defined try to retrieve the authors defined on the FileDocuments

Returns:

true if ControllerStatus is ok

validateUploadedFileDocument

protected boolean validateUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML,
                                               Member author)

Validates the specified fileDocuments to upload.

Parameters:

fileDocumentsML - a map of list of FileDocuments to work with

author - the author of the fileDocuments

Returns:

true if ControllerStatus is ok

createUploadedFileDocument

protected boolean createUploadedFileDocument(java.util.List<? extends FileDocument> fileDocuments,
                                             Member author)

Performs create on given array of data if it is a FileDocument that have just been uploaded.

Parameters:

fileDocuments - a list of FileDocuments to work with

author - the author of the fileDocuments. If not defined try to retrieve the authors defined on the FileDocuments

Returns:

true if ControllerStatus is ok

createUploadedFileDocument

protected boolean createUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML,
                                             Member author)

Performs create on given array of data if it is a FileDocument that have just been uploaded.

Parameters:

fileDocumentsML - a map of list of FileDocuments to work with

author - the author of the fileDocuments

Returns:

true if ControllerStatus is ok

getTemporaryDir

public static java.io.File getTemporaryDir()

Returns:

the JCMS temporary directory.

getFileDocument

public FileDocument getFileDocument(java.lang.String id,
                                    Member member)

Returns the file document from its ID.

Parameters:

id - file document id

Returns:

FileDocument

getFakeUniqueId

public static java.lang.String getFakeUniqueId(java.lang.Class<? extends Data> clazz)

isFakeUniqueId

public static boolean isFakeUniqueId(java.lang.String id)

getFormStepHiddenFields

public java.lang.String getFormStepHiddenFields()

Overrides:

getFormStepHiddenFields in class JcmsFormHandler

getFormHiddenFields

public java.lang.String getFormHiddenFields()

Method used to add hidden fields in the form.

Returns:

String representing the input[hidden] to add in the form