org.opencms.workplace.commons.CmsPublishBrokenRelationsCollector Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.workplace.commons;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.workplace.explorer.CmsResourceUtil;
import org.opencms.workplace.list.A_CmsListExplorerDialog;
import org.opencms.workplace.list.A_CmsListResourceCollector;
import org.opencms.workplace.list.CmsListItem;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
/**
* Collector for resources with links that could get broken after publishing.
*
* @since 6.5.5
*/
public class CmsPublishBrokenRelationsCollector extends A_CmsListResourceCollector {
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsPublishBrokenRelationsCollector.class);
/** Parameter of the default collector name. */
public static final String COLLECTOR_NAME = "potentialBrokenResources";
/**
* Constructor, creates a new instance.
*
* @param wp the workplace object
* @param resources list of locked resources
*/
public CmsPublishBrokenRelationsCollector(A_CmsListExplorerDialog wp, List resources) {
super(wp);
setResourcesParam(resources);
}
/**
* @see org.opencms.file.collectors.I_CmsResourceCollector#getCollectorNames()
*/
public List getCollectorNames() {
List names = new ArrayList();
names.add(COLLECTOR_NAME);
return names;
}
/**
* @see org.opencms.workplace.list.A_CmsListResourceCollector#getResources(org.opencms.file.CmsObject, java.util.Map)
*/
@Override
public List getResources(CmsObject cms, Map params) {
String siteRoot = cms.getRequestContext().getSiteRoot();
if (siteRoot == null) {
siteRoot = "";
}
List resources = new ArrayList();
try {
cms.getRequestContext().setSiteRoot("");
Iterator itResourceNames = getResourceNamesFromParam(params).iterator();
while (itResourceNames.hasNext()) {
String resName = itResourceNames.next();
try {
resources.add(cms.readResource(resName, CmsResourceFilter.ALL));
} catch (CmsException e) {
if (LOG.isErrorEnabled()) {
LOG.error(e.getLocalizedMessage(), e);
}
}
}
} finally {
cms.getRequestContext().setSiteRoot(siteRoot);
}
return resources;
}
/**
* @see org.opencms.workplace.list.A_CmsListResourceCollector#setAdditionalColumns(org.opencms.workplace.list.CmsListItem, org.opencms.workplace.explorer.CmsResourceUtil)
*/
@Override
protected void setAdditionalColumns(CmsListItem item, CmsResourceUtil resUtil) {
// no-op
}
}