Package 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 class for manipulation of FrontendServer entities and API-Klassse zur Manipulation von FrontendServer-Entitäten und to invoke the appropriate connect / disconnect and connection testing operations

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
FSConnectionAPI()

Method Summary

Modifier and Type	Method	Description
Boolean	closeAllConnections(UserContext uc)	Method for disconnecting all FrontendServer connections.
Boolean	connect(UserContext uc, FrontendServer frontendServer)	Method for establishing the connection to a FrontendServer.
Boolean	disconnect(UserContext uc, FrontendServer frontendServer)	Method for disconnecting the connection to a FrontendServer.
EConnectionStatus	getStatus(UserContext uc, long frontendserverId)	Method for determining the status of a FrontendServers by his ID.
Boolean	initConnections(UserContext uc)	Method for initializing all existing FrontendServer connections.
Boolean	testConnection(UserContext uc, FrontendServer frontendServer)	Method to test a connection to a FrontendServer.

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

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, 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)

Method to test a connection to a FrontendServer.

Parameters:

uc - UserContext the user context in which the action is to be performed.

frontendServer - FrontendServer whose connection is to be tested.

Returns:

Boolean whether the connection could be established successfully or not.

Since:

2.4.3

connect

public Boolean connect(UserContext uc,
                       FrontendServer frontendServer)

Method for establishing the connection to a FrontendServer.

Parameters:

uc - UserContext the user context in which the action is to be performed.

frontendServer - FrontendServer to be connected.

Returns:

Boolean whether the connection could be established successfully.

Since:

2.4.3

disconnect

public Boolean disconnect(UserContext uc,
                          FrontendServer frontendServer)

Method for disconnecting the connection to a FrontendServer.

Parameters:

uc - UserContext the user context in which the action is to be performed.

frontendServer - FrontendServer to be separated.

Returns:

Boolean whether the connection could be successfully disconnected.

Since:

2.4.3

getStatus

public EConnectionStatus getStatus(UserContext uc,
                                   long frontendserverId)

Method for determining the status of a FrontendServers by his ID.

Parameters:

uc - UserContext the user context in which the action is to be performed.

frontendserverId - Integer the id of FrontendServers.

Returns:

EConnectionStatus the connection status of FrontendServers.

Since:

2.4.3

initConnections

public Boolean initConnections(UserContext uc)

Method for initializing all existing FrontendServer connections.

Parameters:

uc - UserContext the user context in which the action is to be performed.

Returns:

Boolean whether the initialization was successful.

Since:

2.4.3

closeAllConnections

public Boolean closeAllConnections(UserContext uc)

Method for disconnecting all FrontendServer connections.

Parameters:

uc - UserContext the user context in which the action is to be performed.

Returns:

Boolean whether the disconnecting was successful.

Since:

2.4.3