Thema dieser Dokumentation / Das FirstSpirit 5 Modul- / Komponenten-Modell / Modul-Implementierung mit den Komponenten-Typen - PUBLIC, SERVICE, LIBRARY / Implementierung der SERVICE Basis-Komponente
Implementierung der SERVICE Basis-Komponente
Interface: de.espirit.firstspirit.opt.vscan:VScanService
Interface: VScanService
Package: de.espirit.firstspirit.opt.vscan
Definition der grundlegenden Service-Eigenschaften, wie z. B. Status-Codes, Laden der Konfiguration.
Class: de.espirit.firstspirit.opt.vscan.VScanServiceImpl
Klasse: VscanServiceImpl
Package: de.espirit.firstspirit.opt.vscan
Konkrete Implementierung der Service-Komponente. Start- und Stopp-Behandlung sowie das Reagieren auf Ereignisse wie Installation, Aktualisierung und Deinstallation. Als Beispiel ist hier das Kopieren der Konfigurationsdatei fs-vscan.conf bei der Installation des Moduls (conf/modules/FS VScan Service.VScanService) zu nennen.
public class VScanServiceImpl implements VScanService,
de.espirit.firstspirit.module.Service<VScanService>
Quellcode: de.espirit.firstspirit.opt.vscan.VScanServiceImpl
Class: de.espirit.firstspirit.opt.vscan.VScanServiceConfiguration
Klasse: VScanServiceConfiguration
Package: de.espirit.firstspirit.opt.vscan
Modell für die notwendigen Konfigurations-Einstellungen des Services. Getter und Setter zu jeder Konfigurationseigenschaft. Lädt bei Initialisierung die persistenten Einstellungen aus der fs-vscan.conf Datei. Besitzt eine save()-Methode, um die geladenen oder in der Konfigurationsoberfläche geänderten Einstellungen in die Konfigurationsdatei zu schreiben. Jedes Key/Value-Paar in der fs-vscan.conf entspricht hier einer Member-Variable der Klasse und benötigt hierfür jeweils einen Getter und Setter. Die init()-Methode muss ggf. um die weiteren benötigten Konfigurationsoptionen erweitert werden. Laden und Speichern der Konfigurationsoptionen erfolgt über VScanServiceImpl#saveConfiguration() und VScanServiceImpl#loadConfiguration(). Die Konfigurationsklasse implementiert hier das Interface Serializable, das diese vom serverseitigen Service zum FirstSpirit ServerManager übertragen wird. Der Service kontrolliert den Lifecycle der Konfiguration.
public class VScanServiceConfigurationimplements Serializable
Class: de.espirit.firstspirit.opt.vscan.VScanServiceConfigPanel
Klasse: VscanServiceConfigPanel
Package: de.espirit.firstspirit.opt.vscan
Die Service-Konfigurationsoberfläche ist über den FirstSpirit ServerManager zu erreichen. Alle notwendigen Felder der VscanServiceConfiguration können hier geladen werden – die Methode getGui() initialisiert die Konfigurationsoberfläche, wobei die Methode hasGui() hartcodiert true zurückliefern muss.
Quellcode: de.espirit.firstspirit.opt.vscan.VScanServiceConfigPanel
Interface: de.espirit.firstspirit.opt.vscan.ScanEngine
Interface: ScanEngine
Package: de.espirit.firstspirit.opt.vscan
Definition der grundlegenden Methoden, die von einer VirusScan-Engine zur Verfügung gestellt werden müssen (siehe auch ClamScanEngine.java und ScanEngine.javaJavaDoc), damit diese ohne weiteres in die bestehende Infrastruktur eingebunden werden kann.