Package org.springframework.webflow.context.servlet

Interface FlowUrlHandler

All Known Implementing Classes:
DefaultFlowUrlHandler, FilenameFlowUrlHandler, WebFlow1FlowUrlHandler
public interface FlowUrlHandler
A interface for parsing and generating flow URLs. Encapsulates a specific flow URL format.
Author:
Keith Donald

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createFlowDefinitionUrl(String flowId, AttributeMap<?> input, jakarta.servlet.http.HttpServletRequest request)
    Create a URL that when addressed will launch a new execution of a flow.
    String
    createFlowExecutionUrl(String flowId, String flowExecutionKey, jakarta.servlet.http.HttpServletRequest request)
    Create a URL that when addressed will resume an existing execution of a flow.
    String
    getFlowExecutionKey(jakarta.servlet.http.HttpServletRequest request)
    Extract the flow execution from the request.
    String
    getFlowId(jakarta.servlet.http.HttpServletRequest request)
    Extract the flow id from the request.

  • Method Details

    • getFlowExecutionKey

      String getFlowExecutionKey(jakarta.servlet.http.HttpServletRequest request)
      Extract the flow execution from the request.
      Parameters:
      request - the request
      Returns:
      the flow execution key, or null if no flow execution key is present

    • getFlowId

      String getFlowId(jakarta.servlet.http.HttpServletRequest request)
      Extract the flow id from the request.
      Parameters:
      request - the request
      Returns:
      the flow id, or null if no flow id is present

    • createFlowDefinitionUrl

      String createFlowDefinitionUrl(String flowId, AttributeMap<?> input, jakarta.servlet.http.HttpServletRequest request)
      Create a URL that when addressed will launch a new execution of a flow.
      Parameters:
      flowId - the id of the flow definition
      input - the input to pass the new flow execution
      request - the current request
      Returns:
      the flow definition url

    • createFlowExecutionUrl

      String createFlowExecutionUrl(String flowId, String flowExecutionKey, jakarta.servlet.http.HttpServletRequest request)
      Create a URL that when addressed will resume an existing execution of a flow.
      Parameters:
      flowExecutionKey - the flow execution key that is paused and waiting to be resumed
      request - the current request
      Returns:
      the flow execution url