org.opencms.workplace.commons
Class CmsPublishProject

java.lang.Object
  extended byorg.opencms.workplace.CmsWorkplace
      extended byorg.opencms.workplace.tools.CmsToolDialog
          extended byorg.opencms.workplace.CmsDialog
              extended byorg.opencms.workplace.CmsMultiDialog
                  extended byorg.opencms.workplace.CmsReport
                      extended byorg.opencms.workplace.commons.CmsPublishProject

public class CmsPublishProject
extends CmsReport

Creates the dialogs for publishing a project or a resource.

The following files use this class:

Since:
6.0.0
Version:
$Revision: 1.27 $
Author:
Andreas Zahner

Field Summary
static int ACTION_UNLOCK_CONFIRMATION
          Value for the action: show unlock confirmation.
static int ACTION_UNLOCK_CONFIRMED
          Value for the action: unlock confirmed.
static java.lang.String DIALOG_TYPE
          The dialog type.
static java.lang.String DIALOG_UNLOCK_CONFIRMATION
          Request parameter value for the action: show unlock confirmation.
static java.lang.String DIALOG_UNLOCK_CONFIRMED
          Request parameter value for the action: unlock confirmed.
static java.lang.String PARAM_PUBLISHSIBLINGS
          Request parameter name for the publishsiblings parameter.
static java.lang.String PARAM_SUBRESOURCES
          Request parameter name for the subresources parameter.
 
Fields inherited from class org.opencms.workplace.CmsReport
PARAM_REPORT_CONTINUEKEY, PARAM_REPORT_TYPE, REPORT_UPDATE_SIZE, REPORT_UPDATE_TIME
 
Fields inherited from class org.opencms.workplace.CmsMultiDialog
DELIMITER_RESOURCES, PARAM_RESOURCELIST
 
Fields inherited from class org.opencms.workplace.CmsDialog
ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_DEFAULT, 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_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, 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_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
 
Fields inherited from class org.opencms.workplace.CmsWorkplace
DEBUG, 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, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE
 
Constructor Summary
CmsPublishProject(CmsJspActionElement jsp)
          Public constructor.
CmsPublishProject(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Public constructor with JSP variables.
 
Method Summary
 void actionReport()
          Performs the publish report, will be called by the JSP page.
 java.lang.String buildCheckSiblings()
          Builds the HTML for the "publish siblings" and "publish sub resources" checkboxes when direct publishing a file.
 java.lang.String getParamDirectpublish()
          Returns if a resource will be directly published.
 java.lang.String getParamModifieddate()
          Returns the last modification date of the resource which will be published.
 java.lang.String getParamModifieduser()
          Returns the user who modified the resource which will be published.
 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 getParamResourcename()
          Returns the name of the resource which will be published.
 java.lang.String getParamSubresources()
          Returns the value of the subresources parameter.
protected  void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
          Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
 void setParamDirectpublish(java.lang.String value)
          Sets if a resource will be directly published.
 void setParamModifieddate(java.lang.String value)
          Sets the last modification date of the resource which will be published.
 void setParamModifieduser(java.lang.String value)
          Sets the user who modified the resource which will be published.
 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 setParamResourcename(java.lang.String value)
          Sets the name of the resource which will be published.
 void setParamSubresources(java.lang.String paramSubresources)
          Sets the value of the subresources parameter.
 
Methods inherited from class org.opencms.workplace.CmsReport
dialogButtonsContinue, dialogButtonsOkCancelDetails, getParamRefreshWorkplace, getParamReportContinueKey, getParamReportType, getParamThread, getParamThreadHasNext, getReportUpdate, hasError, htmlStart, htmlStart, initCmsReport, isAlive, isSimpleReport, pageHtml, performDialogOperation, setParamRefreshWorkplace, setParamReportContinueKey, setParamReportType, setParamThread, setParamThreadHasNext
 
Methods inherited from class org.opencms.workplace.CmsMultiDialog
addMultiOperationException, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResourcelist
 
Methods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, 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, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamRedirect, setParamResource, setParamTitle
 
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, 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, checkLock, checkLock, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_UNLOCK_CONFIRMATION

public static final int ACTION_UNLOCK_CONFIRMATION
Value for the action: show unlock confirmation.

See Also:
Constant Field Values

ACTION_UNLOCK_CONFIRMED

public static final int ACTION_UNLOCK_CONFIRMED
Value for the action: unlock confirmed.

See Also:
Constant Field Values

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE
The dialog type.

See Also:
Constant Field Values

DIALOG_UNLOCK_CONFIRMATION

public static final java.lang.String DIALOG_UNLOCK_CONFIRMATION
Request parameter value for the action: show unlock confirmation.

See Also:
Constant Field Values

DIALOG_UNLOCK_CONFIRMED

public static final java.lang.String DIALOG_UNLOCK_CONFIRMED
Request parameter value for the action: unlock confirmed.

See Also:
Constant Field Values

PARAM_PUBLISHSIBLINGS

public static final java.lang.String PARAM_PUBLISHSIBLINGS
Request parameter name for the publishsiblings parameter.

See Also:
Constant Field Values

PARAM_SUBRESOURCES

public static final java.lang.String PARAM_SUBRESOURCES
Request parameter name for the subresources parameter.

See Also:
Constant Field Values
Constructor Detail

CmsPublishProject

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

actionReport

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

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

buildCheckSiblings

public java.lang.String buildCheckSiblings()
Builds the HTML for the "publish siblings" and "publish sub resources" checkboxes when direct publishing a file.

Returns:
the HTMl for the "publish siblings" and "publish sub resources" checkboxes

getParamDirectpublish

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

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

getParamModifieddate

public java.lang.String getParamModifieddate()
Returns the last modification date of the resource which will be published.

Returns:
the last modification date of the resource

getParamModifieduser

public java.lang.String getParamModifieduser()
Returns the user who modified the resource which will be published.

Returns:
the user who modified the resource

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

getParamResourcename

public java.lang.String getParamResourcename()
Returns the name of the resource which will be published.

Returns:
the name of the resource

getParamSubresources

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

Returns:
the value of the subresources parameter

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

setParamModifieddate

public void setParamModifieddate(java.lang.String value)
Sets the last modification date of the resource which will be published.

Parameters:
value - the last modification date of the resource

setParamModifieduser

public void setParamModifieduser(java.lang.String value)
Sets the user who modified the resource which will be published.

Parameters:
value - the user who modified the resource

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

setParamResourcename

public void setParamResourcename(java.lang.String value)
Sets the name of the resource which will be published.

Parameters:
value - the name of the resource

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(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)
Description copied from class: CmsWorkplace
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:
initWorkplaceRequestValues in class CmsReport
See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)