|
Tab. 13.7: Die wichtigsten HTTP-Methoden
So behandelt bspw. die doGet-Methode der Klasse HTTPServlet solche Anfragen, die mit Hilfe der HTTP-Methode GET gestellt werden. Die doPost-Methode muss überschrieben werden, wenn die HTTP-Anfrage POST bearbeitet werden soll. Ein HTTP-Servlet bearbeitet Client-Anfragen mit Hilfe der service-Methode. Diese Methode dient in der Regel nur als Kommando-Container und wird nur in Ausnahmefällen überschrieben. Sie leitet jede ankommende Anfrage gemäß der HTTP_Methode an die entsprechende HttpServlet-Spezialmethode weiter, also bspw. GET_Anfragen an die doGet-Methode und POST_Anfragen an die doPost-Methode. Im Folgenden sind die Methoden der Klasse HttpServlet aufgelistet, die von der service-Methode an die entsprechenden HTTP-Methoden weiterleitet werden.
doGet, um GET-Anfragen, bedingte GET-Anfragen und HEAD-Anfragen zu bearbeiten.
doPost zur Bearbeitung von POST-Anfragen.
doPut, um PUT-Anfragen zu bearbeiten.
doDelete zur Bearbeitung von DELETE-Anfragen.
doOptions zur Bearbeitung von OPTION-Anfragen.
doTrace, um TRACE-Anfragen zu bearbeiten.
Methoden, die nicht unterstützt werden, werden mit dem HTTP-Fehler Bad Request quittiert (im Browser durch die Zahl 400 repräsentiert).
Ist das Servlet initialisiert, so können HTTP-Anfragen beantwortet werden. Wie jede service-Methode akzeptieren alle do-Methoden zwei Parameter: Der erste Parameter ist ein Objekt der Klasse HttpServletRequest, der zweite Parameter stellt ein Objekt der Klasse HttpServletResponse dar. Als Unterklassen von ServletRequest bzw. ServletResponse repräsentieren die Klassen HttpServletRequest und HttpServletResponse die Anfrage eines Clients bzw. die Antwort eines Servlets. Darüber hinaus erlauben sie aber auch den Zugriff auf die HTTP_spezifischen Eigenschaften der Anfragen und Antworten
Interface HTTPServletRequest
Das Interface HttpServletRequest erweitert das Interface ServletRequest und erlaubt darüber hinaus den Zugriff auf die HTTP_spezifischen Eigenschaften von Anfragen eines Clients, die an einen Server gesendet werden. Klassen, die dieses Interface implementieren, können bspw. auf Client-Informationen zugreifen, wie bspw. auf die Bezeichnung der vom Client gesendeten Parameter, das vom Client verwendete Protokoll, den Namen der Client-Maschine oder den Namen des Servers, der die Anfrage empfängt. Der Zugriff auf eine Client-Anfrage kann folgendermaßen erfolgen:
getParameter-Methode.
Durch die Verwendung der getQueryString-Methode bei der HTTP-Anfrage GET. Die Methode liefert ein String-Objekt zurück, das verarbeitet werden muss, um die Parameter und deren Werte auslesen zu können.
Durch die Verwendung der getReader-Methode bei den HTTP-Anfragen POST, PUT oder DELETE. Diese Methode liefert ein BufferedReader-Objekt zurück und wird verwendet, falls Textdaten empfangen werden sollen. Werden dagegen binäre Daten übertragen, so wird die getInputStream-Methode verwendet, die ein ServletInputStream zurückliefert.
Eine der Schlüsselmethoden der Klasse HttpServletRequest, die vom Interface javax.servlet.ServletRequest vererbt wird, ist die Methode getParameter(). Ein Aufruf dieser Methode liefert das Argument des entsprechenden Parameters zurück, bzw. falls dieser nicht existiert, eine Null-Referenz. Hierbei handelt es sich um einen Parameter, der bspw. von einem Browser bei der Betätigung des Absenden-Knopfs eines Formulars übergeben wird. Wenn nicht davon ausgegangen werden kann, dass nur ein Parameter übergeben wird (bspw. eine Aufzählung bei einem HTML-Formular mit einem <SELECT>-Feld), so wird anstelle der getParameter()-Methode die getParameterValues()-Methode aufgerufen. Diese Methode gibt ein Feld aller übergebenen Parameter zurück. Das Auslesen von dokumentspezifischen Parametern kann wie folgt realisiert werden:
String parameter = request.getParameter(String name);
Dieser Aufruf liefert dann den Parameter zurück, der durch name gekennzeichnet ist. Derartige Parameter werden im HTML-Code festgelegt. Als Beispiel dient folgender Code:
String Nachname = request.getParameter ("name");
Eine Alternative dazu ist die Aufzählung sämtlicher Parameternamen:
Enumeration names = request.getParameterNames();
Zum Auslesen von HTTP-Anfrageparametern stehen u. a. die folgenden Methoden der Klassen javax.servlet.http.HttpServletRequest und javax.servlet.ServletRequest zur Verfügung:
String methode = request.getMethod();
Diese Methode übergibt die entsprechende HTTP-Methode, bspw. GET oder POST.
String uri = request.getRequestURI();
Hierbei wird der Uniform Resource Identifier (URI) des Senders zur Identifikation übergeben. Der URI wird durch das Lesen der ersten Zeile einer HTTP-Anfrage bestimmt. Eine HTTP-Anfrage besteht aus der verwendeten HTTP-Methode, gefolgt von der URI und der HTTP-Version.
GET /path/index.html HTTP/1.1.
Die Methode getRequestURI() liefert den Wert /path/index.html. Mittels der Anweisung String pathInfo = request.getPathInfo(); wird die im Dokumentenpfad gespeicherte Information übergeben.
int length = request.getContentLength(); übergibt die Länge der Anfragedaten. Diese Methode ist gleichbedeutend mit der CGI-Variablen CONTENT_LENGTH.
String type = request.getContentType(); übergibt den Datentyp des verwendeten Mediums. Dieser Typ ist gleichbedeutend mit der CGI-Variablen CONTENT_TYPE.
Zum Interface HTTPServletRequest gehören unter anderem auch die folgenden Methoden:
getAuthType()
Diese Methode erfragt das Authentifizierungsschema der Anfrage.
getCookies()
Diese Methode erfragt der Liste der Cookies, die in dieser Anfrage enthalten sind.
getDateHeader(String)
Diese Methode erfragt den Wert des Datums des Headers.
getHeader(String)
Diese Methode erfragt die Header-Informationen einer Anfrage.
getHeaderNames()
Diese Methode erfragt die Namen der Header-Informationen.
getIntHeader(String)
Diese Methode erfragt den Wert des als Argument übergebenen Header-Feldes der Anfrage.
isRequestedSessionIdFromCookie()
Diese Methode erfragt, ob die Anfrage mit einem Cookie-Objekt empfangen wurde.
Interface HTTPServletResponse
Das Interface javax.servlet.http.ServletResponse erweitert das Interface ServletResponse und erlaubt darüber hinaus den Zugriff auf die HTTP_spezifischen Eigenschaften von Antworten, die von einem Server an einen Client gesendet werden. Klassen, die dieses Interface implementiert haben, können bspw. die Größe der gesendeten Antwort und deren MIME-Datentyp setzen.
Ein HttpServletResponse-Objekt bietet zwei Möglichkeiten, Daten an den Client zu senden:
getWriter-Methode liefert ein Writer-Objekt und wird verwendet, falls es sich um eine textbasierte Antwort handelt.
Die getOutputStream-Methode liefert ein ServletOutputStream-Objekt. Diese Methode wird dann verwendet, wenn es sich um eine Antwort handelt, die binäre Daten enthält.
Das Schließen des Writer-Objekts bzw. des ServletOutputStream-Objekts mit Hilfe der close-Methode nach dem Empfang der Antwort erlaubt es dem Server, festzustellen, ob die Antwort vollständig ist.
public class EinfachesServlet extends HttpServlet {
// Verwende die HTTP-Methode GET, um eine einfache Webseite
// zu erzeugen.
public void doGet (HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
PrintWriter out;
String title = "Einfaches Servlet: Output";
// lege den Datentyp des Inhalts der Antwort fest
response.setContentType("text/html");
// Schreibe die Antwort als Text
out = response.getWriter();
out.println("<HTML><HEAD><TITLE>");
out.println(title);
out.println("</TITLE></HEAD><BODY>");
out.println("<H1>" + title + "</H1>");
out.println("<P>Dies ist der Body-Teil dieser Seite.");
out.println("</BODY></HTML>");
// Schließen des Writer-Objekts, damit der Server erkennt,
// dass das Ende der Antwort erreicht ist.
out.close();
}
// Die doPost-Methode ruft die doGet-Methode auf
public void doPost (HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
}
}
Eine einfache HTTP-Antwort beginnt im Unterschied zu einer HTTP-Anfrage mit der Version des unterstützten Protokolls, gefolgt von einem Status-Code und einem Kommentar zum Status-Code:
HTTP/Versionsnummer Status-Code Reason-Phrase
Ein Beispiel für eine derartige Antwort ist im Folgenden angegeben.
HTTP/1.0 200 OK
Die Versionsnummer gibt an, in welcher Version das HTTP-Protokoll läuft (Version 1.0 oder Version 1.1). Der Status-Code einer Antwort ist ein ganzzahliger Wert, der aus drei Ziffern besteht. Die erste Ziffer ist die wichtigste, da sie die Antwortkategorie identifiziert:
1xx: Beschreibt eine Informationsnachricht.
2xx: Zeigt eine erfolgreiche Ausführung an:
200 OK: Erfolgreiche Anfrage.
201 OK: Neue Ressource erzeugt (bei einer POST-Methode).
204 OK: Aber kein Inhalt.
3xx: Leitet den Client zu einer anderen Adresse um.
4xx: Zeigt einen Fehler beim Client an.
400: Falsche Anfrage.
401: Client hat sich nicht authentifiziert.
403: Verbotener Zugriff auf das Dokument.
404: Dokument wurde nicht gefunden.
5xx: Zeigt einen Fehler beim Server an.
500: Interner Fehler (beim Server).
Der sog. Reason-Nachrichtsteil ist ein Beschreibungstext des Status-Codes. Für die Ausgabe der Ergebnisse (sog. Response) wird ein Outputstream-Objekt erzeugt:
ServletOutputStream out = response.getOutputStream();
Alle Daten, die in diesen Stream geschrieben werden, werden automatisch an den Client weitergeleitet (bspw. HTML-Code). Aufgrund dieses Mechanismus kann das Ergebnisdokument dynamisch erzeugt werden.
Ein Servlet muss immer mit Hilfe der Methode setStatus() einen HTTP-StatusCode zurückgeben, um bspw. dem Client den Erfolg einer Abfrage mitzuteilen. Verläuft die Ausführung des Servlets ordnungsgemäß, kann man mit der response.setStatus(Statuscode)-Methode den Statuscode auf den Wert SC_OK setzen. Status-Codes sind in Tab. 13-8 aufgeführt.
Die Methode setStatus kann zusätzlich zum Status-Code eine Statusmeldung entsprechend der HTTP-Spezifikationen zurückliefern:
setStatus(Statuscode, Statusmeldung);
Tab. 13-8 listet die wichtigsten Status-Code-Variablen der Klasse javax.servlet.http.ServletResponse auf. |
