Package org.opencms.workplace.administration

Class A_CmsImportFromHttp

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DIALOG_TYPE
      The dialog type.
      static java.lang.String PARAM_IMPORTFILE
      Import file request parameter.

      • 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_ACTION_VALUE_FOR_CHANGED_INDEX, 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_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

      • Fields inherited from class org.opencms.workplace.CmsWorkplace

        DEBUG, DEFAULT_DATE_STRING, 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, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, 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_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

    • Constructor Summary

      Constructors 
      Constructor Description
      A_CmsImportFromHttp​(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.
      A_CmsImportFromHttp​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      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 org.opencms.main.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()  
      protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)  
      protected void setException​(org.opencms.main.CmsException exception)
      Sets the dialog exception.
      void setParamImportfile​(java.lang.String importfile)
      Sets the import file name that is uploaded.

      • Methods inherited from class org.opencms.workplace.CmsDialog

        actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, 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, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

      • Methods inherited from class 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

      • 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, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • A_CmsImportFromHttp

        public A_CmsImportFromHttp​(org.opencms.jsp.CmsJspActionElement jsp)
        Public constructor with JSP action element.

        Parameters:
        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.

        Parameters:
        context - the JSP page context
        req - the JSP request
        res - the JSP response

    • Method Detail

      • actionCommit

        public abstract void actionCommit()
                           throws java.io.IOException,
                                  javax.servlet.ServletException
        Performs the import operation after "OK" has been pressed.

        Throws:
        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.

        Throws:
        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.

        Returns:
        return uri for this dialog

      • getImportMessage

        public abstract java.lang.String getImportMessage()
        Gets the localized import message text for the input form.

        Returns:
        localized import message text for the input form

      • getParamImportfile

        public java.lang.String getParamImportfile()
        Returns the import file name that is uploaded.

        Returns:
        the import file name that is uploaded

      • getStarttext

        public abstract java.lang.String getStarttext()
        Gets the localized start text for the input form.

        Returns:
        localized start text for the input form

      • setParamImportfile

        public void setParamImportfile​(java.lang.String importfile)
        Sets the import file name that is uploaded.

        Parameters:
        importfile - the import file name that is uploaded

      • getAdditionalParameters

        protected java.lang.String getAdditionalParameters()
        Html code for the additional parameters.

        Returns:
        html code

      • copyFileToServer

        protected java.lang.String copyFileToServer​(java.lang.String destination)
                                     throws org.opencms.main.CmsIllegalArgumentException,
                                            org.opencms.util.CmsRfsException
        Gets a database import file from the client and copies it to the server.

        Parameters:
        destination - the destination of the file on the server
        Returns:
        the name of the file or null if something went wrong when importing the file
        Throws:
        org.opencms.main.CmsIllegalArgumentException - if the specified file name is invalid
        org.opencms.util.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.

        Returns:
        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.

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

      • getException

        protected org.opencms.main.CmsException getException()
        Returns the dialog exception.

        Returns:
        the dialog exception

      • initMessages

        protected abstract void initMessages()
        Overrides:
        initMessages in class org.opencms.workplace.CmsWorkplace
        See Also:
        CmsWorkplace.initMessages()

      • initWorkplaceRequestValues

        protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)
        Overrides:
        initWorkplaceRequestValues in class org.opencms.workplace.CmsDialog
        See Also:
        CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

      • setException

        protected void setException​(org.opencms.main.CmsException exception)
        Sets the dialog exception.

        Parameters:
        exception - the dialog exception