Module io.helidon.reactive.webserver
Package io.helidon.reactive.webserver

Interface ServerRequest

public interface ServerRequest
Represents HTTP Request and provides WebServer related API.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ServerRequest.Path
    Represents requested normalised URI path.

  • Method Summary

    Modifier and Type
    Method
    Description
    default URI
    absoluteUri()
    Absolute URI of the incoming request, including query parameters and fragment.
    Single<Void>
    closeConnection()
    Request to close the connection and report success or failure asynchronously with returned single.
    MessageBodyReadableContent
    content()
    Returns MessageBodyReadableContent reactive representation of the request content.
    Context
    context()
    Returns a request context as a child of WebServer context.
    String
    fragment()
    Returns a decoded request URI fragment without leading hash '#' character.
    RequestHeaders
    headers()
    Returns http request headers.
    boolean
    isSecure()
    Returns an indicating whether this request was made using a secure channel, such as HTTPS.
    String
    localAddress()
    Returns the Internet Protocol (IP) address of the interface on which the request was received.
    int
    localPort()
    Returns the Internet Protocol (IP) port number of the interface on which the request was received.
    Http.Method
    method()
    Returns an HTTP request method.
    void
    next()
    Continue request processing on the next registered handler.
    void
    next(Throwable t)
    Continues or enters an error branch of a request processing.
    ServerRequest.Path
    path()
    Returns a path which was accepted by matcher in actual routing.
    String
    query()
    Returns an encoded query string without leading '?' character.
    UriQuery
    queryParams()
    Returns query parameters.
    String
    remoteAddress()
    Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
    int
    remotePort()
    Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
    UriInfo
    requestedUri()
    URI as requested by the originating client (to the best of our ability to compute it).
    long
    requestId()
    A unique correlation ID that is associated with this request and its associated response.
    Optional<SpanContext>
    spanContext()
    Returns a span context related to the current request.
    Tracer
    tracer()
    Returns the Tracer associated with WebServer.
    URI
    uri()
    Returns a Request-URI (or alternatively path) as defined in request line.
    Http.Version
    version()
    Returns an HTTP version from the request line.
    WebServer
    webServer()
    Returns actual WebServer instance.

  • Method Details

    • next

      void next()
      Continue request processing on the next registered handler.

      If error is being handled, this is identical to calling next(Throwable) with a cause of the error.

    • next

      void next(Throwable t)
      Continues or enters an error branch of a request processing. This call has identical effect to throwing the exception t except that the exception is directly passed to a next registered ErrorHandler and this it's faster.

      It is not possible to leave error request processing and continue in registered Handler.

      Parameters:
      t - a cause that is directly passed to a next registered ErrorHandler

    • webServer

      WebServer webServer()
      Returns actual WebServer instance.
      Returns:
      actual WebServer instance

    • context

      Context context()
      Returns a request context as a child of WebServer context.
      Returns:
      a request context

    • localAddress

      String localAddress()
      Returns the Internet Protocol (IP) address of the interface on which the request was received.
      Returns:
      an address

    • localPort

      int localPort()
      Returns the Internet Protocol (IP) port number of the interface on which the request was received.
      Returns:
      the port number

    • remoteAddress

      String remoteAddress()
      Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
      Returns:
      the address of the client that sent the request

    • remotePort

      int remotePort()
      Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
      Returns:
      the port number.

    • isSecure

      boolean isSecure()
      Returns an indicating whether this request was made using a secure channel, such as HTTPS.
      Returns:
      true if the request was made using a secure channel

    • headers

      RequestHeaders headers()
      Returns http request headers.
      Returns:
      an http headers

    • content

      MessageBodyReadableContent content()
      Returns MessageBodyReadableContent reactive representation of the request content.
      Returns:
      a request content
      See Also:

    • requestId

      long requestId()
      A unique correlation ID that is associated with this request and its associated response.
      Returns:
      a unique correlation ID associated with this request and its response

    • spanContext

      Optional<SpanContext> spanContext()
      Returns a span context related to the current request.

      SpanContext is a tracing component from opentracing.io standard.

      Returns:
      the related span context, empty if not enabled

    • tracer

      Tracer tracer()
      Returns the Tracer associated with WebServer.
      Returns:
      the tracer associated, or Tracer.global()

    • closeConnection

      Single<Void> closeConnection()
      Request to close the connection and report success or failure asynchronously with returned single. After connection is closed it is not possible to use it again.
      Returns:
      Single completed when connection is closed.

    • absoluteUri

      default URI absoluteUri()
      Absolute URI of the incoming request, including query parameters and fragment. The host and port are obtained from the interface this server listens on (host header is not used).
      Returns:
      the URI of incoming request

    • method

      Http.Method method()
      Returns an HTTP request method. See also HTTP standard methods utility class.
      Returns:
      an HTTP method
      See Also:

    • version

      Http.Version version()
      Returns an HTTP version from the request line.

      See HTTP Version enumeration for supported versions.

      If communication starts as a HTTP/1.1 with h2c upgrade, then it will be automatically upgraded and this method returns HTTP/2.0.

      Returns:
      an HTTP version

    • uri

      URI uri()
      Returns a Request-URI (or alternatively path) as defined in request line.
      Returns:
      a request URI

    • query

      String query()
      Returns an encoded query string without leading '?' character.
      Returns:
      an encoded query string

    • queryParams

      UriQuery queryParams()
      Returns query parameters.
      Returns:
      an parameters representing query parameters

    • path

      ServerRequest.Path path()
      Returns a path which was accepted by matcher in actual routing. It is path without a context root of the routing.

      Use ServerRequest.Path.absolute() method to obtain absolute request URI path representation.

      Returned ServerRequest.Path also provide access to path template parameters. An absolute path then provides access to all (including) context parameters if any. In case of conflict between parameter names, most recent value is returned.

      Returns:
      a path

    • fragment

      String fragment()
      Returns a decoded request URI fragment without leading hash '#' character.
      Returns:
      a decoded URI fragment

    • requestedUri

      UriInfo requestedUri()
      URI as requested by the originating client (to the best of our ability to compute it). By default, the URI is from the Http.Header.HOST header on the current request. If requested URI discovery is enabled by configuration, additional headers (such as Http.Header.FORWARDED) may be used to derive the originally-requested URI.
      Returns:
      uri info that can be used for redirects