Caching Proxy Help

Verarbeitung von API-Anforderungen

Übersicht über das API

Die Schnittstelle API erlaubt Ihnen, die Basisfunktionen des Proxyservers zu erweitern. Durch Schreiben von Plug-Ins (von Ihnen erstellte Anwendungserweiterungen) können Sie die Verarbeitung wie folgt steuern:

Grundlegender Serverabfrageprozess

Der grundlegende Serverabfrageprozess lässt sich in mehrere Schritte unterteilen, basierend auf der Art der Verarbeitung, die der Server während dieser Phase durchführt. Jeder Schritt beinhaltet eine Verzweigung, an der ein bestimmter Programmteil ausgeführt werden kann. Durch Hinzufügen von API-Anweisungen zur Konfigurationsdatei können Sie festlegen, welche Anwendungsfunktionen der Server während eines bestimmten Schrittes aufrufen soll. Sie können mehrere Anwendungsfunktionen während eines einzelnen Anforderungsverarbeitungschritts aufrufen, wenn Sie für diesen Schritt mehr als eine der API-Anweisungen hinzufügen.

Abhängig vom verwendeten Betriebssystem ist das kompilierte Plug-In-Programm eine Datei mit der Erweiterung .DLL, .so oder .o. Während der Server die Schritte zur Anforderungsverarbeitung abarbeitet, ruft er die den einzelnen Schritten zugeordneten Plug-In-Anwendungsfunktionen auf, bis eine der Funktionen signalisiert, dass sie die Anforderung ausgeführt hat. Werden in einem bestimmten Schritt mehrere Plug-In-Funktionen aufgerufen, werden sie in der Reihenfolge aufgerufen, in der sie in der Konfigurationsdatei aufgeführt sind.

Wird die Anforderung von keiner Anwendungsfunktion ausgeführt (weil entweder keine Anwendungsfunktion angegeben wurde oder weil die Anwendungsfunktion für diesen Schritt den Code HTTP_NOACTION zurückgegeben hat), führt der Server die für diesen Schritt definierte Standardaktion aus. Anmerkung: Dies gilt für alle Schritte außer dem Service-Schritt; für den Service-Schritt ist keine Standardaktion vorgesehen.

API - Konfigurationsanweisungen

Für jeden Schritt innerhalb des Anforderungsprozesses ist eine Konfigurationsanweisung vorhanden, mit der Sie eine angepasste Anwendungsfunktion festlegen können, die während dieses Schritts aufgerufen und ausgeführt werden sollen.

API Anweisungsformate

ServerInit /Pfad/Datei:Funktionsname
PreExit /Pfad/Datei:Funktionsname
Authentication Typ /Pfad/Datei:Funktionsname
NameTrans /URL /Pfad/Datei:Funktionsname
Berechtigung /URL /Pfad/Datei:Funktionsname
Objektart /URL /Pfad/Datei:Funktionsname
PostAuth /Pfad/Datei:Funktionsname
Service /URL /Pfad/Datei:Funktionsname
Transmogrifier /Pfad/Datei:Name_Funktion_Öffnen:Name_Funktion_Schreiben:Name_Funktion_Schließen:Name_Funktion_Fehler
Protokoll /URL /Pfad/Datei:Funktionsname
Fehler /URL /Pfad/Datei:Funktionsname
PostExit /Pfad/Datei:Funktionsname
ServerTerm /Pfad/Datei:Funktionsname
Midnight /Pfad/Datei:Funktionsname
PICSDBLookup /Pfad/Datei:Funktionsname
GC Advisor /Pfad/Datei:Funktionsname
Proxy Advisor /Pfad/Datei:Funktionsname

API Anweisungsvariablen

Die Variablen in diesen Anweisungen haben die folgenden Bedeutungen:
Typ
(Wird nur mit der Anweisung Authentication verwendet.) Diese Einstellung legt fest, ob die Anwendungsfunktion aufgerufen wird. Zulässige Werte sind:
Basis
Die Anwendungsfunktion wird nur für Basisauthentifizierungsanforderungen aufgerufen
*
Anwendungsfunktion wird für alle Anforderungen aufgerufen

/URL
Dieser Wert legt fest, für welche URL-Anforderungen Ihre Anwendungsfunktion aufgerufen wird. Die URL-Spezifikationen in diesen Anweisungen sind virtuell (sie beziehen das Protokoll nicht mit ein), sie werden jedoch mit einem Schrägstrich (/) eingeleitet. So ist z. B. /www.ibm.com korrekt, http://www.ibm.com jedoch nicht. Zulässige Werte sind:
Ein bestimmter URL
Die Anwendungsfunktion wird nur für diesen URL aufgerufen
URL-Schablone
Anwendungsfunktionen werden nur für URLs aufgerufen, die mit der Schablone übereinstimmen. Sie können eine Schablone als /URL*, /* oder * angeben.

Anmerkung: Eine URL-Schablone ist für die Anweisung Service erforderlich, wenn Sie eine Pfadübersetzung wünschen.


/Pfad/Datei
Der vollständig qualifizierte Dateiname des kompilierten Programms
:Funktionsname
Der Name, den Sie der Anwendungsfunktion innerhalb Ihres Programms zugewiesen haben. In der Transmogrifier-Anweisung müssen Sie die Namen für die Funktionen zum Öffnen, Schreiben und Schließen angeben.

Zugehörige Informationen