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.service.servlet;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  import java.util.Map;
39  
40  import javax.servlet.Servlet;
41  
42  /**
43   * LuteceServlet
44   */
45  public class LuteceServlet
46  {
47      private String _strName;
48      private Servlet _servlet;
49      private String _strMapping;
50      private Plugin _plugin;
51      private Map<String, String> _mapInitParameters;
52  
53      /**
54       * Constructor
55       * 
56       * @param strName
57       *            The name
58       * @param servlet
59       *            The servlet class
60       * @param strMapping
61       *            The mapping url pattern
62       * @param plugin
63       *            The plugin
64       * @param mapInitParameters
65       *            Init parameters as a map
66       */
67      public LuteceServlet( String strName, Servlet servlet, String strMapping, Plugin plugin, Map<String, String> mapInitParameters )
68      {
69          _strName = strName;
70          _servlet = servlet;
71          _strMapping = strMapping;
72          _plugin = plugin;
73          _mapInitParameters = mapInitParameters;
74      }
75  
76      /**
77       * Returns the Name
78       *
79       * @return The Name
80       */
81      public String getName( )
82      {
83          return _strName;
84      }
85  
86      /**
87       * Returns the servlet
88       *
89       * @return The servlet
90       */
91      public Servlet getServlet( )
92      {
93          return _servlet;
94      }
95  
96      /**
97       * Returns the Mapping
98       *
99       * @return The Mapping
100      */
101     public String getMappingUrlPattern( )
102     {
103         return _strMapping;
104     }
105 
106     /**
107      * Returns the Plugin
108      *
109      * @return The Plugin
110      */
111     public Plugin getPlugin( )
112     {
113         return _plugin;
114     }
115 
116     /**
117      * Returns init parameters
118      * 
119      * @return Init parameters in a map object
120      */
121     public Map<String, String> getInitParameters( )
122     {
123         return _mapInitParameters;
124     }
125 
126     /**
127      * for debug purpose
128      * 
129      * @return The name of the servlet
130      */
131     @Override
132     public String toString( )
133     {
134         return getName( );
135     }
136 }