Show TOC

Interface IF_BSP_APPLICATION_EVENTSLocate this document in the navigation structure

Verwendung

Das Interface IF_BSP_APPLICATION_EVENTS kann von einer BSP-Applikationsklasse implementiert werden, wenn sie zu bestimmten Zeitpunkten im Verlauf des Lebenszyklus einer BSP-Applikation die Kontrolle zur Ausführung eigener Funktionalität erhalten möchte. Die möglichen Zeitpunkte sind Applikationsbeginn und -ende sowie HTTP-Request-Eingang und HTTP-Response-Ausgang. Typischerweise werden diese Zeitpunkte eingesetzt, um Berechtigungsprüfungen oder Datenpersistierung bzw. Datenrestaurierung in stateless BSP-Applikationen zu realisieren.

Vererbungshierarchie/Interfacekomposition

Erweitertes Interface

-

Spezialisierende Interfaces

-
Attribute

-

Methoden
Methode on_start

Signatur 

method on_start
  importing
    runtime  type ref to if_bsp_runtime
    request  type ref to if_http_request
    response type ref to if_http_response 
  .

Beschreibung

Diese Methode wird von der BSP-Laufzeit aufgerufen, wenn die zugehörige BSP-Applikation erstmalig gestartet wird, d.h. zu Beginn der entsprechenden BSP-Session. Dies trifft für stateless wie stateful Applikationen zu. Typischerweise wird dieser Zeitpunkt für die Ausführung von Autorisierungschecks, die die gesamte Applikation betreffen, oder zur Vorabdatenbeschaffung (in statefull Applikationen) eingesetzt.

Parameter

RUNTIME

Referenz auf die BSP-Laufzeit
REQUEST

Referenz auf den aktuellen HTTP-Request
RESPONSE

Referenz auf die aktuelle HTTP-Response

Return-Werte/Ausnahmen

-

 -
Methode on_stop

Signatur 

method on_stop
  importing
    runtime  type ref to if_bsp_runtime
    request  type ref to if_http_request
    response type ref to if_http_response 
  .

Beschreibung

Diese Methode wird von der BSP-Laufzeit aufgerufen, wenn die zugehörige BSP-Applikation explizit beendet wird. Dies trifft für stateless wie stateful Applikationen zu.

Hinweis

Beachten Sie, dass dieser Zeitpunkt bei stateless BSP-Applikationen nicht nach jedem Request gegeben ist! Außerdem wird dieser Zeitpunkt nicht ausgewertet, wenn die Session durch einen Timeout implizit beendet wird. Insofern können in dieser Methode nur optionale Operationen ausgeführt werden, deren Ausbleiben keinen kritischen Charakter hat.

Typischerweise wird dieser Zeitpunkt für "Aufräumarbeiten" wie dem Löschen von Browser-Cookies oder Server-seitigen Cookies eingesetzt, falls die Applikation solche zuvor erzeugt hat.

Parameter

RUNTIME

Referenz auf die BSP-Laufzeit

REQUEST

Referenz auf den aktuellen HTTP-Request

RESPONSE

Referenz auf die aktuelle HTTP-Response

Return-Werte/Ausnahmen

-

 -
Methode on_request

Signatur 

method on_request
  importing
    runtime  type ref to if_bsp_runtime
    request  type ref to if_http_request
    response type ref to if_http_response 
  .

Beschreibung

Diese Methode wird von der BSP-Laufzeit für jeden eingehenden Request auf eine BSP aufgerufen, bevor die BSP die Kontrolle erhält (im OnRequest-Eventhandler).

Dieser Zeitpunkt kann von der Anwendungsklasse z.B. zum Wiederherstellen von Attributen verwendet werden, wenn diese in Client- oder Server-seitige Cookies in einem vorangegangenen Request gerettet wurden.

Parameter

RUNTIME

Referenz auf die BSP-Laufzeit
REQUEST

Referenz auf den aktuellen HTTP-Request
RESPONSE

Referenz auf die aktuelle HTTP-Response

Return-Werte/Ausnahmen

-

 -
Methode on_response

Signatur 

method get_parameter
  importing
    name  type string 
  returning 
    value type string
  .

Beschreibung

Diese Methode wird von der BSP-Laufzeit für jede ausgehende Response einer BSP aufgerufen, nachdem die BSP bearbeitet wurde (nach dem OnManipulation-Eventhandler).

Dieser Zeitpunkt kann von einer stateless Anwendungsklasse z.B. zum Retten von Attributen in Client- oder Server-seitigen Cookies verwendet werden

Parameter

RUNTIME

Referenz auf die BSP-Laufzeit
REQUEST

Referenz auf den aktuellen HTTP-Request
RESPONSE

Referenz auf die aktuelle HTTP-Response

Return-Werte/Ausnahmen

-

 -