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.repository;
029
030import org.opencms.file.CmsResource;
031
032/**
033 * Abstract implementation of the interface {@link I_CmsRepositorySession} to provide
034 * the functionality of filtering items.<p>
035 *
036 * @since 6.5.6
037 */
038public abstract class A_CmsRepositorySession implements I_CmsRepositorySession {
039
040    /** The filter to use for this session. */
041    private CmsRepositoryFilter m_filter;
042
043    /**
044     * Returns the filter.<p>
045     *
046     * @return the filter
047     */
048    public CmsRepositoryFilter getFilter() {
049
050        return m_filter;
051    }
052
053    /**
054     * Sets the filter.<p>
055     *
056     * @param filter the filter to set
057     */
058    public void setFilter(CmsRepositoryFilter filter) {
059
060        m_filter = filter;
061    }
062
063    /**
064     * Checks if a path is filtered out of the filter or not.<p>
065     *
066     * @param path the path of a resource to check
067     * @return true if the name matches one of the given filter patterns
068     */
069
070    protected boolean isFiltered(String path) {
071
072        // filter all temporary files
073        if (CmsResource.isTemporaryFileName(path)) {
074            return true;
075        }
076
077        if (m_filter == null) {
078            return false;
079        }
080
081        return m_filter.isFiltered(path);
082    }
083
084}