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, 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.CmsResource;
032import org.opencms.file.CmsResourceFilter;
033import org.opencms.main.CmsException;
034import org.opencms.main.CmsRuntimeException;
035import org.opencms.main.OpenCms;
036import org.opencms.xml.I_CmsXmlDocument;
037import org.opencms.xml.content.CmsXmlContentFactory;
038
039import javax.servlet.ServletRequest;
040import javax.servlet.http.HttpServletRequest;
041
042/**
043 * The SEO file loader.<p>
044 */
045public class CmsSeoFileLoader extends A_CmsXmlDocumentLoader {
046
047    /** The loader id. */
048    public static final int LOADER_ID = 14;
049
050    /** The SEO file template JSP path. */
051    public static final String TEMPLATE_PATH = "/system/modules/org.opencms.ade.config/pages/render-seo-file.jsp";
052
053    /**
054     * @see org.opencms.loader.I_CmsResourceLoader#getLoaderId()
055     */
056    public int getLoaderId() {
057
058        return LOADER_ID;
059    }
060
061    /**
062     * @see org.opencms.loader.I_CmsResourceLoader#getResourceLoaderInfo()
063     */
064    public String getResourceLoaderInfo() {
065
066        return Messages.get().getBundle().key(Messages.GUI_LOADER_SEOFILE_DEFAULT_DESC_0);
067    }
068
069    /**
070     * @see org.opencms.loader.A_CmsXmlDocumentLoader#getTemplateLoaderFacade(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest)
071     */
072    @Override
073    protected CmsTemplateLoaderFacade getTemplateLoaderFacade(
074        CmsObject cms,
075        CmsResource resource,
076        HttpServletRequest req) throws CmsException {
077
078        CmsResource template = cms.readFile(TEMPLATE_PATH, CmsResourceFilter.IGNORE_EXPIRATION);
079        return new CmsTemplateLoaderFacade(OpenCms.getResourceManager().getLoader(template), resource, template);
080    }
081
082    /**
083     * @see org.opencms.loader.A_CmsXmlDocumentLoader#getTemplatePropertyDefinition()
084     */
085    @Override
086    protected String getTemplatePropertyDefinition() {
087
088        throw new CmsRuntimeException(
089            Messages.get().container(Messages.ERR_TEMPLATE_PROTERTY_UNSUPPORTED_1, getClass().getName()));
090    }
091
092    /**
093     * @see org.opencms.loader.A_CmsXmlDocumentLoader#unmarshalXmlDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.ServletRequest)
094     */
095    @Override
096    protected I_CmsXmlDocument unmarshalXmlDocument(CmsObject cms, CmsResource resource, ServletRequest req)
097    throws CmsException {
098
099        return CmsXmlContentFactory.unmarshal(cms, resource, req);
100    }
101
102}