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.portal.business.portlet;
35
36 import fr.paris.lutece.portal.service.message.SiteMessageException;
37 import fr.paris.lutece.util.xml.XmlUtil;
38
39 import java.util.Map;
40
41 import javax.servlet.http.HttpServletRequest;
42
43
44 /**
45 * This class represents business objects AliasPortlet
46 */
47 public class AliasPortlet extends Portlet
48 {
49 /////////////////////////////////////////////////////////////////////////////////
50 // Constants
51 private int _nAliasId;
52
53 /**
54 * Sets the identifier of the portlet type to the value specified in the AliasPortletHome class
55 */
56 public AliasPortlet( )
57 {
58 setPortletTypeId( AliasPortletHome.getInstance( ).getPortletTypeId( ) );
59 }
60
61 /**
62 * Sets the alias identifier of the portlet with the specified int value
63 *
64 * @param nAliasId the Alias identifier
65 */
66 public void setAliasId( int nAliasId )
67 {
68 _nAliasId = nAliasId;
69 }
70
71 /**
72 * Returns the alias identifier of the portlet
73 *
74 * @return the Alias identifier
75 */
76 public int getAliasId( )
77 {
78 return _nAliasId;
79 }
80
81 /**
82 * Returns the Xml code of the Alias portlet without XML heading
83 *
84 * @param request The HTTP servlet request
85 * @return the Xml code of the Alias portlet content
86 * @throws SiteMessageException occurs when a site message need to be displayed
87 */
88 public String getXml( HttpServletRequest request )
89 throws SiteMessageException
90 {
91 int nAliasId = AliasPortletHome.getAliasId( getId( ) );
92
93 //gets the portlet parent
94 Portlet portlet = PortletHome.findByPrimaryKey( nAliasId );
95 String strXmlAlias = portlet.getXml( request );
96 String strTagPortletName = "</" + TAG_PORTLET_NAME + ">";
97 int indexDeb = strXmlAlias.indexOf( strTagPortletName );
98 int indexFin = strXmlAlias.indexOf( "</" + TAG_PORTLET + ">" );
99 strXmlAlias = strXmlAlias.substring( indexDeb + strTagPortletName.length( ), indexFin );
100
101 StringBuffer buffXml = new StringBuffer( );
102 XmlUtil.beginElement( buffXml, TAG_PORTLET );
103 XmlUtil.addElement( buffXml, TAG_PORTLET_NAME, getName( ) );
104 buffXml.append( strXmlAlias );
105 XmlUtil.endElement( buffXml, TAG_PORTLET );
106
107 return buffXml.toString( );
108 }
109
110 /**
111 * Returns the Xml code of the Alias portlet with XML heading
112 *
113 * @param request The HTTP Servlet request
114 * @return the Xml code of the Alias portlet
115 * @throws SiteMessageException occurs when a site message need to be displayed
116 */
117 public String getXmlDocument( HttpServletRequest request )
118 throws SiteMessageException
119 {
120 return XmlUtil.getXmlHeader( ) + getXml( request );
121 }
122
123 /**
124 * Gets the XSl parameters of the alias portlet and returns them in form of a dictionnary
125 *
126 * @return the Xsl params
127 */
128 public Map<String, String> getXslParams( )
129 {
130 int nIdAlias = AliasPortletHome.getAliasId( getId( ) );
131
132 //gets the portlet parent
133 Portlet portlet = PortletHome.findByPrimaryKey( nIdAlias );
134
135 return portlet.getXslParams( );
136 }
137
138 /**
139 * Updates the current instance of the AliasPortlet object
140 */
141 public void update( )
142 {
143 AliasPortletHome.getInstance( ).update( this );
144 }
145
146 /**
147 * Removes the current instance of the AliasPortlet object
148 */
149 public void remove( )
150 {
151 AliasPortletHome.getInstance( ).remove( this );
152 }
153 }