org.ikasan.spec.rest

Interface ModuleResource

@Path(value="/modules")
 @Produces(value="application/json")
public interface ModuleResource

Spec for the module's REST interface

Method Summary

Modifier and Type	Method and Description
void	controlFlowStartupMode(javax.ws.rs.core.SecurityContext context, String moduleName, String flowName, String startupType, String startupComment)
void	controlFlowState(javax.ws.rs.core.SecurityContext context, String moduleName, String flowName, String action)
List<? extends FlowElement<?>>	getFlowElements(String moduleName, String flowName)
List<? extends Flow>	getFlows(String moduleName)
Module	getModule(String moduleName)
List<Module>	getModules()

Method Detail

getModules

@GET
List<Module> getModules()

getModule

@GET
 @Path(value="{moduleName}")
Module getModule(@PathParam(value="moduleName")
                                                   String moduleName)

getFlows

@GET
 @Path(value="{moduleName}/flows")
List<? extends Flow> getFlows(@PathParam(value="moduleName")
                                                                      String moduleName)

getFlowElements

@GET
 @Path(value="{moduleName}/flow/{flowName}")
List<? extends FlowElement<?>> getFlowElements(@PathParam(value="moduleName")
                                                                                                 String moduleName,
                                                                                                 @PathParam(value="flowName")
                                                                                                 String flowName)

controlFlowState

@POST
 @Path(value="{moduleName}/flow/{flowName}/state")
void controlFlowState(@Context
                                                                               javax.ws.rs.core.SecurityContext context,
                                                                               @PathParam(value="moduleName")
                                                                               String moduleName,
                                                                               @PathParam(value="flowName")
                                                                               String flowName,
                                                                               @QueryParam(value="action")
                                                                               String action)

controlFlowStartupMode

@POST
 @Path(value="{moduleName}/flow/{flowName}/mode")
void controlFlowStartupMode(@Context
                                                                                    javax.ws.rs.core.SecurityContext context,
                                                                                    @PathParam(value="moduleName")
                                                                                    String moduleName,
                                                                                    @PathParam(value="flowName")
                                                                                    String flowName,
                                                                                    @QueryParam(value="startupType")
                                                                                    String startupType,
                                                                                    @QueryParam(value="startupComment")
                                                                                    String startupComment)