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.main;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.security.CmsSecurityException;
033
034import javax.servlet.http.HttpServletRequest;
035import javax.servlet.http.HttpServletResponse;
036
037/**
038 * This interface checks the requested resource from the OpenCms request context
039 * and returns it to the calling method, which will usually be
040 * {@link OpenCms#initResource(CmsObject, String, HttpServletRequest, HttpServletResponse)}.<p>
041 *
042 * @since 6.0.0
043 */
044public interface I_CmsResourceInit {
045
046    /**
047     * Possibility to modify or change the CmsFile with the CmsObject.<p>
048     *
049     * Caution: reading parameters from the request, destroys special characters in all
050     * parameters, because the encoding for the request was not set yet.<p>
051     *
052     * @param resource the requested file
053     * @param cms the current CmsObject
054     * @param req the current request
055     * @param res the current response
056     * @return a resource in the OpenCms VFS
057     *
058     * @throws CmsResourceInitException if other implementations of the interface should not be executed
059     * @throws CmsSecurityException if other implementations of the interface should not be executed,
060     *      and the security exception should be escalated
061     */
062    CmsResource initResource(CmsResource resource, CmsObject cms, HttpServletRequest req, HttpServletResponse res)
063    throws CmsResourceInitException, CmsSecurityException;
064
065}