Package org.ikasan.spec.module

Interface ModuleService

  • public interface ModuleService
    Service Tier interface for providing user access to modules
    Author:
    Ikasan Development Team

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Module getModule​(java.lang.String moduleName)
      Resolves a specified Module by name
      java.util.List<Module> getModules()
      Returns all available Modules
      StartupControl getStartupControl​(java.lang.String moduleName, java.lang.String flowName)
      Get the startup control for the given module and flow
      void pauseFlow​(java.lang.String moduleName, java.lang.String flowName, java.lang.String actor)
      Attempts to pause a Flow
      void resumeFlow​(java.lang.String moduleName, java.lang.String flowName, java.lang.String actor)
      Attempts to resume a Flow
      void setStartupType​(java.lang.String moduleName, java.lang.String flowName, StartupType startupType, java.lang.String comment, java.lang.String actor)
      Set the startup type for the given module and flow
      void startContextListeners​(java.lang.String moduleName, java.lang.String flowName, java.lang.String actor)
      Start the context listeners on a given module/flow
      void startFlow​(java.lang.String moduleName, java.lang.String flowName, java.lang.String actor)
      Attempts to start a Flow
      void startPauseFlow​(java.lang.String moduleName, java.lang.String flowName, java.lang.String actor)
      Attempts to start a Flow, but will immediately pause the consumer.
      void stopContextListeners​(java.lang.String moduleName, java.lang.String flowName, java.lang.String actor)
      Stop the context listeners from being invoked on a given module/flow
      void stopFlow​(java.lang.String moduleName, java.lang.String flowName, java.lang.String actor)
      Attempts to stop a Flow

    • Method Detail

      • getModules

        java.util.List<Module> getModules()
        Returns all available Modules
        Returns:
        List of all accessible Modules

      • getModule

        Module getModule​(java.lang.String moduleName)
        Resolves a specified Module by name
        Parameters:
        moduleName - the module name
        Returns:
        Module named by moduleName

      • stopFlow

        void stopFlow​(java.lang.String moduleName,
              java.lang.String flowName,
              java.lang.String actor)
        Attempts to stop a Flow
        Parameters:
        moduleName -
        flowName -
        actor -

      • startFlow

        void startFlow​(java.lang.String moduleName,
               java.lang.String flowName,
               java.lang.String actor)
        Attempts to start a Flow
        Parameters:
        moduleName -
        flowName -
        actor -

      • startPauseFlow

        void startPauseFlow​(java.lang.String moduleName,
                    java.lang.String flowName,
                    java.lang.String actor)
        Attempts to start a Flow, but will immediately pause the consumer.
        Parameters:
        moduleName -
        flowName -
        actor -

      • pauseFlow

        void pauseFlow​(java.lang.String moduleName,
               java.lang.String flowName,
               java.lang.String actor)
        Attempts to pause a Flow
        Parameters:
        moduleName -
        flowName -
        actor -

      • resumeFlow

        void resumeFlow​(java.lang.String moduleName,
                java.lang.String flowName,
                java.lang.String actor)
        Attempts to resume a Flow
        Parameters:
        moduleName -
        flowName -
        actor -

      • setStartupType

        void setStartupType​(java.lang.String moduleName,
                    java.lang.String flowName,
                    StartupType startupType,
                    java.lang.String comment,
                    java.lang.String actor)
        Set the startup type for the given module and flow
        Parameters:
        moduleName -
        flowName -
        startupType -
        comment -
        actor -

      • getStartupControl

        StartupControl getStartupControl​(java.lang.String moduleName,
                                 java.lang.String flowName)
        Get the startup control for the given module and flow
        Parameters:
        moduleName -
        flowName -

      • stopContextListeners

        void stopContextListeners​(java.lang.String moduleName,
                          java.lang.String flowName,
                          java.lang.String actor)
        Stop the context listeners from being invoked on a given module/flow
        Parameters:
        moduleName - the module name
        flowName - the flow name
        actor - the actor invoking this request

      • startContextListeners

        void startContextListeners​(java.lang.String moduleName,
                           java.lang.String flowName,
                           java.lang.String actor)
        Start the context listeners on a given module/flow
        Parameters:
        moduleName - the module name
        flowName - the flow name
        actor - the actor invoking this request