View Javadoc
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 java.util.HashMap;
37  import java.util.Map;
38  
39  
40  /**
41   * Servlet Entry used to load servlet from the plugin XML file
42   * @since v 3.0
43   */
44  public class ServletEntry
45  {
46      private String _strName;
47      private String _strServletClass;
48      private String _strMapping;
49      private Map<String, String> _mapInitParameters = new HashMap<String, String>(  );
50  
51      /**
52       * Returns the Name
53       *
54       * @return The Name
55       */
56      public String getName(  )
57      {
58          return _strName;
59      }
60  
61      /**
62       * Sets the Name
63       *
64       * @param strName The Name
65       */
66      public void setName( String strName )
67      {
68          _strName = strName;
69      }
70  
71      /**
72       * Returns the servlet
73       *
74       * @return The servlet
75       */
76      public String getServletClass(  )
77      {
78          return _strServletClass;
79      }
80  
81      /**
82       * Sets the servlet.
83       *
84       * @param strServletClass the new servlet class
85       */
86      public void setServletClass( String strServletClass )
87      {
88          _strServletClass = strServletClass;
89      }
90  
91      /**
92       * Returns the Mapping
93       *
94       * @return The Mapping
95       */
96      public String getMappingUrlPattern(  )
97      {
98          return _strMapping;
99      }
100 
101     /**
102      * Sets the Mapping
103      *
104      * @param strMapping The Mapping
105      */
106     public void setMappingUrlPattern( String strMapping )
107     {
108         _strMapping = strMapping;
109     }
110 
111     /**
112      * Add an init parameter
113      * @param strName The parameter name
114      * @param strValue The parameter value
115      */
116     public void addParameter( String strName, String strValue )
117     {
118         _mapInitParameters.put( strName, strValue );
119     }
120 
121     /**
122      * Returns init parameters
123      * @return Init parameters in a map object
124      */
125     public Map<String, String> getInitParameters(  )
126     {
127         return _mapInitParameters;
128     }
129 }