Package com.aquima.web.aaas

Class DefaultBaasFlowStarter

java.lang.Object
com.aquima.web.aaas.DefaultBaasFlowStarter
All Implemented Interfaces:
BaasFlowStarter
public class DefaultBaasFlowStarter extends Object implements BaasFlowStarter
Default BaasFlowStarter implementation. This class can be used as a starting point for custom flow starters, either via extension or via delegation.
Since:
11.4
Author:
Petru Galanton

  • Constructor Summary Link icon

    Constructors
    Constructor
    Description
    DefaultBaasFlowStarter(com.blueriq.component.api.security.IAuthorisationManager authManager, SessionHeadersProperties sessionHeadersProperties)
     

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    com.aquima.interactions.portal.IPortalSession
    createSession(com.aquima.interactions.portal.IApplication application)
    Creates the portal session in which the BAAS flow executes.
    protected Map<String,Serializable>
    getFlowParameters()
    Returns the flow parameters, which will be added to the request scope.
    void
    startFlow(com.aquima.interactions.portal.IApplication application, com.aquima.interactions.portal.IWebServiceOperationDefinition operation, com.aquima.interactions.portal.IPortalSession session)
    Starts the flow (if any) for the given web service operation in the given session.

    Methods inherited from class java.lang.Object Link icon

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

  • Constructor Details Link icon

    • DefaultBaasFlowStarter Link icon

      public DefaultBaasFlowStarter(com.blueriq.component.api.security.IAuthorisationManager authManager, SessionHeadersProperties sessionHeadersProperties)

  • Method Details Link icon

    • createSession Link icon

      public com.aquima.interactions.portal.IPortalSession createSession(com.aquima.interactions.portal.IApplication application)
      Description copied from interface: BaasFlowStarter
      Creates the portal session in which the BAAS flow executes.
      Specified by:
      createSession in interface BaasFlowStarter
      Parameters:
      application - the application for which a session should be created
      Returns:
      the created session, never null.

    • startFlow Link icon

      public void startFlow(com.aquima.interactions.portal.IApplication application, com.aquima.interactions.portal.IWebServiceOperationDefinition operation, com.aquima.interactions.portal.IPortalSession session)
      Description copied from interface: BaasFlowStarter
      Starts the flow (if any) for the given web service operation in the given session.

      When this method is called, the input mapping (if any) of the operation is already performed. Implementations should check if the operation has an associated flow. It is not an error when the web service operation doesn't have a flow. In this case, implementations should simply return.

      Specified by:
      startFlow in interface BaasFlowStarter
      Parameters:
      application - the application definition
      operation - the web service operation
      session - the session in which the flow should be started

    • getFlowParameters Link icon

      protected Map<String,Serializable> getFlowParameters()
      Returns the flow parameters, which will be added to the request scope. May return null if there are no parameters. This class always returns null from this method. Subclasses may override this method to add flow parameters.
      Returns:
      the flow parameters or null