1 /*
2 * Copyright (c) 2002-2014, Mairie de 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.rss.business.portlet;
35
36 import fr.paris.lutece.plugins.rss.business.RssFeed;
37 import fr.paris.lutece.plugins.rss.business.RssFeedHome;
38 import fr.paris.lutece.portal.business.portlet.Portlet;
39 import fr.paris.lutece.util.xml.XmlUtil;
40
41 import java.util.List;
42
43 import javax.servlet.http.HttpServletRequest;
44
45
46 /**
47 * This class represents business objects RssPortlet
48 */
49 public class RssListPortlet extends Portlet
50 {
51 private static final String TAG_RSS_LIST_PORTLET = "rss-list-portlet";
52 private static final String TAG_RSS_LIST_PORTLET_NAME = "rss-list-portlet-name";
53 private static final String TAG_RSS_LIST_PORTLET_URL = "rss-list-portlet-url";
54
55 /**
56 * Sets the identifier of the portlet type to value specified
57 */
58 public RssListPortlet( )
59 {
60 setPortletTypeId( RssListPortletHome.getInstance( ).getPortletTypeId( ) );
61 }
62
63 /**
64 * Returns the Xml code of the Rss portlet with XML heading
65 *
66 * @param request The HTTP servlet request
67 * @return the Xml code of the Rss portlet
68 */
69 public String getXmlDocument( HttpServletRequest request )
70 {
71 return XmlUtil.getXmlHeader( ) + getXml( request );
72 }
73
74 /**
75 * Returns the Xml code of the Rss portlet without XML heading
76 *
77 * @param request The HTTP servlet request
78 * @return the Xml code of the Rss portlet content
79 */
80 public String getXml( HttpServletRequest request )
81 {
82 StringBuffer strXml = new StringBuffer( );
83 List<RssFeed> listRssFeedList = RssFeedHome.getRssFeeds( );
84
85 if ( listRssFeedList != null )
86 {
87 for ( RssFeed feed : listRssFeedList )
88 {
89 XmlUtil.beginElement( strXml, TAG_RSS_LIST_PORTLET );
90 XmlUtil.addElementHtml( strXml, TAG_RSS_LIST_PORTLET_NAME, feed.getName( ) );
91 XmlUtil.addElementHtml( strXml, TAG_RSS_LIST_PORTLET_URL, feed.getUrl( ) );
92 XmlUtil.endElement( strXml, TAG_RSS_LIST_PORTLET );
93 }
94 }
95
96 return addPortletTags( strXml );
97 }
98
99 /**
100 * Updates the current instance of the RssPortlet object
101 */
102 public void update( )
103 {
104 RssListPortletHome.getInstance( ).update( this );
105 }
106
107 /**
108 * Removes the current instance of the RssPortlet object
109 */
110 public void remove( )
111 {
112 RssListPortletHome.getInstance( ).remove( this );
113 }
114 }