RequestProcessor


1   /*
2    * $Header: /cvsroot/mvnforum/mvnforum/src/com/mvnforum/RequestProcessor.java,v 1.5 2006/04/14 17:05:25 minhnn Exp $
3    * $Author: minhnn $
4    * $Revision: 1.5 $
5    * $Date: 2006/04/14 17:05:25 $
6    *
7    * ====================================================================
8    *
9    * Copyright (C) 2002-2006 by MyVietnam.net
10   *
11   * All copyright notices regarding mvnForum MUST remain 
12   * intact in the scripts and in the outputted HTML.
13   * The "powered by" text/logo with a link back to
14   * http://www.mvnForum.com and http://www.MyVietnam.net in 
15   * the footer of the pages MUST remain visible when the pages
16   * are viewed on the internet or intranet.
17   *
18   * This program is free software; you can redistribute it and/or modify
19   * it under the terms of the GNU General Public License as published by
20   * the Free Software Foundation; either version 2 of the License, or
21   * any later version.
22   *
23   * This program is distributed in the hope that it will be useful,
24   * but WITHOUT ANY WARRANTY; without even the implied warranty of
25   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26   * GNU General Public License for more details.
27   *
28   * You should have received a copy of the GNU General Public License
29   * along with this program; if not, write to the Free Software
30   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
31   *
32   * Support can be obtained from support forums at:
33   * http://www.mvnForum.com/mvnforum/index
34   *
35   * Correspondence and Marketing Questions can be sent to:
36   * info at MyVietnam net
37   *
38   * @author: Luis Miguel Hernanz 
39   * @author: Minh Nguyen  
40   */
41  package com.mvnforum;
42  
43  import javax.servlet.http.HttpServletRequest  ;
44  import javax.servlet.http.HttpServletResponse  ;
45  
46  /**
47   * Interface to hook additional preprocessing to the user request.
48   * This interface is meatn as extension points to ease the integration
49   * of the forum system with external systems.
50   *
51   * @author <a HREF="luish@germinus.com">Luis Miguel Hernanz</a>
52   * @version $Revision: 1.5 $
53   */
54  public interface RequestProcessor {
55  
56      /**
57       * This is the first method called in the request processing.
58       *
59       * @param request a <code>HttpServletRequest</code> value
60       * @param response a <code>HttpServletResponse</code> value
61       * @return the new responseURI to redirect to. The control will be
62       * forwarded to this page (if responseURI is an jsp). No furher
63       * processing will take place.
64       */
65      public String   preLogin(HttpServletRequest   request, HttpServletResponse   response);
66  
67      /**
68       * The method receives teh user request just before the
69       * authentication has been checked.
70       *
71       * @param request a <code>HttpServletRequest</code> value
72       * @param response a <code>HttpServletResponse</code> value
73       * @return the new responseURI to redirect to.
74       */
75      public String   preProcess(HttpServletRequest   request, HttpServletResponse   response);
76  
77      /**
78       * This method is called just before the call to the final request
79       * dispatcher forward.
80       *
81       * @param request a <code>HttpServletRequest</code> value
82       * @param response a <code>HttpServletResponse</code> value
83       * @param responseURI the path to which the control will be
84       * forwarded after this method has finished.
85       * @return the new responseURI to redirect to.
86       */
87      public String   postProcess(HttpServletRequest   request, HttpServletResponse   response, String   responseURI);
88  
89  }
90
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags