1 /*
2 * Copyright (c) 2002-2017, 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.links.business.portlet;
35
36 import fr.paris.lutece.plugins.links.business.Link;
37 import fr.paris.lutece.plugins.links.business.LinkHome;
38 import fr.paris.lutece.portal.business.portlet.Portlet;
39 import fr.paris.lutece.portal.service.util.AppPathService;
40 import fr.paris.lutece.util.xml.XmlUtil;
41
42 import java.util.Collection;
43
44 import javax.servlet.http.HttpServletRequest;
45
46
47 /**
48 * This class represents business object LinkPortlet
49 */
50 public class LinksPortlet extends Portlet
51 {
52 /////////////////////////////////////////////////////////////////////////////////
53 // Constantes
54 private static final String TAG_LINKS_PORTLET = "links-portlet";
55 private int _nLinkId;
56 private int _nPortletOrder;
57
58 /**
59 * Creates a new LinkPortlet object.
60 */
61 public LinksPortlet( )
62 {
63 setPortletTypeId( LinksPortletHome.getInstance( ).getPortletTypeId( ) );
64 }
65
66 /**
67 * Returns the identifier of the Link of this portlet
68 *
69 * @return The Link identifier
70 */
71 public int getLinkId( )
72 {
73 return _nLinkId;
74 }
75
76 /**
77 * Sets the identifier of the Link of this LinkPortlet to the specified int
78 *
79 * @param nLinkId the new identifier of the Link
80 */
81 public void setLinkId( int nLinkId )
82 {
83 _nLinkId = nLinkId;
84 }
85
86 /**
87 * Returns the XML content of the portlet without the XML header
88 *
89 * @param request The HTTP servlet request
90 * @return The Xml content of this portlet
91 */
92 public String getXml( HttpServletRequest request )
93 {
94 StringBuffer strXml = new StringBuffer( );
95 XmlUtil.beginElement( strXml, TAG_LINKS_PORTLET );
96
97 Collection<Link> list = LinkHome.findByPortlet( getId( ) );
98
99 String strServerKey = AppPathService.getVirtualHostKey( request );
100
101 for ( Link link : list )
102 {
103 if ( link.getUrl( strServerKey ) != null )
104 {
105 strXml.append( link.getXml( request ) );
106 }
107 }
108
109 XmlUtil.endElement( strXml, TAG_LINKS_PORTLET );
110
111 return addPortletTags( strXml );
112 }
113
114 /**
115 * Returns the XML content of the portlet with the XML header
116 *
117 * @param request The HTTP servlet request
118 * @return The XML content of this portlet
119 */
120 public String getXmlDocument( HttpServletRequest request )
121 {
122 return XmlUtil.getXmlHeader( ) + getXml( request );
123 }
124
125 /**
126 * Updates this portlet
127 */
128 public void update( )
129 {
130 LinksPortletHome.getInstance( ).update( this );
131 }
132
133 /**
134 * Removes this portlet
135 */
136 public void remove( )
137 {
138 LinksPortletHome.getInstance( ).remove( this );
139 }
140
141 /**
142 * Return the order of the portlet in the links page
143 *
144 * @return the order
145 */
146 public int getPortletOrder( )
147 {
148 return _nPortletOrder;
149 }
150
151 /**
152 * Sets the order of the portlet in the links page
153 *
154 * @param nPortletOrder The new value
155 */
156 public void setPortletOrder( int nPortletOrder )
157 {
158 this._nPortletOrder = nPortletOrder;
159 }
160 }