View Javadoc

1   /**
2    * This file Copyright (c) 2008-2010 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.rssaggregator.servlet;
35  
36  import javax.servlet.ServletException;
37  import javax.servlet.http.HttpServlet;
38  import javax.servlet.http.HttpServletRequest;
39  import javax.servlet.http.HttpServletResponse;
40  import java.io.IOException;
41  
42  /**
43   * Convenience base servlet for simple request handling. As such provides a {@link #handleRequest(HttpServletRequest,
44   * HttpServletResponse) main entry point} for handling POST and GET requests.
45   *
46   * @author Rob van der Linden Vooren
47   * @deprecated since 1.0 use MVCServlet instead
48   */
49  public abstract class AbstractServlet extends HttpServlet {
50  
51      /**
52       * Delegate POST requests to {@link #processRequest}.
53       *
54       * @see #handleRequest
55       */
56      @Override
57      protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
58          processRequest(request, response);
59      }
60  
61      /**
62       * Delegate GET requests to {@link #processRequest}.
63       *
64       * @see #handleRequest
65       */
66      @Override
67      protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
68          processRequest(request, response);
69      }
70  
71      /**
72       * Delegates to template method {@link #handleRequest(HttpServletRequest, HttpServletResponse) handleRequest} which
73       * handles actual handling of the request. Additionaly wraps exceptions other than IOException and ServletException
74       * in a ServletException.
75       *
76       * @param request  the request to handle
77       * @param response the associated response
78       * @throws IOException      if an input or output error is detected when the servlet handles the request
79       * @throws ServletException if the request could not be handled
80       */
81      protected void processRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
82          try {
83              handleRequest(request, response);
84          } catch (ServletException se) {
85              throw se;
86          } catch (IOException ioe) {
87              throw ioe;
88          } catch (Throwable t) {
89              throw new ServletException("Failed to process request", t);
90          }
91      }
92  
93      /**
94       * Subclass need implement this method in order to handle the request.
95       *
96       * @param request  the request to handle
97       * @param response the associated response
98       * @throws Exception if an exception occurs during request handling
99       */
100     public abstract void handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
101 
102 }