JasperPortlet.java

/*
 * Copyright (c) 2002-2020, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.jasper.business.portlet;

import fr.paris.lutece.portal.business.portlet.Portlet;
import fr.paris.lutece.util.xml.XmlUtil;

import javax.servlet.http.HttpServletRequest;

/**
 * This class represents business objects JasperPortlet
 */
public class JasperPortlet extends Portlet
{
    private static final String TAG_JASPER_PORTLET = "jasper-portlet";
    private static final String TAG_JASPER_PORTLET_CONTENT = "jasper-portlet-content";

    // ///////////////////////////////////////////////////////////////////////////////
    // Constants
    private String _strJasperFeedId;

    /**
     * Sets the identifier of the portlet type to value specified
     */
    public JasperPortlet( )
    {
        setPortletTypeId( JasperPortletHome.getInstance( ).getPortletTypeId( ) );
    }

    /**
     * Sets the url of the portlet
     *
     * @param strJasperFeedId
     *            the Jasper portlet url
     */
    public void setJasperFeedId( String strJasperFeedId )
    {
        _strJasperFeedId = strJasperFeedId;
    }

    /**
     * Returns the Jasper Feed Id of the Jasper portlet
     *
     * @return the Jasper Portlet url
     */
    public String getJasperFeedId( )
    {
        return _strJasperFeedId;
    }

    /**
     * Returns the Xml code of the Jasper portlet with XML heading
     *
     * @param request
     *            The HTTP servlet request
     * @return the Xml code of the Jasper portlet
     */
    public String getXmlDocument( HttpServletRequest request )
    {
        return XmlUtil.getXmlHeader( ) + getXml( request );
    }

    /**
     * Returns the Xml code of the Jasper portlet without XML heading
     *
     * @param request
     *            The HTTP servlet request
     * @return the Xml code of the Jasper portlet content
     */
    public String getXml( HttpServletRequest request )
    {
        StringBuffer strXml = new StringBuffer( );

        XmlUtil.beginElement( strXml, TAG_JASPER_PORTLET );
        XmlUtil.addElementHtml( strXml, TAG_JASPER_PORTLET_CONTENT, _strJasperFeedId );
        XmlUtil.endElement( strXml, TAG_JASPER_PORTLET );

        return addPortletTags( strXml );
    }

    /**
     * Updates the current instance of the JasperPortlet object
     */
    public void update( )
    {
        JasperPortletHome.getInstance( ).update( this );
    }

    /**
     * Removes the current instance of the JasperPortlet object
     */
    public void remove( )
    {
        JasperPortletHome.getInstance( ).remove( this );
    }
}