Environment-Klasse
Jump to navigation
Jump to search
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. |
|
| get_request_ssl() | Gibt in Form eines Boolean zurück, ob der Webuser bei der Anfrage SSL genutzt hat oder nicht. |
|
| get_request_method() | Gibt die Methode der Anfrage vom Webuser zurück.
Zum Beispiel: 'HEAD', 'GET' oder 'POST' |
|
| get_request_uri() | Gibt die vom Webuser angefragte URI zurück.
Zum Beispiel: '/main/index.php?site=home' |
|
| get_request_path() | Gibt die vom Webuser angefragte URL ohne Query-String zurück.
Zum Beispiel: '/main/index.php' |
|
| 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.
Zum Beispiel: 'site=home' oder None |
|
| 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.
Zum Beispiel: {'site': 'home'} |
|
| 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. |
|
| get_request_headers() | Gibt eine Liste mit den Headern der Anfrage vom Webuser zurück.
Zum Beispiel: [['Accept-Encoding', 'gzip'], ['Host', 'example.wavecdn.net']] |
|
| set_request_headers(headers) | Ersetzt nachträglich in der Webuser-Anfrage alle Header. Der einzige Original-Header, der immer bestehen bleibt und seinen Originalwert beibehält, ist der Host-Header. Erwartet wird eine Liste von Headern. |
|
| 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. |
|
| set_request_header(name) | Setzt nachträglich in der Webuser-Anfrage den Header mit dem angegebenen Namen. Alle Header, die bei Ignorierung von Groß- und Kleinschreibung den gleichen Namen haben, werden überschrieben. Am Ende gibt es genau einen Header mit dem angegebenen Namen. |
|
| unset_request_header(name) | Entfernt nachträglich aus der Webuser-Anfrage bei Ignorierung von Groß- und Kleinschreibung alle Header mit dem angegebenen Namen. |
|
| get_backend_response_headers() | Gibt eine Liste mit den Headern aus der Origin/Storage-Antwort zurück.
Zum Beispiel: [['Set-Cookie', 'sessionid=f938a47a9ef3259860a8b7c4; path=/']] |
|
| set_backend_response_headers(headers) | Ersetzt nachträglich in der Antwort vom Origin/Storage alle Header. Erwartet wird eine Liste von Headern. |
|
| 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. |
|
| 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. |
|
| 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. |
|
| 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. |
|
| get_response_headers() | Gibt ein Dictionary mit den Headern der Antwort zurück, die WaveCDN an den Webuser schicken wird. |
|
| 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. |
|
| set_response_header(name, value) | Setzt den Header mit dem angegebenen Namen und Wert in der Anwort, die WaveCDN an den Webuser schicken wird. |
|
| remove_response_header(name) | Entfernt den Header mit dem angegebenen Namen aus der Anwort, die WaveCDN an den Webuser schicken wird. |
|