Allgemeines
Der Resource Service erlaubt Ihnen die Bereitstellung beliebiger Dokumente unter Einbeziehung der Benutzer- und Rechteverwaltung.
Aufruf
Ein Musteraufruf einer Resource geschieht mittels ./restservice/resource/<resourcepath>?file=<resourcename>.
Hierbei muss zu <resourcepath> eine entsprechende Konfigurationsdatei innerhalb von <GISX3HOME>/config/resource existieren.
Konfiguration
Für jeden Resource-Pfad ist eine eigene Konfigurationsdatei mit dem Namen <resourcepath>.properties in <GISX3HOME>/config/resource zu definieren.
Die Datei hat folgenden Aufbau:
# The directory we are pointing to directory=GISX3HOME:/test # No roles, no restriction roles=
Wobei folgende Parameter verfügbar sind
| Parameter | Beschreibung | Optional | Bemerkung |
|---|---|---|---|
| directory | Das Verzeichnis in dem alle Dateien zum resourcepath abgelegt sind. Es werden keine Unterverzeichnisse berücksichtigt, diese sind als neue resource einzubinden. | Nein | Sofern sich das Zielverzeichnis innerhalb Ihres GISX3 Home Verzeichnisses befindet, können Sie den Verzeichnisnamen mit GISX3HOME: beginnen lassen. Dieser Bestandteil wird durch das GISX3HOME Verzeichnis ersetzt. |
| roles | Kommagetrennte Liste von Rollennamen. Ein Benutzer muss mindestens einen dieser Rollennamen zugewiesen haben um eine Resource zu sehen. Findet hier keine Angabe statt, steht die Resource allen Benutzern zur Verfügung | Ja |
Beispiel
Gegeben sei ein Verzeichnis C:/temp/docs welches unter anderem die Datei bild.jpg beinhaltet.
Durch die Konfigurationsdatei <GISX3HOME>/config/resource/test.properties:
# The directory we are pointing to directory=C:/temp/docs # No roles, no restriction roles=
kann unter <GISX3URL>/restservice/resource/test?file=bild.jpg das beinhaltete Bild im Browser aufgerufen werden.
Anwendungsfälle
In der Regel findet dieser Service Anwendung in dem er in den Tooltip von Themen eingebunden wird und dadurch die Anzeige weiterer Informationen erlaubt.