Class ProcessBasedRouterPayload

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.processes.QProcessPayload
com.kingsrook.qqq.middleware.javalin.routeproviders.ProcessBasedRouterPayload
public class ProcessBasedRouterPayload extends QProcessPayload
process payload shared the processes which are used as process-based-router processes. e.g., the fields here are those written to and read by ProcessBasedRouter.

  • Constructor Details

    • ProcessBasedRouterPayload

      public ProcessBasedRouterPayload()
      Constructor

    • ProcessBasedRouterPayload

      public ProcessBasedRouterPayload(ProcessState processState)
      Constructor

  • Method Details

    • getFormParam

      public String getFormParam(String name)
      Get a single form parameter value by name. Convenience method for the common use-case of retrieving a single value from form parameters, rather than dealing with the List of values that the formal HTTP interface provides.
      Parameters:
      name - the form parameter name
      Returns:
      the first value for the parameter, or null if not present

    • getQueryParam

      public String getQueryParam(String name)
      Get a single query parameter value by name. Convenience method for the common use-case of retrieving a single value from query parameters, rather than dealing with the List of values that the formal HTTP interface provides.
      Parameters:
      name - the query parameter name
      Returns:
      the first value for the parameter, or null if not present

    • getPath

      public String getPath()
      Getter for path
      See Also:

    • setPath

      public void setPath(String path)
      Setter for path
      See Also:

    • withPath

      public ProcessBasedRouterPayload withPath(String path)
      Fluent setter for path
      Parameters:
      path - the HTTP request path
      Returns:
      this

    • getMethod

      public String getMethod()
      Getter for method
      See Also:

    • setMethod

      public void setMethod(String method)
      Setter for method
      See Also:

    • withMethod

      public ProcessBasedRouterPayload withMethod(String method)
      Fluent setter for method
      Parameters:
      method - the HTTP method (GET, POST, etc.)
      Returns:
      this

    • getPathParams

      public Map<String,String> getPathParams()
      Getter for pathParams
      See Also:

    • setPathParams

      public void setPathParams(Map<String,String> pathParams)
      Setter for pathParams
      See Also:

    • withPathParams

      public ProcessBasedRouterPayload withPathParams(Map<String,String> pathParams)
      Fluent setter for pathParams
      Parameters:
      pathParams - map of path parameters extracted from the URL pattern
      Returns:
      this

    • getCookies

      public Map<String,String> getCookies()
      Getter for cookies
      See Also:

    • setCookies

      public void setCookies(Map<String,String> cookies)
      Setter for cookies
      See Also:

    • withCookies

      public ProcessBasedRouterPayload withCookies(Map<String,String> cookies)
      Fluent setter for cookies
      Parameters:
      cookies - map of HTTP cookies from the request
      Returns:
      this

    • getStatusCode

      public Integer getStatusCode()
      Getter for statusCode
      See Also:

    • setStatusCode

      public void setStatusCode(Integer statusCode)
      Setter for statusCode
      See Also:

    • withStatusCode

      public ProcessBasedRouterPayload withStatusCode(Integer statusCode)
      Fluent setter for statusCode
      Parameters:
      statusCode - HTTP status code for the response (e.g., 200, 404, 500)
      Returns:
      this

    • getResponseHeaders

      public Map<String,String> getResponseHeaders()
      Getter for responseHeaders
      See Also:

    • setResponseHeaders

      public void setResponseHeaders(Map<String,String> responseHeaders)
      Setter for responseHeaders
      See Also:

    • withResponseHeaders

      public ProcessBasedRouterPayload withResponseHeaders(Map<String,String> responseHeaders)
      Fluent setter for responseHeaders
      Parameters:
      responseHeaders - map of HTTP headers to include in the response
      Returns:
      this

    • getResponseString

      public String getResponseString()
      Getter for responseString
      See Also:

    • setResponseString

      public void setResponseString(String responseString)
      Setter for responseString
      See Also:

    • withResponseString

      public ProcessBasedRouterPayload withResponseString(String responseString)
      Fluent setter for responseString
      Parameters:
      responseString - string content to send in the HTTP response body
      Returns:
      this

    • getResponseBytes

      public byte[] getResponseBytes()
      Getter for responseBytes
      See Also:

    • setResponseBytes

      public void setResponseBytes(byte[] responseBytes)
      Setter for responseBytes
      See Also:

    • withResponseBytes

      public ProcessBasedRouterPayload withResponseBytes(byte[] responseBytes)
      Fluent setter for responseBytes
      Parameters:
      responseBytes - binary content to send in the HTTP response body
      Returns:
      this

    • getRedirectURL

      public String getRedirectURL()
      Getter for redirectURL
      See Also:

    • setRedirectURL

      public void setRedirectURL(String redirectURL)
      Setter for redirectURL
      See Also:

    • withRedirectURL

      public ProcessBasedRouterPayload withRedirectURL(String redirectURL)
      Fluent setter for redirectURL
      Parameters:
      redirectURL - URL to redirect the client to instead of sending a body
      Returns:
      this

    • getQueryParams

      public Map<String,List<String>> getQueryParams()
      Getter for queryParams
      See Also:

    • setQueryParams

      public void setQueryParams(Map<String,List<String>> queryParams)
      Setter for queryParams
      See Also:

    • withQueryParams

      public ProcessBasedRouterPayload withQueryParams(Map<String,List<String>> queryParams)
      Fluent setter for queryParams
      Parameters:
      queryParams - map of query parameters from the URL
      Returns:
      this

    • getFormParams

      public Map<String,List<String>> getFormParams()
      Getter for formParams
      See Also:

    • setFormParams

      public void setFormParams(Map<String,List<String>> formParams)
      Setter for formParams
      See Also:

    • withFormParams

      public ProcessBasedRouterPayload withFormParams(Map<String,List<String>> formParams)
      Fluent setter for formParams
      Parameters:
      formParams - map of form parameters from POST request body
      Returns:
      this

    • getBodyString

      public String getBodyString()
      Getter for bodyString
      See Also:

    • setBodyString

      public void setBodyString(String bodyString)
      Setter for bodyString
      See Also:

    • withBodyString

      public ProcessBasedRouterPayload withBodyString(String bodyString)
      Fluent setter for bodyString
      Parameters:
      bodyString - raw request body content as a string
      Returns:
      this