Package org.opencms.workplace.commons

Class CmsPublishProject

  • public class CmsPublishProject
extends CmsMultiDialog
    Creates the dialogs for publishing a project or a resource.

    The following files use this class:

    • /commons/publishproject.jsp
    • /commons/publishresource.jsp

    Since:
    6.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTION_PUBLISH
      Value for the action: delete the resource.
      static int ACTION_RESOURCES_CONFIRMED
      Value for the action: resources confirmed.
      static java.lang.String DIALOG_RESOURCES_CONFIRMED
      Request parameter value for the action: dialog resources confirmed.
      static java.lang.String DIALOG_TYPE
      The dialog type.
      static java.lang.String PARAM_DIRECTPUBLISH
      Request parameter name for the directpublish parameter.
      static java.lang.String PARAM_PUBLISHSIBLINGS
      Request parameter name for the publishsiblings parameter.
      static java.lang.String PARAM_RELATEDRESOURCES
      Request parameter name for the relatedresources parameter.
      static java.lang.String PARAM_SUBRESOURCES
      Request parameter name for the subresources parameter.

      • 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_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_RESOURCELIST, 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

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsPublishProject​(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.
      CmsPublishProject​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionCloseDialog()  
      void actionPublish()
      Performs the publish action, will be called by the JSP page.
      java.lang.String buildConfirmation()
      Returns the html for the confirmation message.
      java.lang.String buildLockConfirmationMessageJS()
      Returns the html code to build the confirmation messages.
      java.lang.String buildLockDialog()
      Returns the html code to build the lock dialog.
      java.lang.String buildLockHeaderBox()  
      java.lang.String buildPublishOptions()
      Override to display additional options in the lock dialog.
      CmsPublishBrokenRelationsList getBrokenRelationsList()
      Returns the list of the resources to publish with broken relations.
      java.lang.String getParamDirectpublish()
      Returns if a resource will be directly published.
      java.lang.String getParamFramename()  
      java.lang.String getParamProgresskey()
      Returns the value for the progress key.
      java.lang.String getParamProjectid()
      Returns the value of the project id which will be published.
      java.lang.String getParamProjectname()
      Returns the value of the project name which will be published.
      java.lang.String getParamPublishsiblings()
      Returns if siblings of the resource should be published.
      java.lang.String getParamRelatedresources()
      Returns the value of the related resources parameter.
      java.lang.String getParamSubresources()
      Returns the value of the subresources parameter.
      CmsProgressWidget getProgress()
      Returns the progress bar for the dialog.
      org.opencms.db.CmsPublishList getPublishList()
      Unlocks all selected resources, will be called by the JSP page.
      CmsPublishResourcesList getPublishResourcesList()
      Returns the list with the resources to publish.
      boolean hasBrokenLinks()
      Returns true if the resources to be published will generate broken links.
      protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)  
      boolean isCanPublish()
      Returns true if the current user is allowed to publish the selected resources.
      boolean isLockStateOk()
      Returns true if the selection has blocking locks.
      protected boolean performDialogOperation()
      Performs the dialog operation for the selected resources.
      void setParamDirectpublish​(java.lang.String value)
      Sets if a resource will be directly published.
      void setParamProgresskey​(java.lang.String value)
      Sets the value for the progress key.
      void setParamProjectid​(java.lang.String value)
      Sets the value of the project id which will be published.
      void setParamProjectname​(java.lang.String value)
      Sets the value of the project name which will be published.
      void setParamPublishsiblings​(java.lang.String value)
      Sets if siblings of the resource should be published.
      void setParamRelatedresources​(java.lang.String relatedResources)
      Sets the value of the related resources parameter.
      void setParamSubresources​(java.lang.String paramSubresources)
      Sets the value of the subresources parameter.

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

        appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, 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, 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

      • CmsPublishProject

        public CmsPublishProject​(org.opencms.jsp.CmsJspActionElement jsp)
        Public constructor.

        Parameters:
        jsp - an initialized JSP action element

      • CmsPublishProject

        public CmsPublishProject​(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

      • actionCloseDialog

        public void actionCloseDialog()
                       throws javax.servlet.jsp.JspException
        Overrides:
        actionCloseDialog in class org.opencms.workplace.CmsDialog
        Throws:
        javax.servlet.jsp.JspException
        See Also:
        CmsDialog.actionCloseDialog()

      • actionPublish

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

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

      • buildConfirmation

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

        Returns:
        the html for the confirmation message

      • buildLockConfirmationMessageJS

        public java.lang.String buildLockConfirmationMessageJS()
        Returns the html code to build the confirmation messages.

        Overrides:
        buildLockConfirmationMessageJS in class org.opencms.workplace.CmsDialog
        Returns:
        html code

      • buildLockDialog

        public java.lang.String buildLockDialog()
                                 throws org.opencms.main.CmsException
        Returns the html code to build the lock dialog.

        Returns:
        html code
        Throws:
        org.opencms.main.CmsException - if something goes wrong

      • buildPublishOptions

        public java.lang.String buildPublishOptions()
        Override to display additional options in the lock dialog.

        Returns:
        html code to display additional options

      • getParamDirectpublish

        public java.lang.String getParamDirectpublish()
        Returns if a resource will be directly published.

        Returns:
        "true" if a resource will be directly published

      • getParamFramename

        public java.lang.String getParamFramename()
        Overrides:
        getParamFramename in class org.opencms.workplace.CmsDialog
        See Also:
        CmsDialog.getParamFramename()

      • getParamProgresskey

        public java.lang.String getParamProgresskey()
        Returns the value for the progress key.

        Returns:
        the value for the progress key

      • getParamProjectid

        public java.lang.String getParamProjectid()
        Returns the value of the project id which will be published.

        Returns:
        the String value of the project id

      • getParamProjectname

        public java.lang.String getParamProjectname()
        Returns the value of the project name which will be published.

        Returns:
        the String value of the project name

      • getParamPublishsiblings

        public java.lang.String getParamPublishsiblings()
        Returns if siblings of the resource should be published.

        Returns:
        "true" (String) if siblings of the resource should be published

      • getParamRelatedresources

        public java.lang.String getParamRelatedresources()
        Returns the value of the related resources parameter.

        Returns:
        the value of the related resources parameter

      • getParamSubresources

        public java.lang.String getParamSubresources()
        Returns the value of the subresources parameter.

        Returns:
        the value of the sub resources parameter

      • getPublishList

        public org.opencms.db.CmsPublishList getPublishList()
                                             throws javax.servlet.jsp.JspException
        Unlocks all selected resources, will be called by the JSP page.

        Returns:
        true if everything went ok
        Throws:
        javax.servlet.jsp.JspException - if there is some problem including the error page

      • getPublishResourcesList

        public CmsPublishResourcesList getPublishResourcesList()
                                                throws javax.servlet.jsp.JspException
        Returns the list with the resources to publish.

        Returns:
        the list with the resources to publish
        Throws:
        javax.servlet.jsp.JspException - if creation of publish list fails

      • hasBrokenLinks

        public boolean hasBrokenLinks()
        Returns true if the resources to be published will generate broken links.

        Returns:
        true if the resources to be published will generate broken links

      • isCanPublish

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

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

      • isLockStateOk

        public boolean isLockStateOk()
        Returns true if the selection has blocking locks.

        Returns:
        true if the selection has blocking locks

      • setParamDirectpublish

        public void setParamDirectpublish​(java.lang.String value)
        Sets if a resource will be directly published.

        Parameters:
        value - "true" (String) if a resource will be directly published

      • setParamProgresskey

        public void setParamProgresskey​(java.lang.String value)
        Sets the value for the progress key.

        Parameters:
        value - the value for the progress key to set

      • setParamProjectid

        public void setParamProjectid​(java.lang.String value)
        Sets the value of the project id which will be published.

        Parameters:
        value - the String value of the project id

      • setParamProjectname

        public void setParamProjectname​(java.lang.String value)
        Sets the value of the project name which will be published.

        Parameters:
        value - the String value of the project name

      • setParamPublishsiblings

        public void setParamPublishsiblings​(java.lang.String value)
        Sets if siblings of the resource should be published.

        Parameters:
        value - "true" (String) if siblings of the resource should be published

      • setParamRelatedresources

        public void setParamRelatedresources​(java.lang.String relatedResources)
        Sets the value of the related resources parameter.

        Parameters:
        relatedResources - the value of the related resources parameter

      • setParamSubresources

        public void setParamSubresources​(java.lang.String paramSubresources)
        Sets the value of the subresources parameter.

        Parameters:
        paramSubresources - the value of the subresources parameter

      • 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)