Package org.opencms.workplace.commons

Class CmsPublishProject

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.CmsMultiDialog
org.opencms.workplace.commons.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 final int
    ACTION_PUBLISH
    Value for the action: delete the resource.
    static final int
    ACTION_RESOURCES_CONFIRMED
    Value for the action: resources confirmed.
    static final String
    DIALOG_RESOURCES_CONFIRMED
    Request parameter value for the action: dialog resources confirmed.
    static final String
    DIALOG_TYPE
    The dialog type.
    static final String
    PARAM_DIRECTPUBLISH
    Request parameter name for the directpublish parameter.
    static final String
    PARAM_PUBLISHSIBLINGS
    Request parameter name for the publishsiblings parameter.
    static final String
    PARAM_RELATEDRESOURCES
    Request parameter name for the relatedresources parameter.
    static final String
    PARAM_SUBRESOURCES
    Request parameter name for the subresources parameter.

    Fields inherited from class org.opencms.workplace.CmsMultiDialog

    DELIMITER_RESOURCES

    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

    Modifier and Type
    Method
    Description
    void
    actionCloseDialog()
     
    void
    actionPublish()
    Performs the publish action, will be called by the JSP page.
    String
    buildConfirmation()
    Returns the html for the confirmation message.
    String
    buildLockConfirmationMessageJS()
    Returns the html code to build the confirmation messages.
    String
    buildLockDialog()
    Returns the html code to build the lock dialog.
    String
    buildLockHeaderBox()
     
    String
    buildPublishOptions()
    Override to display additional options in the lock dialog.
    CmsPublishBrokenRelationsList
    getBrokenRelationsList()
    Returns the list of the resources to publish with broken relations.
    String
    getParamDirectpublish()
    Returns if a resource will be directly published.
    String
    getParamFramename()
     
    String
    getParamProgresskey()
    Returns the value for the progress key.
    String
    getParamProjectid()
    Returns the value of the project id which will be published.
    String
    getParamProjectname()
    Returns the value of the project name which will be published.
    String
    getParamPublishsiblings()
    Returns if siblings of the resource should be published.
    String
    getParamRelatedresources()
    Returns the value of the related resources parameter.
    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(String value)
    Sets if a resource will be directly published.
    void
    setParamProgresskey(String value)
    Sets the value for the progress key.
    void
    setParamProjectid(String value)
    Sets the value of the project id which will be published.
    void
    setParamProjectname(String value)
    Sets the value of the project name which will be published.
    void
    setParamPublishsiblings(String value)
    Sets if siblings of the resource should be published.
    void
    setParamRelatedresources(String relatedResources)
    Sets the value of the related resources parameter.
    void
    setParamSubresources(String paramSubresources)
    Sets the value of the subresources parameter.

    Methods inherited from class org.opencms.workplace.CmsMultiDialog

    addMultiOperationException, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, setParamResourcelist

    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

  • Field Details

  • Constructor Details

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

    • 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 String buildConfirmation()
      Returns the html for the confirmation message.

      Returns:
      the html for the confirmation message

    • buildLockConfirmationMessageJS

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

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

    • buildLockDialog

      public 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

    • buildLockHeaderBox

      public String buildLockHeaderBox() throws org.opencms.main.CmsException
      Overrides:
      buildLockHeaderBox in class CmsMultiDialog
      Throws:
      org.opencms.main.CmsException
      See Also:

    • buildPublishOptions

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

      Returns:
      html code to display additional options

    • getBrokenRelationsList

      public CmsPublishBrokenRelationsList getBrokenRelationsList()
      Returns the list of the resources to publish with broken relations.

      Returns:
      the list of the resources to publish with broken relations

    • getParamDirectpublish

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

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

    • getParamFramename

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

    • getParamProgresskey

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

      Returns:
      the value for the progress key

    • getParamProjectid

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

      Returns:
      the String value of the project id

    • getParamProjectname

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

      Returns:
      the String value of the project name

    • getParamPublishsiblings

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

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

    • getParamRelatedresources

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

      Returns:
      the value of the related resources parameter

    • getParamSubresources

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

      Returns:
      the value of the sub resources parameter

    • getProgress

      public CmsProgressWidget getProgress()
      Returns the progress bar for the dialog.

      Returns:
      the progress bar for the dialog

    • 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(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(String value)
      Sets the value for the progress key.

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

    • setParamProjectid

      public void setParamProjectid(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(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(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(String relatedResources)
      Sets the value of the related resources parameter.

      Parameters:
      relatedResources - the value of the related resources parameter

    • setParamSubresources

      public void setParamSubresources(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)

    • performDialogOperation

      protected boolean performDialogOperation() throws org.opencms.main.CmsException
      Description copied from class: CmsMultiDialog
      Performs the dialog operation for the selected resources.

      Specified by:
      performDialogOperation in class CmsMultiDialog
      Returns:
      true, if the operation was successful, otherwise false
      Throws:
      org.opencms.main.CmsException - if operation was not successful
      See Also: