DocUploadHandler (JCMS API)

java.lang.Object
- com.jalios.jcms.context.JcmsContext
- - com.jalios.jcms.context.JcmsJspContext
  - - com.jalios.jcms.handler.JcmsFormHandler
    - - com.jalios.jcms.handler.EditDataHandler
      - com.jalios.jcms.handler.EditPublicationHandler
        
        com.jalios.jcms.upload.DocUploadHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants
```
public class DocUploadHandler
extends EditPublicationHandler
```
This form handler processes document upload. It use new UploadFilter mechanism and no longer decode MultiPart request.

Since:

jcms-5.7.0

Version:

$Revision: 93983 $

Author:

Jean-Philippe Encausse

See Also:
MultipartFilter

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Set<Category>`	`categorySet`
`protected EditFileDocumentHandler`	`docFormHandler`
`protected FileDocument`	`document`
`protected java.lang.String[]`	`filename`
`protected boolean`	`isModal`
`protected boolean`	`opUpload`
`protected java.lang.Class`	`originalType`
`static java.lang.String`	`REVISION`
`protected boolean`	`showOptions`

Fields inherited from class com.jalios.jcms.handler.EditPublicationHandler
adate, anchor, author, authorizedGroupsAddCount, authorizedGroupSet, authorizedMemberSet, authorizedMemberSetAddCount, checkMemberForRequestUnlock, cids, DISPLAY_URL_TOKEN, doNotStore, edate, fieldStatusMap, friendlyURLSet, 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, opUnlock, pdate, PREVIEW_URL_TOKEN, pubClass, publication, requestUnlockMessage, reviewRating, roleIds, roleMap, roleMembers, sdate, showAllTabs, showContentTabOnly, templates, title, titleML, typeLabel, updateGroupsAddCount, updateGroupSet, updateMemberSet, updateMemberSetAddCount, wf, wfNote, workingPub, wste

Fields inherited from class com.jalios.jcms.handler.EditDataHandler
extFormHandler, id, isDeleteForced, op, opCancel, opCreate, opDelete, opFinish, opNext, opPrevious, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, 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, 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, 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

DocUploadHandler()

Constructors
Constructor and Description
`DocUploadHandler()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkMemberClassWorkspaceCompliance()`
`void`	`checkWorkspaceChange()` check if the workspace has been explictly changed and reconfigure the handler to be consistent
`void`	`forceUpdate()` Will force an update of all JcmsContext variables (retrieve it from the request) Update the protected variable initDone (to false at begining of method, and true on end).
`java.util.HashMap<java.lang.String,java.lang.String>`	`getAllAvailableDescriptionML()`
`Category[]`	`getAvailableCategories()`
`java.util.Set<Category>`	`getAvailableCategorySet()`
`java.lang.String`	`getAvailableDescription()`
`java.lang.String`	`getAvailableDescription(java.lang.String lang)`
`java.util.HashMap<java.lang.String,java.lang.String>`	`getAvailableDescriptionML()`
`FileDocument`	`getAvailableFileDocument()`
`FileDocument[]`	`getAvailableFileDocuments()`
`java.lang.String`	`getAvailableFilename()`
`java.lang.String`	`getAvailableJsFunc()`
`boolean`	`getAvailableMajorUpdate()`
`int`	`getAvailableNbElt()`
`java.lang.String`	`getAvailableOpenerForm()`
`java.lang.String`	`getAvailableOpenerRefresh()`
`java.lang.Class`	`getAvailableOriginalType()`
`int`	`getAvailablePstatus()`
`boolean`	`getAvailableRemoveFile()`
`boolean`	`getAvailableShowOptions()`
`int`	`getAvailableStartElt()`
`boolean`	`getAvailableTracked()`
`java.lang.Class<? extends FileDocument>`	`getAvailableType()`
`FieldStatus`	`getFieldStatus(java.lang.String fieldName)` Returns the FieldStatus for the given field.
`static java.lang.Class<? extends FileDocument>`	`getFirstDocumentClassAuthorized(Member member, Workspace workspace, java.lang.Class<? extends FileDocument> defaultValue)` Retrieve the first document class authorized for publication by the specified member.
`java.lang.String`	`getNextUploadStep()` Returns the JavaScript code to use depending of the upload step.
`java.lang.Class<? extends Publication>`	`getPublicationClass()`
`protected com.jalios.jcms.upload.DocUploadHandler.UploadStep`	`getStepCase()` Returns the upload step depending of multiple paramter steps OpenerForm, OpenerRefresh, Redirect
`java.util.Set`	`getTypeSet()`
`boolean`	`getUnzipUploadedFiles()` Check if archives should be unziped and a new document created each time
`java.util.Map<java.lang.String,java.lang.String>`	`handleUpload()` Performs upload of all FileDocuments and create/update FileDocuments.
`java.util.Map<java.lang.String,java.lang.String>`	`handleUpload(DocUploadInfo dui)` This method allow the use of this formHandler by a programatic call, not in a jsp:usebean tag.
`java.lang.String`	`handleUploadError(java.util.Map<java.lang.String,java.lang.String> failedMap)` Convenient method that returns a list (ul/li) of errors for each files.
`void`	`internalInit()`
`protected boolean`	`isFieldMissing(java.lang.String field)` Check if the given parameter is present in the query parameters
`boolean`	`isInModal()`
`boolean`	`isUpdate()`
`boolean`	`isUploadEnabled()`
`boolean`	`isUploading()`
`protected void`	`performCreate(DocUploadInfo info, java.util.Map<java.lang.String,java.lang.String> controllerFailedMap, java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)` Performs creation of a FileDocument from a given DocUploadInfo.
`protected void`	`performUpdate(DocUploadInfo info, java.util.Map<java.lang.String,java.lang.String> controllerFailedMap, java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)` Performs creation of a FileDocument from a given DocUploadInfo.
`void`	`setCids(java.lang.String[] v)`
`void`	`setDescription(java.lang.String[] v)`
`void`	`setDocumentFormHandler(EditFileDocumentHandler docFormHandler)`
`void`	`setFilename(java.lang.String[] v)`
`void`	`setId(java.lang.String id)` Set the value of id.
`void`	`setJsFunc(java.lang.String v)`
`void`	`setMajorUpdate(boolean v)`
`void`	`setModal(boolean modal)`
`void`	`setNbElt(int v)`
`void`	`setOpenerForm(java.lang.String v)`
`void`	`setOpUpload(java.lang.String v)`
`void`	`setOriginalType(java.lang.String type)`
`void`	`setPstatus(int v)`
`void`	`setRefresh(java.lang.String v)`
`void`	`setRemoveFile(boolean v)`
`void`	`setShowOptions(java.lang.String v)`
`void`	`setStartElt(int v)`
`void`	`setTracked(boolean v)`
`void`	`setType(java.lang.String type)`
`void`	`setUnlock(boolean v)`
`void`	`setUnzipUploadedFiles(boolean unzip)` Set whether uploaded archives should be unziped and a new document created each time
`void`	`setUploadEnabled(boolean uploadEnabled)`

Methods inherited from class com.jalios.jcms.handler.EditPublicationHandler
cannotRead, containsHiddenParts, doWorkflowUpdate, getAllAvailableTitleML, getAnchor, getAuthorizedGroupsCount, getAuthorizedMemberSetCount, getAvailableAdate, getAvailableAuthor, getAvailableAuthorizedGroupSet, getAvailableAuthorizedMemberSet, getAvailableEdate, getAvailableField, getAvailableFriendlyURLSet, getAvailableInternalWorkflow, getAvailableMainLanguage, getAvailablePdate, getAvailableRoleMap, getAvailableSdate, getAvailableTemplateEntry, getAvailableTemplates, getAvailableTitle, getAvailableTitle, getAvailableTitleML, getAvailableUpdateGroupSet, getAvailableUpdateMemberSet, getAvailableWFNote, getAvailableWorkspace, getCategorySet, getClosePopupUrl, getControllerContext, getDataClass, getDefaultAuthorizedGroupSet, getDefaultAuthorizedMemberSet, getDefaultCategorySet, getDefaultTemplateUsage, getDefaultUpdateGroupSet, getDefaultUpdateMemberSet, getDoNotStore, getHiddenCatSet, getIgnoreWorkspaceCompliance, getMemberSetAssignedToRole, getOldPstatus, getOpenTab, getPublication, getShowAllTabs, getShowContentTabOnly, getTabLabel, getTitleFieldValue, getTypeLabel, getUpdateGroupsCount, getUpdateMemberSetCount, getWorkAreaCss, getWorkflow, getWorkspaceComplianceWarning, getWSTypeEntry, init, initWorkspace, internalPerformCreate, internalPerformDelete, internalPerformUpdate, isAdvancedTabHidden, isCategoryTabHidden, isContentTabOnly, isDBType, isExpanded, isFieldEdition, isForm, isLocked, isReadRightTabHidden, isStrongLocked, isTabForced, isTemplateTabHidden, isUpdateRightTabHidden, isWorkflowTabHidden, lock, performAddItem, performAddItemReadRights, performAddItemUpdateRights, performCreate, performDelete, performLock, performMerge, performRefresh, performRequestUnlock, performUnlock, performUpdate, prepare, processAction, processStatus, releaseDBWorkingPub, sendRedirect, setAdate, setAnchor, setAuthor, setAuthorForced, setAuthorizedGroupIds, setAuthorizedMemberIds, setAuthorizedMemberSetAddCount, setCheckMemberForRequestUnlock, setDoNotStore, setEdate, setFields, setFriendlyURL, setIgnoreWorkspaceCompliance, setInternalWf, setItemPos, setMainLanguage, setMajorUpdate, setOpAddItem, setOpAddItemReadRights, setOpAddItemUpdateRights, setOpenTab, setOpLock, setOpMerge, setOpRequestUnlock, setOpUnlock, setOpUpdateMajor, setPdate, setRequestUnlockMessage, setRoleId, setSdate, setShowAllTabs, setShowContentTabOnly, setTemplates, setTitle, setUpdateGroupIds, setUpdateMemberIds, setUpdateMemberSetAddCount, setWfNote, setWorkspaceComplianceWarning, showForceDelete, showFriendlyURL, showLanguageChooser, showLockWarning, showMainLanguage, showReaderTracker, showSDate, showWFRole, unlock, updateCids, validateAddItem, validateAddItemReadRights, validateAddItemUpdateRights, validateBeforeOp, validateCreate, validateDelete, validateFieldFormat, validateForm, validateLock, validateMember, validateMerge, validateRequestUnlock, validateUnlock, validateUpdate, validateWorkspace, workflowHasNotBeenChanged

Methods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getEnumLabels, getEnumValues, getExtFormHandler, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isFirstAccess, performCancel, performCreateExtension, performFinish, performNext, performPrevious, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpFinish, setOpNext, setOpPrevious, setOpRefresh, setOpUpdate, validateCancel, validateCreateExtension, validateFinish, validateNext, validatePrevious, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
checkMissingField, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, 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, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, 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

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    Constant Field Values
  - originalType
```
protected java.lang.Class originalType
```
  - docFormHandler
```
protected EditFileDocumentHandler docFormHandler
```
  - showOptions
```
protected boolean showOptions
```
  - isModal
```
protected boolean isModal
```
  - document
```
protected FileDocument document
```
  - filename
```
protected java.lang.String[] filename
```
  - categorySet
```
protected java.util.Set<Category> categorySet
```
  - opUpload
```
protected boolean opUpload
```
- Constructor Detail
  - DocUploadHandler
```
public DocUploadHandler()
```
- Method Detail
  - getPublicationClass
```
public java.lang.Class<? extends Publication> getPublicationClass()
```
    Overrides:
    
    getPublicationClass in class EditPublicationHandler
  - internalInit
```
public void internalInit()
```
  - getTypeSet
```
public java.util.Set getTypeSet()
```
  - setDocumentFormHandler
```
public void setDocumentFormHandler(EditFileDocumentHandler docFormHandler)
```
  - handleUploadError
```
public java.lang.String handleUploadError(java.util.Map<java.lang.String,java.lang.String> failedMap)
```
    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
```
public java.util.Map<java.lang.String,java.lang.String> 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
```
public java.util.Map<java.lang.String,java.lang.String> handleUpload(DocUploadInfo dui)
```
    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,
                 java.util.Map<java.lang.String,java.lang.String> controllerFailedMap,
                 java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)
