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