Požadavek unload-soap

Účel a dopady

Uvolní z operační paměti serveru jednu pojmenovanou načtenou SOAP službu (akci), nebo – není-li name uveden – všechny načtené služby najednou. Volitelně navíc vynutí znovunačtení globálních souborů SOAP brány. Požadavek není běžně vůbec zapotřebí – server si aktuálnost načtených akcí hlídá sám.

Dostupnost, kontext, oprávnění apod.

Smí použít jen uživatel s r_admin nebo r_manage; jinak je požadavek zamítnut.

XML požadavek (syntax + popis)

  <request>
   <unload-soap
    name="{string}"
    refresh="{bool}"
    />
  </request>

Parametry a pravidla (atributy, potomci)

• name - Cílová služba - Přesný název jedné načtené služby, která se má z paměti uvolnit. (typ: string; nepovinný)
• refresh - Znovunačíst globální soubory - Je-li "true", po uvolnění se navíc znovu načtou globální soubory SOAP brány (chybová/extrakční/výstupní XSLT šablony a soubor soap-unifault.xml) – ty se běžně nemění a bez tohoto příznaku by k jejich aktualizaci v paměti byl jinak zapotřebí restart serveru. (typ: bool; nepovinný; výchozí: false)

Požadavek nemá žádné potomky.

Závislosti

Není-li name uveden, uvolní se všechny aktuálně načtené služby, ne jen jedna.

Příklady požadavku

(Zatím bez ověřeného příkladu.)

Zpracování a vedlejší účinky

• Je-li name uveden, server zavolá odstranění jen té jedné pojmenované služby z paměti; jinak vymaže celou interní tabulku načtených služeb.
• Je-li refresh="true", server následně vyvolá znovunačtení globálních souborů SOAP brány; to je jediný krok, který pro tento požadavek může skončit chybou.

XML odpověď (syntax + popis)

  <response>
   <unload-soap
    type="ok"
    />
  </response>

Parametry a pravidla (atributy, potomci) – odpověď

• type - Výsledek - Hodnota ok při úspěchu. (typ: enum; povolené hodnoty: ok)

Příklady odpovědi

(Zatím bez ověřeného příkladu.)

Chyby a reakce

• <unload-soap type="error" detail="Inicializace SOAP se nezdarila"/> – refresh="true" a znovunačtení globálních souborů SOAP brány selhalo.
• <unload-soap status="error" detail="Nemate patricna opravneni"/> – volající nemá r_admin ani r_manage. Pozor: tato chybová odpověď používá atribut status, zatímco chyba inicializace SOAP i úspěšná odpověď používají type.
• Výraz pro identifikaci chyb v odpovědi serveru: unload-soap[@type='error'] | unload-soap[@status='error'].

Související požadavky

• soap-services – vypíše seznam právě načtených služeb, které lze tímto požadavkem uvolnit.
• unload-pseudo – obdobné ruční uvolnění paměti, ale pro šablony pseudo dokumentů.