Java Web Services via REST bereitstellen
ulrich
2014-11-17 42c48ee10645856f3d893856c1cf6512e048f4fd
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 /**
42c48e 33  * Das TransitServletRS macht beliebige Klassen und Methoden 
ca8e1e 34  * ueber HTTP zugaenglich. 
U 35  * 
42c48e 36  * <p>Methodenaufrufe über dieses Servlet erfolgen in der Form<br>
U 37  * <code>
38  * http://server:port/contextpfad/servletpfad/name.der.package.Klasse/methode/antwortformat/param1/param2/../paramN
39  * </code></p>
40  * 
41  * <p>Standardmäßig werden von Transit die Antwortformate JSON, JSONFLAT und XML 
42  * bereitgestellt. Über die Schnittstelle Wandler lassen sich weitere Formate 
43  * hinzufügen.</p>
44  * 
45  * <p><b>Achtung:</b>Das TransitServletRS sollte nur in einem 
ca8e1e 46  * per Authentifizierung und Autorisierung geschuetzten 
U 47  * Bereich einer Webanwendung bereitgestellt werden da andernfalls 
48  * durchweg alle Klassen und Methoden, die sich auf dem Server 
49  * finden, zugaenglich werden.</p>
50  * 
51  * <p>Fuer die Bereitstellung von Funktionen ist eine Berechtigungspruefung  
42c48e 52  * noetig, die am besten in Form eines Filters implementiert wird. 
U 53  * Transit stellt hierfür die Klassen Waechter und RechtePruefer bereit.</p>
ca8e1e 54  * 
U 55  * @author Copyright (c) Ulrich Hilger, http://uhilger.de
56  * @author Published under the terms and conditions of
57  * the <a href="http://www.gnu.org/licenses/agpl-3.0" target="_blank">GNU Affero General Public License</a>
58  * 
59  * @version 1, September 16, 2012
60  */
1da1ca 61 public class TransitServletRS extends AbstractServlet {
ca8e1e 62
U 63   /** Proforma Konstante fuer Schnittstelle Serializable */
64   public static final long serialVersionUID = 42L;
65   
66   private static final Logger logger = Logger.getLogger(TransitServletRS.class.getName());
1da1ca 67     
ca8e1e 68   /**
U 69    * Eine Anfrage via HTTP GET verarbeiten
70    * 
71    * <p>Folgende Parameter werden erwartet:</p>
72    * <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
73    * m: Methode<br>
74    * p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
75    * p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
76    *  .<br>
77    *  .<br>
78    * p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
79    * 
80    * <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im 
81    * Format der JavaScript Object Notation (JSON) in die Antwort der 
82    * HTTP-Anfrage geschrieben.</p>
83    * 
84    * @param req die Anfrage, die verarbeitet werden soll
85    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
86    */
87   @Override
88   protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
89     anfrageAusfuehren(req, resp);
90   }
91   
92   /**
93    * Eine Anfrage via HTTP POST verarbeiten
94    * 
95    * <p>Folgende Parameter werden erwartet:</p>
96    * <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
97    * m: Methode<br>
98    * p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
99    * p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
100    *  .<br>
101    *  .<br>
102    * p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
103    * 
104    * <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im 
105    * Format der JavaScript Object Notation (JSON) in die Antwort der 
106    * HTTP-Anfrage geschrieben.</p>
107    * 
108    * @param req die Anfrage, die verarbeitet werden soll
109    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
110    */
111   @Override
112   protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
113     anfrageAusfuehren(req, resp);
114   }
115   
116   /**
117    * Diese Methode verarbeitet die Anfragen, die via HTTP GET und HTTP POST 
118    * an dieses Servlet gestellt werden.
119    * 
120    * @param req die Anfrage, die verarbeitet werden soll
121    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
122    */
123   @SuppressWarnings("unchecked")
124   public void anfrageAusfuehren(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
125     JavaServer server = null;
126     try {
127       /*
128         http://server:port/contextpfad/servletpfad/de.irgend.eine.Klasse/methode/format/param1/param2/../paramN
129         wird zu
130         elemente[0] = /
131         elemente[1] = de.irgend.eine.Klasse
132         elemente[2] = methode
133         elemente[3] = format
1da1ca 134         elemente[4]-[n] = param1 - paramn
ca8e1e 135       */
U 136       
137       String pathInfo = req.getPathInfo();
1da1ca 138       logger.log(Level.INFO, "pathInfo: {0}", pathInfo); 
ca8e1e 139       String[] elemente = pathInfo.split("/");
U 140       String klassenName = elemente[1];
1da1ca 141       StringBuilder buf = new StringBuilder();
84429d 142       if(istErlaubt(klassenName)) {
ca8e1e 143         String methodenName = elemente[2];
U 144         String formatName = elemente[3];
145         List parameterListe = new ArrayList();
146         for(int i = 4; i < elemente.length; i++) {
147           parameterListe.add(elemente[i]);
148         }
149         
150         Object[] parameter = parameterListe.toArray(new Object[0]);
151   
152         server = new JavaServer();
153         server.wandlerHinzufuegen(new JsonWandler());
154         server.wandlerHinzufuegen(new JsonFlatWandler());
155         server.wandlerHinzufuegen(new XmlWandler());
156         Class cls = server.klasseFinden(klassenName);
157         if(cls != null) {
158           Object o = cls.newInstance();
159           if(o != null) {
160             if(o instanceof NutzerKontext) {
1da1ca 161               ((NutzerKontext) o).setNutzerId(getUserName(req));
ca8e1e 162             }
U 163             if(o instanceof WebKontext) {
164               ((WebKontext) o).setServletContext(getServletContext());
165             }
166             if(o instanceof RequestKontext) {
167               ((RequestKontext) o).setRequest(req);
168             }
169             if(o instanceof VerbindungsKontext) {
170               ((VerbindungsKontext) o).setVerbindung(req.getSession());
171             }
172           }
173           Object resultat = null;
174           if(formatName != null) {
175             resultat = server.methodeAusfuehren(o, methodenName, formatName, parameter);
176           } else {
177             resultat = server.methodeAusfuehren(o, methodenName, JsonWandler.FORMAT_JSON, parameter);
178           }
179           if(resultat != null) {
180             if(formatName == null) {
181               resp.setContentType(MIME_JSON);
182             } else {
183               if(formatName.equalsIgnoreCase(JsonWandler.FORMAT_JSON) || formatName.equalsIgnoreCase(JsonFlatWandler.FORMAT_FLATJSON)) {
184                 resp.setContentType(MIME_JSON);
185               } else if(formatName.equalsIgnoreCase(XmlWandler.FORMAT_XML)) {
186                 resp.setContentType(MIME_XML);
187               }
188             }
189             buf.append(escapeHtml(resultat.toString()));
190           } else {
191             buf.append("<p>Resultat von server.methodeAusfuehren ist null.</p>");
192           }
193         } else {
194           buf.append("<p>Ergebnis von server.klasseFinden ist null (Klasse nicht gefunden?).</p>");
195         }
196       } else {
197         buf.append("<p>Klasse " + klassenName + " nicht erlaubt.</p>");
198       }
199       Writer w = resp.getWriter();
200       w.write(buf.toString());
201       w.flush();
202       w.close();
203     } catch(Exception ex) {
204       throw new ServletException(ex);
205     } finally {
206       if(server != null) {
207         server.aufloesen();
208         server = null;
209       }
210     }
211   }    
84429d 212   
ca8e1e 213 }