ServletModule exception cleanup + different error templates for admin + open postings...
[mir.git] / source / mir / servlet / ServletModuleDispatch.java
1 /*
2  * Copyright (C) 2001, 2002  The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with the com.oreilly.servlet library, any library
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
24  * the above that use the same license as the above), and distribute linked
25  * combinations including the two.  You must obey the GNU General Public
26  * License in all respects for all of the code used other than the above
27  * mentioned libraries.  If you modify this file, you may extend this exception
28  * to your version of the file, but you are not obligated to do so.  If you do
29  * not wish to do so, delete this exception statement from your version.
30  */
31
32 package  mir.servlet;
33
34 import java.lang.reflect.InvocationTargetException;
35 import java.lang.reflect.Method;
36
37 import javax.servlet.http.HttpServletRequest;
38 import javax.servlet.http.HttpServletResponse;
39
40 import mir.log.LoggerWrapper;
41
42
43 /**
44  * Dispatcher, calls the method passed to ServletModule Class, through the "do"
45  * Parameter (via POST or GET)
46  *
47  * @version $Id: ServletModuleDispatch.java,v 1.13 2003/03/06 05:40:39 zapata Exp $
48  *
49  * @Author rk
50  *
51  */
52 public final class ServletModuleDispatch {
53
54   private static LoggerWrapper logger = new LoggerWrapper("ServletModule.Dispatch");
55   private static final Class[] SIGNATURE = { HttpServletRequest.class, HttpServletResponse.class };
56
57  /**
58   * private constructor to prevent unwanted instantiation;
59   */
60
61   private ServletModuleDispatch () {
62   }
63
64         /**
65          *  Die Dispatch-Routine ruft das von dem Hauptservlet kommende ServletModule
66          *  mit dem per HttpServletRequest angegebenen Paramter <code>do</code> auf.
67          *  Ist kein Parameter angegeben, so wird versucht, in die <code>defaultAction</code>
68          *  des ServletModules zu springen.
69          *
70          * @param req Http-Request, das vom Dispatcher an die Methode des
71          *    ServletModules durchgereicht wird
72          * @param res Http-Response, die vom Dispatcher an die Methode des
73          *    ServletModules durchgereicht wird
74          * @param sMod ServletModule, an das dispatched wird.
75          * @param mod Name des Modules als String (f?r Logfile)
76          */
77
78   public static void dispatch(ServletModule sMod, HttpServletRequest req,
79           HttpServletResponse res) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure
80   {
81     //sMod.predeliver(req,res);
82
83     String doParam = req.getParameter("do");
84     logger.info("ServletModuleDispatch: " + sMod.toString() + " with method " + doParam);
85     if (doParam == null) {
86       if (sMod.defaultAction() != null)
87         doParam = sMod.defaultAction();
88       else
89         throw new ServletModuleExc("no parameter do supplied!");
90     }
91
92     try {
93       Method method = sMod.getClass().getMethod(doParam,SIGNATURE);
94       if (method != null) {
95         method.invoke(sMod,new Object[] {req,res} );
96         return;
97       }
98       else logger.debug("method lookup unsuccesful");
99     }
100     catch ( NoSuchMethodException e) {
101       throw new ServletModuleFailure("no such method '"+doParam+"' (" + e.getMessage() + ")", e);
102     }
103     catch ( SecurityException e) {
104       throw new ServletModuleFailure("method not allowed!" + e.getMessage(), e);
105     }
106     catch ( InvocationTargetException e) {
107       logger.debug( "invocation target exception: " + e.getMessage());
108
109       throw new ServletModuleFailure(e.getTargetException().getMessage(), e.getTargetException());
110     }
111     catch ( IllegalAccessException e) {
112       throw new ServletModuleFailure("illegal method not allowed!" + e.getMessage(), e);
113     }
114     catch (Throwable t) {
115       throw new ServletModuleFailure(t);
116     }
117   }
118 }