org.ikasan.web.controller

Class ModulesController

java.lang.Object

org.ikasan.web.controller.ModulesController

@Controller
 @RequestMapping(value="/modules")
public class ModulesController
extends Object

Controller class for the web-console dealing with modules

Author:

Ikasan Development Team

Constructor Summary

Constructors

Constructor and Description
ModulesController(ModuleService moduleService) Constructor

Method Summary

Modifier and Type	Method and Description
String	controlFlow(String moduleName, String flowName, String action)
String	controlInitiator(String moduleName, String flowName, String startupType, String startupComment) Control the initiator (stop, start etc)
String	deleteTrigger(String moduleName, String flowName, String flowElementName, String triggerId, org.springframework.ui.ModelMap model) Delete a wiretap trigger
String	listModules(org.springframework.ui.ModelMap model) List the modules given a window (map)
void	setJobAwareFlowEventListener(JobAwareFlowEventListener jobAwareFlowEventListener) Set the job aware flow event listener
String	viewFlow(String moduleName, String flowName, org.springframework.ui.ModelMap model) View the flow
String	viewFlowElement(String moduleName, String flowName, String flowElementName, org.springframework.ui.ModelMap model) View the flow element
String	viewModule(String moduleName, org.springframework.ui.ModelMap model) View the module

Methods inherited from class java.lang.Object

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

Constructor Detail

ModulesController

@Autowired
public ModulesController(ModuleService moduleService)

Constructor

Parameters:

moduleService - - The module service

monitor - - A moitor of module's flows

Method Detail

listModules

@RequestMapping(value="list.htm")
public String listModules(org.springframework.ui.ModelMap model)

List the modules given a window (map)

Parameters:

model - - The window (map)

Returns:

"modules/modules"

viewModule

@RequestMapping(value="view.htm")
public String viewModule(@RequestParam(value="moduleName")
                                                           String moduleName,
                                                           org.springframework.ui.ModelMap model)

View the module

Parameters:

moduleName - - The name of the module to view

model - - The window

Returns:

- "modules/viewModule"

viewFlow

@RequestMapping(value="viewFlow.htm")
public String viewFlow(@RequestParam(value="moduleName")
                                                             String moduleName,
                                                             @RequestParam(value="flowName")
                                                             String flowName,
                                                             org.springframework.ui.ModelMap model)

View the flow

Parameters:

moduleName - - The name of the module

flowName - - The name of the flow

model - - The window

Returns:

"modules/viewFlow"

controlInitiator

@RequestMapping(value="flowStartupControl.htm",
                method=POST)
public String controlInitiator(@RequestParam(value="moduleName")
                                                                                                            String moduleName,
                                                                                                            @RequestParam(value="flowName")
                                                                                                            String flowName,
                                                                                                            @RequestParam(value="startupType",required=false)
                                                                                                            String startupType,
                                                                                                            @RequestParam(value="startupComment",required=false)
                                                                                                            String startupComment)

Control the initiator (stop, start etc)

Parameters:

moduleName - The name of the module

initiatorName - - The name of the initiator

initiatorAction - - The controlling action for the initiator

Returns:

"modules/viewModule"

Throws:

Exception - - Exception if we cannot control the initiator

controlFlow

@RequestMapping(value="flow.htm",
                method=POST)
 @PreAuthorize(value="hasAnyAuthority(\'ALL\',\'WriteBlueConsole\')")
public String controlFlow(@RequestParam(value="moduleName")
                                                                                                                                                               String moduleName,
                                                                                                                                                               @RequestParam(value="flowName")
                                                                                                                                                               String flowName,
                                                                                                                                                               @RequestParam(value="action")
                                                                                                                                                               String action)

Parameters:

moduleName -

flowName -

action -

Returns:

viewFlowElement

@RequestMapping(value="viewFlowElement.htm")
public String viewFlowElement(@RequestParam(value="moduleName")
                                                                           String moduleName,
                                                                           @RequestParam(value="flowName")
                                                                           String flowName,
                                                                           @RequestParam(value="flowElementName")
                                                                           String flowElementName,
                                                                           org.springframework.ui.ModelMap model)

View the flow element

Parameters:

moduleName - - The name of the module

flowName - - The name of the flow

flowElementName - - The name of the flow element

model - - The window

Returns:

"modules/viewFlowElement"

deleteTrigger

@RequestMapping(value="deleteTrigger.htm")
public String deleteTrigger(@RequestParam(value="moduleName")
                                                                       String moduleName,
                                                                       @RequestParam(value="flowName")
                                                                       String flowName,
                                                                       @RequestParam(value="flowElementName")
                                                                       String flowElementName,
                                                                       @RequestParam(value="triggerId")
                                                                       String triggerId,
                                                                       org.springframework.ui.ModelMap model)
                                                                throws Exception

Delete a wiretap trigger

Parameters:

moduleName - - The name of the module

flowName - - The name of the flow

flowElementName - - The name of the flow element

triggerId - - The id of the trigger to delete

model - - The window

Returns:

"modules/viewFlowElement"

Throws:

Exception - - Exception if we fail to delete the trigger

setJobAwareFlowEventListener

@Autowired
public void setJobAwareFlowEventListener(JobAwareFlowEventListener jobAwareFlowEventListener)

Set the job aware flow event listener

Parameters:

jobAwareFlowEventListener - - The job aware flow event listener to set