6 import javax.servlet.http.*;
7 import freemarker.template.*;
9 import mir.servlet.ServletModuleException;
17 * Abstract class ServletModule provides the base functionality for servlets.
18 * Deriving a class from ServletModule enables class to insert/edit/update/delete
19 * and list Entity from a Database via mainModule.
22 * Abstrakte Klasse ServletModule stellt die Basisfunktionalitaet der
23 * abgeleiteten ServletModule zur Verfügung.
29 public abstract class ServletModule {
31 public String defaultAction;
32 protected Logfile theLog;
33 protected AbstractModule mainModule;
34 protected String templateListString;
35 protected String templateObjektString;
36 protected String templateConfirmString;
39 * Singelton - Methode muss in den abgeleiteten Klassen ueberschrieben werden.
40 * @return ServletModule
42 public static ServletModule getInstance() { return null; }
45 * get the session binded language
47 public String getLanguage(HttpServletRequest req){
48 HttpSession session = req.getSession(false);
49 String language = (String)session.getAttribute("Language");
51 language=MirConfig.getProp("StandardLanguage");
56 // ACHTUNG DEPRECATED::::
57 public void process(HttpServletRequest req, HttpServletResponse res) throws ServletModuleException {}
62 * list(req,res) - generische Listmethode. Wennn die Funktionalitaet
63 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
64 * ueberschreiben werden.
66 * @param req Http-Request, das vom Dispatcher durchgereicht wird
67 * @param res Http-Response, die vom Dispatcher durchgereicht wird
69 public void list(HttpServletRequest req, HttpServletResponse res)
70 throws ServletModuleException {
73 String offsetParam = req.getParameter("offset");
75 PrintWriter out = res.getWriter();
77 // hier offsetcode bearbeiten
78 if (offsetParam != null && !offsetParam.equals("")){
79 offset = Integer.parseInt(offsetParam);
81 if (req.getParameter("next") != null){
82 offset=Integer.parseInt(req.getParameter("nextoffset"));
84 if (req.getParameter("prev") != null){
85 offset = Integer.parseInt(req.getParameter("prevoffset"));
88 theList = mainModule.getByWhereClause(null, offset);
89 //theList = mainModule.getByWhereClause((String)null, offset);
90 if (theList == null || theList.getCount() == 0 || theList.getCount()>1){
91 HTMLTemplateProcessor.process(res,getLanguage(req)+"/"+templateListString, theList, out,req.getLocale());
93 deliver(req, res, theList.elementAt(0), templateObjektString);
95 } catch (Exception e) {
96 throw new ServletModuleException(e.toString());
101 * add(req,res) - generische Addmethode. Wennn die Funktionalitaet
102 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
103 * ueberschreiben werden.
104 * @param req Http-Request, das vom Dispatcher durchgereicht wird
105 * @param res Http-Response, die vom Dispatcher durchgereicht wird
107 public void add(HttpServletRequest req, HttpServletResponse res)
108 throws ServletModuleException {
111 SimpleHash mergeData = new SimpleHash();
112 mergeData.put("new", "1");
113 deliver(req, res, mergeData, templateObjektString);
114 } catch (Exception e) {
115 throw new ServletModuleException(e.toString());
120 * insert(req,res) - generische Insertmethode, folgt auf add.
121 * Wennn die Funktionalitaet
122 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
123 * ueberschreiben werden.
125 * @param req Http-Request, das vom Dispatcher durchgereicht wird
126 * @param res Http-Response, die vom Dispatcher durchgereicht wird
128 public void insert(HttpServletRequest req, HttpServletResponse res)
129 throws ServletModuleException, ServletModuleUserException {
131 HashMap withValues = getIntersectingValues(req, mainModule.getStorageObject());
132 String id = mainModule.add(withValues);
133 // theLog.printDebugInfo("--trying to deliver..."+id);
135 //deliver(req, res, mainModule.getById(id), templateObjektString);
136 } catch (Exception e) {
137 throw new ServletModuleException(e.toString());
142 * delete(req,res) - generische Deletemethode. Wennn die Funktionalitaet
143 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
144 * ueberschreiben werden.
146 * @param req Http-Request, das vom Dispatcher durchgereicht wird
147 * @param res Http-Response, die vom Dispatcher durchgereicht wird
150 public void delete(HttpServletRequest req, HttpServletResponse res)
151 throws ServletModuleException
154 String idParam = req.getParameter("id");
155 if (idParam == null) throw new ServletModuleException("Falscher Aufruf: (id) nicht angegeben");
156 // Hier code zum Loeschen
157 String confirmParam = req.getParameter("confirm");
158 String cancelParam = req.getParameter("cancel");
159 if (confirmParam == null && cancelParam == null) {
160 // HTML Ausgabe zum Confirmen!
161 SimpleHash mergeData = new SimpleHash();
162 String moduleClassName = mainModule.getClass().getName();
163 int i = moduleClassName.indexOf(".Module");
164 String moduleName = moduleClassName.substring(i+7);
165 mergeData.put("module", moduleName);
166 mergeData.put("infoString", moduleName + ": " + idParam);
167 mergeData.put("id", idParam);
168 mergeData.put("where", req.getParameter("where"));
169 mergeData.put("order", req.getParameter("order"));
170 mergeData.put("offset", req.getParameter("offset"));
171 deliver(req, res, mergeData,templateConfirmString);
173 if (confirmParam!= null && !confirmParam.equals("")) {
174 //theLog.printInfo("delete confirmed!");
175 mainModule.deleteById(idParam);
176 list(req,res); // back to list
178 if (req.getParameter("where") != null)
184 } catch (Exception e) {
185 throw new ServletModuleException(e.toString());
190 * edit(req,res) - generische Editmethode. Wennn die Funktionalitaet
191 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
192 * ueberschreiben werden.
194 * @param req Http-Request, das vom Dispatcher durchgereicht wird
195 * @param res Http-Response, die vom Dispatcher durchgereicht wird
197 public void edit(HttpServletRequest req, HttpServletResponse res)
198 throws ServletModuleException {
200 String idParam = req.getParameter("id");
201 deliver(req, res, mainModule.getById(idParam), templateObjektString);
202 } catch(ModuleException e) {
203 throw new ServletModuleException(e.toString());
208 * update(req,res) - generische Updatemethode. Wennn die Funktionalitaet
209 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
210 * ueberschreiben werden.
212 * @param req Http-Request, das vom Dispatcher durchgereicht wird
213 * @param res Http-Response, die vom Dispatcher durchgereicht wird
216 public void update(HttpServletRequest req, HttpServletResponse res)
217 throws ServletModuleException {
219 String idParam = req.getParameter("id");
220 HashMap withValues = getIntersectingValues(req, mainModule.getStorageObject());
221 String id = mainModule.set(withValues);
222 //theLog.printInfo("Showing Entity with id: " + id);
224 String whereParam = req.getParameter("where");
225 String orderParam = req.getParameter("order");
226 if ((whereParam!=null && !whereParam.equals("")) || (orderParam!=null && !orderParam.equals(""))){
227 //theLog.printDebugInfo("update to list");
233 } catch (Exception e) {
234 throw new ServletModuleException(e.toString());
240 public void predeliver(HttpServletResponse res, TemplateModelRoot rtm, String tmpl)
241 throws ServletModuleException {
243 PrintWriter out = new LineFilterWriter(res.getWriter());
244 StringWriter a = new StringWriter();
245 deliver(new PrintWriter(a),rtm,tmpl);
246 out.write(a.toString());
248 } catch (Exception e) {
249 e.printStackTrace();System.err.println(e.toString());
255 * deliver liefert das Template mit dem Filenamen templateFilename
256 * an den HttpServletResponse res aus, nachdem es mit den Daten aus
257 * TemplateModelRoot rtm gemischt wurde
259 * @param res Http-Response, die vom Dispatcher durchgereicht wird
260 * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
261 * Daten, die ins Template gemerged werden sollen.
262 * @param tmpl Name des Templates
263 * @exception ServletModuleException
265 public void deliver(HttpServletRequest req, HttpServletResponse res, TemplateModelRoot rtm, String templateFilename)
266 throws ServletModuleException {
267 if (rtm == null) rtm = new SimpleHash();
269 //PrintWriter out = new LineFilterWriter(res.getWriter());
270 PrintWriter out = res.getWriter();
271 HTMLTemplateProcessor.process(res,getLanguage(req)+"/"+templateFilename, rtm , out, req.getLocale());
273 } catch (HTMLParseException e) {
274 throw new ServletModuleException(e.toString());
275 } catch (IOException e) {
276 throw new ServletModuleException(e.toString());
280 * deliver liefert das Template mit dem Filenamen templateFilename
281 * an den HttpServletResponse res aus, nachdem es mit den Daten aus
282 * TemplateModelRoot rtm gemischt wurde
284 * @param res Http-Response, die vom Dispatcher durchgereicht wird
285 * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
286 * Daten, die ins Template gemerged werden sollen.
287 * @param tmpl Name des Templates
288 * @exception ServletModuleException
290 public void deliver_compressed(HttpServletRequest req, HttpServletResponse res, TemplateModelRoot rtm, String templateFilename)
291 throws ServletModuleException {
292 if (rtm == null) rtm = new SimpleHash();
294 PrintWriter out = new LineFilterWriter(res.getWriter());
295 //PrintWriter out = res.getWriter();
296 HTMLTemplateProcessor.process(res,getLanguage(req)+"/"+templateFilename, rtm , out, req.getLocale());
298 } catch (HTMLParseException e) {
299 throw new ServletModuleException(e.toString());
300 } catch (IOException e) {
301 throw new ServletModuleException(e.toString());
306 * deliver liefert das Template mit dem Filenamen templateFilename
307 * an den HttpServletResponse res aus, nachdem es mit den Daten aus
308 * TemplateModelRoot rtm gemischt wurde
310 * @param out ist der OutputStream, in den die gergten Daten geschickt werden sollen.
311 * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
312 * Daten, die ins Template gemerged werden sollen.
313 * @param tmpl Name des Templates
314 * @exception ServletModuleException
316 private void deliver(HttpServletResponse res,HttpServletRequest req, PrintWriter out, TemplateModelRoot rtm, String templateFilename)
317 throws HTMLParseException {
318 HTMLTemplateProcessor.process(res,getLanguage(req)+"/"+templateFilename, rtm , out, req.getLocale());
322 * Wenn die abgeleitete Klasse diese Methode ueberschreibt und einen String mit einem
323 * Methodennamen zurueckliefert, dann wird diese Methode bei fehlender Angabe des
324 * doParameters ausgefuehrt.
326 * @return Name der Default-Action
328 public String defaultAction() { return defaultAction; }
331 * Hier kann vor der Datenaufbereitung schon mal ein response geschickt
332 * werden (um das subjektive Antwortverhalten bei langsamen Verbindungen
335 public void predeliver(HttpServletRequest req, HttpServletResponse res) { ; }
338 * Holt die Felder aus der Metadatenfelderliste des StorageObjects, die
339 * im HttpRequest vorkommen und liefert sie als HashMap zurueck
341 * @return HashMap mit den Werten
343 public HashMap getIntersectingValues(HttpServletRequest req, StorageObject theStorage)
344 throws ServletModuleException {
345 ArrayList theFieldList;
347 theFieldList = theStorage.getFields();
348 } catch (StorageObjectException e) {
349 throw new ServletModuleException("ServletModule.getIntersectingValues: " + e.toString());
352 HashMap withValues = new HashMap();
353 String aField, aValue;
355 for(int i=0; i<theFieldList.size();i++) {
356 aField = (String)theFieldList.get(i);
357 aValue = req.getParameter(aField);
358 if (aValue!=null) withValues.put(aField,aValue);