Das Interface ServerInformationAgent

Package: de.espirit.firstspirit.agency

Das Interface ServerInformationAgent

Das Interface dient dazu, die Versionsinformationen des FirstSpirit-Servers zu ermitteln. Die entsprechenden Informationen können in allen Kontexten angefordert werden. Neben der Verwendung in Modulkomponenten (Services, Projektanwendungen, …) zählen dazu beispielsweise auch Skripte innerhalb der Auftragsverwaltung oder innerhalb von Arbeitsabläufen.

Ein ServerInformationAgent wird über ein Objekt vom Typ SpecialistsBroker mithilfe der Methode <S> S requireSpecialist(SpecialistType<S> type) angefordert:

...

final ServerInformationAgent serverInformationAgent =
        _context.getBroker().requireSpecialist(ServerInformationAgent.TYPE);

final ServerInformationAgent.VersionInfo serverVersionInfo = serverInformationAgent.getServerVersion();

// Which version is this FirstSpirit server?
serverVersionInfo.getFullVersionString();
serverVersionInfo.getMajor();
serverVersionInfo.getMinor();
serverVersionInfo.getBuild();

// Which quality level is this FirstSpirit server version?
serverVersionInfo.getBranch();
serverVersionInfo.getQuality();

// Is the FirstSpirit server running in isolated or legacy mode?
serverVersionInfo.getMode();

// Get the FirstSpirit server version's release name.
serverVersionInfo.getReleaseName();

...

Das Interface bietet Zugriff auf die folgende Methode:

public ServerInformationAgent.VersionInfo getServerVersion(): Die Methode liefert ein Objekt vom Typ VersionInfo zurück.

Das Interface ServerInformationAgent$VersionInfo

Das Interface ServerInformationAgent.VersionInfo bietet den Zugriff auf folgende Methoden:

Version:

public String getFullVersionString(): Die Methode liefert den vollen Versionsstring der zugehörigen FirstSpirit-Server-Version zurück, beispielsweise 5.0.31.51560 oder 5.0_BETA.31.51560 (falls ein Branch existiert). Neben der Major- und Minor-Version, der Branch-Information und der Build-Nummer enthält der Versionsstring zusätzlich die Revisionsnummer (im Beispiel 51560).

public int getMajor(): Die Methode liefert die Major-Version des FirstSpirit-Servers. Major-Versionen werden durch die erste Zahl der Versionsnummer gekennzeichnet (z. B. Version 5.0) und stellen eine signifikante Veränderung in der Leistungsfähigkeit der Software dar.

public int getMinor(): Die Methode liefert die Minor-Version des FirstSpirit-Servers. Minor-Versionen bilden die Entwicklungszyklen innerhalb einer Major-Version ab und werden, wie allgemein üblich, mit der Zahl nach dem Punkt in der Versionsnummer beschrieben (z .B. Version 5.2).

public int getBuild(): Die Methode liefert die Build-Nummer des FirstSpirit-Servers. Läuft der FirstSpirit-Server beispielsweise auf der Version: 5.0.110.5411 liefert diese Methode die Build-Nummer 110 zurück.

Qualitäts-Level:

public String getBranch(): Die Methode liefert den Entwicklungsstrang (Branch) der zugehörigen FirstSpirit-Server bzw. –Client-Version zurück, z. B. DEV oder BETA. Wird null zurückgeliefert, so handelt es sich um eine stabilen Versionszweig (STABLE). Läuft der FirstSpirit-Server beispielsweise auf der Version 5.1_DEV.0.54219, so liefert diese Methode die Branch-Information DEV zurück. Läuft der FirstSpirit-Server dagegen auf 5.0.110.5411 wird null zurückgeliefert.

public ServerInformationAgent.VersionInfo.Quality getQuality(): Diese Methode liefert den Qualitäts-Level der FirstSpirit-Version zurück, z.B. STABLE, BETA oder DEV.

Modus:

public ServerInformationAgent.VersionInfo.Mode getMode(): Diese Methode liefert die Information zurück, ob der FirstSpirit-Server im isolierten Modus (ISOLATED) oder im Legacy-Modus (LEGACY) betrieben wird.

Release-Name:

public String getReleaseName(): Diese Methode liefert den Release-Namen der aktuellen FirstSpirit-Server-Version im Format „yyyy-mm“ zurück. Dieser Release-Name ist ein einfach zu merkender Name, der das Erscheinungsdatum der dazugehörigen FirstSpirit-Version angibt, und wird in den Benutzeroberflächen der FirstSpirit-Clients (z.B. FirstSpirit-Startseite, SiteArchitect, ContentCreator, etc.) verwendet.