HttpServerRequestImpl (Vert.x Core 3.0.0 API)

java.lang.Object
- io.vertx.core.http.impl.HttpServerRequestImpl

All Implemented Interfaces:

HttpServerRequest, ReadStream<Buffer>, StreamBase
```
public class HttpServerRequestImpl
extends Object
implements HttpServerRequest
```
This class is optimised for performance when used on the same event loop that is was passed to the handler with. However it can be used safely from other threads. The internal state is protected by using the connection as a lock. If always used on the same event loop, then we benefit from biased locking which makes the overhead of synchronized near zero. It's important we don't have different locks for connection and request/response to avoid deadlock conditions

Author:

Tim Fox

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`absoluteURI()`
`HttpServerRequest`	`bodyHandler(Handler<Buffer> bodyHandler)` Convenience method for receiving the entire request body in one piece.
`HttpServerRequest`	`endHandler(Handler<Void> handler)` Set an end handler.
`HttpServerRequest`	`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
`MultiMap`	`formAttributes()` Returns a map of all form attributes in the request.
`String`	`getFormAttribute(String attributeName)` Return the first form attribute value with the specified name
`String`	`getHeader(String headerName)` Return the first header value with the specified name
`String`	`getParam(String paramName)` Return the first param value with the specified name
`HttpServerRequest`	`handler(Handler<Buffer> dataHandler)` Set a data handler.
`MultiMap`	`headers()`
`boolean`	`isEnded()` Has the request ended? I.e.
`boolean`	`isExpectMultipart()`
`SocketAddress`	`localAddress()`
`HttpMethod`	`method()`
`NetSocket`	`netSocket()` Get a net socket for the underlying connection of this request.
`MultiMap`	`params()`
`String`	`path()`
`HttpServerRequest`	`pause()` Pause the `ReadSupport`.
`X509Certificate[]`	`peerCertificateChain()`
`String`	`query()`
`SocketAddress`	`remoteAddress()`
`HttpServerResponse`	`response()`
`HttpServerRequest`	`resume()` Resume reading.
`HttpServerRequest`	`setExpectMultipart(boolean expect)` Call this with true if you are expecting a multi-part body to be submitted in the request.
`ServerWebSocket`	`upgrade()` Upgrade the connection to a WebSocket connection.
`HttpServerRequest`	`uploadHandler(Handler<HttpServerFileUpload> handler)` Set an upload handler.
`String`	`uri()`
`HttpVersion`	`version()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - version
```
public HttpVersion version()
```
    Specified by:
    
    version in interface HttpServerRequest
    
    Returns:
    
    the HTTP version of the request
  - method
```
public HttpMethod method()
```
    Specified by:
    
    method in interface HttpServerRequest
    
    Returns:
    
    the HTTP method for the request.
  - uri
```
public String uri()
```
    Specified by:
    
    uri in interface HttpServerRequest
    
    Returns:
    
    the URI of the request. This is usually a relative URI
  - path
```
public String path()
```
    Specified by:
    
    path in interface HttpServerRequest
    
    Returns:
    
    The path part of the uri. For example /somepath/somemorepath/someresource.foo
  - query
```
public String query()
```
    Specified by:
    
    query in interface HttpServerRequest
    
    Returns:
    
    the query part of the uri. For example someparam=32&someotherparam=x
  - response
```
public HttpServerResponse response()
```
    Specified by:
    
    response in interface HttpServerRequest
    
    Returns:
    
    the response. Each instance of this class has an HttpServerResponse instance attached to it. This is used to send the response back to the client.
  - headers
```
public MultiMap headers()
```
    Specified by:
    
    headers in interface HttpServerRequest
    
    Returns:
    
    the headers in the request.
  - getHeader
```
public String getHeader(String headerName)
```
    Description copied from interface: HttpServerRequest
    
    Return the first header value with the specified name
    
    Specified by:
    
    getHeader in interface HttpServerRequest
    
    Parameters:
    
    headerName - the header name
    
    Returns:
    
    the header value
  - params
```
public MultiMap params()
```
    Specified by:
    
    params in interface HttpServerRequest
    
    Returns:
    
    the query parameters in the request
  - getParam
```
public String getParam(String paramName)
```
    Description copied from interface: HttpServerRequest
    
    Return the first param value with the specified name
    
    Specified by:
    
    getParam in interface HttpServerRequest
    
    Parameters:
    
    paramName - the param name
    
    Returns:
    
    the param value
  - handler
```
public HttpServerRequest handler(Handler<Buffer> dataHandler)
```
    Description copied from interface: ReadStream
    
    Set a data handler. As data is read, the handler will be called with the data.
    
    Specified by:
    
    handler in interface HttpServerRequest
    
    Specified by:
    
    handler in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - exceptionHandler
```
public HttpServerRequest exceptionHandler(Handler<Throwable> handler)
```
    Description copied from interface: ReadStream
    
    Set an exception handler on the read stream.
    
    Specified by:
    
    exceptionHandler in interface HttpServerRequest
    
    Specified by:
    
    exceptionHandler in interface ReadStream<Buffer>
    
    Specified by:
    
    exceptionHandler in interface StreamBase
    
    Parameters:
    
    handler - the exception handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pause
```
public HttpServerRequest pause()
```
    Description copied from interface: ReadStream
    
    Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler
    
    Specified by:
    
    pause in interface HttpServerRequest
    
    Specified by:
    
    pause in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - resume
