1 /*
2 * Copyright (c) 2002-2020, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.jasper.business.portlet;
35
36 import fr.paris.lutece.portal.business.portlet.Portlet;
37 import fr.paris.lutece.util.xml.XmlUtil;
38
39 import javax.servlet.http.HttpServletRequest;
40
41 /**
42 * This class represents business objects JasperPortlet
43 */
44 public class JasperPortlet extends Portlet
45 {
46 private static final String TAG_JASPER_PORTLET = "jasper-portlet";
47 private static final String TAG_JASPER_PORTLET_CONTENT = "jasper-portlet-content";
48
49 // ///////////////////////////////////////////////////////////////////////////////
50 // Constants
51 private String _strJasperFeedId;
52
53 /**
54 * Sets the identifier of the portlet type to value specified
55 */
56 public JasperPortlet( )
57 {
58 setPortletTypeId( JasperPortletHome.getInstance( ).getPortletTypeId( ) );
59 }
60
61 /**
62 * Sets the url of the portlet
63 *
64 * @param strJasperFeedId
65 * the Jasper portlet url
66 */
67 public void setJasperFeedId( String strJasperFeedId )
68 {
69 _strJasperFeedId = strJasperFeedId;
70 }
71
72 /**
73 * Returns the Jasper Feed Id of the Jasper portlet
74 *
75 * @return the Jasper Portlet url
76 */
77 public String getJasperFeedId( )
78 {
79 return _strJasperFeedId;
80 }
81
82 /**
83 * Returns the Xml code of the Jasper portlet with XML heading
84 *
85 * @param request
86 * The HTTP servlet request
87 * @return the Xml code of the Jasper portlet
88 */
89 public String getXmlDocument( HttpServletRequest request )
90 {
91 return XmlUtil.getXmlHeader( ) + getXml( request );
92 }
93
94 /**
95 * Returns the Xml code of the Jasper portlet without XML heading
96 *
97 * @param request
98 * The HTTP servlet request
99 * @return the Xml code of the Jasper portlet content
100 */
101 public String getXml( HttpServletRequest request )
102 {
103 StringBuffer strXml = new StringBuffer( );
104
105 XmlUtil.beginElement( strXml, TAG_JASPER_PORTLET );
106 XmlUtil.addElementHtml( strXml, TAG_JASPER_PORTLET_CONTENT, _strJasperFeedId );
107 XmlUtil.endElement( strXml, TAG_JASPER_PORTLET );
108
109 return addPortletTags( strXml );
110 }
111
112 /**
113 * Updates the current instance of the JasperPortlet object
114 */
115 public void update( )
116 {
117 JasperPortletHome.getInstance( ).update( this );
118 }
119
120 /**
121 * Removes the current instance of the JasperPortlet object
122 */
123 public void remove( )
124 {
125 JasperPortletHome.getInstance( ).remove( this );
126 }
127 }