```
    Performs creation of a FileDocument from a given DocUploadInfo. Store errors in the given controllerFailedMap.
    
    Parameters:
    info - a DocUploadInfo
    controllerFailedMap - a Map of errors.
    indexingLatchList - if specified, will be filled with IndexingLatch object for each document updated
  - performCreate
```
protected void performCreate(DocUploadInfo info,
                 java.util.Map<java.lang.String,java.lang.String> controllerFailedMap,
                 java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)
```
    Performs creation of a FileDocument from a given DocUploadInfo. Store errors in the given controllerFailedMap.
    
    Parameters:
    info - a DocUploadInfo
    controllerFailedMap - a Map of errors.
    indexingLatchList - if specified, will be filled with IndexingLatch object for each document updated
  - getNextUploadStep
```
public java.lang.String 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
```
public void setId(java.lang.String id)
```
    Description copied from class: EditPublicationHandler
    
    Set the value of id.
    
    Overrides:
    
    setId in class EditPublicationHandler
    
    Parameters:
    id - Value to assign to id.
  - getAvailableFileDocument
```
public FileDocument getAvailableFileDocument()
```
  - getAvailableFileDocuments
```
public FileDocument[] getAvailableFileDocuments()
```
  - isUpdate
```
public boolean isUpdate()
```
  - isFieldMissing
