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.service.RssContent;
37 import fr.paris.lutece.plugins.rss.service.RssContentService;
38 import fr.paris.lutece.portal.business.portlet.Portlet;
39 import fr.paris.lutece.util.xml.XmlUtil;
40
41 import javax.servlet.http.HttpServletRequest;
42
43
44 /**
45 * This class represents business objects RssPortlet
46 */
47 public class RssPortlet extends Portlet
48 {
49 /////////////////////////////////////////////////////////////////////////////////
50 // Constants
51 private String _strRssFeedId;
52
53 /**
54 * Sets the identifier of the portlet type to value specified
55 */
56 public RssPortlet( )
57 {
58 setPortletTypeId( RssPortletHome.getInstance( ).getPortletTypeId( ) );
59 }
60
61 /**
62 * Sets the url of the portlet
63 *
64 * @param strRssFeedId the Rss portlet url
65 */
66 public void setRssFeedId( String strRssFeedId )
67 {
68 _strRssFeedId = strRssFeedId;
69 }
70
71 /**
72 * Returns the Rss Feed Id of the Rss portlet
73 *
74 * @return the Rss Portlet url
75 */
76 public String getRssFeedId( )
77 {
78 return _strRssFeedId;
79 }
80
81 /**
82 * Returns the Xml code of the Rss portlet with XML heading
83 *
84 * @param request The HTTP servlet request
85 * @return the Xml code of the Rss portlet
86 */
87 public String getXmlDocument( HttpServletRequest request )
88 {
89 return XmlUtil.getXmlHeader( ) + getXml( request );
90 }
91
92 /**
93 * Returns the Xml code of the Rss portlet without XML heading
94 *
95 * @param request The HTTP servlet request
96 * @return the Xml code of the Rss portlet content
97 */
98 public String getXml( HttpServletRequest request )
99 {
100 StringBuffer strXml = new StringBuffer( );
101 RssContent rssContent = RssContentService.getInstance( ).getRssContent( getRssFeedId( ) );
102 String strDocument = rssContent.getContent( );
103
104 if ( strDocument != null )
105 {
106 /* removes the Xml heading of the downloaded file RSS */
107 int nPos = strDocument.indexOf( "<rss" );
108
109 if ( nPos > 0 )
110 {
111 strXml.append( strDocument.substring( nPos, strDocument.length( ) ) );
112 }
113 }
114
115 return addPortletTags( strXml );
116 }
117
118 /**
119 * Updates the current instance of the RssPortlet object
120 */
121 public void update( )
122 {
123 RssPortletHome.getInstance( ).update( this );
124 }
125
126 /**
127 * Removes the current instance of the RssPortlet object
128 */
129 public void remove( )
130 {
131 RssPortletHome.getInstance( ).remove( this );
132 }
133 }