Mir goes GPL
[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.*;
35 import  javax.servlet.http.*;
36 import  mir.servlet.ServletModuleException;
37 import  mir.misc.*;
38
39
40 /**
41  * Dispatcher, calls the method passed to ServletModule Class, through the "do"
42  * Parameter (via POST or GET)
43  *
44  * @version $Id: ServletModuleDispatch.java,v 1.7 2002/09/01 22:05:52 mh Exp $
45  *
46  * @Author rk
47  *
48  */
49 public final class ServletModuleDispatch {
50
51         private static Logfile theLog;
52         private static final    Class[] SIGNATURE =
53                                                                                                                 { HttpServletRequest.class, HttpServletResponse.class };
54
55
56         static {
57                 theLog = Logfile.getInstance("/tmp/smod.dispatch");
58         }
59
60         /**
61          * privater Konstruktor, um versehentliche Instantiierung zu verhindern
62          */
63         private ServletModuleDispatch () {
64         }
65
66         /**
67          *  Die Dispatch-Routine ruft das von dem Hauptservlet kommende ServletModule
68          *  mit dem per HttpServletRequest angegebenen Paramter <code>do</code> auf.
69          *  Ist kein Parameter angegeben, so wird versucht, in die <code>defaultAction</code>
70          *  des ServletModules zu springen.
71          *
72          * @param req Http-Request, das vom Dispatcher an die Methode des
73          *    ServletModules durchgereicht wird
74          * @param res Http-Response, die vom Dispatcher an die Methode des
75          *    ServletModules durchgereicht wird
76          * @param sMod ServletModule, an das dispatched wird.
77          * @param mod Name des Modules als String (für Logfile)
78          */
79
80         public static void dispatch(ServletModule sMod, HttpServletRequest req,
81                 HttpServletResponse res) throws ServletModuleException, ServletModuleUserException
82         {
83                         //sMod.predeliver(req,res);
84
85                         String doParam = req.getParameter("do");
86                         theLog.printInfo("SerletModuleDispatch: " + sMod.toString() + " with method " + doParam);
87                         if (doParam == null) {
88                                 if (sMod.defaultAction() != null) doParam = sMod.defaultAction();
89                                 else throw new ServletModuleException("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 theLog.printDebugInfo("method lookup unsuccesful");
99                         }
100                         catch ( NoSuchMethodException e) { throw new ServletModuleException("no such method!" + e.toString());}
101                         catch ( SecurityException e) { throw new ServletModuleException("method not allowed!" + e.toString());}
102                         catch ( InvocationTargetException e) {
103                                 if (e.getTargetException().getClass().getName().equals("mir.servlet.ServletModuleUserException")) {
104                                                 throw new ServletModuleUserException(((ServletModuleUserException)e.getTargetException()).getMsg());
105                                 } else {
106                                                 e.printStackTrace();
107                                                 throw new ServletModuleException(e.getTargetException().toString());
108                                 }
109                         }
110                         catch ( IllegalAccessException e) { throw new ServletModuleException("illegal method not allowed!" + e.toString());}
111
112                         //hopefully we don't get here ...
113                         throw new ServletModuleException("delivery failed! -- ");
114         }
115 }