```
protected boolean isFieldMissing(java.lang.String field)
```
    Description copied from class: JcmsFormHandler
    
    Check if the given parameter is present in the query parameters
    
    Overrides:
    
    isFieldMissing in class JcmsFormHandler
    
    Parameters:
    field - the field to be checked
    
    Returns:
    true if this field is present in the query parameters
  - setFilename
```
public void setFilename(java.lang.String[] v)
```
  - getAvailableFilename
```
public java.lang.String getAvailableFilename()
```
  - setDescription
```
public void setDescription(java.lang.String[] v)
```
  - getAvailableDescription
```
public java.lang.String getAvailableDescription()
```
  - getAvailableDescriptionML
```
public java.util.HashMap<java.lang.String,java.lang.String> getAvailableDescriptionML()
```
  - getAvailableDescription
```
public java.lang.String getAvailableDescription(java.lang.String lang)
```
  - getAllAvailableDescriptionML
```
public java.util.HashMap<java.lang.String,java.lang.String> getAllAvailableDescriptionML()
```
  - setCids
```
public void setCids(java.lang.String[] v)
```
    Overrides:
    
    setCids in class EditPublicationHandler
  - getAvailableCategories
```
public Category[] getAvailableCategories()
```
    Overrides:
    
    getAvailableCategories in class EditPublicationHandler
  - getAvailableCategorySet
