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, 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.xml.xml2json.document;
029
030import org.opencms.json.JSONException;
031import org.opencms.json.JSONObject;
032import org.opencms.main.CmsException;
033import org.opencms.xml.content.CmsXmlContent;
034import org.opencms.xml.xml2json.CmsJsonRequest;
035import org.opencms.xml.xml2json.handler.CmsJsonHandlerException;
036import org.opencms.xml.xml2json.handler.CmsJsonHandlerXmlContent.PathNotFoundException;
037import org.opencms.xml.xml2json.renderer.CmsJsonRendererContainerPage;
038
039/**
040 * Class representing a JSON document for a container page.
041 */
042public class CmsJsonDocumentContainerPage extends CmsJsonDocumentXmlContent {
043
044    /** The container page renderer. */
045    private CmsJsonRendererContainerPage m_renderer;
046
047    /**
048     * Creates a new container page JSON document.<p>
049     *
050     * @param jsonRequest the JSON request
051     * @param xmlContent the XML content
052     * @throws Exception if something goes wrong
053     */
054    public CmsJsonDocumentContainerPage(CmsJsonRequest jsonRequest, CmsXmlContent xmlContent)
055    throws Exception {
056
057        this(jsonRequest, xmlContent, true);
058    }
059
060    /**
061     * Creates a new container page JSON document.<p>
062     *
063     * @param jsonRequest the JSON request
064     * @param xmlContent the XML content
065     * @param embedLinkedModelgroups whether to embedLinkedContents
066     * @throws Exception if something goes wrong
067     */
068    public CmsJsonDocumentContainerPage(
069        CmsJsonRequest jsonRequest,
070        CmsXmlContent xmlContent,
071        boolean embedLinkedModelgroups)
072    throws Exception {
073
074        super(jsonRequest, xmlContent, embedLinkedModelgroups);
075        initRenderer();
076    }
077
078    /**
079     * @see org.opencms.xml.xml2json.document.CmsJsonDocumentResource#getJson()
080     */
081    @Override
082    public Object getJson()
083    throws JSONException, CmsException, CmsJsonHandlerException, PathNotFoundException, Exception {
084
085        insertJsonContainerPage();
086        Boolean paramContent = m_jsonRequest.getParamContent();
087        if (paramContent.booleanValue()) {
088            insertJsonLinkedContents();
089        }
090        insertJsonWrapper();
091        return m_json;
092    }
093
094    /**
095     * Initializes the container page renderer.<p>
096     */
097    private void initRenderer() {
098
099        m_renderer = new CmsJsonRendererContainerPage(
100            m_context.getCms(),
101            m_xmlContent.getFile(),
102            m_context.getAccessPolicy()::checkPropertyAccess);
103    }
104
105    /**
106     * Inserts a JSON representation of this container page into this JSON document.<p>
107     *
108     * @throws Exception if JSON rendering fails
109     */
110    private void insertJsonContainerPage() throws Exception {
111
112        m_json = (JSONObject)m_renderer.renderJson();
113    }
114}