Interface IAquimaEngineFacade

public interface IAquimaEngineFacade
Interface for portal engines used in web based applications.
Since:
8.0
Author:
Danny Roest

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    activateSession(IAquimaSession session)
    Activates the given session.
    IAquimaSession
    createChildSession(IAquimaSessionsMap manager, String parentSessionId, com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.project.ModuleID moduleId, com.aquima.interactions.metamodel.Channel channel, com.aquima.interactions.project.IUserData userData, String name)
    Creates a child portal session for the specified application and module and saves the session.
    IAquimaSession
    createChildSession(IAquimaSessionsMap sessionManager, String parentSessionId, com.aquima.interactions.foundation.ApplicationID applicationId, String channel, com.aquima.interactions.project.IUserData user, String name)
    Creates a portal session for the specified application.
    IAquimaSession
    createNonInteractiveSession(com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.project.IUserData userData)
    Creates a portal session for the specified application and saves the session.
    IAquimaSession
    createSession(IAquimaSessionsMap manager, com.aquima.interactions.foundation.ApplicationID applicationId, String channel, com.aquima.interactions.project.IUserData userData, String name)
    Creates a web portal session for the specified application and saves the session.
    IAquimaUi
    getAquimaUi(String name)
    Returns the render engine by name.
    List<String>
    getAvailableAquimaUIs()
    Returns the list of the name of configured Aquima user interfaces.
    com.aquima.interactions.foundation.Version
    getDefaultVersion(String projectName)
    Returns the default version of the project.
    com.aquima.interactions.portal.IPortalEngine
    getPortalEngine()
     
    IProjectDetails
    getProjectDetails(com.aquima.interactions.foundation.ApplicationID applicationId)
    This method returns the details about the application started running this session.
    List<String>
    getProjectNames()
    Returns the list with project names.
    List<com.aquima.interactions.foundation.Version>
    getVersions(String projectName)
    Returns the versions of the project.
    void
    passivateSession(IAquimaSession session)
    Passivates the given session.
    void
    reloadProject(String projectName)
    Reloads the project definition.
    void
    reloadProjects()
    Reloads the all the project definitions.
    void
    reloadProjects(String branchName, String... projectNames)
    Reloads the projects definition.
    IAquimaSession
    restoreSession(IAquimaSessionsMap sessionManager, com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.portal.model.ISessionState sessionState, String sessionId, com.aquima.interactions.portal.IPortalMessageBus messageBus, com.aquima.interactions.portal.IPortalEventBus eventBus)
    This method may be used to restore a session from binary data containing a saved session state.
    IAquimaSession
    restoreSession(IAquimaSessionsMap sessionManager, com.aquima.interactions.foundation.ApplicationID applicationId, String sessionXml, String sessionId, com.aquima.interactions.portal.IPortalMessageBus messageBus, com.aquima.interactions.portal.IPortalEventBus eventBus)
    This method may be used to restore a session from an XML containing a saved session state.

  • Method Details

    • createSession

      IAquimaSession createSession(IAquimaSessionsMap manager, com.aquima.interactions.foundation.ApplicationID applicationId, String channel, com.aquima.interactions.project.IUserData userData, String name)
      Creates a web portal session for the specified application and saves the session.
      Parameters:
      manager - The session manager, may not be null.
      applicationId - the id of the application
      channel - optional name of the channel to start
      userData - optional userData
      name - The name of the session
      Returns:
      an Aquima session
      Throws:
      com.aquima.interactions.foundation.exception.AppException - when the session could not be created.

    • createNonInteractiveSession

      IAquimaSession createNonInteractiveSession(com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.project.IUserData userData)
      Creates a portal session for the specified application and saves the session. This session is assumed to be noninteractive, i.e. the flow it executes will reach an end state without user interaction (pages). Such a session can be used for automatic task execution. The session will not be managed in a session manager.
      Parameters:
      applicationId - the id of the application
      userData - optional userData
      Returns:
      an Aquima session
      Throws:
      com.aquima.interactions.foundation.exception.AppException - when the session could not be created.

    • createChildSession

      IAquimaSession createChildSession(IAquimaSessionsMap manager, String parentSessionId, com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.project.ModuleID moduleId, com.aquima.interactions.metamodel.Channel channel, com.aquima.interactions.project.IUserData userData, String name)
      Creates a child portal session for the specified application and module and saves the session. The child session shares the message bus and event bus of the parent session.
      Parameters:
      manager - The session manager, may not be null.
      parentSessionId - the ID of the parent portal session (not null)
      applicationId - the id of the application, may not be null
      moduleId - the id of the module, may not be null
      channel - optional name of the channel to start
      userData - optional userdata
      name - The name of the session
      Returns:
      the id of the child session
      Throws:
      com.aquima.interactions.foundation.exception.AppException - when the session could not be created.

    • createChildSession

      IAquimaSession createChildSession(IAquimaSessionsMap sessionManager, String parentSessionId, com.aquima.interactions.foundation.ApplicationID applicationId, String channel, com.aquima.interactions.project.IUserData user, String name)
      Creates a portal session for the specified application.

      The created session is registered as a child of the portal session specified by parentSessionId. Sessions created with this method can be used to start a flow from an external application in a flow widget. The created child session shares the message bus and event bus of the parent session.

      Parameters:
      sessionManager - the session manager (not null)
      parentSessionId - the ID of the parent portal session (not null)
      applicationId - the ID of the application (not null)
      channel - the optional channel (may be null)
      user - the optional user (may be null)
      name - the session name (may be null)
      Returns:
      a newly created child portal session
      Throws:
      com.aquima.interactions.foundation.exception.AppException - when the session could not be created

    • getPortalEngine

      com.aquima.interactions.portal.IPortalEngine getPortalEngine()

    • getAvailableAquimaUIs

      List<String> getAvailableAquimaUIs()
      Returns the list of the name of configured Aquima user interfaces.
      Returns:
      The list of the name of configured Aquima user interfaces.

    • getAquimaUi

      IAquimaUi getAquimaUi(String name)
      Returns the render engine by name.
      Parameters:
      name - The name of the web render engine
      Returns:
      the web render engine information

    • getProjectNames

      List<String> getProjectNames()
      Returns the list with project names.
      Returns:
      the list with project names.

    • reloadProject

      void reloadProject(String projectName)
      Reloads the project definition.
      Parameters:
      projectName - the name of the project

    • reloadProjects

      void reloadProjects(String branchName, String... projectNames)
      Reloads the projects definition.
      Parameters:
      branchName - The branch name for the projects for which the definition should be reloaded.
      projectNames - The projects (with this version) for which the definition should be reloaded. When null, reload the definition for all projects with this version

    • reloadProjects

      void reloadProjects()
      Reloads the all the project definitions.

    • getDefaultVersion

      com.aquima.interactions.foundation.Version getDefaultVersion(String projectName)
      Returns the default version of the project.
      Parameters:
      projectName - the name of the project
      Returns:
      the default version of the project
      Throws:
      com.aquima.interactions.portal.exception.PortalException - when default version of the application cannot be determined.

    • getVersions

      List<com.aquima.interactions.foundation.Version> getVersions(String projectName)
      Returns the versions of the project.
      Parameters:
      projectName - the name of the project
      Returns:
      the versions of the project
      Throws:
      com.aquima.interactions.portal.exception.PortalException - then the versions cannot be determined

    • restoreSession

      IAquimaSession restoreSession(IAquimaSessionsMap sessionManager, com.aquima.interactions.foundation.ApplicationID applicationId, String sessionXml, String sessionId, com.aquima.interactions.portal.IPortalMessageBus messageBus, com.aquima.interactions.portal.IPortalEventBus eventBus)
      This method may be used to restore a session from an XML containing a saved session state.

      If the sessionId is specified the current session is updated via IAquimaSessionsMap.updateSession(IAquimaSession) else the session is added via IAquimaSessionsMap.addSession(IAquimaSession)

      Parameters:
      sessionManager - the current session manager
      applicationId - the id of the application to restore
      sessionXml - XML containing a saved session state.
      sessionId - the optional sessionId to use
      messageBus - the message bus that should be used by this session
      eventBus - the event bus that should be used by this session
      Returns:
      An initialized session ready for use.
      Throws:
      com.aquima.interactions.foundation.exception.AppException - This exception is thrown when the session could not be restored.
      See Also:
      • ISessionMonitor.getCurrentState()

    • restoreSession

      IAquimaSession restoreSession(IAquimaSessionsMap sessionManager, com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.portal.model.ISessionState sessionState, String sessionId, com.aquima.interactions.portal.IPortalMessageBus messageBus, com.aquima.interactions.portal.IPortalEventBus eventBus)
      This method may be used to restore a session from binary data containing a saved session state.

      If the sessionId is specified the current session is updated via IAquimaSessionsMap.updateSession(IAquimaSession) else the session is added via IAquimaSessionsMap.addSession(IAquimaSession)

      Parameters:
      sessionManager - the current session manager
      applicationId - the id of the application to restore
      sessionState - Data containing a saved session state.
      sessionId - the optional sessionId to use
      messageBus - the message bus that should be used by this session
      eventBus - the event bus that should be used by this session
      Returns:
      An initialized session ready for use.
      Throws:
      com.aquima.interactions.foundation.exception.AppException - This exception is thrown when the session could not be restored.
      See Also:
      • ISessionMonitor.getCurrentSessionState()

    • getProjectDetails

      IProjectDetails getProjectDetails(com.aquima.interactions.foundation.ApplicationID applicationId)
      This method returns the details about the application started running this session. This method should be used instead of using an IApplication (not recommended).
      Parameters:
      applicationId - the id of the application to get the details from
      Returns:
      details about the application started running this session.
      Throws:
      com.aquima.interactions.foundation.exception.AppException - When the application cannot be found.

    • activateSession

      void activateSession(IAquimaSession session)
      Activates the given session. See IAquimaSessionLifecycle for details about the passivation-activation lifecycle.
      Parameters:
      session - the session that should be activated.

    • passivateSession

      void passivateSession(IAquimaSession session)
      Passivates the given session. See IAquimaSessionLifecycle for details about the passivation-activation lifecycle.
      Parameters:
      session - the session that should be passivated