001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workplace.tools.database;
029
030import org.opencms.importexport.CmsExportParameters;
031import org.opencms.importexport.CmsVfsImportExportHandler;
032import org.opencms.jsp.CmsJspActionElement;
033import org.opencms.report.I_CmsReportThread;
034import org.opencms.workplace.list.A_CmsListReport;
035import org.opencms.workplace.threads.CmsExportThread;
036
037import java.util.Map;
038
039import javax.servlet.http.HttpServletRequest;
040import javax.servlet.http.HttpServletResponse;
041import javax.servlet.jsp.PageContext;
042
043/**
044 * Provides a report for exporting VFS resources to zipped files of the OpenCms server.<p>
045 *
046 * @since 6.0.0
047 */
048public class CmsDatabaseExportReport extends A_CmsListReport {
049
050    /** Request parameter name for the class name to get the dialog object from. */
051    public static final String PARAM_CLASSNAME = "classname";
052
053    /** Request parameter for the class name to get the dialog object from. */
054    private String m_paramClassname;
055
056    /**
057     * Public constructor with JSP action element.<p>
058     *
059     * @param jsp an initialized JSP action element
060     */
061    public CmsDatabaseExportReport(CmsJspActionElement jsp) {
062
063        super(jsp);
064    }
065
066    /**
067     * Public constructor with JSP variables.<p>
068     *
069     * @param context the JSP page context
070     * @param req the JSP request
071     * @param res the JSP response
072     */
073    public CmsDatabaseExportReport(PageContext context, HttpServletRequest req, HttpServletResponse res) {
074
075        this(new CmsJspActionElement(context, req, res));
076    }
077
078    /**
079     * Returns the request parameter value for the class name to get the dialog object from.<p>
080     *
081     * @return the request parameter value for the class name to get the dialog object from
082     */
083    public String getParamClassname() {
084
085        return m_paramClassname;
086    }
087
088    /**
089     * @see org.opencms.workplace.list.A_CmsListReport#initializeThread()
090     */
091    @Override
092    public I_CmsReportThread initializeThread() {
093
094        CmsExportParameters params = (CmsExportParameters)((Map)getSettings().getDialogObject()).get(
095            getParamClassname());
096        CmsVfsImportExportHandler handler = new CmsVfsImportExportHandler();
097        handler.setExportParams(params);
098        I_CmsReportThread exportThread = new CmsExportThread(getCms(), handler, false);
099
100        return exportThread;
101    }
102
103    /**
104     * Sets the request parameter value for the class name to get the dialog object from.<p>
105     *
106     * @param className the request parameter value for the class name to get the dialog object from
107     */
108    public void setParamClassname(String className) {
109
110        m_paramClassname = className;
111    }
112
113}