Environment-Klasse: Difference between revisions

From WaveCDN Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 88: Line 88:
* wavecdn_deliver
* wavecdn_deliver
|-
|-
|get_request_header(name)
|set_request_headers(headers)
|Gibt den ersten Header aus der Webuser-Anfrage zurück, der bei Ignorierung von Groß- und Kleinschreibung den gleichen Namen hat. Wenn der Header nicht existiert, wird None zurückgegeben.
|Setzt nachträglich in der Webuser-Anfrage die Header. Erwartet wird eine Liste von Headern.
|
|
* wavecdn_receive
* wavecdn_receive
Line 97: Line 97:
* wavecdn_deliver
* wavecdn_deliver
|-
|-
|set_request_header(name)
|get_request_header(name)
|Setzt nachträglich in der Webuser-Anfrage den Header mit dem angegebenen Namen. Wenn es bei Ignorierung von Groß- und Kleinschreibung einen anderen Header mit dem angegebenen Namen gibt, wird dieser überschrieben. Wenn es mehrere mit dem gleichen Namen gibt, wird der erste überschrieben.
|Gibt den ersten Header aus der Webuser-Anfrage zurück, der bei Ignorierung von Groß- und Kleinschreibung den gleichen Namen hat. Wenn der Header nicht existiert, wird None zurückgegeben.
|
|
* wavecdn_receive
* wavecdn_receive
Line 106: Line 106:
* wavecdn_deliver
* wavecdn_deliver
|-
|-
|set_request_headers(headers)
|set_request_header(name)
|Setzt nachträglich in der Webuser-Anfrage die Header. Erwartet wird eine Liste von Headern.
|Setzt nachträglich in der Webuser-Anfrage den Header mit dem angegebenen Namen. Wenn es bei Ignorierung von Groß- und Kleinschreibung einen anderen Header mit dem angegebenen Namen gibt, wird dieser überschrieben. Wenn es mehrere mit dem gleichen Namen gibt, wird der erste überschrieben.
|
|
* wavecdn_receive
* wavecdn_receive

Revision as of 09:18, 9 January 2014

Konkret handelt es sich bei der Environment-Klasse um die Python-Klasse WavecdnEnvironmentV1. Sie ist bei der Programmierung von Erweiterungen relevant. Im folgenden findet sich die Dokumentation der Klassenmethoden. Die Spalte 'Verfügbarkeit' gibt die Schritte der Anfragenabarbeitung an, in denen die jeweilige Methode verfügbar ist.


Methode Beschreibung Verfügbarkeit
get_client_ip() Gibt die IP vom Webuser zurück.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_ssl() Gibt in Form eines Boolean zurück, ob der Webuser bei der Anfrage SSL genutzt hat oder nicht.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_method() Gibt die Methode der Anfrage vom Webuser zurück. Zum Beispiel 'GET' oder 'POST'.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_uri() Gibt die vom Webuser angefragte URI zurück, beispielsweise '/main/index.php?site=example'.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_path() Gibt die vom Webuser angefragte URL ohne Query-String zurück.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_query_string() Gibt den Query-String aus der vom Webuser angefragten URL zurück. Wenn kein Query-String vorhanden ist, wird None zurückgegeben.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_query_string_parameters() Gibt ein Dictionary mit den Parametern des Query-Strings zurück. Wenn zwei Parameter den gleichen Namen haben, wird nur der erste in das Dictionary aufgenommen. Wenn kein Query-String vorhanden ist, wird ein leeres Dictionary zurückgegeben.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_query_string_parameter(name) Gibt den Wert vom Parameter mit dem angegebenen Namen aus dem Query-String zurück. Wenn es zwei Parameter mit dem angebenen Namen im Query-String gibt, wird der Wert vom ersten Parameter zurückgegeben. Wenn der angegebene Parameter nicht existiert, wird None zurückgegeben.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_headers() Gibt ein Dictionary mit den Headern der Anfrage vom Webuser zurück.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
set_request_headers(headers) Setzt nachträglich in der Webuser-Anfrage die Header. Erwartet wird eine Liste von Headern.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_request_header(name) Gibt den ersten Header aus der Webuser-Anfrage zurück, der bei Ignorierung von Groß- und Kleinschreibung den gleichen Namen hat. Wenn der Header nicht existiert, wird None zurückgegeben.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
set_request_header(name) Setzt nachträglich in der Webuser-Anfrage den Header mit dem angegebenen Namen. Wenn es bei Ignorierung von Groß- und Kleinschreibung einen anderen Header mit dem angegebenen Namen gibt, wird dieser überschrieben. Wenn es mehrere mit dem gleichen Namen gibt, wird der erste überschrieben.
  • wavecdn_receive
  • wavecdn_hit
  • wavecdn_miss
  • wavecdn_fetch
  • wavecdn_deliver
get_backend_response_headers() Gibt ein Dictionary mit den Headern aus der Origin/Storage-Antwort zurück.
  • wavecdn_fetch
get_backend_response_header(name) Gibt den Header mit dem angegebenen Namen aus der Origin/Storage-Antwort zurück. Wenn der Header nicht existiert, wird None zurückgegeben.
  • wavecdn_fetch
set_backend_response_header(name, value) Setzt den Header mit dem angegebenen Namen und Wert in der Origin/Storage-Antwort. Sinnvoll, wenn Header noch vor dem Caching hinzugefügt werden sollen.
  • wavecdn_fetch
get_response_status_code() Gibt den HTTP-Code der Antwort zurück, die WaveCDN an den Webuser schicken wird. Es handelt sich um einen Integer.
  • wavecdn_deliver
set_response_status_code(code) Setzt den HTTP-Code der Antwort, die WaveCDN an den Webuser schicken wird. Beim Code handelt es sich um einen Integer.
  • wavecdn_deliver
get_response_headers() Gibt ein Dictionary mit den Headern der Antwort zurück, die WaveCDN an den Webuser schicken wird.
  • wavecdn_deliver
get_response_header(name) Gibt den Header mit dem angegebenen Namen aus der Antwort zurück, die WaveCDN an den Webuser schicken wird. Wenn der Header nicht existiert, wird None zurückgegeben.
  • wavecdn_deliver
set_response_header(name, value) Setzt den Header mit dem angegebenen Namen und Wert in der Anwort, die WaveCDN an den Webuser schicken wird.
  • wavecdn_deliver
remove_response_header(name) Entfernt den Header mit dem angegebenen Namen aus der Anwort, die WaveCDN an den Webuser schicken wird.
  • wavecdn_deliver