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