| com.teamkonzept.web.TKHttpInterface
All known Subclasses: com.teamkonzept.web.servlet.ServletInterface,
| TKHttpInterface | | public interface TKHttpInterface (Code) | | Das Interface TKHpptInterface legt die Methoden fest, die eine
Implementierung einer HTTP-Server-Schnittstelle zur Verfügung stellen
muß.
Java-Anwendungen sollten sich für die Kommunikation mit dem HTTP-Server
auf diese Methoden beschränken, damit
die Lauffähigkeit der Anwendung unter beliebigen Servern gewährleistet
ist.
Das Interface enthält vier Methoden um die verschiedenen Bestandteile einer
HTTP-Response zusammen zu bauen: setStatus, addHeader, getOutputStream. Daneben gibt
es noch die getLogStream-Methode, über die der Zugriff auf eventuelle
Fehler-Logging-Mechanismen des HTTP-Servers zur Verfügung gestellt werden soll.
Eine Interface-Implementierung muš gewährleisten, daß der Aufruf in folgender
Reihenfolge gelingt:
- setStatus
- addHeader (mehrfach)
- Ausgabe ¸ber getLogStream-Ergebnisobjekt
- Ausgabe über getOutStream-Ergebnisobjekt
Das Interface TKHttpInterface und seine abstrakten Methoden.
Die Implementierung dieser Methoden erfolgt zur Zeitin der Klasse
OracleWRBInterface.
Wird spaeter ein Interface fuer Servlets (Sun) benoetigt, muss das Interface
ein weiters mal implementiert werden und dem Konstruktor des Thread in der
Applikation uebergeben werden.
Es werden die CGI-Enviroment Variablen bereitgestellt.
getParams() -> Parameter eines Events und der event selbst
TK_EV[EIN_EVENT]=, TK_PAR[EIN_PARAMETER]=xy, TK_PAR[SID]=20 Stellen
getEnvironment() -> Die CGI-Enviroment Variablen sind im Hash abgelegt
getOutputStream() -> Ergebnis z.B.: tk.web.oracle.OracleWRBOutput@ed3018c0
getLogStream() -> Ergebnis z.B.: oracle.owas.wrb.services.logger.OutputLogStream@ed310af0
getOwnName() -> PATH_INFO, /Name der gerade laufenden Applikation
getOwnURL() -> SCRIPT_NAME+PATHNAME, /java/Applikationsname
getOwnPath() -> SCRIPT_NAME, /java
getDocumentRoot() -> gemeinsame Documentroot fuer verschiedene Benutzer
getServerName() -> Severname
getPathInfo() -> liefert extra-Pfadinformation
getPathTranslated() -> liefert extra-Pfadinformation
getCookies() -> liefert alle Cookies f¸r die aktuelle Domain
setCookie() -> setzt ein Cookie
author:
$Author: mischa $
version:
$Revision: 1.9 $ |
| addCookie | | void addCookie(Cookie cookie)(Code) | | setzt ein Cookie
|
| addDateHeader | | void addDateHeader(String name, long value)(Code) | | setzt einen (weiteren) HTTP-Header
Parameters:
name - HTTP-Header-Name
Parameters:
value - HTTP-Header-Wert |
| addHeader | | void addHeader(String name, String value)(Code) | | setzt einen (weiteren) HTTP-Header
Parameters:
name - HTTP-Header-Name
Parameters:
value - HTTP-Header-Wert |
| getAbsoluteURL | | String getAbsoluteURL()(Code) | | liefert absolute URL - inkl. Servername + Port
|
| getContextPath | | String getContextPath()(Code) | | liefert den Context Pfad von Webman
|
| getCookies | | Cookie[] getCookies()(Code) | | liefert alle Cookies der aktuellen Domain
|
| getDocumentRoot | | String getDocumentRoot()(Code) | | liefert den Pfad der Document-Root des Web-Servers
|
| getEnvironment | | TKHashtable getEnvironment()(Code) | | liefert einen Hash, in dem alle anderen Attribute, die der
HTTP-Server an die Anwendung übergeben hat, enthalten sind.
Da diese Attribute HTTP-Server-spezifisch sind, sollte Anwendungen
von diesem Hash nur in Ausnahmen gebrauch machen.
|
| getHeaders | | TKHashtable getHeaders()(Code) | | liefert die http-Request-Header mit denen die Anwendung
aufgerufen wurde
|
| getLogStream | | OutputStream getLogStream()(Code) | | liefert ein OutputStream-Objekt, über das die Fehlermeldungen
an den HTTP-Server geschickt werden können.
|
| getOutputStream | | OutputStream getOutputStream()(Code) | | liefert ein OutputStream-Objekt, ¸ber das die HTTP-Daten geschickt werden können.
|
| getOwnName | | String getOwnName()(Code) | | liefert den Namen der Java-Anwendungsklasse
|
| getOwnPath | | String getOwnPath()(Code) | | liefert den (virtuellen URL-) Pfad der Java-Anwendung
|
| getOwnURL | | String getOwnURL()(Code) | | liefert die URL der Java-Anwendung
|
| getParams | | TKHashtable getParams()(Code) | | liefert einen Hash in dem die Parameter der Anwendung
enthalten sind. Falls ein Parameter mehrmals verwendet
wurde, enthält der Hash als Value ein TKVector-Objekt
|
| getPathInfo | | String getPathInfo()(Code) | | liefert extra-Pfadinformation, d.h. die Informationen, die
zwischen Servletpfad u. Query-String stehen.
Ist keine extra-Pfadinformation vorhanden, so wird null
zurückgeliefert.
|
| getPathTranslated | | String getPathTranslated()(Code) | | liefert extra-Pfadinformationen und übersetzt diese in
den realen absoluten Pfad.
|
| getRemoteUser | | String getRemoteUser()(Code) | | liefert den Namen des RemoteUsers
|
| getServerName | | String getServerName()(Code) | | liefert den Namen des HTTP-Servers
|
| setStatus | | void setStatus(int code, String msg)(Code) | | setzt den HTTP-Response-Status
Parameters:
code - HTTP-Status-Code
Parameters:
msg - HTTP-Reason-Phrase (null wenn nicht benötigt) |
|
|