org.opencms.workplace.administration

类 A_CmsImportFromHttp

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.administration.A_CmsImportFromHttp

直接已知子类:

CmsDatabaseImportFromHttp, CmsModulesUploadFromHttp, CmsSiteFaviconDialog

public abstract class A_CmsImportFromHttp
extends CmsDialog

Abstract class to upload a zip file containing VFS resources with HTTP upload.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DIALOG_TYPE The dialog type.
static java.lang.String	PARAM_IMPORTFILE Import file request parameter.

从类继承的字段 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

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 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, 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_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
A_CmsImportFromHttp(CmsJspActionElement jsp) Public constructor with JSP action element.
A_CmsImportFromHttp(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
abstract void	actionCommit() Performs the import operation after "OK" has been pressed.
protected java.lang.String	copyFileToServer(java.lang.String destination) Gets a database import file from the client and copies it to the server.
protected java.lang.String	createDialogErrorMessage() Creates the HTML for the error message if validation errors were found.
protected java.lang.String	defaultActionHtml() Returns the HTML to build the input form of the upload dialog.
void	displayDialog() Performs the dialog actions depending on the initialized action and displays the dialog form.
protected java.lang.String	getAdditionalParameters() Html code for the additional parameters.
abstract java.lang.String	getDialogReturnUri() Gets the return uri for this dialog.
protected CmsException	getException() Returns the dialog exception.
abstract java.lang.String	getImportMessage() Gets the localized import message text for the input form.
java.lang.String	getParamImportfile() Returns the import file name that is uploaded.
abstract java.lang.String	getStarttext() Gets the localized start text for the input form.
protected abstract void	initMessages() Initializes the message object.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected void	setException(CmsException exception) Sets the dialog exception.
void	setParamImportfile(java.lang.String importfile) Sets the import file name that is uploaded.

从类继承的方法 org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, 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, 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

从类继承的方法 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

从类继承的方法 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, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

另请参阅:

常量字段值

PARAM_IMPORTFILE

public static final java.lang.String PARAM_IMPORTFILE

Import file request parameter.

另请参阅:

常量字段值

构造器详细资料

A_CmsImportFromHttp

public A_CmsImportFromHttp(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

jsp - an initialized JSP action element

A_CmsImportFromHttp

public A_CmsImportFromHttp(javax.servlet.jsp.PageContext context,
                   javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

actionCommit

public abstract void actionCommit()
                           throws java.io.IOException,
                                  javax.servlet.ServletException

Performs the import operation after "OK" has been pressed.

抛出:

java.io.IOException - in case of errors forwarding to the required result page

javax.servlet.ServletException - in case of errors forwarding to the required result page

displayDialog

public void displayDialog()
                   throws java.io.IOException,
                          javax.servlet.jsp.JspException,
                          javax.servlet.ServletException

Performs the dialog actions depending on the initialized action and displays the dialog form.

抛出:

javax.servlet.jsp.JspException - if dialog actions fail

java.io.IOException - if writing to the JSP out fails, or in case of errors forwarding to the required result page

javax.servlet.ServletException - in case of errors forwarding to the required result page

getDialogReturnUri

public abstract java.lang.String getDialogReturnUri()

Gets the return uri for this dialog.

返回:

return uri for this dialog

getImportMessage

public abstract java.lang.String getImportMessage()

Gets the localized import message text for the input form.

返回:

localized import message text for the input form

getParamImportfile

public java.lang.String getParamImportfile()

Returns the import file name that is uploaded.

返回:

the import file name that is uploaded

getStarttext

public abstract java.lang.String getStarttext()

Gets the localized start text for the input form.

返回:

localized start text for the input form

setParamImportfile

public void setParamImportfile(java.lang.String importfile)

Sets the import file name that is uploaded.

参数:

importfile - the import file name that is uploaded

getAdditionalParameters

protected java.lang.String getAdditionalParameters()

Html code for the additional parameters.

返回:

html code

copyFileToServer

protected java.lang.String copyFileToServer(java.lang.String destination)
                                     throws CmsIllegalArgumentException,
                                            CmsRfsException

Gets a database import file from the client and copies it to the server.

参数:

destination - the destination of the file on the server

返回:

the name of the file or null if something went wrong when importing the file

抛出:

CmsIllegalArgumentException - if the specified file name is invalid

CmsRfsException - if generating folders or files on the server fails

createDialogErrorMessage

protected java.lang.String createDialogErrorMessage()

Creates the HTML for the error message if validation errors were found.

返回:

the HTML for the error message if validation errors were found

defaultActionHtml

protected java.lang.String defaultActionHtml()

Returns the HTML to build the input form of the upload dialog.

返回:

the HTML to build the input form of the upload dialog

getException

protected CmsException getException()

Returns the dialog exception.

返回:

the dialog exception

initMessages

protected abstract void initMessages()

从类复制的说明: CmsWorkplace

Initializes the message object.

By default the CmsWorkplaceMessages are initialized.

You SHOULD override this method for setting the bundles you really need, using the CmsWorkplace.addMessages(CmsMessages) or CmsWorkplace.addMessages(String) method.

覆盖:

initMessages 在类中 CmsWorkplace

另请参阅:

CmsWorkplace.initMessages()

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                              javax.servlet.http.HttpServletRequest request)

从类复制的说明: CmsWorkplace

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

覆盖:

initWorkplaceRequestValues 在类中 CmsDialog

参数:

settings - the workplace settings

request - the current request

另请参阅:

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

setException

protected void setException(CmsException exception)

Sets the dialog exception.

参数:

exception - the dialog exception