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, 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.workflow;
029
030import org.opencms.ade.publish.CmsRealProjectVirtualWrapper;
031import org.opencms.file.CmsObject;
032import org.opencms.file.CmsResource;
033import org.opencms.main.CmsException;
034import org.opencms.util.CmsUUID;
035
036import java.util.List;
037import java.util.Map;
038
039/**
040 * Project wrapper which specially handles the 'release' workflow by reading resources of a project regardless of publish permissions.
041 */
042public class CmsExtendedRealProjectWrapper extends CmsRealProjectVirtualWrapper {
043
044    /**
045     * Creates a new wrapper instance.<p>
046     *
047     * @param id the project id
048     */
049    public CmsExtendedRealProjectWrapper(CmsUUID id) {
050
051        super(id);
052    }
053
054    /**
055     * @see org.opencms.ade.publish.CmsRealProjectVirtualWrapper#getResources(org.opencms.file.CmsObject, java.util.Map, java.lang.String)
056     */
057    @Override
058    public List<CmsResource> getResources(CmsObject cms, Map<String, String> params, String workflowId)
059    throws CmsException {
060
061        if (CmsExtendedWorkflowManager.WORKFLOW_RELEASE.equals(workflowId)) {
062            // use readProjectView because it doesn't check for publish permissions on the resources
063            return cms.readProjectView(getProjectId(), CmsResource.STATE_KEEP);
064        } else {
065            return super.getResources(cms, params, workflowId);
066        }
067    }
068
069}