Java Web Services via REST bereitstellen
view | history | commit | commitdiff
ulrich
2014-11-16 ac059cdc92b9b9cbfc47850dded547dd2f206325
commit | author | age
ca8e1e 1 /*
U 2     Transit - Remote procedure calls made simple
3     Copyright (c) 2012  Ulrich Hilger
4
5     This program is free software: you can redistribute it and/or modify
6     it under the terms of the GNU Affero General Public License as published by
7     the Free Software Foundation, either version 3 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU Affero General Public License for more details.
14
15     You should have received a copy of the GNU Affero General Public License
16     along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 package de.uhilger.transit.web;
20
21 import javax.servlet.*;
22
23 import javax.servlet.http.*;
24
25 import java.io.*;
26
27 import java.util.*;
28 import java.util.logging.*;
29
30 import de.uhilger.transit.*;
31
32 /**
33  * Das TransitServlet macht beliebige Klassen und Methoden 
34  * ueber HTTP zugaenglich. 
35  * 
36  * <p><b>Achtung:</b>Das TransitServlet sollte nur in einem 
37  * per Authentifizierung und Autorisierung geschuetzten 
38  * Bereich einer Webanwendung bereitgestellt werden da andernfalls 
39  * durchweg alle Klassen und Methoden, die sich auf dem Server 
40  * finden, zugaenglich werden.</p>
41  * 
42  * <p>Fuer die Bereitstellung von Funktionen ist eine Berechtigungspruefung  
43  * noetig, die am besten in Form eines Filters implementiert wird.</p>
44  * 
45  * @author Copyright (c) Ulrich Hilger, http://uhilger.de
46  * @author Published under the terms and conditions of
47  * the <a href="http://www.gnu.org/licenses/agpl-3.0" target="_blank">GNU Affero General Public License</a>
48  * 
49  * @version 1, September 16, 2012
50  */
1da1ca 51 public class TransitServletRS extends AbstractServlet {
ca8e1e 52
U 53   /** Proforma Konstante fuer Schnittstelle Serializable */
54   public static final long serialVersionUID = 42L;
55   
56   private static final Logger logger = Logger.getLogger(TransitServletRS.class.getName());
1da1ca 57     
ca8e1e 58   /**
U 59    * Eine Anfrage via HTTP GET verarbeiten
60    * 
61    * <p>Folgende Parameter werden erwartet:</p>
62    * <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
63    * m: Methode<br>
64    * p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
65    * p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
66    *  .<br>
67    *  .<br>
68    * p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
69    * 
70    * <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im 
71    * Format der JavaScript Object Notation (JSON) in die Antwort der 
72    * HTTP-Anfrage geschrieben.</p>
73    * 
74    * @param req die Anfrage, die verarbeitet werden soll
75    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
76    */
77   @Override
78   protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
79     anfrageAusfuehren(req, resp);
80   }
81   
82   /**
83    * Eine Anfrage via HTTP POST verarbeiten
84    * 
85    * <p>Folgende Parameter werden erwartet:</p>
86    * <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
87    * m: Methode<br>
88    * p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
89    * p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
90    *  .<br>
91    *  .<br>
92    * p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
93    * 
94    * <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im 
95    * Format der JavaScript Object Notation (JSON) in die Antwort der 
96    * HTTP-Anfrage geschrieben.</p>
97    * 
98    * @param req die Anfrage, die verarbeitet werden soll
99    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
100    */
101   @Override
102   protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
103     anfrageAusfuehren(req, resp);
104   }
105   
106   /**
107    * Diese Methode verarbeitet die Anfragen, die via HTTP GET und HTTP POST 
108    * an dieses Servlet gestellt werden.
109    * 
110    * @param req die Anfrage, die verarbeitet werden soll
111    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
112    */
113   @SuppressWarnings("unchecked")
114   public void anfrageAusfuehren(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
115     JavaServer server = null;
116     try {
117       /*
118         http://server:port/contextpfad/servletpfad/de.irgend.eine.Klasse/methode/format/param1/param2/../paramN
119         wird zu
120         elemente[0] = /
121         elemente[1] = de.irgend.eine.Klasse
122         elemente[2] = methode
123         elemente[3] = format
1da1ca 124         elemente[4]-[n] = param1 - paramn
ca8e1e 125       */
U 126       
127       String pathInfo = req.getPathInfo();
1da1ca 128       logger.log(Level.INFO, "pathInfo: {0}", pathInfo); 
ca8e1e 129       String[] elemente = pathInfo.split("/");
U 130       String klassenName = elemente[1];
1da1ca 131       StringBuilder buf = new StringBuilder();
84429d 132       if(istErlaubt(klassenName)) {
ca8e1e 133         String methodenName = elemente[2];
U 134         String formatName = elemente[3];
135         List parameterListe = new ArrayList();
136         for(int i = 4; i < elemente.length; i++) {
137           parameterListe.add(elemente[i]);
138         }
139         
140         Object[] parameter = parameterListe.toArray(new Object[0]);
141   
142         server = new JavaServer();
143         server.wandlerHinzufuegen(new JsonWandler());
144         server.wandlerHinzufuegen(new JsonFlatWandler());
145         server.wandlerHinzufuegen(new XmlWandler());
146         Class cls = server.klasseFinden(klassenName);
147         if(cls != null) {
148           Object o = cls.newInstance();
149           if(o != null) {
150             if(o instanceof NutzerKontext) {
1da1ca 151               ((NutzerKontext) o).setNutzerId(getUserName(req));
ca8e1e 152             }
U 153             if(o instanceof WebKontext) {
154               ((WebKontext) o).setServletContext(getServletContext());
155             }
156             if(o instanceof RequestKontext) {
157               ((RequestKontext) o).setRequest(req);
158             }
159             if(o instanceof VerbindungsKontext) {
160               ((VerbindungsKontext) o).setVerbindung(req.getSession());
161             }
162           }
163           Object resultat = null;
164           if(formatName != null) {
165             resultat = server.methodeAusfuehren(o, methodenName, formatName, parameter);
166           } else {
167             resultat = server.methodeAusfuehren(o, methodenName, JsonWandler.FORMAT_JSON, parameter);
168           }
169           if(resultat != null) {
170             if(formatName == null) {
171               resp.setContentType(MIME_JSON);
172             } else {
173               if(formatName.equalsIgnoreCase(JsonWandler.FORMAT_JSON) || formatName.equalsIgnoreCase(JsonFlatWandler.FORMAT_FLATJSON)) {
174                 resp.setContentType(MIME_JSON);
175               } else if(formatName.equalsIgnoreCase(XmlWandler.FORMAT_XML)) {
176                 resp.setContentType(MIME_XML);
177               }
178             }
179             buf.append(escapeHtml(resultat.toString()));
180           } else {
181             buf.append("<p>Resultat von server.methodeAusfuehren ist null.</p>");
182           }
183         } else {
184           buf.append("<p>Ergebnis von server.klasseFinden ist null (Klasse nicht gefunden?).</p>");
185         }
186       } else {
187         buf.append("<p>Klasse " + klassenName + " nicht erlaubt.</p>");
188       }
189       Writer w = resp.getWriter();
190       w.write(buf.toString());
191       w.flush();
192       w.close();
193     } catch(Exception ex) {
194       throw new ServletException(ex);
195     } finally {
196       if(server != null) {
197         server.aufloesen();
198         server = null;
199       }
200     }
201   }    
84429d 202   
ca8e1e 203 }