Einführung
Einführung

Einführung / FirstSpirit ServerManager / Server-Eigenschaften / Module

Module

Verwendungen aktualisierenDienst startenAutostart aktivierenSichtbarkeitDeinstallierenModulnameKonfigurierenTypInstallieren / AktualisierenDienst stoppenVersion
Inhaltsverzeichnis

In diesem Bereich können FirstSpirit-Module installiert und konfiguriert werden. Initial ist mindestens das Modul „System“ (Ordner-Symbol) mit den Standard-Komponenten vorhanden. Die Anzeige der Module ist alphabetisch (nach den Namen der Module) sortiert.

Wichtig Bei Installation und Aktualisierung von Modulen, die entweder selbst oder durch direkt oder indirekt abhängige Dienste Grundlage für Daten sind, stehen diese Daten bis zum Neustart der auf diese zugreifenden Prozesse (Generierungen, Clients...) diesen Prozessen nicht mehr zur Verfügung.

Name: Name des Moduls bzw. einer Komponente des Moduls. Die Module werden innerhalb des Dialogs mit einem Ordner-Icon gekennzeichnet. Zu jedem Modul gehören eine oder mehrere Komponenten, die unterhalb des Moduls angezeigt werden. Komponenten werden mit einem Datei-Icon gekennzeichnet. Es gibt unterschiedliche Arten von Komponenten (siehe „Typ“).

Version: Versionsnummer des Moduls bzw. der Komponente, die auf dem FirstSpirit-Server installiert ist.

Typ: Art der Komponente. Es wird zwischen folgenden Komponenten unterschieden:

  • Bibliothek: Eine Bibliothek ist eine konfigurationslose Sammlung von Klassen, verpackt in einer oder mehreren Jar-Dateien. Sie stehen nach der Installation auf dem FirstSpirit-Server, innerhalb der Clients, in Skripten und anderen Modulen zur Verfügung.
  • Editor: Ein Editor ist eine Kombination aus GUI- und Render-Komponente. Hierüber ist es möglich, den FirstSpirit-Client um eigene Eingabemöglichkeiten zu erweitern. (Beispiel CMS_INPUT_PERMISSION-Eingabekomponente zur Definition von Rechten, siehe dazu Konfiguration von Benutzerrechten. Diese Eingabekomponente arbeitet mit dem passenden Dienst zusammen, der die Gruppendefinitionen vom Server lädt und bereitstellt.)
  • Dienst: Ein Dienst ist eine Server-Komponente, die über eine öffentliche Schnittstelle aus Eingabekomponenten oder Skripten angesprochen werden kann. (Beispiele sind die Rechtschreibprüfung oder der Dienst der Rechte-Eingabekomponente CMS_INPUT_PERMISSION.)
  • Webanwendung: Eine Webanwendung definiert JSP-Tags und Servlets, die in Projekten verwendet und aufgerufen werden können. (Die Personalisierung und Suche sind Beispiele für Webanwendungen.)
  • Webserver: Eine Webserver-Komponente stellt Funktionalitäten zur Verfügung, um Webanwendungen zu installieren und zu deinstallieren. (Beispiele hierfür sind die interne Webserver-Steuerung oder eine Tomcat-Unterstützung, siehe dazu Webserver.)

Sichtbar: Komponenten stehen nach der Installation nur innerhalb eines bestimmten Bereichs zur Verfügung. Es wird zwischen folgenden Bereichen unterschieden:

  • Global: Globale (systemweite) Komponenten stehen nach der Installation auf dem Server zur Verfügung; damit sind diese Komponenten auch innerhalb der FirstSpirit-Anwendungen in allen Skripten und anderen Komponenten verfügbar (Beispiel: alle Services; z. B. Permission-Service).
  • Projekt: Projekt-lokale Komponenten können nach der Installation den gewünschten Projekten über deren Projekteigenschaften hinzugefügt werden (siehe Web-Komponenten). Anschließend besteht die Möglichkeit, diese Komponenten zu konfigurieren. Die Konfigurationsmöglichkeit ist abhängig von der installierten Komponente.
  • Web: Web-lokale Komponenten können nach der Installation den einzelnen Web-Bereichen (preview, staging, live) innerhalb der gewünschten Projekte zugefügt werden (siehe Web-Komponenten). Die Konfigurationsmöglichkeit ist abhängig von der installierten Komponente. Die Komponenten können für die jeweiligen Projekte unterschiedlich konfiguriert werden.

Installieren / Aktualisieren: Mit einem Klick auf Installieren öffnet sich ein Dateiauswahldialog. Hier kann die zu installierende fsm-Datei ausgewählt werden (beispielsweise das Modul zu „FirstSpirit DynamicPersonalization“, siehe FirstSpirit DynamicPersonalization (→Online Dokumentation FirstSpirit)). Die erfolgreich installierte Datei wird anschließend im Dialog „Server-Eigenschaften“ (siehe Abbildung oben) angezeigt.

