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.configuration.CmsParameterConfiguration;
031import org.opencms.file.CmsObject;
032import org.opencms.file.CmsResource;
033import org.opencms.security.CmsSecurityException;
034
035import javax.servlet.http.HttpServletRequest;
036import javax.servlet.http.HttpServletResponse;
037
038/**
039 * This interface checks the requested resource from the OpenCms request context
040 * and returns it to the calling method, which will usually be
041 * {@link OpenCms#initResource(CmsObject, String, HttpServletRequest, HttpServletResponse)}.<p>
042 *
043 * @since 6.0.0
044 */
045public interface I_CmsResourceInit {
046
047    /** Resource init handlers can use this attribute to pass an alternative CmsObject for loading the resource returned by them. */
048    public static final String ATTR_ALTERNATIVE_CMS_OBJECT = "resourceinit.alternativeCmsObject";
049
050    /**
051     * Gets the configuration data.
052     *
053     * @return the configuration data
054     */
055    default CmsParameterConfiguration getConfiguration() {
056
057        return new CmsParameterConfiguration();
058    }
059
060    /**
061     * Initializes parameters.
062     *
063     * @param params the configuration parameters
064     */
065    default void initParameters(CmsParameterConfiguration params) {
066
067        // do nothing
068    }
069
070    /**
071     * Possibility to modify or change the CmsFile with the CmsObject.<p>
072     *
073     * Caution: reading parameters from the request, destroys special characters in all
074     * parameters, because the encoding for the request was not set yet.<p>
075     *
076     * @param resource the requested file
077     * @param cms the current CmsObject
078     * @param req the current request
079     * @param res the current response
080     * @return a resource in the OpenCms VFS
081     *
082     * @throws CmsResourceInitException if other implementations of the interface should not be executed
083     * @throws CmsSecurityException if other implementations of the interface should not be executed,
084     *      and the security exception should be escalated
085     */
086    CmsResource initResource(CmsResource resource, CmsObject cms, HttpServletRequest req, HttpServletResponse res)
087    throws CmsResourceInitException, CmsSecurityException;
088
089}