Požadavek cache-boost

Účel a dopady

Zapne nebo vypne globální příznak „boost“ interní statistiky serveru, nebo – bez uvedení atributu – jen zjistí jeho aktuální hodnotu bez jakékoli změny. Vedlejší efekt: ovlivňuje běh serveru globálně pro všechny uživatele, ne jen pro volajícího.

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

• Smí použít jen uživatel s r_admin; jinak je požadavek zamítnut.
• Podléhá standardnímu transakčnímu zpracování obálky <request> (transactional/přeskočení při odvolané transakci) – viz obálka požadavku.

XML požadavek (syntax + popis)

  <request>
   <cache-boost
    state="{bool}"
    />
  </request>

Parametry a pravidla (atributy, potomci)

• state - Nový stav boostu - Je-li atribut uveden, nastaví globální příznak na "true"/nastaví jej vypnutý pro cokoli jiného (server porovnává jen s "true", jinak vypne). Není-li atribut uveden vůbec, server hodnotu nemění a jen vrátí aktuální stav. (typ: bool; nepovinný)

Požadavek nemá žádné potomky.

Příklady požadavku

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

Zpracování a vedlejší účinky

• Je-li state uveden, přesná hodnota "true" (case-sensitive) zapne cache boost; jakákoli jiná hodnota (např. "1", "True") jej vypne.
• Není-li state uveden, server vrátí aktuální stav cache boostu beze změny.
• Nemá-li volající r_admin, k žádnému čtení ani zápisu stavu nedojde.

XML odpověď (syntax + popis)

  <response>
   <cache-boost
    type="ok"
    state="{bool}"
    />
  </response>

state v odpovědi je vždy přítomen při úspěchu a odráží výsledný (případně nezměněný) stav boostu.

Příklady odpovědi

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

Chyby a reakce

• <cache-boost status="error" detail="Nemate patricna opravneni"/> – volající nemá r_admin. Na rozdíl od dosavadní dokumentace tato chyba nepoužívá atribut type, ale status, a nikdy neobsahuje state.
• <cache-boost status="error" detail="Transakce byla odvolana"/> / <cache-boost status="skip" detail="Transakce byla preskocena"/> – požadavek byl vyřazen standardním transakčním zpracováním obálky.
• Uzel cache-boost s type="error" nevzniká – jedinou pozorovanou chybovou větví je selhání oprávnění (status="error"), případně transakční vyřazení. Výraz pro identifikaci chyb v odpovědi serveru: cache-boost[@status='error'].

Související požadavky

• service – další administrátorský požadavek ovlivňující běh serveru jako celku.