org.opencms.workplace.explorer
Class CmsNewResourceUpload

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.explorer.CmsNewResource
                  org.opencms.workplace.explorer.CmsNewResourceUpload

Direct Known Subclasses:

CmsNewCsvFile

public class CmsNewResourceUpload
extends CmsNewResource

The new resource upload dialog handles the upload of single files or zipped files.

The following files use this class:

• /commons/newresource_upload.jsp

Since:

6.0.0

Version:

$Revision: 1.21 $

Author:

Andreas Zahner

Field Summary

static int	ACTION_APPLET The value for the resource upload applet action.
static int	ACTION_NEWFORM2 The value for the resource name form action.
static int	ACTION_SHOWERROR The value for the resource upload applet action: error occured.
static int	ACTION_SUBMITFORM2 The value for the resource name form submission action.
static String	DIALOG_SHOWERROR The name for the resource form submission action.
static String	DIALOG_SUBMITFORM2 The name for the resource form submission action.
static String	PARAM_NEWRESOURCENAME Request parameter name for the new resource file name.
static String	PARAM_REDIRECTURL Request parameter name for the redirect url.
static String	PARAM_TARGETFRAME Request parameter name for the redirect target frame name.
static String	PARAM_UNZIPFILE Request parameter name for the upload file unzip flag.
static String	PARAM_UPLOADERROR Request parameter name for the upload file name.
static String	PARAM_UPLOADFILE Request parameter name for the upload file name.
static String	PARAM_UPLOADFOLDER Request parameter name for the upload folder name.

Fields inherited from class org.opencms.workplace.explorer.CmsNewResource

ACTION_NEWFORM, ACTION_SUBMITFORM, BUTTON_NEXT, DIALOG_NEWFORM, DIALOG_SUBMITFORM, DIALOG_TYPE, PARAM_CURRENTFOLDER, PARAM_NEWRESOURCEEDITPROPS, PARAM_NEWRESOURCETYPE, PARAM_NEWRESOURCEURI

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

CmsNewResourceUpload(CmsJspActionElement jsp)
Public constructor with JSP action element.

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

Method Summary

void	actionCloseDialog() Used to close the current JSP dialog.
void	actionUpdateFile() Updates the file type and renames the file if desired.
void	actionUpload() Uploads the specified file and unzips it, if selected.
String	buildTypeList() Builds the list of possible types for the uploaded file.
String	createAppletCode() Creates the HTML code of the file upload applet with all required parameters.
String	getParamNewResourceName() Returns the new resource name of the uploaded file.
String	getParamRedirectUrl() Returns the paramRedirectUrl.
String	getParamTargetFrame() Returns the paramTargetFrame.
String	getParamUnzipFile() Returns true if the upload file should be unzipped, otherwise false.
String	getParamUploadError() Returns the upload error message for the error dialog.
String	getParamUploadFile() Returns the upload file name.
String	getParamUploadFolder() Returns the upload folder name.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
void	setParamNewResourceName(String newResourceName) Sets the new resource name of the uploaded file.
void	setParamRedirectUrl(String paramRedirectUrl) Sets the paramRedirectUrl.
void	setParamTargetFrame(String paramTargetFrame) Sets the paramTargetFrame.
void	setParamUnzipFile(String unzipFile) Sets if the upload file should be unzipped.
void	setParamUploadError(String uploadError) Sets the upload error message for the error dialog.
void	setParamUploadFile(String uploadFile) Sets the upload file name.
void	setParamUploadFolder(String uploadFolder) Sets the upload folder name.
boolean	unzipUpload() Returns if the upload file should be unzipped.

Methods inherited from class org.opencms.workplace.explorer.CmsNewResource

actionCreateResource, actionEditProperties, actionSelect, buildNewList, computeCurrentFolder, computeFullResourceName, computeNewTitleProperty, createPropertyObject, createResourceProperties, dialogButtonsHtml, dialogButtonsNextCancel, getNewResourceHandler, getParamCurrentFolder, getParamNewResourceEditProps, getParamNewResourceType, getParamNewResourceUri, getParamPage, isResourceCreated, setParamCurrentFolder, setParamNewResourceEditProps, setParamNewResourceType, setParamNewResourceUri, setParamPage, setResourceCreated

Methods inherited from class org.opencms.workplace.CmsDialog

appendDelimiter, checkResourcePermissions, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, 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_APPLET

public static final int ACTION_APPLET

The value for the resource upload applet action.

See Also:

Constant Field Values

ACTION_NEWFORM2

public static final int ACTION_NEWFORM2

The value for the resource name form action.

See Also:

Constant Field Values

ACTION_SHOWERROR

public static final int ACTION_SHOWERROR

The value for the resource upload applet action: error occured.

See Also:

Constant Field Values

ACTION_SUBMITFORM2

public static final int ACTION_SUBMITFORM2

The value for the resource name form submission action.

See Also:

Constant Field Values

DIALOG_SHOWERROR

