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 GmbH & Co. KG, 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.jsp;
029
030import javax.servlet.jsp.tagext.BodyTagSupport;
031
032/**
033 * Allows to have certain JSP code on a JSP not processed by OpenCms,
034 * which can be useful in case you want to create a JSP page using the OpenCms static export.<p>
035 *
036 * Usually, if you want to create a JSP page using the OpenCms static export,
037 * some parts of the page should be processed by OpenCms, while other parts of the JSP
038 * are processed later when the exported JSP is deployed in another servlet container.
039 * A typical use case is that you have a template applied to the page in OpenCms, but the body content of the page
040 * is generated after the static export, for example by a database application.<p>
041 *
042 * <b>Please note:</b> In order to static export a JSP page with the <code>".jsp"</code> suffix, you need to add the
043 * property <code>"exportsuffix"</code> with the value <code>".jsp"</code> to the OpenCms JSP file in the VFS.
044 * Otherwise the static export will always add the suffix <code>".html"</code>.<p>
045 *
046 * @since 7.0.4
047 */
048public class CmsJspTagExport extends BodyTagSupport {
049
050    /** Serial version UID required for safe serialization. */
051    private static final long serialVersionUID = 6326430271724241959L;
052
053    /**
054     * @see javax.servlet.jsp.tagext.BodyTagSupport#doStartTag()
055     */
056    @Override
057    public int doStartTag() {
058
059        return EVAL_BODY_INCLUDE;
060    }
061}