org.ikasan.framework.module.service
Interface ModuleService

All Known Implementing Classes:

ModuleServiceImpl

public interface ModuleService

Service Tier interface for providing user access to modules

Author:

Ikasan Development Team

Method Summary

InitiatorStartupControl	getInitiatorStartupControl(String moduleName, String initiatorName) Allows access to the InitiatorStartupControl object for the specified Initiator
Module	getModule(String moduleName) Resolves a specified Module by name
List<Module>	getModules() Returns all available Modules
void	startInitiator(String moduleName, String initiatorName, String actor) Attempts to start an Initiator
void	stopInitiator(String moduleName, String initiatorName, String actor) Attempts to stop an Initiator
void	updateInitiatorStartupType(String moduleName, String initiatorName, InitiatorStartupControl.StartupType startupType, String comment, String actor) Updates the startup type for the Initiator

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 -

Returns:

Module named by moduleName

stopInitiator

void stopInitiator(String moduleName,
                   String initiatorName,
                   String actor)

Attempts to stop an Initiator

Parameters:

moduleName -

initiatorName -

actor -

startInitiator

void startInitiator(String moduleName,
                    String initiatorName,
                    String actor)

Attempts to start an Initiator

Parameters:

moduleName -

initiatorName -

actor -

updateInitiatorStartupType

void updateInitiatorStartupType(String moduleName,
                                String initiatorName,
                                InitiatorStartupControl.StartupType startupType,
                                String comment,
                                String actor)

Updates the startup type for the Initiator

Parameters:

moduleName -

initiatorName -

startupType -

comment -

actor -

getInitiatorStartupControl

InitiatorStartupControl getInitiatorStartupControl(String moduleName,
                                                   String initiatorName)

Allows access to the InitiatorStartupControl object for the specified Initiator

Parameters:

moduleName -

initiatorName -

Returns:

InitiatorStartupControl object for the specified Initiator