Package de.xima.fc.com.interfaces

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 Detail

      • 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

      • disconnect

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

      • ping

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