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.jsp.CmsJspActionElement;
031import org.opencms.report.I_CmsReportThread;
032import org.opencms.ui.apps.dbmanager.CmsRemovePubLocksThread;
033import org.opencms.util.CmsFileUtil;
034import org.opencms.util.CmsStringUtil;
035import org.opencms.workplace.list.A_CmsListReport;
036
037import java.util.ArrayList;
038import java.util.List;
039
040import javax.servlet.http.HttpServletRequest;
041import javax.servlet.http.HttpServletResponse;
042import javax.servlet.jsp.PageContext;
043
044/**
045 * A report for displaying the remove publish lock process.<p>
046 *
047 * @since 7.0.2
048 */
049public class CmsRemovePubLocksReport extends A_CmsListReport {
050
051    /** Resources parameter: Value is a list of comma separated resources. */
052    public static final String PARAM_RESOURCES = "resources";
053
054    /** The request parameter value for resources: comma-separated names. **/
055    private String m_paramResources;
056
057    /**
058     * Public constructor with JSP action element.<p>
059     *
060     * @param jsp an initialized JSP action element
061     */
062    public CmsRemovePubLocksReport(CmsJspActionElement jsp) {
063
064        super(jsp);
065
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 CmsRemovePubLocksReport(PageContext context, HttpServletRequest req, HttpServletResponse res) {
076
077        super(context, req, res);
078
079    }
080
081    /**
082     * Returns the comma-separated list of resources.<p>
083     *
084     * @return the comma-separated list of resources
085     */
086    public String getParamResources() {
087
088        return m_paramResources;
089    }
090
091    /**
092     * Returns the <b>unstarted</b> <code>Thread</code> that will do the work.<p>
093     *
094     * @return the <b>unstarted</b> <code>Thread</code> that will do the work
095     *
096     * @see org.opencms.workplace.list.A_CmsListReport#initializeThread()
097     */
098    @Override
099    public I_CmsReportThread initializeThread() {
100
101        List resources = new ArrayList();
102        if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(getParamResources())) {
103            resources = CmsStringUtil.splitAsList(getParamResources(), ",");
104        }
105        resources = CmsFileUtil.removeRedundancies(resources);
106
107        CmsRemovePubLocksThread thread = new CmsRemovePubLocksThread(getCms(), resources);
108        return thread;
109    }
110
111    /**
112     * Sets the comma-separated list of resources.<p>
113     *
114     * @param paramIndexes the comma-separated list of resources
115     */
116    public void setParamResources(String paramIndexes) {
117
118        m_paramResources = paramIndexes;
119    }
120}