Interface HttpIncomingRequest<Self>

    • Method Detail

      • method

        HttpMethod method()
        Returns:
        Request HTTP method.
      • path

        java.lang.String path()
        Returns:
        Request URL path. Will always start with a leading forward slash (/).
      • pathParameter

        default java.lang.String pathParameter​(int index)
        Gets value of identified path parameter.

        This operation accesses an arbitrary list that has exactly the same size as the number of path parameters of the HttpPattern matched prior to this request becoming available.

        Note that it is possible to match a path parameter with an empty string. It should never be assumed that a non-empty value returned by this method has a length larger than 0.

        Parameters:
        index - Position of path parameter in original pattern.
        Returns:
        Path parameter value, if any.
        Throws:
        java.lang.IndexOutOfBoundsException - If provided index is out of the bounds of the request path parameter list.
      • pathParameters

        java.util.List<java.lang.String> pathParameters()
        Returns:
        Unmodifiable list of all path parameters.
      • queryParameter

        default java.util.Optional<java.lang.String> queryParameter​(java.lang.CharSequence name)
        Gets first query parameter with given name, if any such.
        Parameters:
        name - Name of query parameter. Case sensitive.
        Returns:
        Query parameter value, if a corresponding parameter name exists.
      • queryParameters

        default java.util.List<java.lang.String> queryParameters​(java.lang.CharSequence name)
        Gets all query parameters with given name.
        Parameters:
        name - Name of query parameter. Case sensitive.
        Returns:
        Unmodifiable list of query parameter values. May be empty.
      • queryParameters

        java.util.Map<java.lang.String,​java.util.List<java.lang.String>> queryParameters()
        Returns:
        Unmodifiable map of all query parameters.
      • uri

        default java.net.URI uri()
        Gets request URL data and assembles it into a URI.
        Returns:
        Request URI, if any.