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