From 2c72f85fed2d2001335bcaffccebcc2c9f0dc123 Mon Sep 17 00:00:00 2001
From: ulrich <not disclosed>
Date: Tue, 27 Dec 2016 15:33:02 +0000
Subject: [PATCH] Erstellung von javadoc verbessert
---
src/de/uhilger/transit/web/TransitServletRS.java | 51 ++++++++++++++++++++++++++++++++++++++-------------
1 files changed, 38 insertions(+), 13 deletions(-)
diff --git a/src/de/uhilger/transit/web/TransitServletRS.java b/src/de/uhilger/transit/web/TransitServletRS.java
index cadcac9..33c042b 100644
--- a/src/de/uhilger/transit/web/TransitServletRS.java
+++ b/src/de/uhilger/transit/web/TransitServletRS.java
@@ -18,29 +18,46 @@
package de.uhilger.transit.web;
-import javax.servlet.*;
+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;
-import javax.servlet.http.*;
-import java.io.*;
-
-import java.util.*;
-import java.util.logging.*;
-
-import de.uhilger.transit.*;
/**
- * Das TransitServlet macht beliebige Klassen und Methoden
+ * Das TransitServletRS macht beliebige Klassen und Methoden
* ueber HTTP zugaenglich.
*
- * <p><b>Achtung:</b>Das TransitServlet sollte nur in einem
+ * <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.</p>
+ * 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
@@ -73,6 +90,8 @@
*
* @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 {
@@ -97,6 +116,8 @@
*
* @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 {
@@ -109,6 +130,8 @@
*
* @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 {
@@ -142,6 +165,7 @@
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) {
@@ -160,7 +184,8 @@
((VerbindungsKontext) o).setVerbindung(req.getSession());
}
}
- Object resultat = null;
+ 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 {
@@ -184,7 +209,7 @@
buf.append("<p>Ergebnis von server.klasseFinden ist null (Klasse nicht gefunden?).</p>");
}
} else {
- buf.append("<p>Klasse " + klassenName + " nicht erlaubt.</p>");
+ buf.append("<p>Klasse ").append(klassenName).append(" nicht erlaubt.</p>");
}
Writer w = resp.getWriter();
w.write(buf.toString());
--
Gitblit v1.9.3