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.ugc;
029
030import org.opencms.jsp.CmsJspActionElement;
031import org.opencms.ugc.shared.CmsUgcException;
032
033import javax.servlet.http.HttpServletRequest;
034import javax.servlet.http.HttpServletResponse;
035import javax.servlet.jsp.PageContext;
036
037/**
038 * Form action element class for use in rendering user-generated content forms.<p>
039 */
040public class CmsUgcActionElement extends CmsJspActionElement {
041
042    /**
043     * Creates a new instance.<p>
044     *
045     * @param pageContext the JSP page context
046     * @param request the current request
047     * @param response the current response
048     */
049    public CmsUgcActionElement(PageContext pageContext, HttpServletRequest request, HttpServletResponse response) {
050
051        super(pageContext, request, response);
052    }
053
054    /**
055     * Creates a new form session to edit the file with the given name using the given form configuration.
056     *
057     * @param configPath the site path of the form configuration
058     * @param fileName the name (not path) of the XML content to edit
059     * @return the id of the newly created form session
060     *
061     * @throws CmsUgcException if something goes wrong
062     */
063    public String createSessionForResource(String configPath, String fileName) throws CmsUgcException {
064
065        CmsUgcSession formSession = CmsUgcSessionFactory.getInstance().createSessionForFile(
066            getCmsObject(),
067            getRequest(),
068            configPath,
069            fileName);
070        return "" + formSession.getId();
071    }
072
073}