Enthält die installierte Komponente einen Dienst, wird außerdem ein Dialog angezeigt, mit dem die Autostart-Option für den Dienst konfiguriert werden kann. Wird der Dialog mit Ja bestätigt, wird der Dienst bei jedem Neustart des Servers automatisch gestartet (vgl. Option Autostart aktivieren / deaktivieren unten).

Steht eine neuere Version des Moduls zur Verfügung, kann das Modul ebenfalls über die Schaltfläche Installieren auf dem FirstSpirit-Server aktualisiert werden. Es ist nicht notwendig, das Modul dafür zuvor zu deinstallieren. Obwohl die ursprüngliche Konfiguration erhalten bleibt, sind jedoch eventuell Anpassungen in der Konfiguration oder innerhalb der das Modul verwendenden Projekte erforderlich. Daher wird die neue Version des Moduls nicht automatisch in die Projekte übernommen, sondern die Aktualisierung innerhalb eines Projekts muss manuell durchgeführt werden (siehe Projekt-Komponenten und Web-Komponenten). Die Verwendungen können über die Schaltfläche Verwendungen aktualisieren vorgenommen werden.

Wichtig Nach dem Update von Modulen, die Abhängigkeiten zu Modulen mit Diensten („Service“) haben, müssen diese Dienste manuell neugestartet werden. (Schaltflächen Dienst stoppen / Dienst starten, siehe unten, bzw. über das ServerMonitoring, Dienste)

Deinstallieren: Zum Deinstallieren wird das gewünschte Modul in der Übersicht der installierten Module ausgewählt und mit einem Klick auf den Button deinstalliert. Das Modul „System“ (Ordner-Symbol) kann nicht deinstalliert werden.

Es können nur Module deinstalliert werden, die nicht in einem Projekt verwendet werden. Beim Versuch ein Modul zu deinstallieren, das noch verwendet wird, erscheint eine Fehlermeldung mit einer Liste aller Projekte, die das Modul zurzeit verwenden. Zur Deinstallation muss das Modul zunächst aus diesen Projekten entfernt werden (siehe Web-Komponenten).

Konfigurieren: Mit einem Klick auf den Button kann die selektierte Komponente konfiguriert werden. Die Konfigurationsmöglichkeit ist abhängig von der ausgewählten Komponente (siehe Beispiel SpellService). Außerdem können Rechte für ein Modul gesetzt werden (siehe Abschnitt Vertrauenswürdige Module):

Verwendungen aktualisieren: Für das komfortable Aktualisieren eines Moduls, das eine Projekt- oder eine Webanwendung beinhaltet, steht die Funktion Verwendungen aktualisieren zur Verfügung. Beim Klick auf die Schaltfläche öffnet sich ein Dialogfenster zur Aktualisierung der Projekt- bzw. der Webanwendungen für alle Projekte, die diese Anwendung bisher verwenden:

Die Aktualisierung muss also nicht einzeln für jedes Projekt über die Projekteigenschaften ausgeführt werden, sondern kann zentral über die Servereigenschaften gesteuert werden.

Dienst starten: Mit einem Klick auf den Button kann ein Dienst gestartet werden. Das Starten eines Dienstes ist auch über das ServerMonitoring möglich (siehe Dienste).

Wichtig Nach dem Update von Modulen, die Abhängigkeiten zu Modulen mit Diensten („Service“) haben, müssen diese Dienste manuell neugestartet werden.

Dienst stoppen: Mit einem Klick auf den Button kann ein gestarteter Service gestoppt werden. Das Stoppen eines Dienstes ist auch über das ServerMonitoring möglich (siehe Dienste).

Autostart aktivieren/deaktivieren: Mit einem Klick auf den Button kann der automatische Start für einen Dienst aktiviert bzw. deaktiviert werden. Wird die Option Autostart aktivieren gewählt, wird der Dienst bei jedem Server-Neustart automatisch gestartet. Wird die Option Autostart deaktivieren gewählt, muss der Dienst bei jedem Server-Neustart manuell gestartet werden. Diese Einstellung kann initial auch beim Installieren bzw. Aktualisieren von Diensten gesetzt werden.

Wichtig Viele der oben dokumentierten Funktionen sind auch über die FirstSpirit Developer-API möglich (Interface ModuleAdminAgent, Paket de.espirit.firstspirit.agency).

Vertrauenswürdige Module

