001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH (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, 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.loader;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsPropertyDefinition;
032import org.opencms.file.CmsResource;
033import org.opencms.jsp.util.CmsJspStandardContextBean.TemplateBean;
034import org.opencms.main.CmsException;
035import org.opencms.main.OpenCms;
036import org.opencms.xml.containerpage.CmsXmlContainerPage;
037import org.opencms.xml.containerpage.CmsXmlContainerPageFactory;
038
039import java.io.IOException;
040
041import javax.servlet.ServletException;
042import javax.servlet.ServletRequest;
043import javax.servlet.http.HttpServletRequest;
044import javax.servlet.http.HttpServletResponse;
045
046/**
047 * OpenCms loader for resources of type <code>{@link org.opencms.file.types.CmsResourceTypeXmlContainerPage}</code>.<p>
048 *
049 * It is just a xml-content loader with template capabilities.<p>
050 *
051 * @since 7.6
052 */
053public class CmsXmlContainerPageLoader extends CmsXmlContentLoader {
054
055    /** The id of this loader. */
056    public static final int CONTAINER_PAGE_RESOURCE_LOADER_ID = 11;
057
058    /**
059     * Default constructor.<p>
060     */
061    public CmsXmlContainerPageLoader() {
062
063        // empty
064    }
065
066    /**
067     * @see org.opencms.loader.I_CmsResourceLoader#getLoaderId()
068     */
069    @Override
070    public int getLoaderId() {
071
072        return CONTAINER_PAGE_RESOURCE_LOADER_ID;
073    }
074
075    /**
076     * Returns a String describing this resource loader, which is (localized to the system default locale)
077     * <code>"The OpenCms default resource loader for container page"</code>.<p>
078     *
079     * @return a describing String for the ResourceLoader
080     */
081    @Override
082    public String getResourceLoaderInfo() {
083
084        return Messages.get().getBundle().key(Messages.GUI_LOADER_CONTAINERPAGE_DEFAULT_DESC_0);
085    }
086
087    /**
088     * @see org.opencms.loader.A_CmsXmlDocumentLoader#isUsableForTemplates()
089     */
090    @Override
091    public boolean isUsableForTemplates() {
092
093        return true;
094    }
095
096    /**
097     * @see org.opencms.loader.A_CmsXmlDocumentLoader#load(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
098     */
099    @Override
100    public void load(CmsObject cms, CmsResource resource, HttpServletRequest req, HttpServletResponse res)
101    throws ServletException, IOException, CmsException {
102
103        CmsTemplateLoaderFacade loaderFacade = OpenCms.getResourceManager().getTemplateLoaderFacade(
104            cms,
105            req,
106            resource,
107            getTemplatePropertyDefinition());
108        CmsTemplateContext context = loaderFacade.getTemplateContext();
109        req.setAttribute(CmsTemplateContextManager.ATTR_TEMPLATE_CONTEXT, context);
110        TemplateBean templateBean = new TemplateBean(
111            context != null ? context.getKey() : loaderFacade.getTemplateName(),
112            loaderFacade.getTemplate());
113        templateBean.setForced((context != null) && context.isForced());
114        req.setAttribute(CmsTemplateContextManager.ATTR_TEMPLATE_BEAN, templateBean);
115        loaderFacade.getLoader().load(cms, loaderFacade.getLoaderStartResource(), req, res);
116    }
117
118    /**
119     * @see org.opencms.loader.A_CmsXmlDocumentLoader#getTemplatePropertyDefinition()
120     */
121    @Override
122    protected String getTemplatePropertyDefinition() {
123
124        return CmsPropertyDefinition.PROPERTY_TEMPLATE;
125    }
126
127    /**
128     * @see org.opencms.loader.A_CmsXmlDocumentLoader#unmarshalXmlDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.ServletRequest)
129     */
130    @Override
131    protected CmsXmlContainerPage unmarshalXmlDocument(CmsObject cms, CmsResource resource, ServletRequest req)
132    throws CmsException {
133
134        return CmsXmlContainerPageFactory.unmarshal(cms, resource, req);
135    }
136}