```
public java.util.Set<Category> getAvailableCategorySet()
```
  - setRemoveFile
```
public void setRemoveFile(boolean v)
```
  - getAvailableRemoveFile
```
public boolean getAvailableRemoveFile()
```
  - setUnlock
```
public void setUnlock(boolean v)
```
  - setPstatus
```
public void setPstatus(int v)
```
    Overrides:
    
    setPstatus in class EditPublicationHandler
  - getAvailablePstatus
```
public int getAvailablePstatus()
```
    Overrides:
    
    getAvailablePstatus in class EditPublicationHandler
  - setTracked
```
public void setTracked(boolean v)
```
    Overrides:
    
    setTracked in class EditPublicationHandler
  - getAvailableTracked
```
public boolean getAvailableTracked()
```
    Overrides:
    
    getAvailableTracked in class EditPublicationHandler
  - 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
  - forceUpdate
```
public void forceUpdate()
```
    Description copied from class: JcmsJspContext
    
    Will force an update of all JcmsContext variables (retrieve it from the request) Update the protected variable initDone (to false at begining of method, and true on end).
    
    Overrides:
    
    forceUpdate in class JcmsJspContext
  - getFirstDocumentClassAuthorized
```
public static java.lang.Class<? extends FileDocument> getFirstDocumentClassAuthorized(Member member,
                                                                      Workspace workspace,
                                                                      java.lang.Class<? extends FileDocument> defaultValue)
```
    Retrieve the first document class authorized for publication by the specified member.
    
    Parameters:
    member - the member for which to perform the verification
    workspace - the workspace in which to perform the verification
    defaultValue - the default class to return if either member or workspace is null, or if member cannot publish any document class in specified workspace
    
    Returns:
    a FileDocument type class (or return the value specified in defaultValue parameter if member cannot publish any document class in specified workspace)
    Since:
    
    jcms-9.0.1
  - setType
