001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.loader;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.main.CmsException;
033
034import java.io.IOException;
035
036import jakarta.servlet.http.HttpServletRequest;
037import jakarta.servlet.http.HttpServletResponse;
038
039/**
040 * Capability interface for loaders which can handle on-demand static export without a local export file.<p>
041 */
042public interface I_CmsStaticExportDirectResponseLoader {
043
044    /**
045     * Tries to handle an on-demand static export directly.<p>
046     *
047     * @param cms the CMS context
048     * @param resource the resource to export
049     * @param req the current request
050     * @param res the current response
051     *
052     * @return <code>true</code> if the export response has been handled
053     *
054     * @throws IOException in case writing fails
055     * @throws CmsException in case export fails
056     */
057    boolean tryExportDirectResponse(
058        CmsObject cms,
059        CmsResource resource,
060        HttpServletRequest req,
061        HttpServletResponse res)
062    throws IOException, CmsException;
063}