View Javadoc
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.web.admin;
35  
36  import fr.paris.lutece.portal.service.admin.AccessDeniedException;
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  import fr.paris.lutece.portal.service.plugin.PluginService;
39  
40  import javax.servlet.http.HttpServletRequest;
41  
42  /**
43   * Provides generic methods for plugin jspBeans
44   */
45  public abstract class PluginAdminPageJspBean extends AdminFeaturesPageJspBean
46  {
47      private static final long serialVersionUID = 4578248013299079234L;
48  
49      // Parameters
50      private static final String PARAMETER_PLUGIN_NAME = "plugin_name";
51      private transient Plugin _plugin;
52  
53      /**
54       * Initialize the jspbean data Allows to set the feature url and feature title associated
55       * 
56       * @param request
57       *            the HTTP request
58       * @param strRight
59       *            The right
60       * @throws fr.paris.lutece.portal.service.admin.AccessDeniedException
61       *             Access denied exception
62       */
63      @Override
64      public void init( HttpServletRequest request, String strRight ) throws AccessDeniedException
65      {
66          super.init( request, strRight );
67  
68          // initialize the plugin
69          String strPluginName = request.getParameter( PARAMETER_PLUGIN_NAME );
70  
71          if ( strPluginName != null && ( _plugin == null || !_plugin.getName( ).equals( strPluginName ) ) )
72          {
73              _plugin = PluginService.getPlugin( strPluginName );
74          }
75  
76          // if no icon is provided for the feature, try to use the plugin's one
77          if ( ( _plugin != null ) && ( ( getFeatureIcon( ) == null ) || ( getFeatureIcon( ).equals( "" ) ) ) )
78          {
79              setFeatureIcon( _plugin.getIconUrl( ) );
80          }
81      }
82  
83      /**
84       * Returns the Plugin
85       *
86       * @return The Plugin
87       */
88      public Plugin getPlugin( )
89      {
90          return _plugin;
91      }
92  }