Java Web Services via REST bereitstellen
view | history | commit | commitdiff
ulrich@undisclosed
2020-05-02 1177762340ebc0e7bee444ae2d7c119f697cbdbb
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
09b3fc 93    * @throws javax.servlet.ServletException
U 94    * @throws java.io.IOException
ca8e1e 95    */
U 96   @Override
97   protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
98     anfrageAusfuehren(req, resp);
99   }
100   
101   /**
102    * Eine Anfrage via HTTP POST verarbeiten
103    * 
104    * <p>Folgende Parameter werden erwartet:</p>
105    * <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
106    * m: Methode<br>
107    * p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
108    * p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
109    *  .<br>
110    *  .<br>
111    * p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
112    * 
113    * <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im 
114    * Format der JavaScript Object Notation (JSON) in die Antwort der 
115    * HTTP-Anfrage geschrieben.</p>
116    * 
117    * @param req die Anfrage, die verarbeitet werden soll
118    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
09b3fc 119    * @throws javax.servlet.ServletException
U 120    * @throws java.io.IOException
ca8e1e 121    */
U 122   @Override
123   protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
124     anfrageAusfuehren(req, resp);
125   }
126   
127   /**
128    * Diese Methode verarbeitet die Anfragen, die via HTTP GET und HTTP POST 
129    * an dieses Servlet gestellt werden.
130    * 
131    * @param req die Anfrage, die verarbeitet werden soll
132    * @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
09b3fc 133    * @throws javax.servlet.ServletException
U 134    * @throws java.io.IOException
ca8e1e 135    */
U 136   @SuppressWarnings("unchecked")
137   public void anfrageAusfuehren(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
138     JavaServer server = null;
139     try {
140       /*
141         http://server:port/contextpfad/servletpfad/de.irgend.eine.Klasse/methode/format/param1/param2/../paramN
142         wird zu
143         elemente[0] = /
144         elemente[1] = de.irgend.eine.Klasse
145         elemente[2] = methode
146         elemente[3] = format
1da1ca 147         elemente[4]-[n] = param1 - paramn
ca8e1e 148       */
U 149       
150       String pathInfo = req.getPathInfo();
1da1ca 151       logger.log(Level.INFO, "pathInfo: {0}", pathInfo); 
ca8e1e 152       String[] elemente = pathInfo.split("/");
U 153       String klassenName = elemente[1];
1da1ca 154       StringBuilder buf = new StringBuilder();
84429d 155       if(istErlaubt(klassenName)) {
ca8e1e 156         String methodenName = elemente[2];
U 157         String formatName = elemente[3];
158         List parameterListe = new ArrayList();
159         for(int i = 4; i < elemente.length; i++) {
160           parameterListe.add(elemente[i]);
161         }
162         
163         Object[] parameter = parameterListe.toArray(new Object[0]);
164   
165         server = new JavaServer();
166         server.wandlerHinzufuegen(new JsonWandler());
167         server.wandlerHinzufuegen(new JsonFlatWandler());
87f8e9 168         server.wandlerHinzufuegen(new JsonNiceWandler());
ca8e1e 169         server.wandlerHinzufuegen(new XmlWandler());
U 170         Class cls = server.klasseFinden(klassenName);
171         if(cls != null) {
172           Object o = cls.newInstance();
173           if(o != null) {
174             if(o instanceof NutzerKontext) {
1da1ca 175               ((NutzerKontext) o).setNutzerId(getUserName(req));
ca8e1e 176             }
U 177             if(o instanceof WebKontext) {
178               ((WebKontext) o).setServletContext(getServletContext());
179             }
180             if(o instanceof RequestKontext) {
181               ((RequestKontext) o).setRequest(req);
182             }
183             if(o instanceof VerbindungsKontext) {
184               ((VerbindungsKontext) o).setVerbindung(req.getSession());
185             }
186           }
09b3fc 187           Object resultat;
U 188           logger.log(Level.FINE, "methodenName: {0}, formatName: {1}", new Object[]{methodenName, formatName});
ca8e1e 189           if(formatName != null) {
U 190             resultat = server.methodeAusfuehren(o, methodenName, formatName, parameter);
191           } else {
192             resultat = server.methodeAusfuehren(o, methodenName, JsonWandler.FORMAT_JSON, parameter);
193           }
194           if(resultat != null) {
195             if(formatName == null) {
196               resp.setContentType(MIME_JSON);
197             } else {
198               if(formatName.equalsIgnoreCase(JsonWandler.FORMAT_JSON) || formatName.equalsIgnoreCase(JsonFlatWandler.FORMAT_FLATJSON)) {
199                 resp.setContentType(MIME_JSON);
200               } else if(formatName.equalsIgnoreCase(XmlWandler.FORMAT_XML)) {
201                 resp.setContentType(MIME_XML);
202               }
203             }
204             buf.append(escapeHtml(resultat.toString()));
205           } else {
206             buf.append("<p>Resultat von server.methodeAusfuehren ist null.</p>");
207           }
208         } else {
209           buf.append("<p>Ergebnis von server.klasseFinden ist null (Klasse nicht gefunden?).</p>");
210         }
211       } else {
3f6c85 212         buf.append("<p>Klasse ").append(klassenName).append(" nicht erlaubt.</p>");
ca8e1e 213       }
U 214       Writer w = resp.getWriter();
215       w.write(buf.toString());
216       w.flush();
217       w.close();
218     } catch(Exception ex) {
219       throw new ServletException(ex);
220     } finally {
221       if(server != null) {
222         server.aufloesen();
223         server = null;
224       }
225     }
226   }    
84429d 227   
ca8e1e 228 }