/*
|
Transit - Remote procedure calls made simple
|
Copyright (c) 2012 Ulrich Hilger
|
|
This program is free software: you can redistribute it and/or modify
|
it under the terms of the GNU Affero General Public License as published by
|
the Free Software Foundation, either version 3 of the License, or
|
(at your option) any later version.
|
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU Affero General Public License for more details.
|
|
You should have received a copy of the GNU Affero General Public License
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
*/
|
|
package de.uhilger.transit.web;
|
|
import de.uhilger.transit.JavaServer;
|
import de.uhilger.transit.JsonFlatWandler;
|
import de.uhilger.transit.JsonNiceWandler;
|
import de.uhilger.transit.JsonWandler;
|
import de.uhilger.transit.NutzerKontext;
|
import de.uhilger.transit.XmlWandler;
|
import java.io.IOException;
|
import java.io.Writer;
|
import java.util.ArrayList;
|
import java.util.List;
|
import java.util.logging.Level;
|
import java.util.logging.Logger;
|
import javax.servlet.ServletException;
|
import javax.servlet.http.HttpServletRequest;
|
import javax.servlet.http.HttpServletResponse;
|
|
|
|
/**
|
* Das TransitServletRS macht beliebige Klassen und Methoden
|
* ueber HTTP zugaenglich.
|
*
|
* <p>Methodenaufrufe über dieses Servlet erfolgen in der Form<br>
|
* <code>
|
* http://server:port/contextpfad/servletpfad/name.der.package.Klasse/methode/antwortformat/param1/param2/../paramN
|
* </code></p>
|
*
|
* <p>Standardmäßig werden von Transit die Antwortformate JSON, JSONFLAT und XML
|
* bereitgestellt. Über die Schnittstelle Wandler lassen sich weitere Formate
|
* hinzufügen.</p>
|
*
|
* <p><b>Achtung:</b>Das TransitServletRS sollte nur in einem
|
* per Authentifizierung und Autorisierung geschuetzten
|
* Bereich einer Webanwendung bereitgestellt werden da andernfalls
|
* durchweg alle Klassen und Methoden, die sich auf dem Server
|
* finden, zugaenglich werden.</p>
|
*
|
* <p>Fuer die Bereitstellung von Funktionen ist eine Berechtigungspruefung
|
* noetig, die am besten in Form eines Filters implementiert wird.
|
* Transit stellt hierfür die Klassen Waechter und RechtePruefer bereit.</p>
|
*
|
* @author Copyright (c) Ulrich Hilger, http://uhilger.de
|
* @author Published under the terms and conditions of
|
* the <a href="http://www.gnu.org/licenses/agpl-3.0" target="_blank">GNU Affero General Public License</a>
|
*
|
* @version 1, September 16, 2012
|
*/
|
public class TransitServletRS extends AbstractServlet {
|
|
/** Proforma Konstante fuer Schnittstelle Serializable */
|
public static final long serialVersionUID = 42L;
|
|
private static final Logger logger = Logger.getLogger(TransitServletRS.class.getName());
|
|
/**
|
* Eine Anfrage via HTTP GET verarbeiten
|
*
|
* <p>Folgende Parameter werden erwartet:</p>
|
* <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
|
* m: Methode<br>
|
* p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
|
* p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
|
* .<br>
|
* .<br>
|
* p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
|
*
|
* <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im
|
* Format der JavaScript Object Notation (JSON) in die Antwort der
|
* HTTP-Anfrage geschrieben.</p>
|
*
|
* @param req die Anfrage, die verarbeitet werden soll
|
* @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
|
* @throws javax.servlet.ServletException
|
* @throws java.io.IOException
|
*/
|
@Override
|
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
|
anfrageAusfuehren(req, resp);
|
}
|
|
/**
|
* Eine Anfrage via HTTP POST verarbeiten
|
*
|
* <p>Folgende Parameter werden erwartet:</p>
|
* <p>c: Klasse, z.B. de.uhilger.test.EineKlasse<br>
|
* m: Methode<br>
|
* p: Erster Parameter der Methode in der Reihenfolge der Deklaration<br>
|
* p: Zweiter Parameter der Methode in der Reihenfolge der Deklaration<br>
|
* .<br>
|
* .<br>
|
* p: Letzter Parameter der Methode in der Reihenfolge der Deklaration</p>
|
*
|
* <p>Das Ergebnis der Verarbeitung wird in Form einer Zeichenkette im
|
* Format der JavaScript Object Notation (JSON) in die Antwort der
|
* HTTP-Anfrage geschrieben.</p>
|
*
|
* @param req die Anfrage, die verarbeitet werden soll
|
* @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
|
* @throws javax.servlet.ServletException
|
* @throws java.io.IOException
|
*/
|
@Override
|
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
|
anfrageAusfuehren(req, resp);
|
}
|
|
/**
|
* Diese Methode verarbeitet die Anfragen, die via HTTP GET und HTTP POST
|
* an dieses Servlet gestellt werden.
|
*
|
* @param req die Anfrage, die verarbeitet werden soll
|
* @param resp das Objekt, mit dem das Ergebnis der Verarbeitung mitgeteilt wird
|
* @throws javax.servlet.ServletException
|
* @throws java.io.IOException
|
*/
|
@SuppressWarnings("unchecked")
|
public void anfrageAusfuehren(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
|
JavaServer server = null;
|
try {
|
/*
|
http://server:port/contextpfad/servletpfad/de.irgend.eine.Klasse/methode/format/param1/param2/../paramN
|
wird zu
|
elemente[0] = /
|
elemente[1] = de.irgend.eine.Klasse
|
elemente[2] = methode
|
elemente[3] = format
|
elemente[4]-[n] = param1 - paramn
|
*/
|
|
String pathInfo = req.getPathInfo();
|
logger.log(Level.INFO, "pathInfo: {0}", pathInfo);
|
String[] elemente = pathInfo.split("/");
|
String klassenName = elemente[1];
|
StringBuilder buf = new StringBuilder();
|
if(istErlaubt(klassenName)) {
|
String methodenName = elemente[2];
|
String formatName = elemente[3];
|
List parameterListe = new ArrayList();
|
for(int i = 4; i < elemente.length; i++) {
|
parameterListe.add(elemente[i]);
|
}
|
|
Object[] parameter = parameterListe.toArray(new Object[0]);
|
|
server = new JavaServer();
|
server.wandlerHinzufuegen(new JsonWandler());
|
server.wandlerHinzufuegen(new JsonFlatWandler());
|
server.wandlerHinzufuegen(new JsonNiceWandler());
|
server.wandlerHinzufuegen(new XmlWandler());
|
Class cls = server.klasseFinden(klassenName);
|
if(cls != null) {
|
Object o = cls.newInstance();
|
if(o != null) {
|
if(o instanceof NutzerKontext) {
|
((NutzerKontext) o).setNutzerId(getUserName(req));
|
}
|
if(o instanceof WebKontext) {
|
((WebKontext) o).setServletContext(getServletContext());
|
}
|
if(o instanceof RequestKontext) {
|
((RequestKontext) o).setRequest(req);
|
}
|
if(o instanceof VerbindungsKontext) {
|
((VerbindungsKontext) o).setVerbindung(req.getSession());
|
}
|
}
|
Object resultat;
|
logger.log(Level.FINE, "methodenName: {0}, formatName: {1}", new Object[]{methodenName, formatName});
|
if(formatName != null) {
|
resultat = server.methodeAusfuehren(o, methodenName, formatName, parameter);
|
} else {
|
resultat = server.methodeAusfuehren(o, methodenName, JsonWandler.FORMAT_JSON, parameter);
|
}
|
if(resultat != null) {
|
if(formatName == null) {
|
resp.setContentType(MIME_JSON);
|
} else {
|
if(formatName.equalsIgnoreCase(JsonWandler.FORMAT_JSON) || formatName.equalsIgnoreCase(JsonFlatWandler.FORMAT_FLATJSON)) {
|
resp.setContentType(MIME_JSON);
|
} else if(formatName.equalsIgnoreCase(XmlWandler.FORMAT_XML)) {
|
resp.setContentType(MIME_XML);
|
}
|
}
|
buf.append(escapeHtml(resultat.toString()));
|
} else {
|
buf.append("<p>Resultat von server.methodeAusfuehren ist null.</p>");
|
}
|
} else {
|
buf.append("<p>Ergebnis von server.klasseFinden ist null (Klasse nicht gefunden?).</p>");
|
}
|
} else {
|
buf.append("<p>Klasse ").append(klassenName).append(" nicht erlaubt.</p>");
|
}
|
Writer w = resp.getWriter();
|
w.write(buf.toString());
|
w.flush();
|
w.close();
|
} catch(Exception ex) {
|
throw new ServletException(ex);
|
} finally {
|
if(server != null) {
|
server.aufloesen();
|
server = null;
|
}
|
}
|
}
|
|
}
|