Der FirstSpirit SiteArchitect und der FirstSpirit ServerManager werden über eine JNLP-Datei, d.h. über Java Web Start ausgeführt. Daraus ergeben sich Einschränkungen in der Nutzung einiger Funktionalitäten für nicht von e-Spirit signierte Module bzw. in den Jar-Archiven enthaltene Klassen. Java-Programme laufen normalerweise in einer „Sandbox“ ab. Das bedeutet, sie besitzen keinen vollwertigen Zugriff auf den Rechner (und dessen Ressourcen), auf dem sie ausgeführt werden. Der Zugriff auf lokale Ressourcen wie Dateien, Zwischenablage, Netzwerk usw. erfolgt über einen Security-Manager.

Die FirstSpirit-internen Module sind mit dem „e-Spirit AG“-Schlüssel signiert. Dieser ist wiederum Bestandteil der FirstSpirit-internen Security-Policy. Des Weiteren ist der Schlüssel von einer Root-Authority bestätigt, die wiederum dem Java Zertifikat Manager bekannt ist.

Externe Komponenten oder Module, die auf sicherheitsrelevante Funktionalitäten zugreifen, können komfortabel über den FirstSpirit ServerManager konfiguriert werden. Dabei kann jedes installierte Modul (mit Ausnahme der FirstSpirit System-Module) optional mit Rechten auf lokale System-Ressourcen ausgestattet werden. Damit besteht die Möglichkeit, einem Modul, das sicherheitsrelevante Operationen durchführt, z. B. den Zugriff auf die Zwischenablage (java.awt.AWTPermission ClipboardAccess), zu vertrauen. Diesem Modul können Rechte zur Durchführung der Operationen zugewiesen werden. Dies geschieht intern über den FirstSpirit Security-Manager/Classloader.

Die Konfigurationsoberfläche zum Setzen der Modulrechte im FirstSpirit ServerManager stellt sich wie folgt dar:

Wichtig Wird eine externe Komponente oder ein Modul als vertrauenswürdig eingestuft, kann nicht sichergestellt werden, dass die Zugriffsschutz-Mechanismen von FirstSpirit voll wirksam sind. Eventuell auftretende Fehlfunktionen können nicht mehr eindeutig zugeordnet werden, so dass eine Fehlerdiagnose erschwert wird oder unmöglich ist. Im Rahmen der Produktwartung von FirstSpirit werden daher Systemkonfigurationen mit als vertrauenswürdig eingestuften, externen Komponenten bzw. Modulen nicht akzeptiert.

Zu weiterführenden Informationen siehe Thema dieser Dokumentation (→Entwicklerhandbuch für Komponenten).

Über die FirstSpirit Developer-API können selbst erstellte Module über die Methode setTrusted im Interface ModuleAdminAgent (Package de.espirit.firstspirit.agency) als vertrauenswürdig ausgezeichnet werden bzw. über die Methode isTrusted die Vertrauenswürdigkeit geprüft werden.

Abhängige Module

Es ist möglich, Abhängigkeiten zwischen FirstSpirit-Modulen zu definieren. Dies erfolgt über den Eintrag

<dependencies>
    <depends>modulname</depends>
</dependencies>

in der Datei module.xml des abhängigen Moduls (Child) (siehe Thema dieser Dokumentation (→Entwicklerhandbuch für Komponenten)).

Es werden sowohl Module, die eine Angabe von <dependencies><depends> enthalten (Child), als auch Module, die über diese Angabe referenziert werden (Parent), rückstandsfrei vom FirstSpirit-Server deinstalliert (Schaltfläche „Deinstallieren“), auch wenn das abhängige Modul nicht mehr auf dem Server vorhanden ist (weil es beispielsweise bereits zuvor entfernt wurde).

Child-Module, deren Parent-Modul sich nicht (mehr) auf dem Server befindet, werden durch ein entsprechendes Icon visualisiert:

Abhängige Module

In einem Tooltip werden die Namen der fehlenden abhängigen Module aufgelistet.

Über die Methode isActive (FirstSpirit Developer-API, Interface ModuleAdminAgent) kann geprüft werden, ob es sich um ein Modul handelt, das unerfüllte Referenzen zu anderen Modulen hat.

Applikations-Konfiguration

Unter dem Modul-Ordner „System“ kann für alle Standard-Applikationen die Sichtbarkeit für unterschiedliche Gruppen konfiguriert werden (siehe dazu auch Seite Startseite).

Hier können Namen von externen Gruppen eingetragen werden, deren Benutzer die Applikationen sehen können sollen.
Die Definition der Namen erfolgt analog zu der zu Parameter

in der Datei fs-server.conf.

Ist die Gruppenliste leer, können alle Benutzer die entsprechende Applikation sehen.

 
Wichtig Die Gruppeneinstellung wird immer ausgewertet und überschreibt die Einstellungen für die Sichtbarkeit auf der Startseite.

Für weitere Informationen zu „Externen Gruppen“ siehe auch Projekteigenschaften / Gruppen.

© 2005 - 2020 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2020-01 | Datenschutz | Impressum | Kontakt