Java Web Services via REST bereitstellen
view | history | commit | commitdiff
ulrich
2014-11-16 84429d5d6f9a864bcc83d41b78646561ddec5ebf
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  */
51 public class TransitServletRS extends HttpServlet {
52
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());
57   
58   public static final String MIME_JSON = "application/json";
59   public static final String MIME_XML = "text/xml";
60   
61   private static final String[] specialChars = {new String("\u00c4"), new String("\u00d6"), 
62       new String("\u00dc"), new String("\u00e4"), new String("\u00f6"), new String("\u00fc"), new String("\u00df")};
63       
84429d 64   public static final String KLASSEN_TRENNER = ";";
U 65   //private String klassen;
66   private String[] klassen;
ca8e1e 67   
U 68   public void init(ServletConfig servletConfig) throws ServletException{
84429d 69     this.klassen = servletConfig.getInitParameter("klassen").split(KLASSEN_TRENNER);
ca8e1e 70     super.init(servletConfig);
U 71   }
72   
73   /**
74    * Eine Anfrage via HTTP GET verarbeiten
75    * 
76    * <p>Folgende Parameter werden erwartet:</p>
77    * <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
78    * m: Methode<br>
79    * p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
80    * p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
81    *  .<br>
82    *  .<br>
83    * p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
84    * 
85    * <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im 
86    * Format der JavaScript Object Notation (JSON) in die Antwort der 
87    * HTTP-Anfrage geschrieben.</p>
88    * 
89    * @param req die Anfrage, die verarbeitet werden soll
90    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
91    */
92   @Override
93   protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
94     anfrageAusfuehren(req, resp);
95   }
96   
97   /**
98    * Eine Anfrage via HTTP POST verarbeiten
99    * 
100    * <p>Folgende Parameter werden erwartet:</p>
101    * <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
102    * m: Methode<br>
103    * p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
104    * p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
105    *  .<br>
106    *  .<br>
107    * p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
108    * 
109    * <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im 
110    * Format der JavaScript Object Notation (JSON) in die Antwort der 
111    * HTTP-Anfrage geschrieben.</p>
112    * 
113    * @param req die Anfrage, die verarbeitet werden soll
114    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
115    */
116   @Override
117   protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
118     anfrageAusfuehren(req, resp);
119   }
120   
121   /**
122    * Diese Methode verarbeitet die Anfragen, die via HTTP GET und HTTP POST 
123    * an dieses Servlet gestellt werden.
124    * 
125    * @param req die Anfrage, die verarbeitet werden soll
126    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
127    */
128   @SuppressWarnings("unchecked")
129   public void anfrageAusfuehren(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
130     JavaServer server = null;
131     try {
132       /*
133       String klassenName = null;
134       String methodenName = null;
135       List parameterListe = new ArrayList();
136       String formatName = null;
137       Enumeration en = req.getParameterNames();
138       while(en.hasMoreElements()) {
139         String pName = en.nextElement().toString();
140         String[] pWerte = req.getParameterValues(pName);
141         if(pName.equals(CLASS_NAME)) {
142           klassenName = pWerte[0];
143         } else if(pName.equals(METHOD_NAME)) {
144           methodenName = pWerte[0];
145         } else if(pName.equals(FORMAT_NAME)) {
146           formatName = pWerte[0];
147         } else {
148           for(int i = 0; i < pWerte.length; i++) {      
149             parameterListe.add(pWerte[i]);
150           }
151         }
152       }
153       */
154       
155       /*
156         http://server:port/contextpfad/servletpfad/de.irgend.eine.Klasse/methode/format/param1/param2/../paramN
157         wird zu
158         elemente[0] = /
159         elemente[1] = de.irgend.eine.Klasse
160         elemente[2] = methode
161         elemente[3] = format
162         elemente[4]-[n] = param1
163       */
164       
165       String pathInfo = req.getPathInfo();
166       logger.info("pathInfo: " + pathInfo); 
167       String[] elemente = pathInfo.split("/");
168       String klassenName = elemente[1];
169       StringBuffer buf = new StringBuffer();
84429d 170       if(istErlaubt(klassenName)) {
U 171       //if(this.klassen.contains(klassenName)) {
172       //if(this.klassen.matches(klassenName)) {
ca8e1e 173         String methodenName = elemente[2];
U 174         String formatName = elemente[3];
175         List parameterListe = new ArrayList();
176         for(int i = 4; i < elemente.length; i++) {
177           parameterListe.add(elemente[i]);
178         }
179         
180         Object[] parameter = parameterListe.toArray(new Object[0]);
181   
182         server = new JavaServer();
183         server.wandlerHinzufuegen(new JsonWandler());
184         server.wandlerHinzufuegen(new JsonFlatWandler());
185         server.wandlerHinzufuegen(new XmlWandler());
186         Class cls = server.klasseFinden(klassenName);
187         if(cls != null) {
188           Object o = cls.newInstance();
189           if(o != null) {
190             if(o instanceof NutzerKontext) {
191               ((NutzerKontext) o).setNutzerId(Waechter.getUserName(req));
192             }
193             if(o instanceof WebKontext) {
194               ((WebKontext) o).setServletContext(getServletContext());
195             }
196             if(o instanceof RequestKontext) {
197               ((RequestKontext) o).setRequest(req);
198             }
199             if(o instanceof VerbindungsKontext) {
200               ((VerbindungsKontext) o).setVerbindung(req.getSession());
201             }
202           }
203           Object resultat = null;
204           if(formatName != null) {
205             resultat = server.methodeAusfuehren(o, methodenName, formatName, parameter);
206           } else {
207             resultat = server.methodeAusfuehren(o, methodenName, JsonWandler.FORMAT_JSON, parameter);
208           }
209           if(resultat != null) {
210             if(formatName == null) {
211               resp.setContentType(MIME_JSON);
212             } else {
213               if(formatName.equalsIgnoreCase(JsonWandler.FORMAT_JSON) || formatName.equalsIgnoreCase(JsonFlatWandler.FORMAT_FLATJSON)) {
214                 resp.setContentType(MIME_JSON);
215               } else if(formatName.equalsIgnoreCase(XmlWandler.FORMAT_XML)) {
216                 resp.setContentType(MIME_XML);
217               }
218             }
219             buf.append(escapeHtml(resultat.toString()));
220           } else {
221             buf.append("<p>Resultat von server.methodeAusfuehren ist null.</p>");
222           }
223         } else {
224           buf.append("<p>Ergebnis von server.klasseFinden ist null (Klasse nicht gefunden?).</p>");
225         }
226       } else {
227         buf.append("<p>Klasse " + klassenName + " nicht erlaubt.</p>");
228       }
229       Writer w = resp.getWriter();
230       w.write(buf.toString());
231       w.flush();
232       w.close();
233     } catch(Exception ex) {
234       throw new ServletException(ex);
235     } finally {
236       if(server != null) {
237         server.aufloesen();
238         server = null;
239       }
240     }
241   }    
84429d 242   
U 243   /**
244    * Hier wird geprueft, ob der Name einer Klasse der Liste der erlaubten 
245    * Klassen bzw. Packages entspricht. Im Deployment Descriptor wird ein 
246    * Ausdruck wie z.B. 
247    * 
248    * de.uhilger.test.web;de.uhilger.test.api;de.uhilger.test.db.KlassenName
249    * 
250    * erwartet. Diese Methode spaltet diesen Ausdruck an den ';' auf und prueft 
251    * fuer jeden Ausdruck, ob der KlassenName mit diesem Ausdruck beginnt. 
252    * Beginnt der Klassenname mit einem der Ausdruecke, wird der Zugriff erlaubt
253    * 
254    * @param klassenName  Name der Klasse, fuer die der Zugriff geprueft 
255    * werden soll
256    * @return true, wenn die Klasse laut dem Eintrag im Deployment Desccriptor 
257    * aufgerufen werden darf, false wenn nicht
258    */
259   private boolean istErlaubt(String klassenName) {
260       boolean erlaubt = false;
261       for(int i = 0; i < klassen.length && !erlaubt; i++) {
262           erlaubt = klassenName.startsWith(klassen[i]);
263       }
264       return erlaubt;
265   }
ca8e1e 266     
U 267   public String escapeHtml(String text) {
268     text = text.replace(specialChars[0], "&Auml;");
269     text = text.replace(specialChars[1], "&Ouml;");
270     text = text.replace(specialChars[2], "&Uuml;");
271     text = text.replace(specialChars[3], "&auml;");
272     text = text.replace(specialChars[4], "&ouml;");
273     text = text.replace(specialChars[5], "&uuml;");
274     text = text.replace(specialChars[6], "&szlig;");
275     return text;
276   }
277 }