Package org.bardframework.flow

Interface FlowController

public interface FlowController

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_PARAMETER_NAME

Method Summary

Modifier and Type	Method	Description
default void	action(String flowToken, String action, Map<String,String> formData, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse)
default org.bardframework.flow.FlowResponse	getCurrent(String flowToken, Locale locale, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse)
FlowHandler	getFlowHandler()
default org.bardframework.flow.FlowResponse	start(Locale locale, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse)
default org.bardframework.flow.FlowResponse	submit(String flowToken, Map<String,String> formData, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse)

Field Details

ACTION_PARAMETER_NAME

static final String ACTION_PARAMETER_NAME

See Also:

• Constant Field Values

Method Details

start

@GetMapping(value="",
            produces="application/json")
default org.bardframework.flow.FlowResponse start(Locale locale,
 jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpServletResponse httpResponse)
                                           throws Exception

Throws:

Exception

getCurrent

@GetMapping(value="",
            produces="application/json",
            headers="X-Flow-Token")
default org.bardframework.flow.FlowResponse getCurrent(@RequestHeader("X-Flow-Token")
 String flowToken,
 Locale locale,
 jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpServletResponse httpResponse)
                                                throws Exception

Throws:

Exception

submit

@PostMapping(value="",
             consumes="application/json",
             produces="application/json")
default org.bardframework.flow.FlowResponse submit(@RequestHeader("X-Flow-Token")
 String flowToken,
 @RequestBody
 Map<String,String> formData,
 jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpServletResponse httpResponse)
                                            throws Exception

Throws:

Exception

action

@PutMapping(value="",
            consumes="application/json")
default void action(@RequestHeader("X-Flow-Token")
 String flowToken,
 @RequestParam("action")
 String action,
 @RequestBody
 Map<String,String> formData,
 jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpServletResponse httpResponse)
             throws Exception

Throws:

Exception

getFlowHandler

FlowHandler getFlowHandler()