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.modules;
029
030import org.opencms.jsp.CmsJspActionElement;
031import org.opencms.main.CmsLog;
032import org.opencms.main.OpenCms;
033import org.opencms.module.CmsModule;
034import org.opencms.module.CmsModuleImportExportHandler;
035import org.opencms.report.I_CmsReportThread;
036import org.opencms.workplace.list.A_CmsListReport;
037import org.opencms.workplace.threads.CmsExportThread;
038
039import javax.servlet.http.HttpServletRequest;
040import javax.servlet.http.HttpServletResponse;
041import javax.servlet.jsp.PageContext;
042
043import org.apache.commons.logging.Log;
044
045/**
046 * Provides a report for exporting modules.<p>
047 *
048 * @since 6.0.0
049 */
050public class CmsModulesListExportReport extends A_CmsListReport {
051
052    /** The log object for this class. */
053    private static final Log LOG = CmsLog.getLog(CmsModulesListExportReport.class);
054
055    /** Modulename. */
056    private String m_paramModule;
057
058    /**
059     * Public constructor with JSP action element.<p>
060     *
061     * @param jsp an initialized JSP action element
062     */
063    public CmsModulesListExportReport(CmsJspActionElement jsp) {
064
065        super(jsp);
066    }
067
068    /**
069     * Public constructor with JSP variables.<p>
070     *
071     * @param context the JSP page context
072     * @param req the JSP request
073     * @param res the JSP response
074     */
075    public CmsModulesListExportReport(PageContext context, HttpServletRequest req, HttpServletResponse res) {
076
077        this(new CmsJspActionElement(context, req, res));
078    }
079
080    /**
081     * Gets the module parameter.<p>
082     *
083     * @return the module parameter
084     */
085    public String getParamModule() {
086
087        return m_paramModule;
088    }
089
090    /**
091     *
092     * @see org.opencms.workplace.list.A_CmsListReport#initializeThread()
093     */
094    @Override
095    public I_CmsReportThread initializeThread() {
096
097        I_CmsReportThread exportThread = new CmsExportThread(getCms(), getExportHandler(), false);
098
099        return exportThread;
100    }
101
102    /**
103     * Sets the module parameter.<p>
104     * @param paramModule the module parameter
105     */
106    public void setParamModule(String paramModule) {
107
108        m_paramModule = paramModule;
109    }
110
111    /**
112     * Gets the module export handler containing all resources used in the module export.<p>
113     * @return CmsModuleImportExportHandler with all module resources
114     */
115    private CmsModuleImportExportHandler getExportHandler() {
116
117        String moduleName = getParamModule();
118
119        // get the module
120        CmsModule module = OpenCms.getModuleManager().getModule(moduleName);
121
122        // create the handler description
123        String handlerDescription = Messages.get().getBundle(getLocale()).key(
124            Messages.GUI_MODULES_LIST_EXPORT_REPORT_HANDLER_NAME_1,
125            moduleName);
126
127        return CmsModuleImportExportHandler.getExportHandler(getCms(), module, handlerDescription);
128    }
129}