Class ExplorerActionHandler

  • All Implemented Interfaces:
    com.jalios.jcms.JcmsConstants, com.jalios.util.JaliosConstants
    Direct Known Subclasses:
    ExplorerJMobileUploadHandler

    public class ExplorerActionHandler
    extends com.jalios.jcms.handler.JcmsFormHandler
    Handles all explorer actions which are handled through ajax
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.io.File[] documents  
      protected com.jalios.jcms.Category explorerCurrentCategory  
      • Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

        contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, 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, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace
      • 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
      • 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, 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, 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_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, 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, 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, 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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ExplorerAppHandler.DisplayMode getAvailableDisplayMode()  
      com.jalios.jcms.Category getAvailableExplorerCurrentCategory()  
      java.util.List<com.jalios.jcms.Data> getAvailableItems()  
      generated.PortletExplorer getAvailablePortletExplorer()  
      com.jalios.jcms.Category getAvailableTargetCategory()  
      java.lang.String getColor()  
      java.lang.String getDataName()  
      java.lang.String getJsonResponse()  
      com.jalios.jcms.FileDocument getUploadedDocument()  
      java.util.List<com.jalios.jcms.upload.DocUploadInfo> getUploadedFileList​(java.lang.String field, boolean isFileDocument, boolean override)
      Performs upload for the given field to JCMS upload directory.
      boolean isOpChangeCategoryColor()  
      boolean isOpDelete()  
      boolean isOpIncrementReaderTracker()  
      boolean isOpLock()  
      boolean isOpMove()  
      boolean isOpRemoveCategory()  
      boolean isOpRenameData()  
      boolean isOpSavePreferences()  
      boolean isOpUnlock()  
      boolean isOpUpload()  
      boolean isUnclassified()  
      boolean processAction()  
      protected <T extends com.jalios.jcms.Data>
      java.util.List<T>
      processDataIds​(java.lang.String fieldName, java.lang.String[] ids, java.lang.Class<T> clazz)
      Computes link array to retrieve Data of the given Class.
      protected <T extends com.jalios.jcms.Data>
      java.util.List<T>
      processDataIds​(java.lang.String fieldName, java.lang.String[] ids, java.lang.Class<T> clazz, boolean trim)
      Computes link array to retrieve Data of the given Class.
      protected boolean processUpload()  
      void setColor​(java.lang.String color)  
      void setDataName​(java.lang.String dataName)  
      void setDisplayMode​(java.lang.String displayMode)  
      void setDocuments​(java.lang.String[] documents)  
      void setExplorerCurrentCategory​(java.lang.String explorerCurrentCategoryId)  
      void setItems​(java.lang.String[] itemIds)  
      void setJsonResponse​(java.lang.String jsonResponse)  
      void setOpChangeCategoryColor​(boolean opChangeCategoryColor)  
      void setOpDelete​(boolean opDelete)  
      void setOpIncrementReaderTracker​(boolean opIncrementReaderTracker)  
      void setOpLock​(boolean opLock)  
      void setOpMove​(boolean opMove)  
      void setOpRemoveCategory​(boolean opRemoveCategory)  
      void setOpRenameData​(boolean opRenameData)  
      void setOpSavePreferences​(boolean opSavePreferences)  
      void setOpUnlock​(boolean opUnlock)  
      void setOpUpload​(boolean opUpload)  
      void setPortletExplorer​(java.lang.String portletExplorer)  
      void setTargetCategory​(java.lang.String targetCategoryId)  
      void setUnclassified​(boolean unclassified)  
      • Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

        afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, 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, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getRunningProcess, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setRunningProcess, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePrevious
      • Methods inherited from class com.jalios.jcms.context.JcmsJspContext

        addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, 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, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, retrieveUploadedFile, 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
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • explorerCurrentCategory

        protected com.jalios.jcms.Category explorerCurrentCategory
      • documents

        protected java.io.File[] documents
    • Constructor Detail

      • ExplorerActionHandler

        public ExplorerActionHandler()
    • Method Detail

      • processAction

        public boolean processAction()
                              throws java.io.IOException
        Overrides:
        processAction in class com.jalios.jcms.handler.JcmsFormHandler
        Throws:
        java.io.IOException
      • processUpload

        protected boolean processUpload()
      • isOpMove

        public boolean isOpMove()
      • setOpMove

        public void setOpMove​(boolean opMove)
      • setItems

        public void setItems​(java.lang.String[] itemIds)
      • getAvailableItems

        public java.util.List<com.jalios.jcms.Data> getAvailableItems()
      • setExplorerCurrentCategory

        public void setExplorerCurrentCategory​(java.lang.String explorerCurrentCategoryId)
      • getAvailableExplorerCurrentCategory

        public com.jalios.jcms.Category getAvailableExplorerCurrentCategory()
      • setTargetCategory

        public void setTargetCategory​(java.lang.String targetCategoryId)
      • getAvailableTargetCategory

        public com.jalios.jcms.Category getAvailableTargetCategory()
      • isOpDelete

        public boolean isOpDelete()
      • setOpDelete

        public void setOpDelete​(boolean opDelete)
      • isOpRemoveCategory

        public boolean isOpRemoveCategory()
      • setOpRemoveCategory

        public void setOpRemoveCategory​(boolean opRemoveCategory)
      • isOpRenameData

        public boolean isOpRenameData()
      • setOpRenameData

        public void setOpRenameData​(boolean opRenameData)
      • getDataName

        public java.lang.String getDataName()
      • setDataName

        public void setDataName​(java.lang.String dataName)
      • isOpLock

        public boolean isOpLock()
      • setOpLock

        public void setOpLock​(boolean opLock)
      • isOpUnlock

        public boolean isOpUnlock()
      • setOpUnlock

        public void setOpUnlock​(boolean opUnlock)
      • isOpUpload

        public boolean isOpUpload()
      • setOpUpload

        public void setOpUpload​(boolean opUpload)
      • setDocuments

        public void setDocuments​(java.lang.String[] documents)
      • getUploadedFileList

        public java.util.List<com.jalios.jcms.upload.DocUploadInfo> getUploadedFileList​(java.lang.String field,
                                                                                        boolean isFileDocument,
                                                                                        boolean override)
        Performs upload for the given field to JCMS upload directory. Calling method must handle job around file like creating or updating associated FileDocument.
        Overrides:
        getUploadedFileList in class com.jalios.jcms.context.JcmsContext
        Parameters:
        field - the submited field
        isFileDocument - upload to a FileDocument upload/docs/...
        override - If file already exists, override or rename with current timemillis
        Returns:
        List a List of uploaded files
        Since:
        jcms-5.7.0
        See Also:
        UploadManager.getUploadedFileList(JcmsContext, String, boolean, boolean)
      • processDataIds

        protected <T extends com.jalios.jcms.Data> java.util.List<T> processDataIds​(java.lang.String fieldName,
                                                                                    java.lang.String[] ids,
                                                                                    java.lang.Class<T> clazz)
        Computes link array to retrieve Data of the given Class. Trim end of the returned List. If link array contains value MultipartRequest.MULTIPART_UPLOAD then instanciate a new FileDocument but do NOT perform create. Handler.validate() should perform Create or Update. Underlaying files are never overrided.
        Type Parameters:
        T - The data type
        Parameters:
        fieldName - the field name
        ids - arrays of ids
        clazz - the class of links
        Returns:
        List a list of Data
        Since:
        jcms-5.7.0
      • processDataIds

        protected <T extends com.jalios.jcms.Data> java.util.List<T> processDataIds​(java.lang.String fieldName,
                                                                                    java.lang.String[] ids,
                                                                                    java.lang.Class<T> clazz,
                                                                                    boolean trim)
        Computes link array to retrieve Data of the given Class. Optionnaly, trims the end of the returned List. If link array contains value MultipartRequest.MULTIPART_UPLOAD then instanciate a new FileDocument but do NOT perform create. Handler.validate() should perform Create or Update. Underlaying files are never overrided.
        Type Parameters:
        T - The data type
        Parameters:
        fieldName - the field name
        ids - arrays of ids
        clazz - the class of links
        trim - if true, trim the end of the returned list.
        Returns:
        List a list of Data
        Since:
        jcms-6.0.0
      • isOpSavePreferences

        public boolean isOpSavePreferences()
      • setOpSavePreferences

        public void setOpSavePreferences​(boolean opSavePreferences)
      • getAvailablePortletExplorer

        public generated.PortletExplorer getAvailablePortletExplorer()
      • setPortletExplorer

        public void setPortletExplorer​(java.lang.String portletExplorer)
      • setDisplayMode

        public void setDisplayMode​(java.lang.String displayMode)
      • isOpChangeCategoryColor

        public boolean isOpChangeCategoryColor()
      • setOpChangeCategoryColor

        public void setOpChangeCategoryColor​(boolean opChangeCategoryColor)
      • getColor

        public java.lang.String getColor()
      • setColor

        public void setColor​(java.lang.String color)
      • isOpIncrementReaderTracker

        public boolean isOpIncrementReaderTracker()
      • setOpIncrementReaderTracker

        public void setOpIncrementReaderTracker​(boolean opIncrementReaderTracker)
      • getJsonResponse

        public java.lang.String getJsonResponse()
      • setJsonResponse

        public void setJsonResponse​(java.lang.String jsonResponse)
      • isUnclassified

        public boolean isUnclassified()
      • setUnclassified

        public void setUnclassified​(boolean unclassified)
      • getUploadedDocument

        public com.jalios.jcms.FileDocument getUploadedDocument()