1 /*
2 * Copyright (c) 2002-2025, 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.plugins.pluginwizard.service.generator;
35
36 import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
37 import fr.paris.lutece.plugins.pluginwizard.business.model.Portlet;
38
39 import java.util.HashMap;
40 import java.util.Map;
41
42 /**
43 *
44 * The class generated the portlet jspbean needed to manage portlets
45 *
46 */
47 public class PortletJspBeanGenerator extends AbstractGenerator
48 {
49 private static final String PATH = "src/java/fr/paris/lutece/plugins/{plugin_name}/web/portlet/";
50
51 /**
52 * {@inheritDoc }
53 */
54 @Override
55 public Map generate( PluginModel pm, String generationSchemeName )
56 {
57 HashMap map = new HashMap( );
58 String strPluginName = pm.getPluginNameAsRadicalPackage( );
59
60 String _path = PATH.replace( "{plugin_name}", pm.getPluginNameAsRadicalPath( ) );
61
62 for ( Portlet portlet : pm.getPortlets( ) )
63 {
64 String strPath = getFilePath( pm, _path, portlet.getPortletClass( ) + "JspBean.java" );
65
66 String strSourceCode = getPortletJspBean( portlet, strPluginName, pm.isModule( ) );
67 map.put( strPath, strSourceCode );
68 }
69
70 return map;
71 }
72
73 /**
74 * Gets the Portlet Jsp Bean
75 *
76 * @param portlet
77 * The portlet
78 * @param strPluginName
79 * The generated plugin name
80 * @return The source code of the jsp
81 */
82 private String getPortletJspBean( Portlet portlet, String strPluginName, boolean isModule )
83 {
84 Map<String, Object> model = new HashMap<>( );
85 model.put( Markers.MARK_PORTLET, portlet );
86 model.put( Markers.MARK_PLUGIN_NAME, strPluginName );
87 model.put( Markers.MARK_IS_MODULE, isModule );
88
89 return build( model );
90 }
91 }