1 /*
2 * Copyright (c) 2002-2022, 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.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 * This class represents business objects AliasPortlet
45 */
46 public class AliasPortlet extends Portlet
47 {
48 // ///////////////////////////////////////////////////////////////////////////////
49 // Constants
50 private int _nAliasId;
51
52 /**
53 * Sets the identifier of the portlet type to the value specified in the AliasPortletHome class
54 */
55 public AliasPortlet( )
56 {
57 setPortletTypeId( AliasPortletHome.getInstance( ).getPortletTypeId( ) );
58 }
59
60 /**
61 * Sets the alias identifier of the portlet with the specified int value
62 *
63 * @param nAliasId
64 * 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 * {@inheritDoc}
83 */
84 @Override
85 public boolean isContentGeneratedByXmlAndXsl( )
86 {
87 Portlet portletParent = PortletHome.findByPrimaryKey( getAliasId( ) );
88 return portletParent.isContentGeneratedByXmlAndXsl( );
89 }
90
91 /**
92 * Returns the html content code of the Alias portlet
93 *
94 * @param request
95 * The HTTP servlet request
96 * @return the Html content code of the Alias portlet content
97 */
98 @Override
99 public String getHtmlContent( HttpServletRequest request )
100 {
101 Portlet portlet = PortletHome.findByPrimaryKey( getAliasId( ) );
102 return portlet.getHtmlContent( request );
103 }
104
105 /**
106 * Returns the Xml code of the Alias portlet without XML heading
107 *
108 * @param request
109 * The HTTP servlet request
110 * @return the Xml code of the Alias portlet content
111 * @throws SiteMessageException
112 * occurs when a site message need to be displayed
113 */
114 public String getXml( HttpServletRequest request ) throws SiteMessageException
115 {
116 // gets the portlet parent
117 Portlet portlet = PortletHome.findByPrimaryKey( getAliasId( ) );
118 String strXmlAlias = portlet.getXml( request );
119 String strTagPortletName = "</" + TAG_PORTLET_NAME + ">";
120 int indexDeb = strXmlAlias.indexOf( strTagPortletName );
121 int indexFin = strXmlAlias.indexOf( "</" + TAG_PORTLET + ">" );
122 strXmlAlias = strXmlAlias.substring( indexDeb + strTagPortletName.length( ), indexFin );
123
124 StringBuffer buffXml = new StringBuffer( );
125 XmlUtil.beginElement( buffXml, TAG_PORTLET );
126 XmlUtil.addElement( buffXml, TAG_PORTLET_NAME, getName( ) );
127 buffXml.append( strXmlAlias );
128 XmlUtil.endElement( buffXml, TAG_PORTLET );
129
130 return buffXml.toString( );
131 }
132
133 /**
134 * Returns the Xml code of the Alias portlet with XML heading
135 *
136 * @param request
137 * The HTTP Servlet request
138 * @return the Xml code of the Alias portlet
139 * @throws SiteMessageException
140 * occurs when a site message need to be displayed
141 */
142 public String getXmlDocument( HttpServletRequest request ) throws SiteMessageException
143 {
144 return XmlUtil.getXmlHeader( ) + getXml( request );
145 }
146
147 /**
148 * Gets the XSl parameters of the alias portlet and returns them in form of a dictionnary
149 *
150 * @return the Xsl params
151 */
152 @Override
153 public Map<String, String> getXslParams( )
154 {
155
156 // gets the portlet parent
157 Portlet portlet = PortletHome.findByPrimaryKey( getAliasId( ) );
158
159 return portlet.getXslParams( );
160 }
161
162 /**
163 * Updates the current instance of the AliasPortlet object
164 */
165 public void update( )
166 {
167 AliasPortletHome.getInstance( ).update( this );
168 }
169
170 /**
171 * Removes the current instance of the AliasPortlet object
172 */
173 public void remove( )
174 {
175 AliasPortletHome.getInstance( ).remove( this );
176 }
177
178 }