org.opencms.workplace.commons
Class CmsTouch

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.commons.CmsTouch

public class CmsTouch
extends CmsDialog

Provides methods for the touch resource(s) dialog.

The following files use this class:

• /commons/touch.jsp

Since:

6.0.0

Version:

$Revision: 1.16 $

Author:

Andreas Zahner

Field Summary

static int	ACTION_TOUCH Value for the action: touch.
static String	DIALOG_TYPE The dialog type.
static String	PARAM_EXPIREDATE Request parameter name for the expiredate.
static String	PARAM_NEWTIMESTAMP Request parameter name for timestamp.
static String	PARAM_RECURSIVE Request parameter name for the recursive flag.
static String	PARAM_RELEASEDATE Request parameter name for the releasedate.
static String	RELEASE_EXPIRE_DEFAULT default value for release or expire date.

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_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

CmsTouch(CmsJspActionElement jsp)
Public constructor.

CmsTouch(PageContext context, HttpServletRequest req, HttpServletResponse res)
Public constructor with JSP variables.

Method Summary

void	actionTouch() Performs the resource touching, will be called by the JSP page.
String	buildCheckRecursive() Creates the "recursive" checkbox for touching subresources of folders.
String	getCurrentDateTime() Returns the current date and time as String formatted in localized pattern.
String	getCurrentExpireDate() Returns the current expiredate as String formatted in localized pattern.
String	getCurrentReleaseDate() Returns the current releasedate as String formatted in localized pattern.
String	getParamExpiredate() Returns the value of the new expiredate parameter, or null if this parameter was not provided.
String	getParamNewtimestamp() Returns the value of the new timestamp parameter, or null if this parameter was not provided.
String	getParamRecursive() Returns the value of the recursive parameter, or null if this parameter was not provided.
String	getParamReleasedate() Returns the value of the new releasedate parameter, or null if this parameter was not provided.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
void	setParamExpiredate(String value) Sets the value of the releasedate expiredate.
void	setParamNewtimestamp(String value) Sets the value of the new timestamp parameter.
void	setParamRecursive(String value) Sets the value of the recursive parameter.
void	setParamReleasedate(String value) Sets the value of the releasedate parameter.

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, checkResourcePermissions, 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, 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, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, calendarIncludes, calendarIncludes, calendarInit, calendarInit, checkLock, checkLock, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCalendarDate, getCalendarJavaDateFormat, getCalendarLocalizedTime, 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, key, 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_TOUCH

public static final int ACTION_TOUCH

Value for the action: touch.

See Also:

Constant Field Values

RELEASE_EXPIRE_DEFAULT

public static final String RELEASE_EXPIRE_DEFAULT

default value for release or expire date.

See Also:

Constant Field Values

DIALOG_TYPE

public static final String DIALOG_TYPE

The dialog type.

See Also:

Constant Field Values

PARAM_EXPIREDATE

public static final String PARAM_EXPIREDATE

Request parameter name for the expiredate.

See Also:

Constant Field Values

PARAM_NEWTIMESTAMP

public static final String PARAM_NEWTIMESTAMP

Request parameter name for timestamp.

See Also:

Constant Field Values

PARAM_RECURSIVE

public static final String PARAM_RECURSIVE

Request parameter name for the recursive flag.

See Also:

Constant Field Values

PARAM_RELEASEDATE

public static final String PARAM_RELEASEDATE

Request parameter name for the releasedate.

See Also:

Constant Field Values

Constructor Detail

CmsTouch

public CmsTouch(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsTouch

public CmsTouch(PageContext context,
                HttpServletRequest req,
                HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

actionTouch

public void actionTouch()
                 throws JspException

Performs the resource touching, will be called by the JSP page.

Throws:

JspException - if problems including sub-elements occur

buildCheckRecursive

public String buildCheckRecursive()

Creates the "recursive" checkbox for touching subresources of folders.

Returns:

the String with the checkbox input field or an empty String for folders.

getCurrentDateTime

public String getCurrentDateTime()

Returns the current date and time as String formatted in localized pattern.

Returns:

the current date and time as String formatted in localized pattern

getCurrentExpireDate

public String getCurrentExpireDate()

Returns the current expiredate as String formatted in localized pattern.

Returns:

the current expiredate as String formatted in localized pattern

getCurrentReleaseDate

public String getCurrentReleaseDate()

Returns the current releasedate as String formatted in localized pattern.

Returns:

the current releasedate as String formatted in localized pattern

getParamExpiredate

public String getParamExpiredate()

Returns the value of the new expiredate parameter, or null if this parameter was not provided.

The releasedate parameter stores the new expiredate as String.

Returns:

the value of the new expiredate parameter

getParamNewtimestamp

public String getParamNewtimestamp()

Returns the value of the new timestamp parameter, or null if this parameter was not provided.

The timestamp parameter stores the new timestamp as String.

Returns:

the value of the new timestamp parameter

getParamRecursive

public String getParamRecursive()

Returns the value of the recursive parameter, or null if this parameter was not provided.

The recursive parameter on folders decides if all subresources of the folder should be touched, too.

Returns:

the value of the recursive parameter

getParamReleasedate

public String getParamReleasedate()

Returns the value of the new releasedate parameter, or null if this parameter was not provided.

The releasedate parameter stores the new releasedate as String.

Returns:

the value of the new releasedate parameter

setParamExpiredate

public void setParamExpiredate(String value)

Sets the value of the releasedate expiredate.

Parameters:

value - the value to set

setParamNewtimestamp

public void setParamNewtimestamp(String value)

Sets the value of the new timestamp parameter.

Parameters:

value - the value to set

setParamRecursive

public void setParamRecursive(String value)

Sets the value of the recursive parameter.

Parameters:

value - the value to set

setParamReleasedate

public void setParamReleasedate(String value)

Sets the value of the releasedate parameter.

Parameters:

value - the value to set

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:

initWorkplaceRequestValues in class CmsDialog

Parameters:

settings - the workplace settings

request - the current request

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)