ServletEntry.java

  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. import java.util.HashMap;
  36. import java.util.Map;

  37. /**
  38.  * Servlet Entry used to load servlet from the plugin XML file
  39.  *
  40.  * @since v 3.0
  41.  */
  42. public class ServletEntry
  43. {
  44.     private String _strName;
  45.     private String _strServletClass;
  46.     private String _strMapping;
  47.     private Map<String, String> _mapInitParameters = new HashMap<>( );

  48.     /**
  49.      * Returns the Name
  50.      *
  51.      * @return The Name
  52.      */
  53.     public String getName( )
  54.     {
  55.         return _strName;
  56.     }

  57.     /**
  58.      * Sets the Name
  59.      *
  60.      * @param strName
  61.      *            The Name
  62.      */
  63.     public void setName( String strName )
  64.     {
  65.         _strName = strName;
  66.     }

  67.     /**
  68.      * Returns the servlet
  69.      *
  70.      * @return The servlet
  71.      */
  72.     public String getServletClass( )
  73.     {
  74.         return _strServletClass;
  75.     }

  76.     /**
  77.      * Sets the servlet.
  78.      *
  79.      * @param strServletClass
  80.      *            the new servlet class
  81.      */
  82.     public void setServletClass( String strServletClass )
  83.     {
  84.         _strServletClass = strServletClass;
  85.     }

  86.     /**
  87.      * Returns the Mapping
  88.      *
  89.      * @return The Mapping
  90.      */
  91.     public String getMappingUrlPattern( )
  92.     {
  93.         return _strMapping;
  94.     }

  95.     /**
  96.      * Sets the Mapping
  97.      *
  98.      * @param strMapping
  99.      *            The Mapping
  100.      */
  101.     public void setMappingUrlPattern( String strMapping )
  102.     {
  103.         _strMapping = strMapping;
  104.     }

  105.     /**
  106.      * Add an init parameter
  107.      *
  108.      * @param strName
  109.      *            The parameter name
  110.      * @param strValue
  111.      *            The parameter value
  112.      */
  113.     public void addParameter( String strName, String strValue )
  114.     {
  115.         _mapInitParameters.put( strName, strValue );
  116.     }

  117.     /**
  118.      * Returns init parameters
  119.      *
  120.      * @return Init parameters in a map object
  121.      */
  122.     public Map<String, String> getInitParameters( )
  123.     {
  124.         return _mapInitParameters;
  125.     }
  126. }