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.BusinessClass;
37 import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
38 import fr.paris.lutece.plugins.pluginwizard.service.ModelService;
39
40 import java.util.Collection;
41 import java.util.HashMap;
42 import java.util.Map;
43
44 /**
45 *
46 * The rest swagger file generator
47 *
48 */
49 public class RestSwaggerGenerator extends AbstractGenerator
50 {
51 private static final String PATH = "src/java/fr/paris/lutece/plugins/{plugin_name}/rs/";
52 private static final String SWAGGER_REST = "SwaggerRest.java";
53
54 /**
55 * {@inheritDoc }
56 *
57 * @param pm
58 */
59 @Override
60 public Map generate( PluginModel pm, String generationSchemeName )
61 {
62 HashMap map = new HashMap( );
63
64 Collection<BusinessClass> listBusinessClasses = ModelService.getBusinessClassesByRest( pm );
65
66 if ( !listBusinessClasses.isEmpty( ) )
67 {
68 String strPath = getFilePath( pm, PATH, SWAGGER_REST );
69 String strSourceCode = getPage( pm );
70 map.put( strPath, strSourceCode );
71 }
72
73 return map;
74 }
75
76 /**
77 * Generates the Rest code
78 *
79 * @param pm
80 * The plugin model
81 * @param businessClasses
82 * the collection of business classes
83 * @return The code of the Rest generated
84 */
85 private String getPage( PluginModel pm )
86 {
87 Map<String, Object> model = getModel( pm );
88 model.put( Markers.MARK_PLUGIN, pm );
89
90 return build( model );
91 }
92 }