Package com.jalios.jcms.trash
Class TrashAppHandler
- java.lang.Object
-
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
public class TrashAppHandler extends QueryAppHandler
Handler used to access Trash application.- Since:
- jcms-10.0.5 / JCMS-8353
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTrashAppHandler.View-
Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler
AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Collection<java.lang.String>bulkPubIdSetprotected booleanopBulkDeleteprotected booleanopBulkRestoreprotected TrashBulkProcessprocessprotected QueryResultSetresultSetprotected QueryHandlersecondQuerystatic java.lang.StringTRASH_PUB_ID_PARAM-
Fields inherited from class com.jalios.jcms.search.QueryAppHandler
isAdvSearchReferer, prevDateSince
-
Fields inherited from class com.jalios.jcms.handler.QueryHandler
CLASSIFICATION_LEVEL_FILTER_PARAM, TEXT_MODE_ADVANCED, TEXT_MODE_ALL_WORDS, TEXT_MODE_ANY_WORD, TEXT_MODE_EXACT
-
Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, 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, 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_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, 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_DIR, 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
-
-
Constructor Summary
Constructors Constructor Description TrashAppHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddFrontEndDependencies()java.lang.StringgetAppUrl()Returns the URL to the current state of this applicationjava.lang.StringgetAppUrl(java.util.Map<java.lang.String,java.lang.String[]> parametersOverride)Returns the URL to the current state of this application, overriding some parameter with the specified valuesjava.util.Set<Workspace>getAvailableTrashWorkspaceSet()DateSettingsgetBeginDateSettings()java.util.Set<Publication>getBulkPublicationSet()DateSettingsgetEndDateSettings()ControlSettings<?>getOpAuthorSettings()java.lang.StringgetQueryString(java.util.Map<java.lang.String,java.lang.String[]> parametersOverride)Returns all parameters of this handler as a queryString, overriding current settings with the specified params with the specified value(s).QueryResultSetgetResultSet()Return results of a query done using thisQueryHandler.java.util.SortedSet<Publication>getSortedResultSet()ControlSettings<?>getViewSettings()ControlSettings<?>getWorkspacesSettings()voidinit()Method to implement if you need to initialize your handler from parameter received, prior to all security validation.booleanisAllView()booleanisPublicationInBulk(Publication pub)protected booleanperformBulkDelete()protected booleanperformBulkRestore()protected java.lang.StringprintParams(AbstractQueryHandler.QueryHandlerPrinter printer)Print current QueryHandler params using specified QueryHandlerPrinter.booleanprocessAction()Method to be implemented to check/validate action to be performed and process them.voidsetOpBulkDelete(java.lang.String v)voidsetOpBulkRestore(java.lang.String v)voidsetTrashId(java.lang.String[] v)voidsetTrashWrkspc(java.lang.String... wsIds)voidsetTypes(java.lang.String... types)voidsetView(java.lang.String viewStr)booleanshowPublicationBulkSelect()booleanshowViews()booleanshowWorkspaceColumn()protected booleanvalidateBulkDelete()protected booleanvalidateBulkRestore()-
Methods inherited from class com.jalios.jcms.search.QueryAppHandler
getDateSettings, getDateSinceSettings, getDateTypeSettings, getMemberSearchIcon, getMemberSearchUrl, getWorkspaceSearchIcon, getWorkspaceSearchUrl, setAdvSearchReferer, setPrevDateSince, showMemberSearch, showWorkspaceSearch
-
Methods inherited from class com.jalios.jcms.handler.QueryHandler
addHighlightAttributes, appendAdvanced, appendAdvanced, clearHighlightAttributes, getAbility, getAdvanced, getAllCidSet, getBeginAndEndDates, getBeginDate, getBeginDay, getBeginMonth, getBeginYear, getCategorySet, getCatMode, getCatName, getCheckPstatus, getCids, getCidsOff, getClassificationLevel, getClassificationLevelSet, getClassOffSet, getClassSet, getContentLangs, getContentTypesFromDocumentKind, getDateSinceInt, getDateType, getDescription, getDescription, getDocumentKinds, getDocumentKindsGroupMap, getDocumentKindsMap, getEndDate, getEndDay, getEndMonth, getEndYear, getExactCat, getExactType, getGids, getGidsOff, getHighlightedMember, getHist, getHistLevel, getHistoryList, getIntPstatus, getLangs, getLogger, getMids, getMidsOff, getMidsOpAuthor, getMode, getMostRecentTextAndModeInHistory, getMostRecentTextInHistoryVisitor, getPagerAll, getPageSize, getPortalIds, getPstatus, getQueryFilterContext, getRefinedWorkspace, getReplaceFileDoc, getResolvedWorkspaceSet, getReverse, getSearchedFields, getSearchInDB, getSearchInFiles, getSearchInMembers, getSearchInPub, getSearchInSubWorkspaces, getSearchInTrash, getSort, getStart, getText, getTextSearch, getTypes, getTypesCommonSuperClass, getTypesOff, getUnresolvedContentLangs, getUnresolvedLangs, getUserLang, getWfId, getWorkspaceSet, isExpanded, isHybridSearch, isModeAdvanced, isModeAll, isModeAny, isModeExact, parseQueryStringParam, setAbility, setAdvanced, setBeginDate, setBeginDateStr, setBeginDateW3c, setBeginDay, setBeginMonth, setBeginYear, setCatMode, setCatName, setCheckPstatus, setCids, setCidsOff, setClassificationLevel, setClassificationLevelSet, setContentLangs, setDateSince, setDateSince, setDateType, setDocumentKinds, setEndDate, setEndDateStr, setEndDateW3c, setEndDay, setEndMonth, setEndYear, setExactCat, setExactType, setGids, setGidsOff, setHist, setHistLevel, setHistoryList, setIgnoreDefaultTypes, setLangs, setMids, setMidsOff, setMidsOpAuthor, setMode, setPagerAll, setPageSize, setPortalIds, setPstatus, setReplaceFileDoc, setReverse, setSearchedFields, setSearchInDB, setSearchInFiles, setSearchInMembers, setSearchInPub, setSearchInSubWorkspaces, setSearchInTrash, setSort, setStart, setText, setTextSearch, setTypesOff, setWfId, setWorkspace, setWorkspaceSet, setWrkspc, toString, validateTypesArray
-
Methods inherited from class com.jalios.jcms.handler.AbstractQueryHandler
getAttribute, getAttributeMap, getDataSet, getHiddenParams, getQueryString, init, parseQueryString, removeAttribute, setAttribute, setDataSet
-
Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, 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, getWorkspace, 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, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, 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, 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, getUploadedFile, getUploadedFileList, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, removeMsg, 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
-
-
-
-
Field Detail
-
TRASH_PUB_ID_PARAM
public static final java.lang.String TRASH_PUB_ID_PARAM
- See Also:
- Constant Field Values
-
secondQuery
protected QueryHandler secondQuery
-
bulkPubIdSet
protected java.util.Collection<java.lang.String> bulkPubIdSet
-
process
protected TrashBulkProcess process
-
opBulkDelete
protected boolean opBulkDelete
-
opBulkRestore
protected boolean opBulkRestore
-
resultSet
protected QueryResultSet resultSet
-
-
Method Detail
-
processAction
public boolean processAction() throws java.io.IOExceptionDescription copied from class:JcmsFormHandlerMethod to be implemented to check/validate action to be performed and process them.Default implementation is to return false. No need to call super method.
This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.
- Overrides:
processActionin classJcmsFormHandler- Returns:
- false if no redirection is needed, true otherwise
- Throws:
java.io.IOException- IO Exception
-
addFrontEndDependencies
public void addFrontEndDependencies()
-
init
public void init()
Description copied from class:JcmsFormHandlerMethod to implement if you need to initialize your handler from parameter received, prior to all security validation.You must absolutely not perform any action which modify data or site configuration.
Therefore it is strongly recommend NOT TO implement this method, or use very wisely.
- Overrides:
initin classQueryAppHandler
-
getResultSet
public QueryResultSet getResultSet()
Description copied from class:QueryHandlerReturn results of a query done using thisQueryHandler.Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.
- Overrides:
getResultSetin classQueryHandler- Returns:
- a
QueryResultSetcontaining all results of this query, it is aHashSetand therefore it is NOT sorted. use eithergetAsSortedSet()orgetAsSortedSet(Comparator)to obtain a sorted Set.
-
getSortedResultSet
public java.util.SortedSet<Publication> getSortedResultSet()
-
printParams
protected java.lang.String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
Description copied from class:QueryHandlerPrint current QueryHandler params using specified QueryHandlerPrinter.- Overrides:
printParamsin classQueryHandler- Parameters:
printer- a QueryHandlerPrinter to use- Returns:
- a string containing all parameters of this handler printed using specified QueryHandlerPrinter.
-
getQueryString
public java.lang.String getQueryString(java.util.Map<java.lang.String,java.lang.String[]> parametersOverride)
Returns all parameters of this handler as a queryString, overriding current settings with the specified params with the specified value(s).- Parameters:
parametersOverride- (optional, can be null)- Returns:
- a query string, starting with a parameter name (no '?' or '&')
- Since:
- 10.0.7 / JCMS-9688
-
getAppUrl
public java.lang.String getAppUrl()
Returns the URL to the current state of this application- Returns:
- a relative URL such as front/trash/trashApp.jsp?mids=j_2
- Since:
- 10.0.7 / JCMS-9688
-
getAppUrl
public java.lang.String getAppUrl(java.util.Map<java.lang.String,java.lang.String[]> parametersOverride)
Returns the URL to the current state of this application, overriding some parameter with the specified values- Parameters:
parametersOverride- (optional, can be null)- Returns:
- a relative URL such as front/trash/trashApp.jsp?mids=j_2
- Since:
- 10.0.7 / JCMS-9688
-
setTypes
public void setTypes(java.lang.String... types)
- Overrides:
setTypesin classQueryHandler
-
showViews
public boolean showViews()
-
setView
public void setView(java.lang.String viewStr)
-
isAllView
public boolean isAllView()
-
getViewSettings
public ControlSettings<?> getViewSettings()
-
setTrashWrkspc
public void setTrashWrkspc(java.lang.String... wsIds)
-
getAvailableTrashWorkspaceSet
public java.util.Set<Workspace> getAvailableTrashWorkspaceSet()
-
showWorkspaceColumn
public boolean showWorkspaceColumn()
-
getWorkspacesSettings
public ControlSettings<?> getWorkspacesSettings()
-
getBeginDateSettings
public DateSettings getBeginDateSettings()
- Overrides:
getBeginDateSettingsin classQueryAppHandler
-
getEndDateSettings
public DateSettings getEndDateSettings()
- Overrides:
getEndDateSettingsin classQueryAppHandler
-
getOpAuthorSettings
public ControlSettings<?> getOpAuthorSettings()
-
validateBulkDelete
protected boolean validateBulkDelete()
-
performBulkDelete
protected boolean performBulkDelete() throws java.io.IOException- Throws:
java.io.IOException
-
setOpBulkDelete
public void setOpBulkDelete(java.lang.String v)
-
validateBulkRestore
protected boolean validateBulkRestore()
-
performBulkRestore
protected boolean performBulkRestore() throws java.io.IOException- Throws:
java.io.IOException
-
setOpBulkRestore
public void setOpBulkRestore(java.lang.String v)
-
isPublicationInBulk
public boolean isPublicationInBulk(Publication pub)
-
showPublicationBulkSelect
public boolean showPublicationBulkSelect()
-
getBulkPublicationSet
public java.util.Set<Publication> getBulkPublicationSet()
- Returns:
- items in the trash selected by user for buld processing
-
setTrashId
public void setTrashId(java.lang.String[] v)
-
-