Package com.inductiveautomation.ignition.gateway.dataroutes

Class RequestContext

  • public class RequestContext
extends java.lang.Object
    Wrapper around an HttpServletRequest to include some helpful data for RouteHandler instances.

    • Constructor Detail

      • RequestContext

        public RequestContext​(javax.servlet.http.HttpServletRequest request,
                      java.lang.String path)

    • Method Detail

      • getRequest

        public javax.servlet.http.HttpServletRequest getRequest()
        The underlying web request

      • getPath

        public java.lang.String getPath()
        Returns the URL path that that matched the route. This will not include /data/module/

      • getMethod

        public HttpMethod getMethod()
        Returns the HttpMethod of the request

      • readBody

        public java.lang.String readBody()
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • getParameter

        public java.lang.String getParameter​(java.lang.String name)

        Fetch a named parameter. First this will match any parameters that were part of the route's named parameters. For example, if your route was /widgets/:id you may call getParameter("id") and it will return the value from the request URL that matched the :id parameter.

        If it does not match a route parameter, it will delegate to the internal HttpServletRequest's parameter map, which comes from the URL's query string or post parameters.

      • putParameter

        public void putParameter​(java.lang.String name,
                         java.lang.String value)

      • getRequestUri

        public java.net.URI getRequestUri()
        Returns:
        the full URI for this HTTP Request (example: http://example.com:8088/foo/bar?baz=abc)

      • getRelativeRequestUri

        public java.net.URI getRelativeRequestUri()
        Returns:
        the relative URI for this HTTP Request (example: /foo/bar?baz=abc)