de.xima.fc.api.system

Class FSConnectionAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<FrontendServer>

de.xima.fc.api.system.FSConnectionAPI

public class FSConnectionAPI
extends AEntityAPI<FrontendServer>

API-Klassse zur Manipulation von FrontendServer-Entitäten und zum Aufruf der entsprechenden Verbinden/Trennen und Verbindung-Testen-Operationen

Author:

Michael Kohlsche

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor and Description
FSConnectionAPI()

Method Summary

Modifier and Type	Method and Description
Boolean	closeAllConnections(UserContext uc) Methode zum Trennen aller FrontendServer-Verbindungen
Boolean	connect(UserContext uc, FrontendServer frontendServer) Methode zum Aufbauen der Verbindung zu einem FrontendServer
Boolean	disconnect(UserContext uc, FrontendServer frontendServer) Methode zum Trennen der Verbindung zu einem FrontendServer.
EConnectionStatus	getStatus(UserContext uc, int frontendserver_id) Methode zum Ermitteln des Status eines FrontendServers anhand seiner ID
Boolean	initConnections(UserContext uc) Methode zum Initialisieren aller vorhandender FrontendServer-Verbindungen
Boolean	testConnection(UserContext uc, FrontendServer frontendServer) Methode zum Testen einer Verbindung zu einem FrontendServer

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, getAll, getAllBy, getBy, getById, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

FSConnectionAPI

public FSConnectionAPI()

Method Detail

testConnection

public Boolean testConnection(UserContext uc,
                              FrontendServer frontendServer)

Methode zum Testen einer Verbindung zu einem FrontendServer

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

frontendServer - FrontendServer dessen Verbindung getestet werden soll

Returns:

Boolean ob die Verbindung erfolgreich aufgebaut werden konnte oder nicht @since 2.4.3

connect

public Boolean connect(UserContext uc,
                       FrontendServer frontendServer)

Methode zum Aufbauen der Verbindung zu einem FrontendServer

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

frontendServer - FrontendServer der verbunden werden soll

Returns:

Boolean ob die Verbindung erfolgreich aufgebaut werden konnte @since 2.4.3

disconnect

public Boolean disconnect(UserContext uc,
                          FrontendServer frontendServer)

Methode zum Trennen der Verbindung zu einem FrontendServer.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

frontendServer - FrontendServer der getrennt werden soll

Returns:

Boolean ob die Verbindung erfolgreich getrennt werden konnte @since 2.4.3

getStatus

public EConnectionStatus getStatus(UserContext uc,
                                   int frontendserver_id)

Methode zum Ermitteln des Status eines FrontendServers anhand seiner ID

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

frontendserver_id - Integer die ID des FrontendServers

Returns:

EConnectionStatus der Verbindungs-Status des FrontendServers @since 2.4.3

initConnections

public Boolean initConnections(UserContext uc)

Methode zum Initialisieren aller vorhandender FrontendServer-Verbindungen

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

Returns:

Boolean ob das Initialisieren erfolgreich durchgeführt wurde @since 2.4.3

closeAllConnections

public Boolean closeAllConnections(UserContext uc)

Methode zum Trennen aller FrontendServer-Verbindungen

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

Returns:

Boolean ob das Trennen erfolgreich war @since 2.4.3