org.ikasan.spec.module

Interface ModuleService

public interface ModuleService

Service Tier interface for providing user access to modules

Author:

Ikasan Development Team

Method Summary

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

Method Detail

getModules

List<Module> getModules()

Returns all available Modules

Returns:

List of all accessible Modules

getModule

Module getModule(String moduleName)

Resolves a specified Module by name

Parameters:

moduleName - the module name

Returns:

Module named by moduleName

stopFlow

void stopFlow(String moduleName,
              String flowName,
              String actor)

Attempts to stop a Flow

Parameters:

moduleName -

flowName -

actor -

startFlow

void startFlow(String moduleName,
               String flowName,
               String actor)

Attempts to start a Flow

Parameters:

moduleName -

flowName -

actor -

startPauseFlow

void startPauseFlow(String moduleName,
                    String flowName,
                    String actor)

Attempts to start a Flow, but will immediately pause the consumer.

Parameters:

moduleName -

flowName -

actor -

pauseFlow

void pauseFlow(String moduleName,
               String flowName,
               String actor)

Attempts to pause a Flow

Parameters:

moduleName -

flowName -

actor -

resumeFlow

void resumeFlow(String moduleName,
                String flowName,
                String actor)

Attempts to resume a Flow

Parameters:

moduleName -

flowName -

actor -

setStartupType

void setStartupType(String moduleName,
                    String flowName,
                    StartupType startupType,
                    String comment,
                    String actor)

Set the startup type for the given module and flow

Parameters:

moduleName -

flowName -

startupType -

comment -

actor -

getStartupControl

StartupControl getStartupControl(String moduleName,
                                 String flowName)

Get the startup control for the given module and flow

Parameters:

moduleName -

flowName -

stopContextListeners

void stopContextListeners(String moduleName,
                          String flowName,
                          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(String moduleName,
                           String flowName,
                           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