ServerRequest (Helidon WebServer 0.9.0 API)

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

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`ServerRequest.Content`	Represents an HTTP request content as a `publisher` of `RequestChunks` with specific features.
`static interface`	`ServerRequest.Path`	Represents requested normalised URI path processed by `PathMatcher`.
`static interface`	`ServerRequest.Reader<R>`	The Reader transforms a byte buffer publisher into a completion stage of the associated type.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`ServerRequest.Content`	`content()`	Returns `reactive representation` of the request content.
`ContextualRegistry`	`context()`	Returns a request context as a child of `WebServer` context.
`java.lang.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.
`java.lang.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.RequestMethod`	`method()`	Returns an HTTP request method.
`void`	`next()`	Continue request processing on the next registered handler.
`void`	`next(java.lang.Throwable t)`	Continues or enters an error branch of a request processing.
`ServerRequest.Path`	`path()`	Returns a path which was accepted by `PathMatcher` in actual routing.
`java.lang.String`	`query()`	Returns an encoded query string without leading '?' character.
`Parameters`	`queryParams()`	Returns query parameters.
`java.lang.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.
`long`	`requestId()`	A unique correlation ID that is associated with this request and its associated response.
`io.opentracing.Span`	`span()`	Deprecated. use `spanContext()` instead
`io.opentracing.SpanContext`	`spanContext()`	Returns a span context related to the current request.
`java.net.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 Detail
  - 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(java.lang.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
```
ContextualRegistry context()
```
    Returns a request context as a child of WebServer context.
    
    Returns:
    
    a request context
  - method
```
Http.RequestMethod method()
```
    Returns an HTTP request method. See also HTTP standard methods utility class.
    
    Returns:
    
    an HTTP method
    
    See Also:
    
    Http.Method
  - 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
```
java.net.URI uri()
```
    Returns a Request-URI (or alternatively path) as defined in request line.
    
    Returns:
    
    a request URI
  - query
```
java.lang.String query()
```
    Returns an encoded query string without leading '?' character.
    
    Returns:
    
    an encoded query string
  - queryParams
```
Parameters queryParams()
```
    Returns query parameters.
    
    Returns:
    
    an parameters representing query parameters
  - path
```
ServerRequest.Path path()
```
    Returns a path which was accepted by PathMatcher 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
```
java.lang.String fragment()
```
    Returns a decoded request URI fragment without leading hash '#' character.
    
    Returns:
    
    a decoded URI fragment
  - localAddress
```
java.lang.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
```
java.lang.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
```
ServerRequest.Content content()
```
    Returns reactive representation of the request content.
    
    Returns:
    
    a request content
    
    See Also:
    
    ServerRequest.Content
  - 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
  - span
```
@Deprecated
io.opentracing.Span span()
```
    Deprecated. use spanContext() instead
    
    Returns a span connected with current Handler call.
    Span is a tracing component from opentracing.io standard.
    
    Returns:
    
    a current span
  - spanContext
```
io.opentracing.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

Interface ServerRequest

Nested Class Summary

Method Summary

Method Detail

next

next

webServer

context

method

version

uri

query

queryParams

path

fragment

localAddress

localPort

remoteAddress

remotePort

isSecure

headers

content

requestId

span

spanContext