Package com.jalios.jcms.upload
Class DocUploadHandler
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
- Direct Known Subclasses:
FileDocumentActionHandler,ImageEditorActionHandler
This form handler processes document upload. It use new UploadFilter mechanism
and no longer decode MultiPart request.
- Since:
- jcms-5.7.0
- Author:
- Jean-Philippe Encausse
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected TypeFieldEntryprotected EditFileDocumentHandlerprotected FileDocumentprotected String[]protected booleanprotected booleanprotected booleanprotected Classprotected booleanFields inherited from class com.jalios.jcms.handler.EditPublicationHandler
adate, anchor, attachWorkspaceSet, author, authorizedGroupsAddCount, authorizedGroupSet, authorizedMemberSet, authorizedMemberSetAddCount, categorySet, checkMemberForRequestUnlock, cids, classificationLevel, createFromPublicationChooser, CTX_SKIP_ACTIVITY, DISPLAY_URL_TOKEN, doNotStore, edate, fieldStatusMap, friendlyURLSet, FULL_EDIT, FULL_MODAL, ID_TOKEN, ignoreWorkspaceCompliance, internalWf, isAuthorForced, isContentType, isDBType, isFormType, isPortletType, isUGCType, itemPos, LAST_PUBLICATION_NOT_STORED, listToProcess, mainLanguage, majorUpdate, oldPstatus, opAddItem, opAddItemReadRights, opAddItemUpdateRights, openTab, opLock, opMerge, opRequestUnlock, opTrash, opUnlock, opUntrash, pdate, PREVIEW_URL_TOKEN, pubClass, publication, readAck, requestUnlockMessage, restrictUpdateRights, reviewRating, roleIds, roleMap, roleMembers, sdate, SHOW_MAJOR_UPDATE_OPTION, SHOW_MODAL_EDITION_CHANGE, showAllTabs, showContentTabOnly, SIMPLE_MODAL, skipActivity, templates, title, titleML, typeLabel, updateGroupsAddCount, updateGroupSet, updateMemberSet, updateMemberSetAddCount, useDefaultCategories, useDefaultCategoriesModified, useDefaultReadRights, useDefaultReadRightsModified, useDefaultUpdateRights, useDefaultUpdateRightsModified, wf, wfNote, workingPub, wsteFields inherited from class com.jalios.jcms.handler.EditDataHandler
id, isDeleteForced, opCancel, opCreate, opDelete, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdateFields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, openTabId, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForcedFields 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_MODULE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADERFields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspaceFields 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_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, 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, IS_IN_FRONT_OFFICE, 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_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_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, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, 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, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidcheck if the workspace has been explictly changed and reconfigure the handler to be consistentstatic FileDocumentdoUploadDocument(DocUploadInfo info, FileDocument document, Consumer<FileDocument> updateBlock, ThrowingConsumer<FileDocument> applyJsonUpdate, boolean majorUpdate, BiConsumer<FileDocument, FileDocument> workflowBlock, boolean removeFile, boolean unlock, Member mbr, String userLang, HashMap<String, Object> context, Map<String, String> controllerFailedMap, List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList) booleanintintbooleanbooleanintbooleanClass<? extends FileDocument> booleangetFieldStatus(String fieldName) Returns the FieldStatus for the given field.Returns the JavaScript code to use depending of the upload step.Class<? extends Publication> Class<? extends FileDocument> protected com.jalios.jcms.upload.DocUploadHandler.UploadStepReturns the upload step depending of multiple paramter steps OpenerForm, OpenerRefresh, RedirectbooleanCheck if archives should be unziped and a new document created each timePerforms upload of all FileDocuments and create/update FileDocuments.This method allow the use of this formHandler by a programatic call, not in a jsp:usebean tag.handleUploadError(Map<String, String> failedMap) Convenient method that returns a list (ul/li) of errors for each files.voidprotected booleanisFieldMissing(String field) Check if the given parameter is present in the query parametersbooleanbooleanbooleanbooleanisUpdate()booleanbooleanbooleanprotected voidperformCreate(DocUploadInfo info, Map<String, String> controllerFailedMap, List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList) Performs creation of a FileDocument from a given DocUploadInfo.protected voidperformUpdate(DocUploadInfo info, Map<String, String> controllerFailedMap, List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList) Performs creation of a FileDocument from a given DocUploadInfo.static voidprocessIndexingLatch(List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList, Class<?> docClass) Process the IndexingLatch list elementsprotected voidresolveType(DocUploadInfo info) voidvoidsetDescription(String[] v) voidsetDocumentFormHandler(EditFileDocumentHandler docFormHandler) voidsetFilename(String[] v) voidSet the value of id.voidsetInitPstatus(boolean initPstatus) voidvoidsetMajorUpdate(boolean v) voidsetModal(boolean modal) voidsetNbElt(int v) voidvoidvoidsetOriginalType(String type) voidsetPstatus(int v) voidsetRefresh(String v) voidsetRemoveFile(boolean v) voidvoidsetStartElt(int v) voidsetTracked(boolean v) voidvoidsetUnlock(boolean v) voidsetUnzipUploadedFiles(boolean unzip) Set whether uploaded archives should be unziped and a new document created each timevoidsetUploadEnabled(boolean uploadEnabled) booleanCheck if the "Advanced edition" or "Simple edition" button should be displayed in modal footer.voidwithJsonUpdate(ThrowingConsumer<FileDocument> applyJsonUpdate) Methods inherited from class com.jalios.jcms.handler.EditPublicationHandler
canDisplayEditForm, cannotRead, checkStrongLock, completeRemovedCatSetWithTypeFieldRootCat, containsHiddenFields, containsHiddenParts, doWorkflowUpdate, getAllAvailableTitleML, getAnchor, getAuthorizedGroupsCount, getAuthorizedMemberSetCount, getAvailableAdate, getAvailableAttachWorkspaceSet, getAvailableAuthor, getAvailableAuthorizedGroupSet, getAvailableAuthorizedMemberSet, getAvailableCategories, getAvailableClassificationLevel, getAvailableEdate, getAvailableField, getAvailableFriendlyURLSet, getAvailableInternalWorkflow, getAvailableMainLanguage, getAvailablePdate, getAvailableReadAck, getAvailableRestrictUpdateRights, getAvailableRoleMap, getAvailableSdate, getAvailableSkipActivity, getAvailableTemplateEntry, getAvailableTemplates, getAvailableTitle, getAvailableTitle, getAvailableTitleML, getAvailableUpdateGroupSet, getAvailableUpdateMemberSet, getAvailableUseDefaultReadRights, getAvailableUseDefaultUpdateRights, getAvailableWFNote, getAvailableWorkspace, getCategorySet, getClassificationLevelSettings, getClosePopupUrl, getControllerContext, getDataClass, getDefaultAuthorizedGroupSet, getDefaultAuthorizedMemberSet, getDefaultCategorySet, getDefaultTemplateUsage, getDefaultUpdateGroupSet, getDefaultUpdateMemberSet, getDoNotStore, getFullModalTitle, getHiddenCatSet, getIgnoreWorkspaceCompliance, getMemberSetAssignedToRole, getModalRedirect, getOldPstatus, getOpenTab, getPublication, getPublication, getRemovedCatSet, getShowAllTabs, getShowContentTabOnly, getSimpleModalTitle, getTabLabel, getTitleFieldValue, getTypeLabel, getUpdateGroupsCount, getUpdateMemberSetCount, getWorkAreaCss, getWorkflow, getWorkspaceComplianceWarning, getWorkspaceSettings, getWSTypeEntry, hideSingleTab, init, initWorkspace, internalPerformCreate, internalPerformDelete, internalPerformUpdate, isAdvancedTabHidden, isCategoryTabHidden, isClassificationTabHidden, isCommonRightTabHidden, isContentTabOnly, isCreateFromPublicationChooser, isDBType, isExpanded, isFieldEdition, isForm, isFormStepClickable, isFullEdit, isFullModal, isLocked, isModalEdition, isPublicationCreatedFromChooser, isReadRightTabHidden, isSimpleModal, isStrongLocked, isTabForced, isTemplateTabHidden, isUpdateRightTabHidden, lock, mustSendForbiddenOnCSRF, performAddItem, performAddItemReadRights, performAddItemUpdateRights, performCancel, performCreate, performDelete, performLock, performMerge, performRefresh, performRequestUnlock, performTrash, performUnlock, performUntrash, performUpdate, prepare, processAction, processStatus, releaseDBWorkingPub, resetCategorySet, sendRedirect, setAdate, setAnchor, setAttachWorkspaceIds, setAuthor, setAuthorForced, setAuthorizedGroupIds, setAuthorizedMemberIds, setAuthorizedMemberSetAddCount, setCheckMemberForRequestUnlock, setClassificationLevel, setCreateFromPublicationChooser, setDoNotStore, setEdate, setFields, setFriendlyURL, setIgnoreWorkspaceCompliance, setInternalWf, setItemPos, setMainLanguage, setMajorUpdate, setOpAddItem, setOpAddItemReadRights, setOpAddItemUpdateRights, setOpenTab, setOpLock, setOpMerge, setOpRequestUnlock, setOpTrash, setOpUnlock, setOpUntrash, setOpUpdateMajor, setPdate, setReadAck, setRequestUnlockMessage, setRestrictUpdateRights, setRoleId, setSdate, setShowAllTabs, setShowContentTabOnly, setSilentUpdate, setSkipActivity, setTemplates, setTitle, setUpdateGroupIds, setUpdateMemberIds, setUpdateMemberSetAddCount, setUseDefaultCategories, setUseDefaultReadRights, setUseDefaultUpdateRights, setWfNote, setWorkspaceComplianceWarning, setWSTypeEntry, showAttachWorkspaceSet, showForceDelete, showFriendlyURL, showLanguageChooser, showLockWarning, showMainLanguage, showMajorUpdate, showReadAck, showReaderTracker, showSDate, showSuperFieldsInCollapsible, showTitleFieldInMainTab, showWFRole, unlock, updateCids, useWeakLockInModal, validateAddItem, validateAddItemReadRights, validateAddItemUpdateRights, validateBeforeOp, validateCreate, validateDelete, validateFieldFormat, validateForm, validateLock, validateMember, validateMerge, validateRequestUnlock, validateTrash, validateUnlock, validateUntrash, validateUpdate, validateWorkspace, workflowHasNotBeenChangedMethods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getDeleteRedirect, getEnumLabels, getEnumValues, getId, getTabGroupMaxCount, handleRestResponse, isExtraDataHidden, isFirstAccess, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpRefresh, setOpUpdate, validateCancel, validateRefresh, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocumentMethods inherited from class com.jalios.jcms.handler.JcmsFormHandler
canStartProcess, checkMissingField, getBackgroundProcess, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getOpenTabId, getRedirect, getRedirectOnClosePopup, getWorkspace, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, performFinish, performNext, performPrevious, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpenTabId, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePreviousMethods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJavaScriptModule, addPrefetchHeader, addStyleHeader, addStyleHeader, addSvgSpriteIcon, addWebAssets, canAccessAdminArea, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptModuleSet, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptModuleSet, getJavaScriptSet, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getStyleHeaders, getSvgSprites, getSvgSpritesHtml, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIconMethods inherited from class com.jalios.jcms.context.JcmsContext
addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, canAccessAdminArea, copyMsgListToMsgSessionList, 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, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWorkZone, removeMessage, removeMessage, removeMsg, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
Field Details
-
originalType
-
docFormHandler
-
showOptions
protected boolean showOptions -
isTypeAutoSelect
protected boolean isTypeAutoSelect -
typeSet
-
isModal
protected boolean isModal -
document
-
filename
-
descriptionTFE
-
description
-
descriptionML
-
opUpload
protected boolean opUpload
-
-
Constructor Details
-
DocUploadHandler
public DocUploadHandler()
-
-
Method Details
-
isTypeAutoSelect
public boolean isTypeAutoSelect() -
getPublicationClass
- Overrides:
getPublicationClassin classEditPublicationHandler
-
internalInit
public void internalInit() -
getTypeSet
-
setDocumentFormHandler
-
handleUploadError
Convenient method that returns a list (ul/li) of errors for each files.- Parameters:
failedMap- a map of errors returned by handleUpload()- Returns:
- String error list
-
handleUpload
Performs upload of all FileDocuments and create/update FileDocuments. Returns a Map of all FileDocuments with errors- Returns:
- Map a map of errors
-
handleUpload
This method allow the use of this formHandler by a programatic call, not in a jsp:usebean tag. Support only one DocUploadInfo.- Parameters:
dui- a DocUploadInfo- Returns:
- failedMap : not empty if some problem occured
-
performUpdate
protected void performUpdate(DocUploadInfo info, Map<String, String> controllerFailedMap, List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList) Performs creation of a FileDocument from a given DocUploadInfo. Store errors in the given controllerFailedMap.- Parameters:
info- a DocUploadInfocontrollerFailedMap- a Map of errors.indexingLatchList- if specified, will be filled with IndexingLatch object for each document updated
-
withJsonUpdate
-
performCreate
protected void performCreate(DocUploadInfo info, Map<String, String> controllerFailedMap, List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList) Performs creation of a FileDocument from a given DocUploadInfo. Store errors in the given controllerFailedMap.- Parameters:
info- a DocUploadInfocontrollerFailedMap- a Map of errors.indexingLatchList- if specified, will be filled with IndexingLatch object for each document updated
-
getNextUploadStep
Returns the JavaScript code to use depending of the upload step. The script may refresh opener, make redrect, fill opener form or close the doc chooser.- Returns:
- String the JavaScript code to execute
-
getStepCase
protected com.jalios.jcms.upload.DocUploadHandler.UploadStep getStepCase()Returns the upload step depending of multiple paramter steps OpenerForm, OpenerRefresh, Redirect- Returns:
- int the upload step
-
setModal
public void setModal(boolean modal) -
isInModal
public boolean isInModal() -
setId
Description copied from class:EditPublicationHandlerSet the value of id.- Overrides:
setIdin classEditPublicationHandler- Parameters:
id- Value to assign to id.
-
getAvailableFileDocument
-
getAvailableFileDocuments
-
isUpdate
public boolean isUpdate() -
isFieldMissing
Description copied from class:JcmsFormHandlerCheck if the given parameter is present in the query parameters- Overrides:
isFieldMissingin classJcmsFormHandler- Parameters:
field- the field to be checked- Returns:
- true if this field is present in the query parameters
-
setFilename
-
getAvailableFilename
-
setDescription
-
getAvailableDescription
-
getAvailableDescriptionML
-
getAvailableDescription
-
getAllAvailableDescriptionML
-
getAvailableUseDefaultCategories
public boolean getAvailableUseDefaultCategories()- Overrides:
getAvailableUseDefaultCategoriesin classEditPublicationHandler
-
setCids
- Overrides:
setCidsin classEditPublicationHandler
-
getAvailableCategorySet
-
setRemoveFile
public void setRemoveFile(boolean v) -
getAvailableRemoveFile
public boolean getAvailableRemoveFile() -
setUnlock
public void setUnlock(boolean v) -
setPstatus
public void setPstatus(int v) - Overrides:
setPstatusin classEditPublicationHandler
-
getAvailablePstatus
public int getAvailablePstatus()- Overrides:
getAvailablePstatusin classEditPublicationHandler
-
setTracked
public void setTracked(boolean v) - Overrides:
setTrackedin classEditPublicationHandler
-
getAvailableTracked
public boolean getAvailableTracked()- Overrides:
getAvailableTrackedin classEditPublicationHandler
-
setUnzipUploadedFiles
public void setUnzipUploadedFiles(boolean unzip) Set whether uploaded archives should be unziped and a new document created each time- Parameters:
unzip- true to unzip, false to leave document intact
-
getUnzipUploadedFiles
public boolean getUnzipUploadedFiles()Check if archives should be unziped and a new document created each time- Returns:
- true to unzip, false to leave document intact
-
setType
-
resolveType
-
getSelectedDocumentClass
-
getAvailableType
-
setOriginalType
-
getAvailableOriginalType
-
setOpenerForm
-
getAvailableOpenerForm
-
setRefresh
-
getAvailableOpenerRefresh
-
setNbElt
public void setNbElt(int v) -
getAvailableNbElt
public int getAvailableNbElt() -
setStartElt
public void setStartElt(int v) -
getAvailableStartElt
public int getAvailableStartElt() -
setJsFunc
-
getAvailableJsFunc
-
isWorkflowTabHidden
public boolean isWorkflowTabHidden()- Overrides:
isWorkflowTabHiddenin classEditPublicationHandler
-
setInitPstatus
public void setInitPstatus(boolean initPstatus) -
isInitPstatus
public boolean isInitPstatus() -
setOpUpload
-
isUploading
public boolean isUploading() -
setMajorUpdate
public void setMajorUpdate(boolean v) -
getAvailableMajorUpdate
public boolean getAvailableMajorUpdate()- Overrides:
getAvailableMajorUpdatein classEditPublicationHandler
-
isUploadEnabled
public boolean isUploadEnabled() -
setUploadEnabled
public void setUploadEnabled(boolean uploadEnabled) -
setShowOptions
-
getAvailableShowOptions
public boolean getAvailableShowOptions() -
showModalEditionChange
public boolean showModalEditionChange()Description copied from class:EditPublicationHandlerCheck if the "Advanced edition" or "Simple edition" button should be displayed in modal footer.The default implementation of this method is to check for request attribute
EditPublicationHandler.SHOW_MODAL_EDITION_CHANGE. If the attribute is not set, the button is displayed only when editing an existing publication (i.e.EditPublicationHandler.getPublication()is not null), and hidden when creating a new one.You can set the attribute to a custom value or provide a custom FormHandler to override this behavior.
See jcore/modalPubFormHandler.jspf for use of this method.
- Overrides:
showModalEditionChangein classEditPublicationHandler- Returns:
- true to display the button, false to hide it
-
getFieldStatus
Returns the FieldStatus for the given field.- Overrides:
getFieldStatusin classEditPublicationHandler- Parameters:
fieldName- the name of the field- Returns:
- the FieldStatus for the given field (never null).
- Since:
- jcms-6.0.1
-
checkWorkspaceChange
public void checkWorkspaceChange()check if the workspace has been explictly changed and reconfigure the handler to be consistent -
checkMemberClassWorkspaceCompliance
public void checkMemberClassWorkspaceCompliance() -
processIndexingLatch
public static void processIndexingLatch(List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList, Class<?> docClass) Process the IndexingLatch list elements- Parameters:
indexingLatchList- theListofLuceneDataSearchEngine.IndexingLatchdocClass- the class of the document (to manage hibernate transaction)
-
doUploadDocument
public static FileDocument doUploadDocument(DocUploadInfo info, FileDocument document, Consumer<FileDocument> updateBlock, ThrowingConsumer<FileDocument> applyJsonUpdate, boolean majorUpdate, BiConsumer<FileDocument, FileDocument> workflowBlock, boolean removeFile, boolean unlock, Member mbr, String userLang, HashMap<String, Object> context, Map<String, String> controllerFailedMap, List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)
-