org.opencms.repository.A_CmsRepositorySession Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * 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.repository;

import org.opencms.file.CmsResource;

/**
 * Abstract implementation of the interface {@link I_CmsRepositorySession} to provide
 * the functionality of filtering items.
 *
 * @since 6.5.6
 */
public abstract class A_CmsRepositorySession implements I_CmsRepositorySession {

    /** The filter to use for this session. */
    private CmsRepositoryFilter m_filter;

    /**
     * Returns the filter.

     *
     * @return the filter
     */
    public CmsRepositoryFilter getFilter() {

        return m_filter;
    }

    /**
     * Sets the filter.

     *
     * @param filter the filter to set
     */
    public void setFilter(CmsRepositoryFilter filter) {

        m_filter = filter;
    }

    /**
     * Checks if a path is filtered out of the filter or not.
     *
     * @param path the path of a resource to check
     * @return true if the name matches one of the given filter patterns
     */

    protected boolean isFiltered(String path) {

        // filter all temporary files
        if (CmsResource.isTemporaryFileName(path)) {
            return true;
        }

        if (m_filter == null) {
            return false;
        }

        return m_filter.isFiltered(path);
    }

}