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.gwt;
029
030import org.opencms.json.JSONObject;
031
032import jakarta.servlet.http.HttpServletRequest;
033
034/**
035 * Convenience interface to provide core server-side data to the client.<p>
036 *
037 * @since 8.0.0
038 */
039public interface I_CmsCoreProvider {
040
041    /**
042     * Returns the JSON code for the core provider and the given message bundle.<p>
043     *
044     * @param request the current request
045     *
046     * @return the JSON code
047     *
048     * @throws Exception
049     */
050    String export(HttpServletRequest request) throws Exception;
051
052    /**
053     * Returns the JSON code for the provider with dependencies.<p>
054     *
055     * @param request the current request
056     *
057     * @return the JSON code
058     *
059     * @throws Exception
060     */
061    String exportAll(HttpServletRequest request) throws Exception;
062
063    /**
064     * Returns the provided json data.<p>
065     *
066     * @param request the current request
067     *
068     * @return the provided json data
069     */
070    JSONObject getData(HttpServletRequest request);
071
072}