Quelltext der Seite Locking

__TOC__
Mit Locking wird ein Mechanismus beschrieben, mit dem exklusiver Zugriff auf ein Element realisiert wird. Hierbei handelt es sich um eine serverseitige Funktionalität, die das Verändern eines gelockten Elements verhindert. Der IES unterstützt das Locking von Elementen unabhängig vom Typ. Gesteuert wird der Locking-Service über entsprechende <code>HandlerKeys</code>. Der Applikationsentwickler kann entscheiden, ob und wann ein Lock gesetzt bzw. entfernt wird. Es können parallel mehrere Locks pro Nutzer angelegt werden. Der Locking-Status eines Elementes lässt sich über SPML abfragen und auswerten. Je nach Umsetzung kann so auch der lesende Zugriff auf Elemente innerhalb einer Applikation verhindert werden.

Praktische Verwendung findet das Locking i.d.R. bei Artikeln um paralelles Bearbeiten der selben Informationen zu verhindern. In InfoSite5 wird ein solcher Artikel grau hervorgehoben und mit einem Tooltip, der Informationen zum aktuellen Bearbeiter angibt, versehen. Außerdem sind die Buttons zum Speichern deaktiviert.

Der Locking-Dienst steuert über einen Timeout-Mechanismus, dass Locks auf Elemente, nach einer konfigurierten Zeit in der keine Aktionen vorgenommen wurden (Standardwert ist 2 Min.), automatisch wieder zurückgesetzt werden. So kann sichergestellt werden, daS die Arbeiten am System in jedem Fall irgendwann fortgesetzt werden können.

==Setzen und Freigeben von Locks==
Um ein Lock auf ein Element (z.B. Artikel oder Template) zu setzen, wird beim Aufruf eines Handlers bzw. des <code>SpmlServlets</code> (beliebige URL des IES) lediglich ein weiterer Parameter via <code>POST</code> oder <code>GET</code> übergeben. Der Parameter heißt je nach Aktion:

;<code>SYS_lock</code>
:Mit <code>SYS_lock=${elementID}</code> wird versucht das Element <code>${elementID}</code> durch den aktuellen Benutzer zu locken. Ist das Element bereits durch einen anderen Nutzer gelockt, wird ein Fehler (<code>LockException</code>) zurückgegeben, der abgefangen werden sollte.

:ERROR-Code: [[Errorcode#SYS-E010|SYS-E010]]

;<code>SYS_unlock</code>
:Mit <code>SYS_unlock=${elementID}</code> wird veruscht das Element vom aktuellen Benutzer wieder freizugeben. Ist das Lock von einem anderen Benutzer angelegt worden, so wird ein Fehler (<code>AccessDeniedException</code>) zurückgegeben, der entsprechend abgefangen werden sollte.

:ERROR-Code: [[Errorcode#SYS-E010|SYS-E010]]

Ist es nötig mehre Elemente auf einmal zu locken, so kann auch eine kommaseparierte Liste von IDs übergeben werden. Tritt beim Locken bzw. Freigeben ein Fehler mit den übergebenen IDs auf, wird ein Fehler mit dem ERROR-Code: [[Errorcode#SYS-F012|SYS-F012]] zurückgegeben.

Ist ein Lock gesetzt, ist der Wert von "<code>.isReadOnly</code>" des entsprechenden Elementes automatisch für die Dauer des Locks auf "<code>true</code>" gesetzt worden.

Ein Beispiel für das Setzen und Freigeben von Locks:
<source lang="xml">
<a href="<sp:url uri="/"/>SYS_lock=<sp:print name="currentElement"/>">lock setzen</a>
<a href="<sp:url uri="/"/>SYS_unlock=<sp:print name="currentElement"/>">lock freigeben</a>
</source>

<noinclude>
[[Category:Funktionsbeschreibungen]]
[[Category:Qualität_des_Codes_prüfen]]
</noinclude>