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 fr.paris.lutece.portal.service.util.AppLogService;
37  
38  import java.io.IOException;
39  
40  import javax.servlet.Servlet;
41  import javax.servlet.ServletConfig;
42  import javax.servlet.ServletException;
43  import javax.servlet.ServletRequest;
44  import javax.servlet.ServletResponse;
45  import javax.servlet.http.HttpServletRequest;
46  import javax.servlet.http.HttpServletResponse;
47  
48  
49  /**
50   * MainServlet
51   */
52  public class MainServlet implements Servlet
53  {
54      /**
55       * {@inheritDoc}
56       */
57      @Override
58      public void init( ServletConfig config ) throws ServletException
59      {
60      }
61  
62      /**
63       * {@inheritDoc}
64       */
65      @Override
66      public void service( ServletRequest requestServlet, ServletResponse responseServlet )
67          throws ServletException, IOException
68      {
69          AppLogService.debug( "MainServlet : service()" );
70  
71          HttpServletRequest request = (HttpServletRequest) requestServlet;
72          HttpServletResponse response = (HttpServletResponse) responseServlet;
73  
74          for ( LuteceServlet servlet : ServletService.getInstance(  ).getServlets(  ) )
75          {
76              AppLogService.debug( "PluginServlet : " + servlet.getName(  ) + " - url pattern : " +
77                  servlet.getMappingUrlPattern(  ) );
78  
79              try
80              {
81                  // Checks mapping and plugin status
82                  if ( matchMapping( servlet, request ) && servlet.getPlugin(  ).isInstalled(  ) )
83                  {
84                      servlet.getServlet(  ).service( request, response );
85                  }
86              }
87              catch ( Exception e )
88              {
89                  AppLogService.error( "Error execution 'service' method - Servlet " + servlet.getName(  ), e );
90              }
91          }
92      }
93  
94      /**
95       * {@inheritDoc}
96       */
97      @Override
98      public void destroy(  )
99      {
100         for ( LuteceServlet servlet : ServletService.getInstance(  ).getServlets(  ) )
101         {
102             // Catch exception for each servlet to execute all chain
103             try
104             {
105                 // Checks mapping and plugin status
106                 if ( servlet.getPlugin(  ).isInstalled(  ) )
107                 {
108                     servlet.getServlet(  ).destroy(  );
109                 }
110             }
111             catch ( Exception e )
112             {
113                 AppLogService.error( "Error execution destroy() method - Servlet " + servlet.getName(  ), e );
114             }
115         }
116     }
117 
118     /**
119      * Check the mapping of the request with an url pattern
120      * @param servlet The servlet
121      * @param request The request
122      * @return True if the request match the url pattern
123      */
124     private boolean matchMapping( LuteceServlet servlet, HttpServletRequest request )
125     {
126         return matchUrl( servlet.getMappingUrlPattern(  ), request.getServletPath(  ) + request.getPathInfo(  ) );
127     }
128 
129     /**
130      * Check the mapping of the request with an url pattern according servlet
131      * specifications 2.3 rules
132      * @param strUrlPattern The servlet url pattern
133      * @param strRequestUrl The request Url
134      * @return True if the request match the url pattern
135      *
136      * Algorithm comming from tomcat6
137      */
138     private boolean matchUrl( String strUrlPattern, String strRequestUrl )
139     {
140         return strRequestUrl.startsWith( strUrlPattern );
141     }
142 
143     /**
144      * {@inheritDoc}
145      */
146     @Override
147     public ServletConfig getServletConfig(  )
148     {
149         throw new UnsupportedOperationException( "Not supported yet." );
150     }
151 
152     /**
153      * {@inheritDoc}
154      */
155     @Override
156     public String getServletInfo(  )
157     {
158         throw new UnsupportedOperationException( "Not supported yet." );
159     }
160 }