Package de.xima.fc.fs.server

Class FSServer

java.lang.Object

de.xima.fc.cryptography.BouncyCastleSupport

de.xima.fc.fs.server.FSServer

public final class FSServer
extends BouncyCastleSupport

Diese Klasse implementiert einen Frontendserver gegen den sich verbunden werden kann.

Der Frontendserver ist eine Instanz gegen den sich von einem Masterserver aus verbunden werden kann. Der Frontendserver wird gestartet und lauscht auf einen definierten Port. Läuft der Frontendserver kann sich genau ein Masterserver auf ihn verbinden. Für mehr Informationen siehe formcycle Hilfe Das Initialisieren eines Fontendservers kann wie folgt aussehen:

 ...
 private void startFServer() {
     // Starte auf Port 4753 mit dem Namen "FormCycle - Frontend-Server".
     // Der Name darf nicht abweichen. Es wird empfohlen die Konstante: "CmnConst.FRONTENDSERVER_NAME" zu nutzen.
     FServer.startServer(4753, CmnConst.FRONTENDSERVER_NAME);
     while (!FServer.getStatus().equals(EConnectionStatus.CONNECTED)) {
       //Warten bis sich ein Masterserver verbunden hat oder abbrechen nach einer definierten Zeit...
     }
     //Masterserver hat sich erfolgreich verbunden
 }
 ...
 

Zum Aufbau der Verbindung muss ein Port angegeben werden, der dann in der Masterserver-Konfiguration eingestellt wird. Zudem muss der Name des Frontendserver angegeben werden. Dieser Name muss "FormCycle - Frontend-Server" lauten. Mit dem Aufbau der Verbindung versucht der Masterserver eine Konfigurationsdatei für die Verbindung anzulegen. Damit dies gelingt muss ein Verzeichnis META-INF existieren mit einer Daten Names xima-formcycle.properties . Der Masterserver legt die Konfiguration in dieses Verzeichnis. Die Datei wird zunächst im Classpath gesucht, wird hier nix gefunden, so wird relativ zum Ausführungsort gesucht.

Wird eine Frontendserver-Verbindung gekappt ohne, dass die Verbindung explizit geschlossen wird, versucht der Masterserver die Verbindung erneut aufzubauen. Gelingt dies nach einer gewissen Zeit nicht, wird die Verbindung komplett geschlossen und es muss sich explizit neu Verbinden werden. Zum expliziten Schließen der Verbindung kann folgender Aufruf genutzt werden:

 ...
 FServer.disconnectMaster();
 ...
 

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method	Description
static IFSSession	authClient(IFSClient client, FrontendServer fsEntity)	Authentifiziert einen Client gegen den Frontend-Server.
static boolean	disconnect(boolean forced)
static IFSClient	getClient()	Getter für currentClient
static EConnectionStatus	getConnectionStatus()	Getter für status
static String	getError()
static FsServerInfoDto	getFsServerInfo()	Getter für status
static String	getNetworkInterface()	Methode zur Ausgabe auf welchem Netzwerk-Interface der Server lauschen soll
static Integer	getPort()
static boolean	isConnected()
static boolean	isRunning()
static void	startServer(String serverName, boolean forceCreateKeystoreIfSSLModeAuto)	Methode zum Starten des Servers mit ggf. zu verwendender SSL-Verschlüsselung
static void	stopServer()	Methode zum vollständigen Stoppen des Frontend-Servers
static void	stopServer(boolean shutdownCompletely)	Methode zum Stoppen des Frontend-Servers.
static void	triggerRestart(boolean forceCreateKeystoreIfSSLModeAuto)	Neustart des Frontend-Servers mit den aktuellen Einstellungen

Methods inherited from class de.xima.fc.cryptography.BouncyCastleSupport

buildSignedCertificate, createCMSContentEncryptorBuilder, createContentSigner, createJceKeyTransRecipientInfoGenerator, createKeyFactory, createKeyPairGenerator, createKeyStore, createOpenSSLPKCS8DecryptorProviderBuilder, createPEMKeyConverter, createSignature, createX509CertificateConverter, createX509CertificateFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

Method Detail

startServer

public static void startServer(String serverName,
                               boolean forceCreateKeystoreIfSSLModeAuto)

Methode zum Starten des Servers mit ggf. zu verwendender SSL-Verschlüsselung

Parameters:

serverName - String der Name des Servers

stopServer

public static void stopServer()

Methode zum vollständigen Stoppen des Frontend-Servers

stopServer

public static void stopServer(boolean shutdownCompletely)

Methode zum Stoppen des Frontend-Servers.

Parameters:

shutdownCompletely - ob der Server vollständig heruntergefahren werden soll, also auch der ExecutorService für den Restart

triggerRestart

public static void triggerRestart(boolean forceCreateKeystoreIfSSLModeAuto)

Neustart des Frontend-Servers mit den aktuellen Einstellungen

isRunning

public static boolean isRunning()

authClient

public static IFSSession authClient(IFSClient client,
                                    FrontendServer fsEntity)
                             throws Exception

Authentifiziert einen Client gegen den Frontend-Server.

Parameters:

client - der Client, der sich verbinden möchte

fsEntity - die Verbindungseigenschaften des Frontend-Servers

Returns:

eine Instanz von IFSSession, die die Verbindung für diesen Client repräsentiert

Throws:

Exception - wenn ein Fehler auftritt, z.B. wenn bereits ein Client verbunden ist oder die Verbindung fehlschlägt

isConnected

public static boolean isConnected()

disconnect

public static boolean disconnect(boolean forced)

getConnectionStatus

public static EConnectionStatus getConnectionStatus()

Getter für status

Returns:

EConnectionStatus des status

getFsServerInfo

public static FsServerInfoDto getFsServerInfo()

Getter für status

Returns:

EConnectionStatus des status

getClient

public static IFSClient getClient()

Getter für currentClient

Returns:

IFSClient des currentClient

getNetworkInterface

public static String getNetworkInterface()

Methode zur Ausgabe auf welchem Netzwerk-Interface der Server lauschen soll

Returns:

das Netzwerk-Interface

getError

public static String getError()

getPort

public static Integer getPort()