Datenobjekte

Die DLE definiert einige Datenobjekte und Nachschlagetabellen, die in einem Brick verwendet werden können.

Nachschlagetabelle	Werte
LookupUploadStatus	OK CANCEL_TO_MANY_FILES CANCEL_FILE_TOO_LARGE
LookupSortOrder	asc desc
LookupGridLoad	disable enable block
LookupNavigatorPos	top bottom topbottom off
LookupFirstLast	first last
LookupSearcchType	AND OR
LookupPosition	center top bottom left right
LookupEffect	blind, bounce, clip, drop, explode, fade, fold, highlight, puff, pulsate, scale, shake, slide, transfer

HttpRequest

Dieses Datenobjekt enthält die für eine HTTP Anfrage (Request) allgemeinen Werte, die vom Webserver gesetzt werden.

Attribut	Beschreibung
authType	Falls die Anfrage autorisiert wurde, z.B. durch einen Login, steht hier der Autorisierungstyp: BASIC, FORM, CLIENT_CERT, DIGEST.
characterEncoding	Der Zeichensatz der Anfrage, z.B. UTF-8 oder ISO-8859-15.
contentLength	Die Länge der Anfrage in Bytes.
contentType	Der Mime-Typ der Anfrage.
contextPath	Der Pfad zur Webanwendung, heißt die Webanwendung z.B. Test, ist dieser /Test. Für Anwendungen mit Namen root ist dieser leer.
data	Wurden Nutzdaten für die Anfrage mit gesendet, wie z.B. ein XML Dokument bei einem Webservice, so finden sich diese in diesem Attribut als Zeichenkette.
localAddr	IP Adresse des Systems, das die Anfrage entgegen genommen hat.
localName	Hostname des Systems, das die Anfrage entgegen genommen hat.
localPort	IP Port des Systems, das die Anfrage entgegen genommen hat.
method	Die HTTP Anfrageart: GET, POST, PUT, HEAD, TRACE, DELETE, etc.
pathInfo	Abhängig vom Servlet Mapping, enthält den zusätzlich zum servletPath angefragten Pfad. Wurde ein Servlet z.B. auf /test/* gemappt, und die Anfrage ging auf /test/eins/zwei enthält die pathInfo /eins/zwei.
pathTranslated	Ist eine Umformung der pathInfo (falls gesetzt) zu einem Dateipfad.
protocol	Das Protokoll der Anfrage, z.B. HTTP/1.1
queryString	Enthält den optionalen Query String einer Anfrage. War die Anfrage z.B. /app/servlet/path?param=test enthält der queryString param=test
remoteAddr	Die IP Adresse des aufrufenden Browsers.
remoteHost	Der Hostname des aufrufenden Browsers.
remotePort	Der IP Port des aufrufenden Browsers.
remoteUser	Falls der User Autorisiert wurde, steht hier der Benutzername. Ob der Wert gesetzt wurde, hängt vom Browser und der verwendeten Autorisierung ab.
requestedSessionId	Die Sitzungs-ID, die der Browser verlangt. Diese muss nicht unbedingt der aktuellen Sitzungs-ID entsprechen.
requestURI	Enthält die URI der Anfrage. War die Anfrage z.B. http://www.test.com:8080/app/servlet/path/test.brick?param=test enthält der requestURI /app/servlet/path/test.brick
scheme	Enthält das Schema der Anfrage, z.B. http oder https.
serverName	Enthält den Hostname des Webservers.
serverPort	Enthält den IP Port des Webservers.
servletPath	Abhängig vom Servlet Mapping, steht hier der Pfad des angefragten Servlets. Wurde das Servlet z.B. auf .brick gemappt und die Anfrage geht an http://localhost:8080/app/test/index.brick, enthält der servletPath* /test/index.brick.
eigenerPfad	Der ServletPath ohne das führende / Zeichen, also der relative Pfad. Dieses Feld kann dazu verwendet werden, die eigene URL wieder aufzurufen, z.B. in "Aktion verknüpfen".
locale	Eingestellte Sprache, Land und optionale Variante des anfragenden Browsers, durch _ getrennt Z.B. de_DE.
localeCountry	Eingestelltes Land des anfragenden Browsers, z.B. US.
localeLanguage	Eingestellte Sprache des anfragenden Browsers, z.B. en.
localeVariant	Eingestellte Variante des anfragenden Browsers, z.B. EURO. Wird üblicherweise nicht (mehr) verwendet.
requestURL	Enthält die gesamte URL der Anfrage. Also Schema, Hostname, Port, Kontextpfad, Servlet Pfad und Query String.

HttpRequestParameter

Dieses Datenobjekt hat zwei Attribute: Name und Wert.

Für jeden Anfrageparameter wird ein Datenobjekt von diesem Typ erstellt.

Ein Anfrageparameter ist ein Parameter, der beim Aufruf vom Browser mitgegeben wurde. Das können Parameter aus der URL sein, oder auch Formulardaten. Je nach Aufrufart erstellt die DLE diese Parameter Browserseitig automatisch aus bestehenden Informationen.

Gibt es zwei oder mehr Anfrageparameter mit dem gleichen Namen, so wird nur ein Datenobjekt erstellt und die einzelnen Werte, durch ein Semikolon getrennt, in dem Parameter Wert gespeichert.

HttpRequestAttribute

Dieses Datenobjekt hat zwei Attribute: Name und Wert.

Für jedes Anfrageattribut wird ein Datenobjekt von diesem TypEin Anfrageattribut kann nicht durch einen Browser erstellt werden, sondern wird innerhalb des Webservers erstellt.

Anfrageattribute sind vor allem dann nützlich, wenn man eine Anfrage weiterleitet. Hier können dann Daten zusätzlich zu den originalen Anfrageparametern hinterlegt werden.

HttpRequestHeader

Dieses Datenobjekt hat zwei Attribute: Name und Wert.

Für jede Kopfzeile wird ein Datenobjekt von diesem Typ erstellt.

Kopfzeilen der Anfrage sind Teil des http Protokolls und werden durch den Browser erstellt. Sie enthalten unter anderem Informationen über den Browser und die Anfrage. Nützlich ist hier z.B. die Kopfzeile User-Agent, sie enthält den Typ und die Version des Browsers.

HttpRequestCookie

Der Browser schickt automatisch bei jeder Anfrage sogenannte Cookies mit, die vorher vom Server an den Browser gesendet wurden. Damit kann man Daten zwischen den einzelnen Anfragen zwischenspeichern.

Neben Standard-Cookies, die z.B. die Sitzungs-ID enthalten, können mit der DLE auch eigene Cookies erstellt werden.

Für jedes vom Browser gesendete Cookie wird ein Datenobjekt von diesem Typ erstellt. erstellt.

Attribut	Beschreibung
name	Eindeutiger Name dieses Cookies
value	Der Wert des Cookies, Sonderzeichen sollten vermieden werden
path	Der Pfad, für den dieses Cookie gilt.
domain	Die Internet Domain, für die dieses Cookie gilt.
comment	Ein optionaler Kommentar.
version	Die Version des Cookies.
maxAge	Die maximale Lebensdauer, in Sekunden. Ein Wert von -1 gibt an, dass das Cookie nur solange gilt, wie der Browser geöffnet ist.
secure	Y, wenn diesees Cookie über sichere (HTTPS) Verbindung gesendet wird, N wenn nicht.

UploadedFile

Wurde ein Datei-Upload gemacht, wird für jede auf den Webserver geladene Datei ein Datenobjekt von diesem Typ erstellt.

Ob ein Datei-Upload erlaubt ist, sowie Parameter zur Steuerung des Uploads lassen sich in der web.xml Konfiguration einer Webanwendung hinterlegen.

Attribut	Beschreibung
originalFileName	Der originale Dateiname, vom Browser abhängig
fileName	Der Dateiname, unter dem die Datei am Webserver gespeichert wurde.
filePath	Der Absolute Pfad unter dem die Datei am Webserver gespeichert wurde.
contentType	Der Mime-Typ der Datei, z.B. image/jpeg
dataInThisObject	Ist auf Y gesetzt, wenn sich der Dateiinhalt als Base-64 Zeichenkette im Feld data befindet.
dataOnDisk	Ist auf Y gesetzt, wenn sich der Dateiphysisch auf dem Webserver befindet.
status	Ergebnis des Uploads, ein Wert aus der Nachschlagetabelle LookupUploadStatus: OK CANCEL_TO_MANY_FILES CANCEL_FILE_TOO_LARGE
fieldName	Feldname des Upload Formulars.
data	Falls so konfiguriert, befindet sich hier der Dateiinhalt im Base-64 Format.

Event

Bestimmte Aktionen auf der Browseroberfläche lösen einen Event (Ereignis) aus. Falls dieses Ereignis an den Browser übermittelt wird, dann finden sich die Informationen zum Ereignis in diesem Datenobjekt.

Welche Daten gesetzt sind, hängt vom jeweiligen Event ab.

Attribut	Beschreibung
type	Die Art des Events, z.B. click
target	Die ID des Elements, das den Event ausgelöst hat.
clientX	Die X-Koordinate des Events im Browser
clientY	Die Y-Koordinate des Events im Browser
tableId	Falls ein Tabellengitter angegeben wurde, steht hier die ID.
tableSelectedRows	Die im Tabellengitter derzeit selektierten Zeilen.
tableLastSelectedRow	Die im Tabellengitter zuletzt selektierte Zeile.

TableRequest

Dieses Datenobjekt wird nur erstellt, wenn ein Tabellengitter Daten vom Server anfragt.

Attribut	Beschreibung
timestamp	Eine zeichenkette mit dem aktuellen Zeitstempel, dient zur Eindeutigen Identifizierung der Anfrage.
operation	Wird derzeit nicht verwendet
page	Die angefragte Tabellenseite
rows	Anzahl der angefragten Zeilen.
fromRow	Von Satz Nummer.
toRow	Bis Satz Nummer.
sort	Spaltenname, nach dem sortiert werden soll.
order	Sortierreihenfolge: ASC oder DESC
search	true, wenn eine Suchanfrage gemacht wurde, sonst false.
id	Der Name (ID) der Tabelle
searchField	Bei einfacher Suche der Spaltenname des Suchfeldes. Sollte nicht mehr verwendet werden, stattdessen searchFilter benutzen.
searchValue	Bei einfacher Suche der Wert des Suchfeldes. Sollte nicht mehr verwendet werden, stattdessen searchFilter benutzen
searchFilter	Dieses Feld enthält bei einer Suche immer den Suchausdruck als JSON-Objekt. Die DLE kann diesen Ausdruck in SQL-Select Kommandos und in den Where-Bedingungen dern Datenkommandos direkt verstehen (z.B. "Schleife DB (Expert)"). Kommt in einer Where-Bedingung oder in einem beliebigen QWL--Select solch ein Suchausdruck vor, wird dieser in eine gültige SQL Where-Bedingung gewandelt. Ist der Suchausdruck leer, lautet die SQL Where-Bedingung 1=1. Das erlaubt es, auch ohne vorherige Abfrage den SQL Ausdruck mit AND oder OR zu erweitern.
searchOper	Bei einfacher Suche der Operator des Suchfeldes. Sollte nicht mehr verwendet werden, stattdessen searchFilter benutzen.