Komponenten¶

Überblick¶

Wesentliche Plugins¶

Wesentliche Plugins bilden die zentralen Funktionen des VLS. Es ist nicht vorgesehen, einzelne Plugins dieser Art abzuschalten (mit Ausnahme der HTTPS-Plugins).

Plugin	Modul	Aktiv	Default	Beschreibung
`VlsAppPlugin`	`vls.core`	`config.app.on`	ja	Stellvertretend für die VLS Applikation.
`StartStopLogger`	`vls.core`	stets	N/A	Das Plugin wird vor allen anderen gestartet.
`MonitorParentProcessPlugin`	`vls.core`	Kind-Prozesse	N/A	Beendet den Prozess, wenn der Elternprozess beendet wird.
`CpWsgiServer`	`vls.core`	`config.http.on`	ja	HTTP/HTTPS WSGI Server.
`HTTPServer`	`vls.core`	`config.server.http.on`	ja	Nur, wenn `config.http.on`.
`HTTPSServer`	`vls.core`	`config.server.https.on`	nein	Nur, wenn `config.http.on` und nicht `config.server.https_proxy.on`.
`HTTPSProxyServer`	`vls.core`	`config.server.https_proxy.on`	nein	Nur, wenn `config.http.on` und nicht `config.server.https.on`.
`VlsDbPlugin`	`vls.db`	`config.database.on`	ja	Steuert die Datenbank-Anbindung.
`StatesController`	`vls.states`	stets	N/A	Versionierte Zustandsverwaltung für Baumknoten.
`TypesController`	`vls.types`	stets	N/A	Typisierung von Baumknoten.
`AVController`	`vls.av`	stets	N/A	Unterstützung für audiovisuelle Medien.
`VlsTemplatingPlugin`	`vls.template`	`config.templating.on`	ja	XSLT-Prozessor zur Erzeugung der Webseiten.

Feature-Plugins¶

Feature-Plugins enthalten eigenständige Funktionen, die abschaltbar sind, ohne die wesentlichen Funktionen des VLS zu beeinträchtigen.

Plugin	Modul	Aktiv	Default	Beschreibung
`CatalogEnrichmentController`	`vls.ce`	`config.ce.on`	nein	Catalog-Enrichment Funktionalität.
`CutterController`	`vls.cutter`	`config.cutter.on`	nein	Auftrennen von PDFs.
`VlsDfgFooterPlugin`	`vls.dfgfooter`	stets	N/A	Image-Footer für Retro-Digitalisate.
`MoodleController`	`vls.moodle`	`config.moodle.on`	nein	Integration elektronischer Semesterapparate.
`VlsPreservationPlugin`	`vls.preservation`	`config.preservation.on`	nein	Langzeitarchivierung (opt. nach DA-NRW).
`VlsSegmentizer`	`vls.lab.segmentize`	`config.lab.segmentize`	nein	Zeitungssegmentierer.
`VlsInternalWebdavPlugin`	`vls.webdav`	`config.webdav.internal.on`	nein	Interner WebDAV-Zugang (experimentell).
`VlsPublicWebdavPlugin`	`vls.webdav`	`config.webdav.public.on`	nein	Öffentlicher WebDAV-Zugang (experimentell).

Statisik-Plugins¶

Statistik-Plugins senden Daten an die zentrale Überwachung bei Semantics, und bilden so die Basis zur Einschätzung von Leistungsproblemen.

Plugin	Modul	Aktiv	Default	Beschreibung
`StatsdController`	`vls.statsd`	`config.statsd.on`	nein	Sendet Statistiken an Graunt.
`MemoryMonitor`	`vls.core`	`config.statsd.on`	nein	Sendet Speicher-Statistiken an Graunt.
`StartupStatsdFeed`	`vls.core`	`config.statsd.on`	nein	Sendet Startup-Statistiken an Graunt.

Plugins für POSIX-Systeme¶

Plugins, die nur für POSIX-Systeme relevant sind.

Plugin	Modul	Aktiv	Default	Beschreibung
`UnixCoreDump`	`vls.core`	`config.debug.enableCoreDump`	nein	Erlaubt core dumps (nur POSIX-Systeme).
`UnixResourceLimit`	`vls.core`	`config.server.rlimit`	nein	Aktiv, wenn limits gesetzt sind (nur POSIX-Systeme).
`PriorityPlugin`	`vls.core`	POSIX-Systeme	N/A	Setze I/O- und CPU-Priorität.

Plugins für Windows-Systeme¶

Plugins, die nur für Windows-Systeme relevant sind.

Plugin	Modul	Aktiv	Default	Beschreibung
`WindowsConsoleEvents`	`vls.core`	W32-Systeme	N/A	Behandelt Windows Console events.
`FaulthandlerPlugin`	`vls.core`	`config.debug.faulthandler`	nein	Behandelt Ausnahmefehler (nur W32-Systeme).

Weitere Plugins¶

Plugin	Modul	Aktiv	Default	Beschreibung
`JccThreadHelper`	`vls.core`	`config.indexing.on`	ja	Jcc Thread Integration, wird vom Such-Index benutzt.
`GarbageCollector`	`vls.core`	`config.indexing.on`	ja	Spezieller Garbage Collector, falls Java-Threads benutzt werden.

Debugging-Plugins¶

Die folgenden Plugins sind nur zu Entwicklungszwecken zu verwenden, und nicht für den produktiven Einsatz gedacht.

Plugin	Modul	Aktiv	Default	Beschreibung
`DebugController`	`vls.debug`	`config.debug.on`	nein	Ergänzt den VLS um Debug-Fußzeile und andere Funktionen.
`VlsAutoReloader`	`vls.core`	`config.debug.autoRestart`	nein	Lädt veränderten Python Code dynamisch nach. Nicht aktiv bei `config.server.ntService`.
`SmcDowserPlugin`	`vls.core`	`config.debug.memory.on`	nein	Memory debugging mit Dowser.
`ProfilerPlugin`	`vls.core`	`config.debug.profiler`	nein	Erzeugt Profiling-Daten (Dateien mit Endung `.pstats`).
`WindowsProcessInfo`	`vls.core`	stets	N/A	Setzt Server-Informationen im Titel des Terminalfensters.
`LabController`	`vls.lab`	`config.lab.on`	nein	Studien zur automatisierten Bildverarbeitung.

Test-Plugins¶

Die folgenden Plugins werden vom Test-Framework (Continuous Integration Tests) verwendet.

Plugin	Modul	Aktiv	Default	Beschreibung
`VlsStartup`	`vls.core`	`config.server.startupChecks`	ja	Falls nein, Server startet auch, wenn Verzeichnis oder Port schon genutzt werden.

Wesentliche Plugins¶

Channels¶

start

stop

exit

graceful

log

main

StartStopLogger¶

cp.startstop (core/plugins.py)

Dies ist kein DependencyPlugin, sondern ein SimplePlugin, und wird auf Modul-Ebene registriert.