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.handler;
029
030import org.opencms.json.JSONException;
031import org.opencms.main.CmsLog;
032import org.opencms.main.OpenCms;
033import org.opencms.xml.xml2json.CmsJsonRequest;
034import org.opencms.xml.xml2json.CmsJsonResult;
035import org.opencms.xml.xml2json.document.CmsJsonDocumentList;
036
037import javax.servlet.http.HttpServletResponse;
038
039import org.apache.commons.logging.Log;
040
041/**
042 * JSON handler for rendering a list.
043 */
044public class CmsJsonHandlerList extends CmsJsonHandlerXmlContent {
045
046    /** The logger instance for this class. */
047    private static final Log LOG = CmsLog.getLog(CmsJsonHandlerList.class);
048
049    /** The list configuration type name. */
050    private final static String TYPE_LIST_CONFIG = "listconfig";
051
052    /**
053     * @see org.opencms.xml.xml2json.handler.I_CmsJsonHandler#getOrder()
054     */
055    @Override
056    public double getOrder() {
057
058        return 50;
059    }
060
061    /**
062     * @see org.opencms.xml.xml2json.handler.I_CmsJsonHandler#matches(org.opencms.xml.xml2json.handler.CmsJsonHandlerContext)
063     */
064    @Override
065    public boolean matches(CmsJsonHandlerContext context) {
066
067        String typeName = OpenCms.getResourceManager().getResourceType(context.getResource()).getTypeName();
068        return typeName.equals(TYPE_LIST_CONFIG);
069    }
070
071    /**
072     * @see org.opencms.xml.xml2json.handler.I_CmsJsonHandler#renderJson(org.opencms.xml.xml2json.handler.CmsJsonHandlerContext)
073     */
074    @Override
075    public CmsJsonResult renderJson(CmsJsonHandlerContext context) {
076
077        try {
078            CmsJsonRequest jsonRequest = new CmsJsonRequest(context, this);
079            jsonRequest.validate();
080            if (jsonRequest.hasErrors()) {
081                return new CmsJsonResult(jsonRequest.getErrorsAsJson(), HttpServletResponse.SC_BAD_REQUEST);
082            }
083            CmsJsonDocumentList jsonDocument = new CmsJsonDocumentList(jsonRequest, context.getContent());
084            return new CmsJsonResult(jsonDocument.getJson(), HttpServletResponse.SC_OK);
085        } catch (JSONException e) {
086            LOG.info(e.getLocalizedMessage(), e);
087            return new CmsJsonResult(e.getLocalizedMessage(), HttpServletResponse.SC_NOT_FOUND);
088        } catch (Exception e) {
089            LOG.error(e.getLocalizedMessage(), e);
090            return new CmsJsonResult(e.getLocalizedMessage(), HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
091        }
092    }
093
094}