Package org.opencms.workplace.commons

Class CmsDelete

  • All Implemented Interfaces:
    org.opencms.configuration.I_CmsConfigurationParameterHandler, org.opencms.workplace.I_CmsDialogHandler
    public class CmsDelete
extends CmsMultiDialog
implements org.opencms.workplace.I_CmsDialogHandler
    Provides methods for the delete resources dialog.

    The following files use this class:

    • /commons/delete_standard.jsp

    Since:
    6.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTION_DELETE
      Value for the action: delete the resource.
      static java.lang.String DIALOG_TYPE
      The dialog type.
      static org.apache.commons.logging.Log LOG
      The log object for this class.
      static java.lang.String PARAM_DELETE_SIBLINGS
      Request parameter name for the deletesiblings parameter.
      static java.lang.String URI_DELETE_DIALOG
      The delete dialog URI.

      • Fields inherited from class org.opencms.workplace.CmsDialog

        ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

      • Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

        PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

      • Fields inherited from class org.opencms.workplace.CmsWorkplace

        DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

      • Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

        ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsDelete()
      Default constructor needed for dialog handler implementation.
      CmsDelete​(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.
      CmsDelete​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionDelete()
      Performs the delete action, will be called by the JSP page.
      void addConfigurationParameter​(java.lang.String paramName, java.lang.String paramValue)  
      java.lang.String buildConfirmation()
      Returns the html for the confirmation message.
      java.lang.String buildDeleteSiblings()
      Returns the html for the "delete siblings" options when deleting a a resource with siblings.
      java.lang.String buildReport()
      Returns html code for the possible broken relations.
      org.opencms.configuration.CmsParameterConfiguration getConfiguration()  
      java.lang.String getDialogHandler()  
      java.lang.String getDialogUri​(java.lang.String resource, org.opencms.jsp.CmsJspActionElement jsp)  
      java.lang.String getParamDeleteSiblings()
      Returns the value of the boolean option to delete siblings.
      void initConfiguration()  
      protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)  
      boolean isCanDelete()
      Returns true if the current user is allowed to delete the selected resources.
      protected boolean performDialogOperation()
      Performs the resource deletion.
      protected void performSingleDeleteOperation​(java.lang.String resource, org.opencms.file.CmsResource.CmsResourceDeleteMode deleteOption)
      Performs the delete operation for a single VFS resource.
      void setParamDeleteSiblings​(java.lang.String value)
      Sets the value of the boolean option to delete siblings.

      • Methods inherited from class org.opencms.workplace.CmsDialog

        actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamTitle

      • Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

        computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

      • Methods inherited from class org.opencms.workplace.CmsWorkplace

        addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsDelete

        public CmsDelete()
        Default constructor needed for dialog handler implementation.

      • CmsDelete

        public CmsDelete​(org.opencms.jsp.CmsJspActionElement jsp)
        Public constructor with JSP action element.

        Parameters:
        jsp - an initialized JSP action element

      • CmsDelete

        public CmsDelete​(javax.servlet.jsp.PageContext context,
                 javax.servlet.http.HttpServletRequest req,
                 javax.servlet.http.HttpServletResponse res)
        Public constructor with JSP variables.

        Parameters:
        context - the JSP page context
        req - the JSP request
        res - the JSP response

    • Method Detail

      • actionDelete

        public void actionDelete()
                  throws javax.servlet.jsp.JspException
        Performs the delete action, will be called by the JSP page.

        Throws:
        javax.servlet.jsp.JspException - if problems including sub-elements occur

      • addConfigurationParameter

        public void addConfigurationParameter​(java.lang.String paramName,
                                      java.lang.String paramValue)
        Specified by:
        addConfigurationParameter in interface org.opencms.configuration.I_CmsConfigurationParameterHandler
        See Also:
        I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

      • buildConfirmation

        public java.lang.String buildConfirmation()
        Returns the html for the confirmation message.

        Returns:
        the html for the confirmation message

      • buildDeleteSiblings

        public java.lang.String buildDeleteSiblings()
        Returns the html for the "delete siblings" options when deleting a a resource with siblings.

        Returns:
        the html for the "delete siblings" options

      • buildReport

        public java.lang.String buildReport()
                             throws javax.servlet.jsp.JspException,
                                    javax.servlet.ServletException,
                                    java.io.IOException
        Returns html code for the possible broken relations.

        Returns:
        html code for the possible broken relations
        Throws:
        javax.servlet.jsp.JspException - if dialog actions fail
        java.io.IOException - in case of errros forwarding to the required result page
        javax.servlet.ServletException - in case of errros forwarding to the required result page

      • getConfiguration

        public org.opencms.configuration.CmsParameterConfiguration getConfiguration()
        Specified by:
        getConfiguration in interface org.opencms.configuration.I_CmsConfigurationParameterHandler
        See Also:
        I_CmsConfigurationParameterHandler.getConfiguration()

      • getDialogHandler

        public java.lang.String getDialogHandler()
        Specified by:
        getDialogHandler in interface org.opencms.workplace.I_CmsDialogHandler
        See Also:
        I_CmsDialogHandler.getDialogHandler()

      • getDialogUri

        public java.lang.String getDialogUri​(java.lang.String resource,
                                     org.opencms.jsp.CmsJspActionElement jsp)
        Specified by:
        getDialogUri in interface org.opencms.workplace.I_CmsDialogHandler
        See Also:
        I_CmsDialogHandler.getDialogUri(java.lang.String, CmsJspActionElement)

      • getParamDeleteSiblings

        public java.lang.String getParamDeleteSiblings()
        Returns the value of the boolean option to delete siblings.

        Returns:
        the value of the boolean option to delete siblings as a lower case string

      • initConfiguration

        public void initConfiguration()
        Specified by:
        initConfiguration in interface org.opencms.configuration.I_CmsConfigurationParameterHandler
        See Also:
        I_CmsConfigurationParameterHandler.initConfiguration()

      • isCanDelete

        public boolean isCanDelete()
        Returns true if the current user is allowed to delete the selected resources.

        Returns:
        true if the current user is allowed to delete the selected resources

      • setParamDeleteSiblings

        public void setParamDeleteSiblings​(java.lang.String value)
        Sets the value of the boolean option to delete siblings.

        Parameters:
        value - the value of the boolean option to delete siblings

      • initWorkplaceRequestValues

        protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)
        Overrides:
        initWorkplaceRequestValues in class org.opencms.workplace.CmsDialog
        See Also:
        CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

      • performDialogOperation

        protected boolean performDialogOperation()
                                  throws org.opencms.main.CmsException
        Performs the resource deletion.

        Specified by:
        performDialogOperation in class CmsMultiDialog
        Returns:
        true, if the resource(s) was/were deleted, otherwise false
        Throws:
        org.opencms.main.CmsException - if deletion is not successful

      • performSingleDeleteOperation

        protected void performSingleDeleteOperation​(java.lang.String resource,
                                            org.opencms.file.CmsResource.CmsResourceDeleteMode deleteOption)
                                     throws org.opencms.main.CmsException
        Performs the delete operation for a single VFS resource.

        Parameters:
        resource - the resource VFS path
        deleteOption - the delete option for sibling deletion
        Throws:
        org.opencms.main.CmsException - if deleting the resource fails