Interface IFSSession

All Superinterfaces:
Serializable
All Known Implementing Classes:
FSSessionImpl
public interface IFSSession extends Serializable
Interface of the client session on the frontend server after authentication
Author:
XIMA MEDIA GmbH

  • Method Details

    • callback

      void callback(String callbackHandlerName, IFormDataAdapter formData, Vorgang process) throws Exception
      Method to perform a callback on the frontend server
      Parameters:
      callbackHandlerName - Name of the callback handler to perform
      formData - The form data adapter with which the callback should be performed
      process - The form record to perform the callback with
      Throws:
      Exception - on errors while performing the callback

    • pushConfig

      void pushConfig(String name, byte[] data) throws Exception
      Method to push a configuration file to the frontend server
      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

    • pullConfigurableProperties

      FSConfigurableProperties pullConfigurableProperties() throws Exception
      Pulls the configuration from the frontend server that can be edited via the backend UI.
      Returns:
      The frontend server configuration. Never null, but may be empty.
      Throws:
      Exception - When the pull fails.

    • pushConfigurableProperties

      void pushConfigurableProperties(FSConfigurableProperties configurableProperties) throws Exception
      Pushes the given configuration to the frontend server.
      Parameters:
      configurableProperties - The error pages config to push.
      Throws:
      Exception - When the push fails.

    • triggerPluginSync

      void triggerPluginSync(PluginSyncData... syncData) throws Exception
      Method to trigger the sync of plugins
      Parameters:
      syncData - PLugin sync data of the plugins to sync
      Throws:
      Exception - on errors

    • triggerConfigSync

      void triggerConfigSync()
      Method to trigger the sync of the server configuration

    • revokeRefreshToken

      void revokeRefreshToken(UUID refreshTokenId)
      Method to revoke a refresh-token
      Parameters:
      refreshTokenId - UUID of the refresh-token to revoke

    • disconnect

      boolean disconnect()
      Method to perform a clean disconnect
      Returns:
      true if the disconnect was successful, false otherwise

    • getServerInfo

      FsServerInfoDto getServerInfo()
      Returns information about the frontend server, e.g. formcycle version, Java version, OS version, SSL info, etc.
      Returns:
      FsServerInfoDto with the server information

    • ping

      boolean ping()
      Method to ping the frontend server
      Returns:
      true if successful, false otherwise

    • fireEvent

      <TEvent extends Serializable> void fireEvent(TEvent event)
      Method to fire an event on the frontend-server
      Type Parameters:
      TEvent - the type of the event (must be serializable)
      Parameters:
      event - TEvent the event to fire
      Throws:
      IllegalArgumentException - if the event is null
      IllegalStateException - if no event handler is found for the event type