public static final String DIALOG_SHOWERROR

The name for the resource form submission action.

See Also:

Constant Field Values

DIALOG_SUBMITFORM2

public static final String DIALOG_SUBMITFORM2

The name for the resource form submission action.

See Also:

Constant Field Values

PARAM_NEWRESOURCENAME

public static final String PARAM_NEWRESOURCENAME

Request parameter name for the new resource file name.

See Also:

Constant Field Values

PARAM_REDIRECTURL

public static final String PARAM_REDIRECTURL

Request parameter name for the redirect url.

See Also:

Constant Field Values

PARAM_TARGETFRAME

public static final String PARAM_TARGETFRAME

Request parameter name for the redirect target frame name.

See Also:

Constant Field Values

PARAM_UNZIPFILE

public static final String PARAM_UNZIPFILE

Request parameter name for the upload file unzip flag.

See Also:

Constant Field Values

PARAM_UPLOADERROR

public static final String PARAM_UPLOADERROR

Request parameter name for the upload file name.

See Also:

Constant Field Values

PARAM_UPLOADFILE

public static final String PARAM_UPLOADFILE

Request parameter name for the upload file name.

See Also:

Constant Field Values

PARAM_UPLOADFOLDER

public static final String PARAM_UPLOADFOLDER

Request parameter name for the upload folder name.

See Also:

Constant Field Values

Constructor Detail

CmsNewResourceUpload

public CmsNewResourceUpload(CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsNewResourceUpload

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

actionCloseDialog

public void actionCloseDialog()
                       throws JspException

Used to close the current JSP dialog.

This method overwrites the close dialog method in the super class, because in case a new file was uploaded and the cancel button pressed, the uploaded file has to be deleted.

It tries to include the URI stored in the workplace settings. This URI is determined by the frame name, which has to be set in the framename parameter.

Overrides:

actionCloseDialog in class CmsDialog

Throws:

JspException - if including an element fails

actionUpdateFile

public void actionUpdateFile()
                      throws JspException

Updates the file type and renames the file if desired.

Throws:

JspException - if inclusion of error dialog fails

actionUpload

public void actionUpload()
                  throws JspException

Uploads the specified file and unzips it, if selected.

Throws:

JspException - if inclusion of error dialog fails

buildTypeList

public String buildTypeList()

Builds the list of possible types for the uploaded file.

Returns:

the list of possible files for the uploaded resource

createAppletCode

public String createAppletCode()

Creates the HTML code of the file upload applet with all required parameters.

Returns:

string containing the applet HTML code

getParamNewResourceName

public String getParamNewResourceName()

Returns the new resource name of the uploaded file.

Returns:

the new resource name of the uploaded file

getParamRedirectUrl

public String getParamRedirectUrl()

Returns the paramRedirectUrl.

Returns:

the paramRedirectUrl

getParamTargetFrame

public String getParamTargetFrame()

Returns the paramTargetFrame.

Returns:

the paramTargetFrame

getParamUnzipFile

public String getParamUnzipFile()

Returns true if the upload file should be unzipped, otherwise false.

Returns:

true if the upload file should be unzipped, otherwise false

getParamUploadError

public String getParamUploadError()

Returns the upload error message for the error dialog.

Returns:

the upload error message for the error dialog

getParamUploadFile

public String getParamUploadFile()

Returns the upload file name.

Returns:

the upload file name

getParamUploadFolder

public String getParamUploadFolder()

Returns the upload folder name.

Returns:

the upload folder name

setParamNewResourceName

public void setParamNewResourceName(String newResourceName)

Sets the new resource name of the uploaded file.

Parameters:

newResourceName - the new resource name of the uploaded file

setParamRedirectUrl

public void setParamRedirectUrl(String paramRedirectUrl)

Sets the paramRedirectUrl.

Parameters:

paramRedirectUrl - the paramRedirectUrl to set

setParamTargetFrame

public void setParamTargetFrame(String paramTargetFrame)

Sets the paramTargetFrame.

Parameters:

paramTargetFrame - the paramTargetFrame to set

setParamUnzipFile

public void setParamUnzipFile(String unzipFile)

Sets if the upload file should be unzipped.

Parameters:

unzipFile - true if the upload file should be unzipped

setParamUploadError

public void setParamUploadError(String uploadError)

Sets the upload error message for the error dialog.

Parameters:

uploadError - the upload error message for the error dialog

setParamUploadFile

public void setParamUploadFile(String uploadFile)

Sets the upload file name.

Parameters:

uploadFile - the upload file name

setParamUploadFolder

public void setParamUploadFolder(String uploadFolder)

Sets the upload folder name.

Parameters:

uploadFolder - the upload folder name

unzipUpload

public boolean unzipUpload()

Returns if the upload file should be unzipped.

Returns:

true if the upload file should be unzipped, otherwise false

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 CmsNewResource

Parameters:

settings - the workplace settings

request - the current request

See Also:

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