```
public HttpServerRequest resume()
```
    Description copied from interface: ReadStream
    
    Resume reading. If the ReadSupport has been paused, reading will recommence on it.
    
    Specified by:
    
    resume in interface HttpServerRequest
    
    Specified by:
    
    resume in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - endHandler
```
public HttpServerRequest endHandler(Handler<Void> handler)
```
    Description copied from interface: ReadStream
    
    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
    
    Specified by:
    
    endHandler in interface HttpServerRequest
    
    Specified by:
    
    endHandler in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - remoteAddress
```
public SocketAddress remoteAddress()
```
    Specified by:
    
    remoteAddress in interface HttpServerRequest
    
    Returns:
    
    the remote (client side) address of the request
  - absoluteURI
```
public String absoluteURI()
```
    Specified by:
    
    absoluteURI in interface HttpServerRequest
    
    Returns:
    
    the absolute URI corresponding to the the HTTP request
  - peerCertificateChain
```
public X509Certificate[] peerCertificateChain()
                                       throws SSLPeerUnverifiedException
```
    Specified by:
    
    peerCertificateChain in interface HttpServerRequest
    
    Returns:
    
    an array of the peer certificates. Returns null if connection is not SSL.
    
    Throws:
    
    SSLPeerUnverifiedException - SSL peer's identity has not been verified.
  - bodyHandler
```
public HttpServerRequest bodyHandler(Handler<Buffer> bodyHandler)
```
    Description copied from interface: HttpServerRequest
    
    Convenience method for receiving the entire request body in one piece.
    This saves the user having to manually setting a data and end handler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.
    
    Specified by:
    
    bodyHandler in interface HttpServerRequest
    
    Parameters:
    
    bodyHandler - This handler will be called after all the body has been received
  - netSocket
```
public NetSocket netSocket()
```
    Description copied from interface: HttpServerRequest
    
    Get a net socket for the underlying connection of this request.
    USE THIS WITH CAUTION!
    Once you have called this method, you must handle writing to the connection yourself using the net socket, the server request instance will no longer be usable as normal. Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol.
    
    Specified by:
    
    netSocket in interface HttpServerRequest
    
    Returns:
    
    the net socket
  - uploadHandler
```
public HttpServerRequest uploadHandler(Handler<HttpServerFileUpload> handler)
```
    Description copied from interface: HttpServerRequest
    
    Set an upload handler. The handler will get notified once a new file upload was received to allow you to deal with the file upload.
    
    Specified by:
    
    uploadHandler in interface HttpServerRequest
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - formAttributes
```
public MultiMap formAttributes()
```
    Description copied from interface: HttpServerRequest
    
    Returns a map of all form attributes in the request.
    Be aware that the attributes will only be available after the whole body has been received, i.e. after the request end handler has been called.
    HttpServerRequest.setExpectMultipart(boolean) must be called first before trying to get the form attributes.
    
    Specified by:
    
    formAttributes in interface HttpServerRequest
    
    Returns:
    
    the form attributes
  - getFormAttribute
```
public String getFormAttribute(String attributeName)
```
    Description copied from interface: HttpServerRequest
    
    Return the first form attribute value with the specified name
    
    Specified by:
    
    getFormAttribute in interface HttpServerRequest
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    the attribute value
  - upgrade
```
public ServerWebSocket upgrade()
```
    Description copied from interface: HttpServerRequest
    
    Upgrade the connection to a WebSocket connection.
    This is an alternative way of handling WebSockets and can only be used if no websocket handlers are set on the Http server, and can only be used during the upgrade request during the WebSocket handshake.
    
    Specified by:
    
    upgrade in interface HttpServerRequest
    
    Returns:
    
    the WebSocket
  - setExpectMultipart
```
public HttpServerRequest setExpectMultipart(boolean expect)
```
    Description copied from interface: HttpServerRequest
    
    Call this with true if you are expecting a multi-part body to be submitted in the request. This must be called before the body of the request has been received
    
    Specified by:
    
    setExpectMultipart in interface HttpServerRequest
    
    Parameters:
    
    expect - true - if you are expecting a multi-part body
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - isExpectMultipart
```
public boolean isExpectMultipart()
```
    Specified by:
    
    isExpectMultipart in interface HttpServerRequest
    
    Returns:
    
    true if we are expecting a multi-part body for this request. See HttpServerRequest.setExpectMultipart(boolean).
  - localAddress
```
public SocketAddress localAddress()
```
    Specified by:
    
    localAddress in interface HttpServerRequest
    
    Returns:
    
    the local (server side) address of the server that handles the request
  - isEnded
```
public boolean isEnded()
```
    Description copied from interface: HttpServerRequest
    
    Has the request ended? I.e. has the entire request, including the body been read?
    
    Specified by:
    
    isEnded in interface HttpServerRequest
    
    Returns:
    
    true if ended

Class HttpServerRequestImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

version

method

uri

path

query

response

headers

getHeader

params

getParam

handler

exceptionHandler

pause

resume

endHandler

remoteAddress

absoluteURI

peerCertificateChain

bodyHandler

netSocket

uploadHandler

formAttributes

getFormAttribute

upgrade

setExpectMultipart

isExpectMultipart

localAddress

isEnded