Caching Proxy - nápověda

Zpracování požadavku rozhraní API

API - přehled

Rozhraní API poskytuje možnost rozšíření základních funkcí serveru proxy. Napsáním modulů plug-in (vámi vytvořených rozšíření aplikace) můžete provádět například následující přizpůsobená zpracování:

Základní proces požadavků serveru

Základní proces požadavků serveru lze rozdělit na kroky podle typu zpracování, která v dané fázi server provádí. Každý krok zahrnuje důležitý okamžik, ve kterém může být spuštěn daný program. Přidáním direktiv API do konfiguračního souboru indikujete, které z funkcí aplikace má server volat během konkrétního kroku. Zahrnutím více než jedné direktivy API pro daný krok můžete v průběhu kroku procesu požadavku zavolat několik funkcí aplikace.

Zkompilovaný program modulu plug-in je soubor .DLL, .so nebo .o v závislosti na operačním systému. Jak server postupuje s kroky procesu požadavku, volá funkce modulu plug-in aplikace asociované s každým krokem, dokud některá funkce neindikuje zvládnutí požadavku. Je-li z konkrétního kroku zavolána více než jedna funkce modulu plug-in, jsou funkce volány v pořadí uvedeném v konfiguračním souboru.

Pokud není požadavek funkcí aplikace dokončen (nebyla zadána žádná funkce aplikace nebo tato funkce vrátila pro daný krok kód HTTP_NOACTION), provede server pro daný krok výchozí akci. Poznámka: Tento postup platí pro všechny kroky kromě kroku služby; krok služby nemá výchozí akci.

Direktivy konfigurace API

Pro každý krok v procesu požadavku existuje direktiva konfigurace, jež umožňuje zadat přizpůsobenou funkci aplikace, která bude zavolána a provedena v průběhu daného kroku.

Formáty direktivy API

ServerInit /cesta/soubor:název_funkce
PreExit /cesta/soubor:název_funkce
Authentication typ /cesta/soubor:název_funkce
NameTrans /adresa_URL /cesta/soubor:název_funkce
Authorization /adresa_URL /cesta/soubor:název_funkce
ObjectType /adresa_URL /cesta/soubor:název_funkce
PostAuth /cesta/soubor:název_funkce
Service /adresa_URL /cesta/soubor:název_funkce
Transmogrifier /cesta/soubor:název_funkce_pro_otevření:název_funkce_pro_zápis:název_funkce_pro_zavření:název_chybové_funkce
Log /adresa_URL /cesta/soubor:název_funkce
Error /adresa_URL /cesta/soubor:název_funkce
PostExit /cesta/soubor:název_funkce
ServerTerm /cesta/soubor:název_funkce
Midnight /cesta/soubor:název_funkce
PICSDBLookup /cesta/soubor:název_funkce
GC Advisor /cesta/soubor:název_funkce
Proxy Advisor /cesta/soubor:název_funkce

Proměnné direktivy API

Proměnné v těchto direktivách mají následující významy:
typ
(Použito pouze u direktivy Authentication.) Toto nastavení určuje, zda bude zavolána daná funkce aplikace. Platné hodnoty:
Základní
Funkce aplikace je volána pouze u požadavků základního ověřování.
*
Funkce aplikace je volána u všech požadavků.

/adresa_URL
Tato hodnota určuje, pro které požadavky na adresy URL bude volána daná funkce aplikace. Specifikace adres URL v těchto direktivách jsou virtuální (nezahrnují protokol), ale předchází jim lomítko (/). Například /www.ibm.com je správně, ale http://www.ibm.com nikoli. Platné hodnoty:
Konkrétní adresa URL
Funkce aplikace je volána pouze u dané adresy URL.
Šablona adres URL
Funkce aplikace je volána pouze u adres URL, které odpovídají šabloně. Šablonu můžete zadat jako /URL*, /* nebo *.

Poznámka: Šablona adresy URL je u direktivy Service požadována, pokud má proběhnout převod cesty.


/cesta/soubor
Úplný kvalifikovaný název souboru zkompilovaného programu
:název_funkce
Název, který jste dali funkci aplikace v rámci daného programu. V direktivě Transmogrifier je třeba dodat názvy funkcí pro otevření, zápis a zavření.

Související informace