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