Class FSSessionImpl

java.lang.Object

de.xima.fc.fs.server.FSSessionImpl

All Implemented Interfaces:

de.root1.simon.SimonUnreferenced, IFSSession, Serializable

public class FSSessionImpl
extends Object
implements IFSSession, de.root1.simon.SimonUnreferenced

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FSSessionImpl()

Method Summary

Modifier and Type	Method	Description
void	callback(String callbackName, IFormDataAdapter saveFormData, Vorgang vorgang)	Deprecated. will be removed
boolean	disconnect()	Method to perform a clean disconnect
<TEvent extends Serializable> void	fireEvent(TEvent event)	Method to fire an event on the frontend-server
FsServerInfoDto	getServerInfo()	Returns information about the frontend server, e.g. formcycle version, Java version, OS version, SSL info, etc.
boolean	ping()	Method to ping the frontend server
FSConfigurableProperties	pullConfigurableProperties()	Pulls the configuration from the frontend server that can be edited via the backend UI.
void	pushConfig(String name, byte[] data)	Method to push a configuration file to the frontend server
void	pushConfigurableProperties(FSConfigurableProperties errorPagesConfig)	Pushes the given configuration to the frontend server.
void	revokeRefreshToken(UUID refreshTokenId)	Method to revoke a refresh-token
void	triggerConfigSync()	Method to trigger the sync of the server configuration
void	triggerPluginSync(PluginSyncData... syncData)	Method to trigger the sync of plugins
void	unreferenced()

Methods inherited from class Object

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

Constructor Details

FSSessionImpl

public FSSessionImpl()

Method Details

callback

@Deprecated
public void callback(String callbackName,
 IFormDataAdapter saveFormData,
 Vorgang vorgang)
              throws Exception

Deprecated.

will be removed

Description copied from interface: IFSSession

Method to perform a callback on the frontend server

Specified by:

callback in interface IFSSession

Parameters:

callbackName - Name of the callback handler to perform

saveFormData - The form data adapter with which the callback should be performed

vorgang - The form record to perform the callback with

Throws:

Exception - on errors while performing the callback

disconnect

public boolean disconnect()

Description copied from interface: IFSSession

Method to perform a clean disconnect

Specified by:

disconnect in interface IFSSession

Returns:

true if the disconnect was successful, false otherwise

fireEvent

public <TEvent extends Serializable> void fireEvent(TEvent event)

Description copied from interface: IFSSession

Method to fire an event on the frontend-server

Specified by:

fireEvent in interface IFSSession

Type Parameters:

TEvent - the type of the event (must be serializable)

Parameters:

event - TEvent the event to fire

getServerInfo

public FsServerInfoDto getServerInfo()

Description copied from interface: IFSSession

Returns information about the frontend server, e.g. formcycle version, Java version, OS version, SSL info, etc.

Specified by:

getServerInfo in interface IFSSession

Returns:

FsServerInfoDto with the server information

ping

public boolean ping()

Description copied from interface: IFSSession

Method to ping the frontend server

Specified by:

ping in interface IFSSession

Returns:

true if successful, false otherwise

pullConfigurableProperties

public FSConfigurableProperties pullConfigurableProperties()

Description copied from interface: IFSSession

Pulls the configuration from the frontend server that can be edited via the backend UI.

Specified by:

pullConfigurableProperties in interface IFSSession

Returns:

The frontend server configuration. Never null, but may be empty.

pushConfig

public void pushConfig(String name,
 byte[] data)
                throws Exception

Description copied from interface: IFSSession

Method to push a configuration file to the frontend server

Specified by:

pushConfig in interface IFSSession

Parameters:

name - The name of the configuration file

data - Byte array with the data of the configuration file

Throws:

Exception - on errors while pushing the configuration file

pushConfigurableProperties

public void pushConfigurableProperties(FSConfigurableProperties errorPagesConfig)
                                throws org.apache.commons.configuration2.ex.ConfigurationException

Description copied from interface: IFSSession

Pushes the given configuration to the frontend server.

Specified by:

pushConfigurableProperties in interface IFSSession

Parameters:

errorPagesConfig - The error pages config to push.

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

revokeRefreshToken

public void revokeRefreshToken(UUID refreshTokenId)

Description copied from interface: IFSSession

Method to revoke a refresh-token

Specified by:

revokeRefreshToken in interface IFSSession

Parameters:

refreshTokenId - UUID of the refresh-token to revoke

triggerConfigSync

public void triggerConfigSync()

Description copied from interface: IFSSession

Method to trigger the sync of the server configuration

Specified by:

triggerConfigSync in interface IFSSession

triggerPluginSync

public void triggerPluginSync(PluginSyncData... syncData)
                       throws Exception

Description copied from interface: IFSSession

Method to trigger the sync of plugins

Specified by:

triggerPluginSync in interface IFSSession

Parameters:

syncData - PLugin sync data of the plugins to sync

Throws:

Exception - on errors

unreferenced

public void unreferenced()

Specified by:

unreferenced in interface de.root1.simon.SimonUnreferenced