Package com.aquima.interactions.portal.portalmessage

Class PortalMessageApplication

java.lang.Object
com.aquima.interactions.portal.portalmessage.PortalMessageApplication
All Implemented Interfaces:
IApplication, ILocalApplication
public class PortalMessageApplication extends Object implements ILocalApplication
Wrapper around the IApplication to register a portal message handler to created session of the application. (AQ-1137)
Since:
9.2
Author:
A.Pragt

  • Constructor Details

    • PortalMessageApplication

      public PortalMessageApplication(ILocalApplication application)

  • Method Details

    • getId

      public ApplicationID getId()
      Description copied from interface: IApplication
      This method returns the ID of the application.
      Specified by:
      getId in interface IApplication
      Returns:
      The ID of the application.

    • createSession

      public IPortalSession createSession()
      Description copied from interface: IApplication
      This method creates a new session object for the application specified.
      Specified by:
      createSession in interface IApplication
      Returns:
      A new portal session for the specified application.

    • createSession

      public IPortalSession createSession(IPortalMessageBus messageBus, IPortalEventBus eventBus)
      Description copied from interface: IApplication
      This method creates a new session object for the application specified.
      Specified by:
      createSession in interface IApplication
      Parameters:
      messageBus - the message bus that should be used by the new session
      eventBus - the event bus that should be used by the new session
      Returns:
      A new portal session for the specified application.

    • createSession

      public IPortalSession createSession(Channel channel, IUserData user)
      Description copied from interface: IApplication
      This method creates a new session for this application. with the specified channel and user.
      Specified by:
      createSession in interface IApplication
      Parameters:
      channel - the channel for which the session is started
      user - the user of the client starting the session
      Returns:
      A new portal session for the specified application

    • createSession

      public IPortalSession createSession(Channel channel, IUserData user, IPortalMessageBus messageBus, IPortalEventBus eventBus)
      Description copied from interface: IApplication
      This method creates a new session for this application, with the specified message bus, event bus, channel and user.
      Specified by:
      createSession in interface IApplication
      Parameters:
      channel - the channel for which the session is started
      user - the user of the client starting the session
      messageBus - the message bus that will be shared between this session and any related (parent or child) sessions
      eventBus - the event bus that will be shared between this session and any related (parent or child) sessions
      Returns:
      A new portal session for the specified application

    • createSession

      public IPortalSession createSession(ModuleID moduleId, Channel channel, IUserData user, IPortalMessageBus messageBus, IPortalEventBus eventBus)
      Description copied from interface: IApplication
      This method creates a new session for this application and the specified module, with the specified message bus, event bus, channel and user
      Specified by:
      createSession in interface IApplication
      Parameters:
      moduleId - the module for which the session is created
      channel - the channel for which the session is started
      user - the user of the client starting the session
      messageBus - the message bus that will be shared between this session and any related (parent or child) sessions
      eventBus - the event bus that will be shared between this session and any related (parent or child) sessions
      Returns:
      A new portal session for the specified application

    • createNonInteractiveSession

      public IPortalSession createNonInteractiveSession(IUserData user, IPortalMessageBus messageBus, IPortalEventBus eventBus)
      Description copied from interface: IApplication
      This method creates a new session for this application, with the specified message bus, event bus, channel and user.
      Specified by:
      createNonInteractiveSession in interface IApplication
      Parameters:
      user - the user of the client starting the session
      messageBus - the message bus that will be shared between this session and any related (parent or child) sessions
      eventBus - the event bus that will be shared between this session and any related (parent or child) sessions
      Returns:
      A new portal session for the specified application

    • getConfiguration

      public IApplicationConfig getConfiguration()
      Description copied from interface: IApplication
      This method returns an object containing the application specific configuration settings.
      Specified by:
      getConfiguration in interface IApplication
      Returns:
      an object containing the application specific configuration settings.

    • getMonitor

      public IApplicationMonitor getMonitor()
      Description copied from interface: IApplication
      This method will return an application monitor object containing information about this portal application.
      Specified by:
      getMonitor in interface IApplication
      Returns:
      The portal monitor of the portal engine

    • restoreSession

      public IPortalSession restoreSession(String sessionXml, IPortalMessageBus messageBus, IPortalEventBus eventBus)
      Description copied from interface: IApplication
      This method may be used to restore a session from an XML containing a saved session state.
      Specified by:
      restoreSession in interface IApplication
      Parameters:
      sessionXml - XML containing a saved session state.
      messageBus - the message bus that will be shared between the restored session and any related (parent or child) sessions
      eventBus - the event bus that will be shared between the restored session and any related (parent or child) sessions
      Returns:
      An initialized session ready for use.
      See Also:

    • restoreSession

      public IPortalSession restoreSession(ISessionState sessionState, IPortalMessageBus messageBus, IPortalEventBus eventBus)
      Description copied from interface: IApplication
      This method may be used to restore a session from binary data containing a saved session state.
      Specified by:
      restoreSession in interface IApplication
      Parameters:
      sessionState - Data containing a saved session state.
      messageBus - the message bus that will be shared between the restored session and any related (parent or child) sessions
      eventBus - the event bus that will be shared between the restored session and any related (parent or child) sessions
      Returns:
      An initialized session ready for use.
      See Also:

    • isProcessEnabled

      public boolean isProcessEnabled()
      Description copied from interface: IApplication
      This method returns whether processes are enabled for the application
      Specified by:
      isProcessEnabled in interface IApplication
      Returns:
      True when this application supports processes, false otherwise
      See Also:

    • getProcessEngine

      public IProcessEngine getProcessEngine()
      Description copied from interface: IApplication
      This method returns the process engine for the current application.
      Specified by:
      getProcessEngine in interface IApplication
      Returns:
      The process engine for the application.
      See Also:

    • getWebServices

      public IWebServices getWebServices()
      Description copied from interface: IApplication
      This method returns the exposed web services for this application.
      Specified by:
      getWebServices in interface IApplication
      Returns:
      The exposed web services, never null.

    • getModel

      public IModule getModel()
      Description copied from interface: ILocalApplication
      This method returns an object containing the static application data. The getModule method is only intended for internal use.
      Specified by:
      getModel in interface ILocalApplication
      Returns:
      an object containing the static application data.

    • getResourceManager

      public IResourceManager getResourceManager()
      Description copied from interface: ILocalApplication
      This method returns the resource manager for the application.
      Specified by:
      getResourceManager in interface ILocalApplication
      Returns:
      the resource manager for the application.

    • getFactoryManager

      public IFactoryManager getFactoryManager()
      Description copied from interface: ILocalApplication
      This method returns the factory manager for the application.
      Specified by:
      getFactoryManager in interface ILocalApplication
      Returns:
      the factory manager for the application.

    • getConnectionManager

      public IConnectionManager getConnectionManager()
      Description copied from interface: ILocalApplication
      This method returns the connection manager for the application.
      Specified by:
      getConnectionManager in interface ILocalApplication
      Returns:
      the connection manager for the application.