DefaultHttpServerRequest (vertx-core 2.0.2-final API)

java.lang.Object
- org.vertx.java.core.http.impl.DefaultHttpServerRequest

All Implemented Interfaces:

HttpServerRequest, ExceptionSupport<HttpServerRequest>, ReadStream<HttpServerRequest>
```
public class DefaultHttpServerRequest
extends java.lang.Object
implements HttpServerRequest
```

Method Summary

Methods
Modifier and Type	Method and Description
`java.net.URI`	`absoluteURI()` Get the absolute URI corresponding to the the HTTP request
`HttpServerRequest`	`bodyHandler(Handler<Buffer> bodyHandler)` Convenience method for receiving the entire request body in one piece.
`HttpServerRequest`	`dataHandler(Handler<Buffer> dataHandler)` Set a data handler.
`HttpServerRequest`	`endHandler(Handler<java.lang.Void> handler)` Set an end handler.
`HttpServerRequest`	`exceptionHandler(Handler<java.lang.Throwable> handler)` Set an exception handler.
`HttpServerRequest`	`expectMultiPart(boolean expect)` Call this with true if you are expecting a multi-part form to be submitted in the request This must be called before the body of the request has been received
`MultiMap`	`formAttributes()` Returns a map of all form attributes which was found in the request.
`MultiMap`	`headers()` A map of all headers in the request, If the request contains multiple headers with the same key, the values will be concatenated together into a single header with the same key value, with each value separated by a comma, as specified here.
`java.lang.String`	`method()` The HTTP method for the request.
`NetSocket`	`netSocket()` Get a net socket for the underlying connection of this request.
`MultiMap`	`params()` Returns a map of all the parameters in the request
`java.lang.String`	`path()` The path part of the uri.
`HttpServerRequest`	`pause()` Pause the `ReadStream`.
`javax.security.cert.X509Certificate[]`	`peerCertificateChain()`
`java.lang.String`	`query()` The query part of the uri.
`java.net.InetSocketAddress`	`remoteAddress()` Return the remote (client side) address of the request
`HttpServerResponse`	`response()` The response.
`HttpServerRequest`	`resume()` Resume reading.
`HttpServerRequest`	`uploadHandler(Handler<HttpServerFileUpload> handler)` Set the upload handler.
`java.lang.String`	`uri()` The uri of the request.
`HttpVersion`	`version()` The HTTP version of the request

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

- Method Detail
  - version
```
public HttpVersion version()
```
    Description copied from interface: HttpServerRequest
    
    The HTTP version of the request
    
    Specified by:
    
    version in interface HttpServerRequest
  - method
```
public java.lang.String method()
```
    Description copied from interface: HttpServerRequest
    
    The HTTP method for the request. One of GET, PUT, POST, DELETE, TRACE, CONNECT, OPTIONS or HEAD
    
    Specified by:
    
    method in interface HttpServerRequest
  - uri
```
public java.lang.String uri()
```
    Description copied from interface: HttpServerRequest
    
    The uri of the request. For example http://www.somedomain.com/somepath/somemorepath/someresource.foo?someparam=32&someotherparam=x
    
    Specified by:
    
    uri in interface HttpServerRequest
  - path
```
public java.lang.String path()
```
    Description copied from interface: HttpServerRequest
    
    The path part of the uri. For example /somepath/somemorepath/someresource.foo
    
    Specified by:
    
    path in interface HttpServerRequest
  - query
```
public java.lang.String query()
```
    Description copied from interface: HttpServerRequest
    
    The query part of the uri. For example someparam=32&someotherparam=x
    
    Specified by:
    
    query in interface HttpServerRequest
  - response
```
public HttpServerResponse response()
```
    Description copied from interface: HttpServerRequest
    
    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.
    
    Specified by:
    
    response in interface HttpServerRequest
  - headers
```
public MultiMap headers()
```
    Description copied from interface: HttpServerRequest
    
    A map of all headers in the request, If the request contains multiple headers with the same key, the values will be concatenated together into a single header with the same key value, with each value separated by a comma, as specified here. The headers will be automatically lower-cased when they reach the server
    
    Specified by:
    
    headers in interface HttpServerRequest
  - params
```
public MultiMap params()
```
    Description copied from interface: HttpServerRequest
    
    Returns a map of all the parameters in the request
    
    Specified by:
    
    params in interface HttpServerRequest
  - dataHandler
```
public HttpServerRequest dataHandler(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:
    
    dataHandler in interface ReadStream<HttpServerRequest>
  - exceptionHandler
```
public HttpServerRequest exceptionHandler(Handler<java.lang.Throwable> handler)
```
    Description copied from interface: ExceptionSupport
    
    Set an exception handler.
    
    Specified by:
    
    exceptionHandler in interface ExceptionSupport<HttpServerRequest>
  - pause
```
public HttpServerRequest pause()
```
    Description copied from interface: ReadStream
    
    Pause the ReadStream. While the stream is paused, no data will be sent to the dataHandler
    
    Specified by:
    
    pause in interface ReadStream<HttpServerRequest>
  - resume
```
public HttpServerRequest resume()
```
    Description copied from interface: ReadStream
    
    Resume reading. If the ReadStream has been paused, reading will recommence on it.
    
    Specified by:
    
    resume in interface ReadStream<HttpServerRequest>
  - endHandler
```
public HttpServerRequest endHandler(Handler<java.lang.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 ReadStream<HttpServerRequest>
  - remoteAddress
```
public java.net.InetSocketAddress remoteAddress()
```
    Description copied from interface: HttpServerRequest
    
    Return the remote (client side) address of the request
    
    Specified by:
    
    remoteAddress in interface HttpServerRequest
  - absoluteURI
```
public java.net.URI absoluteURI()
```
    Description copied from interface: HttpServerRequest
    
    Get the absolute URI corresponding to the the HTTP request
    
    Specified by:
    
    absoluteURI in interface HttpServerRequest
    
    Returns:
    the URI
  - peerCertificateChain
```
public javax.security.cert.X509Certificate[] peerCertificateChain()
                                                           throws javax.net.ssl.SSLPeerUnverifiedException
```
    Specified by:
    
    peerCertificateChain in interface HttpServerRequest
    
    Returns:
    an array of the peer certificates. Returns null if connection is not SSL.
    
    Throws:
    
    javax.net.ssl.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 set 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! 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 the upload handler. The handler will get notified once a new file upload was received and so allow to get notified by the upload in progress.
    
    Specified by:
    
    uploadHandler in interface HttpServerRequest
  - formAttributes
```
public MultiMap formAttributes()
```
    Description copied from interface: HttpServerRequest
    
    Returns a map of all form attributes which was found in the request. Be aware that this message should only get called after the endHandler was notified as the map will be filled on-the-fly. HttpServerRequest.expectMultiPart(boolean) must be called first before trying to get the formAttributes
    
    Specified by:
    
    formAttributes in interface HttpServerRequest
  - expectMultiPart
```
public HttpServerRequest expectMultiPart(boolean expect)
```
    Description copied from interface: HttpServerRequest
    
    Call this with true if you are expecting a multi-part form to be submitted in the request This must be called before the body of the request has been received
    
    Specified by:
    
    expectMultiPart in interface HttpServerRequest

Class DefaultHttpServerRequest

Method Summary

Methods inherited from class java.lang.Object

Method Detail

version

method

uri

path

query

response

headers

params

dataHandler

exceptionHandler

pause

resume

endHandler

remoteAddress

absoluteURI

peerCertificateChain

bodyHandler

netSocket

uploadHandler

formAttributes

expectMultiPart