org.opencms.workplace.explorer
Class CmsNewResourceUpload

java.lang.Object
  extended by org.opencms.workplace.CmsWorkplace
      extended by org.opencms.workplace.tools.CmsToolDialog
          extended by org.opencms.workplace.CmsDialog
              extended by org.opencms.workplace.list.A_CmsListDialog
                  extended by org.opencms.workplace.list.A_CmsListResourceTypeDialog
                      extended by org.opencms.workplace.explorer.CmsNewResource
                          extended by 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:

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

Field Summary
static int ACTION_APPLET
          The value for the resource upload applet action.
static int ACTION_APPLET_CHECK_OVERWRITE
          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 occurred.
static int ACTION_SUBMITFORM2
          The value for the resource name form submission action.
static java.lang.String APPLET_FILEFILTER_IMAGES
          Constant for pre selection of the file filter for web documents / snippets in the upload applet.
static java.lang.String APPLET_FILEFILTER_OFFICE
          Constant for pre selection of the file filter for office documents in the upload applet.
static java.lang.String APPLET_FILEFILTER_WEB
          Constant for pre selection of the file filter for web documents / snippets in the upload applet.
static java.util.Map DEFAULT_APPLET_WINDOW_COLORS
          Default setting for the applet JSP page colors (windows style).
static java.lang.String DIALOG_CHECK_OVERWRITE
          The value for the resource upload applet action.
static java.lang.String DIALOG_SHOWERROR
          The name for the resource form submission action.
static java.lang.String DIALOG_SUBMITFORM2
          The name for the resource form submission action.
static java.lang.String PARAM_CLIENTFOLDER
          Request parameter name for the upload folder name.
static java.lang.String PARAM_NEWRESOURCENAME
          Request parameter name for the new resource file name.
static java.lang.String PARAM_REDIRECTURL
          Request parameter name for the redirect url.
static java.lang.String PARAM_TARGETFRAME
          Request parameter name for the redirect target frame name.
static java.lang.String PARAM_UNZIPFILE
          Request parameter name for the upload file unzip flag.
static java.lang.String PARAM_UPLOADERROR
          Request parameter name for the upload file name.
static java.lang.String PARAM_UPLOADFILE
          Request parameter name for the upload file name.
static java.lang.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, DEFAULT_SUFFIX, DELIM_PROPERTYVALUES, DIALOG_ADVANCED, DIALOG_NEWFORM, DIALOG_SUBMITFORM, DIALOG_TYPE, LIST_COLUMN_URI, PARAM_APPENDSUFFIXHTML, PARAM_CURRENTFOLDER, PARAM_NEWFORMURI, PARAM_NEWRESOURCEEDITPROPS, PARAM_NEWRESOURCETYPE, PARAM_NEWRESOURCEURI, SESSION_ATTR_ADVANCED, SESSION_ATTR_PAGE, VALUE_DEFAULT
 
Fields inherited from class org.opencms.workplace.list.A_CmsListResourceTypeDialog
LIST_ACTION_SEL, LIST_COLUMN_ICON, LIST_COLUMN_NAME, LIST_COLUMN_SELECT, LIST_DETAIL_DESCRIPTION, LIST_ID, PARAM_SELECTED_TYPE
 
