Show TOC Anfang des Inhaltsbereichs

Objektdokumentation IF_HTTP_ENTITY  Dokument im Navigationsbaum lokalisieren

Definition

Das Interface besteht aus den unten aufgeführten Methoden und wird von den Interfaces IF_HTTP_RESPONSE und IF_HTTP_REQUEST umfasst. Die Attribute des Interfaces finden Sie im Abschnitt nach den Methoden.

Verwendung

Das Interface IF_HTTP_ENTITY wird als Basis der Interfaces IF_HTTP_RESPONSE und IF_HTTP_REQUEST genutzt, die einfach dieses Interface durch Hinzufügen von Request- und Response-spezifischen Methoden erweitern.

Zusätzlich zu diesem Zweck wird das Interface IF_HTTP_ENTITY als Interface für Multipart-Segmente genutzt – sowohl in Multipart-Requests als auch Multipart-Responses.

Die Zugriffsmöglichkeiten mittels der unten aufgeführten Methoden sind in den Abschnitten zur Entwicklung eines HTTP-Request-Handlers beschrieben:

·        Zugriff auf Header-Felder

·        Zugriff auf Formfelder

·        Zugriff auf Cookies

·        Zugriff auf HTTP Body Daten

·        Zugriff auf HTTP Multipart Daten

Struktur

Die in der Tabelle aufgelisteten Methoden werden von dem Interface IF_HTTP_ENTITY unterstützt. Diese Methoden werden auch von den Interfaces IF_HTTP_REQUEST und IF_HTTP_RESPONSE unterstützt. Im folgenden soll also der Begriff HTTP-Einheit stehen für einen HTTP-Request, eine HTTP-Response oder ein Multipart-Segment, je nachdem, worauf die Methode angewandt wird.

Zugriff auf Header-Felder

Methodenname

Verwendung/Bedeutung

GET_HEADER_FIELD

Gibt den Wert des spezifizierten (pseudo) HTTP-Header-Feldes zurück (Bezeichnung ist case-insensitive).

GET_HEADER_FIELDS

Gibt eine Tabelle aller (pseudo) HTTP-Header-Felder als Name/Wert-Paare zurück.

DELETE_HEADER_FIELD

Entfernt das angegebene Header-Feld aus der Liste von Header-Feldern.

DELETE_HEADER_FIELD_SECURE

Löscht das das Header-Feld aus der Liste der Header-Felder

SET_COMPRESSION

Aktivierung/Deaktivierung der Komprimierung

SET_HEADER_FIELD

Setzt das spezifizierte (pseudo)-Header-Feld auf den gegebenen Wert (Bezeichnung ist case-insensitive).

SET_HEADER_FIELDS

Setzt alle (pseudo)-HTTP-Header-Felder des Request Objektes auf  diejenigen Werte, die in der Name/Wert-Tabelle abgelegt als Argument mitgegeben werden.

Details zu den Zugriffsarten sowie eine Liste der SAP-spezifischen Header-Felder finden Sie im Abschnitt  Zugriff auf Header-Felder.

Zugriff auf Formfelder

Methodenname

Verwendung/Bedeutung

GET_FORM_FIELD

Gibt den Wert des spezifizierten HTML-Formfeldes zurück (Bezeichnung ist case-insensitive).

GET_FORM_FIELD_CS

Liefert den Wert des angeforderten Form-Felds

GET_FORM_FIELDS

Gibt eine Tabelle aller Name/Wert-Paare aus den HTML-Formfeldern zurück.

GET_FORM_FIELDS_CS

Liefert eine Liste aller Form-Felder (case-sensitive)

DELETE_FORM_FIELD

Entfernt das angegebene Formfeld.

DELETE_FORM_FIELD_SECURE

Löscht das Form-Feld aus der Liste der Form-Felder

SET_FORM_FIELD

Setzt das spezifizierte HTML-Formfeld auf den gegebenen Wert (Bezeichnung ist case-insensitive).

SET_FORM_FIELDS

Setzt alle HTML-Formfelder des Request Objektes auf die angegeben Werte.

Details finden Sie unter Zugriff auf Formfelder.

Zugriff auf Cookies

Methodenname

Verwendung/Bedeutung

ADD_COOKIE_FIELD

Setzt das angegebene Sub-Feld des gegebenen Cookies.

GET_COOKIE_FIELD

Gibt das angegebene Sub-Feld des gegebenen Cookies zurück.

GET_COOKIE

Gibt den Wert des spezifizierten Cookies zurück (Bezeichnung ist case-insensitive).

GET_COOKIES

Gibt eine Liste aller Cookies zurück.

DELETE_COOKIE

Löscht das angegebene Cookie aus der Liste aller Cookies

DELETE_COOKIE_SECURE

Löscht das Cookie aus der Liste der Cookies

SET_COOKIE

Setzt den Wert des spezifizierten Cookies (Bezeichnung ist case-insensitive).

Details finden Sie unter Zugriff auf Cookies.

Zugriff auf HTTP Body Daten

Methodenname

Verwendung/Bedeutung

APPEND_CDATA

Hängt den gegebenen Character-String an den Body der HTTP-Einheit an.

APPEND_CDATA2

Hängt den gegebenen Character-String an den Body der HTTP-Einheit an.

APPEND_DATA

Hängt den gegebenen binären String an den Body der HTTP-Einheit an.

FROM_XSTRING

Instanziiert die HTTP-Einheit anhand des gegeben XSTRINGs

GET_CDATA

Gibt die Daten des Bodys der HTTP-Einheit als Character-String zurück.

GET_DATA

Gibt die Daten des Bodys der HTTP-Einheit als binären String zurück.

SET_CDATA

Belegt  den Inhalt des Bodys der HTTP-Einheit  auf den gegebenen Character-String.

SET_DATA

Belegt den Inhalt des Bodies der HTTP-Einheit  mit dem gegebenen binären String.

TO_XSTRING

Umkehrfunktion von FROM_XSTRING: wandelt eine HTTP-Einheit in einen XSTRING um

GET_LAST_ERROR

Gibt den letzten Fehlercode zurück.

Details finden Sie unter Zugriff auf HTTP Body Daten.

Zugriff auf HTTP Multipart Daten

Hinweis

Die folgenden Methoden sind nur gültig für HTTP-Multipart-Einheiten!

Methodenname

Verwendung/Bedeutung

ADD_MULTIPART

Fügt ein Multipart Segment zum Body der HTTP-Einheit hinzu.

GET_MULTIPART

Gibt das durch einen Index spezifizierte Multipart-Segment zurück

NUM_MULTIPARTS

Gibt die Anzahl der Multipart-Segmente des Request-Objektes zurück.

Details finden Sie im Abschnitt Zugriff auf HTTP Multipart Daten.        

Ende des Inhaltsbereichs