```
public void setType(java.lang.String type)
```
  - getAvailableType
```
public java.lang.Class<? extends FileDocument> getAvailableType()
```
  - setOriginalType
```
public void setOriginalType(java.lang.String type)
```
  - getAvailableOriginalType
```
public java.lang.Class getAvailableOriginalType()
```
  - setOpenerForm
```
public void setOpenerForm(java.lang.String v)
```
  - getAvailableOpenerForm
```
public java.lang.String getAvailableOpenerForm()
```
  - setRefresh
```
public void setRefresh(java.lang.String v)
```
  - getAvailableOpenerRefresh
```
public java.lang.String getAvailableOpenerRefresh()
```
  - setNbElt
```
public void setNbElt(int v)
```
  - getAvailableNbElt
```
public int getAvailableNbElt()
```
  - setStartElt
```
public void setStartElt(int v)
```
  - getAvailableStartElt
```
public int getAvailableStartElt()
```
  - setJsFunc
```
public void setJsFunc(java.lang.String v)
```
  - getAvailableJsFunc
```
public java.lang.String getAvailableJsFunc()
```
  - setOpUpload
```
public void setOpUpload(java.lang.String v)
```
  - isUploading
```
public boolean isUploading()
```
  - setMajorUpdate
```
public void setMajorUpdate(boolean v)
```
  - getAvailableMajorUpdate
```
public boolean getAvailableMajorUpdate()
```
    Overrides:
    
    getAvailableMajorUpdate in class EditPublicationHandler
  - isUploadEnabled
```
public boolean isUploadEnabled()
```
  - setUploadEnabled
```
public void setUploadEnabled(boolean uploadEnabled)
```
  - setShowOptions
```
public void setShowOptions(java.lang.String v)
```
  - getAvailableShowOptions
```
public boolean getAvailableShowOptions()
```
  - getFieldStatus
```
public FieldStatus getFieldStatus(java.lang.String fieldName)
```
    Returns the FieldStatus for the given field.
    
    Overrides:
    
    getFieldStatus in class EditPublicationHandler
    
    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()
```

Class DocUploadHandler

Field Summary

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

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

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

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

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

Fields inherited from interface com.jalios.jcms.JcmsConstants

Fields inherited from interface com.jalios.util.JaliosConstants

Constructor Summary

Method Summary

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

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

REVISION

originalType

docFormHandler

showOptions

isModal

document

filename

categorySet

opUpload

Constructor Detail

DocUploadHandler

Method Detail

getPublicationClass

internalInit

getTypeSet

setDocumentFormHandler

handleUploadError

handleUpload

handleUpload

performUpdate

performCreate

getNextUploadStep

getStepCase

setModal

isInModal

setId

getAvailableFileDocument

getAvailableFileDocuments

isUpdate

isFieldMissing

setFilename

getAvailableFilename

setDescription

getAvailableDescription

getAvailableDescriptionML

getAvailableDescription

getAllAvailableDescriptionML

setCids

getAvailableCategories

getAvailableCategorySet

setRemoveFile

getAvailableRemoveFile

setUnlock

setPstatus

getAvailablePstatus

setTracked

getAvailableTracked

setUnzipUploadedFiles

getUnzipUploadedFiles

forceUpdate

getFirstDocumentClassAuthorized

setType

getAvailableType

setOriginalType

getAvailableOriginalType

setOpenerForm

getAvailableOpenerForm

setRefresh

getAvailableOpenerRefresh

setNbElt

getAvailableNbElt

setStartElt