Fields inherited from class org.opencms.workplace.list.A_CmsListDialog
ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL
 
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_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_BASE, PARAM_FORCE, 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(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.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.
 java.lang.String buildTypeList()
          Builds the list of possible types for the uploaded file.
static java.lang.String buildTypeList(CmsDialog dialog, boolean useTypeId)
          Builds the html for the list of possible types for the uploaded file.
 java.lang.String createAppletCode()
          Creates the HTML code of the file upload applet with all required parameters.
static java.lang.String createAppletCode(CmsJspActionElement jsp, java.util.Locale locale, java.lang.String currentFolder, java.lang.String redirectUrl, java.lang.String targetFrame, java.util.Map appletWindowColors)
          Creates the HTML code of the file upload applet with all required parameters.
 java.lang.String getParamClientFolder()
          Returns the paramClientFolder.
 java.lang.String getParamNewResourceName()
          Returns the new resource name of the uploaded file.
 java.lang.String getParamRedirectUrl()
          Returns the paramRedirectUrl.
 java.lang.String getParamTargetFrame()
          Returns the paramTargetFrame.
 java.lang.String getParamUnzipFile()
          Returns true if the upload file should be unzipped, otherwise false.
 java.lang.String getParamUploadError()
          Returns the upload error message for the error dialog.
 java.lang.String getParamUploadFile()
          Returns the upload file name.
 java.lang.String getParamUploadFolder()
          Returns the upload folder name.
 java.lang.String handleUploadOverwriteCheckRequest(javax.servlet.http.HttpServletRequest request)
          Replies on the request of the upload applet for checking potential overwrites of VFS resources with the line based resources that do exist on the host.
protected  void initWorkplaceMembers(CmsJspActionElement jsp)
          Initializes this workplace class instance.
protected  void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
          Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
 void setAppletWindowColors(java.util.Map appletWindowColors)
          Sets the configurable colors for the applet window (content frame JSP).
 void setParamClientFolder(java.lang.String clientFolder)
          Sets the client upload folder name.
 void setParamNewResourceName(java.lang.String newResourceName)
          Sets the new resource name of the uploaded file.
 void setParamRedirectUrl(java.lang.String paramRedirectUrl)
          Sets the paramRedirectUrl.
 void setParamTargetFrame(java.lang.String paramTargetFrame)
          Sets the paramTargetFrame.
 void setParamUnzipFile(java.lang.String unzipFile)
          Sets if the upload file should be unzipped.
 void setParamUploadError(java.lang.String uploadError)
          Sets the upload error message for the error dialog.
 void setParamUploadFile(java.lang.String uploadFile)
          Sets the upload file name.
 void setParamUploadFolder(java.lang.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, actionDialog, actionEditProperties, actionSelect, appendSuffixHtml, clearSession, computeFullResourceName, computeNewTitleProperty, computeNewTitleProperty, createPropertyObject, createResourceProperties, createResourceProperties, customHtmlStart, dialogButtons, dialogButtonsAdvancedNextCancel, dialogButtonsHtml, dialogButtonsNextCancel, getListItems, getNewResourceHandler, getParamAppendSuffixHtml, getParamCurrentFolder, getParamDialogmode, getParamNewFormUri, getParamNewResourceEditProps, getParamNewResourceType, getParamNewResourceUri, getParamPage, getSuffixHtml, getTitle, isCreateIndexMode, isResourceCreated, paramsAsHidden, setColumns, setInitialResourceName, setParamAppendSuffixHtml, setParamCurrentFolder, setParamDialogmode, setParamNewFormUri, setParamNewResourceEditProps, setParamNewResourceType, setParamNewResourceUri, setParamPage, setResourceCreated
 
Methods inherited from class org.opencms.workplace.list.A_CmsListResourceTypeDialog
customHtmlBeforeList, customHtmlEnd, defaultActionHtmlContent, executeListMultiActions, executeListSingleActions, fillDetails, getParamSelectedType, paramsAsHidden, setIndependentActions, setMultiActions, setParamSelectedType
 
Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
defaultActionHtml, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getParamFormName, getParamListAction, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog
 
Methods inherited from class org.opencms.workplace.CmsDialog
appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, 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, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle
 
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, 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_APPLET_CHECK_OVERWRITE

public static final int ACTION_APPLET_CHECK_OVERWRITE
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 occurred.

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

APPLET_FILEFILTER_IMAGES

public static final java.lang.String APPLET_FILEFILTER_IMAGES
Constant for pre selection of the file filter for web documents / snippets in the upload applet.

See Also:
Constant Field Values

APPLET_FILEFILTER_OFFICE

public static final java.lang.String APPLET_FILEFILTER_OFFICE
Constant for pre selection of the file filter for office documents in the upload applet.

See Also:
Constant Field Values

APPLET_FILEFILTER_WEB

public static final java.lang.String APPLET_FILEFILTER_WEB
Constant for pre selection of the file filter for web documents / snippets in the upload applet.

See Also:
Constant Field Values

DEFAULT_APPLET_WINDOW_COLORS

public static final java.util.Map DEFAULT_APPLET_WINDOW_COLORS
Default setting for the applet JSP page colors (windows style).


DIALOG_CHECK_OVERWRITE

public static final java.lang.String DIALOG_CHECK_OVERWRITE
The value for the resource upload applet action.

See Also:
Constant Field Values

DIALOG_SHOWERROR

public static final java.lang.String DIALOG_SHOWERROR
The name for the resource form submission action.

See Also:
Constant Field Values

DIALOG_SUBMITFORM2

public static final java.lang.String DIALOG_SUBMITFORM2
The name for the resource form submission action.

See Also:
Constant Field Values

PARAM_CLIENTFOLDER

public static final java.lang.String PARAM_CLIENTFOLDER
Request parameter name for the upload folder name.

See Also:
Constant Field Values

PARAM_NEWRESOURCENAME

public static final java.lang.String PARAM_NEWRESOURCENAME
Request parameter name for the new resource file name.

See Also:
Constant Field Values

PARAM_REDIRECTURL

public static final java.lang.String PARAM_REDIRECTURL
Request parameter name for the redirect url.

See Also:
Constant Field Values

PARAM_TARGETFRAME

public static final java.lang.String PARAM_TARGETFRAME
Request parameter name for the redirect target frame name.

See Also:
Constant Field Values

PARAM_UNZIPFILE

public static final java.lang.String PARAM_UNZIPFILE
Request parameter name for the upload file unzip flag.

See Also:
Constant Field Values

PARAM_UPLOADERROR

public static final java.lang.String PARAM_UPLOADERROR
Request parameter name for the upload file name.

See Also:
Constant Field Values

PARAM_UPLOADFILE

public static final java.lang.String PARAM_UPLOADFILE
Request parameter name for the upload file name.

See Also:
Constant Field Values

PARAM_UPLOADFOLDER

public static final java.lang.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(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

buildTypeList

public static java.lang.String buildTypeList(CmsDialog dialog,
                                             boolean useTypeId)
Builds the html for the list of possible types for the uploaded file.

This method can be used by all workplace dialog classes to build radio input buttons to select a resource type.

Parameters:
dialog - the dialog class instance which creates the type list
useTypeId - if true, the resource type ID will be used for value attributes, otherwise the resource type names
Returns:
the list of possible files for the uploaded resource

createAppletCode

public static java.lang.String createAppletCode(CmsJspActionElement jsp,
                                                java.util.Locale locale,
                                                java.lang.String currentFolder,
                                                java.lang.String redirectUrl,
                                                java.lang.String targetFrame,
                                                java.util.Map appletWindowColors)
Creates the HTML code of the file upload applet with all required parameters.

Parameters:
jsp - an initialized action element
locale - the locale to use for the applet
currentFolder - the folder to upload the resources to
redirectUrl - the URL to redirect to after uploading
targetFrame - the name of the target frame to redirect to after uploading
appletWindowColors - the colors to use for the applet, if not provided, the default colors will be used
Returns:
string containing the applet HTML code

actionCloseDialog

public void actionCloseDialog()
                       throws javax.servlet.jsp.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 CmsNewResource
Throws:
javax.servlet.jsp.JspException - if including an element fails

actionUpdateFile

public void actionUpdateFile()
                      throws javax.servlet.jsp.JspException
Updates the file type and renames the file if desired.

Throws:
javax.servlet.jsp.JspException - if inclusion of error dialog fails

actionUpload

public void actionUpload()
                  throws javax.servlet.jsp.JspException
Uploads the specified file and unzips it, if selected.

Throws:
javax.servlet.jsp.JspException - if inclusion of error dialog fails

buildTypeList

public java.lang.String buildTypeList()
Builds the list of possible types for the uploaded file.

Returns:
the list of possible files for the uploaded resource

createAppletCode

public java.lang.String createAppletCode()
Creates the HTML code of the file upload applet with all required parameters.

Returns:
string containing the applet HTML code

getParamClientFolder

public java.lang.String getParamClientFolder()
Returns the paramClientFolder.

Returns:
the paramClientFolder

getParamNewResourceName

public java.lang.String getParamNewResourceName()
Returns the new resource name of the uploaded file.

Returns:
the new resource name of the uploaded file

getParamRedirectUrl

public java.lang.String getParamRedirectUrl()
Returns the paramRedirectUrl.

Returns:
the paramRedirectUrl

getParamTargetFrame

public java.lang.String getParamTargetFrame()
Returns the paramTargetFrame.

Returns:
the paramTargetFrame

getParamUnzipFile

public java.lang.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 java.lang.String getParamUploadError()
Returns the upload error message for the error dialog.

Returns:
the upload error message for the error dialog

getParamUploadFile

public java.lang.String getParamUploadFile()
Returns the upload file name.

Returns:
the upload file name

getParamUploadFolder

public java.lang.String getParamUploadFolder()
Returns the upload folder name.

Returns:
the upload folder name

handleUploadOverwriteCheckRequest

public java.lang.String handleUploadOverwriteCheckRequest(javax.servlet.http.HttpServletRequest request)
Replies on the request of the upload applet for checking potential overwrites of VFS resources with the line based resources that do exist on the host.

Parameters:
request - the request sent by the applet
Returns:
the line based resources that do exist on the host

setAppletWindowColors

public final void setAppletWindowColors(java.util.Map appletWindowColors)
Sets the configurable colors for the applet window (content frame JSP).

Parameters:
appletWindowColors - the configurable colors for the applet window (content frame JSP).

setParamClientFolder

public void setParamClientFolder(java.lang.String clientFolder)
Sets the client upload folder name.

Parameters:
clientFolder - the client upload folder name

setParamNewResourceName

public void setParamNewResourceName(java.lang.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(java.lang.String paramRedirectUrl)
Sets the paramRedirectUrl.

Parameters:
paramRedirectUrl - the paramRedirectUrl to set

setParamTargetFrame

public void setParamTargetFrame(java.lang.String paramTargetFrame)
Sets the paramTargetFrame.

Parameters:
paramTargetFrame - the paramTargetFrame to set

setParamUnzipFile

public void setParamUnzipFile(java.lang.String unzipFile)
Sets if the upload file should be unzipped.

Parameters:
unzipFile - true if the upload file should be unzipped

setParamUploadError

public void setParamUploadError(java.lang.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(java.lang.String uploadFile)
Sets the upload file name.

Parameters:
uploadFile - the upload file name

setParamUploadFolder

public void setParamUploadFolder(java.lang.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

initWorkplaceMembers

protected void initWorkplaceMembers(CmsJspActionElement jsp)
Description copied from class: CmsWorkplace
Initializes this workplace class instance.

This method can be used in case there a workplace class was generated using Class.forName(java.lang.String) to initialize the class members.

Overrides:
initWorkplaceMembers in class CmsWorkplace
Parameters:
jsp - the initialized JSP context
See Also:
CmsWorkplace.initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement)

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 CmsNewResource
Parameters:
settings - the workplace settings
request - the current request
See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)