Http1xServerRequest (Vertx Javadocs 4.0.3.GA API)

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

All Implemented Interfaces:

HttpServerRequest, HttpServerRequestInternal, HttpRequest, ReadStream<Buffer>, StreamBase
```
public class Http1xServerRequest
extends Object
implements HttpServerRequestInternal, HttpRequest
```
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()`
`Future<Buffer>`	`body()` Convenience method for receiving the entire request body in one piece.
`long`	`bytesRead()`
`HttpConnection`	`connection()`
`Context`	`context()`
`Map<String,Cookie>`	`cookieMap()`
`HttpServerRequest`	`customFrameHandler(Handler<HttpFrame> handler)` Set a custom frame handler.
`Future<Void>`	`end()` Returns a future signaling when the request has been fully received successfully or failed.
`HttpServerRequest`	`endHandler(Handler<Void> handler)` Set an end handler.
`HttpServerRequest`	`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
`HttpServerRequest`	`fetch(long amount)` Fetch the specified `amount` of elements.
`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
`HttpServerRequest`	`handler(Handler<Buffer> handler)` Set a data handler.
`MultiMap`	`headers()`
`String`	`host()`
`int`	`id()`
`boolean`	`isEnded()` Has the request ended? I.e.
`boolean`	`isExpectMultipart()`
`HttpMethod`	`method()`
`Object`	`metric()`
`MultiMap`	`params()`
`String`	`path()`
`HttpServerRequest`	`pause()` Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
`X509Certificate[]`	`peerCertificateChain()` Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on.
`String`	`query()`
`SocketAddress`	`remoteAddress()`
`Http1xServerResponse`	`response()`
`HttpServerRequest`	`resume()` Resume reading, and sets the buffer in `flowing` mode.
`HttpServerRequest`	`routed(String route)` Marks this request as being routed to the given route.
`String`	`scheme()`
`HttpServerRequest`	`setExpectMultipart(boolean expect)` Call this with true if you are expecting a multi-part body to be submitted in the request.
`HttpServerRequest`	`streamPriorityHandler(Handler<StreamPriority> handler)` Set an handler for stream priority changes
`Future<NetSocket>`	`toNetSocket()` Like `HttpServerRequest.toNetSocket(Handler)` but returns a `Future` of the asynchronous result
`Future<ServerWebSocket>`	`toWebSocket()` Like `HttpServerRequest.toWebSocket(Handler)` but returns a `Future` of the asynchronous result
`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

Methods inherited from interface io.vertx.core.http.HttpServerRequest
body, bodyHandler, cookieCount, end, getCookie, getHeader, getHeader, getParam, isSSL, localAddress, sslSession, streamId, streamPriority, toNetSocket, toWebSocket

Methods inherited from interface io.vertx.core.streams.ReadStream
pipe, pipeTo, pipeTo

- Method Detail
  - metric
```
public Object metric()
```
    Specified by:
    
    metric in interface HttpServerRequestInternal
    
    Returns:
    
    the metric object returned by the HttpServerMetrics.requestBegin(Object, HttpRequest) call
  - context
```
public Context context()
```
    Specified by:
    
    context in interface HttpServerRequestInternal
    
    Returns:
    
    the Vert.x context associated with this server request
  - id
```
public int id()
```
    Specified by:
    
    id in interface HttpRequest
    
    Returns:
    
    the stream id
  - 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
    
    Specified by:
    
    method in interface HttpRequest
    
    Returns:
    
    the HTTP method for the request.
  - uri
```
public String uri()
```
    Specified by:
    
    uri in interface HttpServerRequest
    
    Specified by:
    
    uri in interface HttpRequest
    
    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
  - host
```
public String host()
```
    Specified by:
    
    host in interface HttpServerRequest
    
    Returns:
    
    the request host. For HTTP2 it returns the :authority pseudo header otherwise it returns the Host header
  - bytesRead
```
public long bytesRead()
```
    Specified by:
    
    bytesRead in interface HttpServerRequest
    
    Returns:
    
    the total number of bytes read for the body of the request.
  - response
```
public Http1xServerResponse 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
    
    Specified by:
    
    headers in interface HttpRequest
    
    Returns:
    
    the headers in the request.
  - params
```
public MultiMap params()
```
    Specified by:
    
    params in interface HttpServerRequest
    
    Returns:
    
    the query parameters in the request
  - handler
```
public HttpServerRequest handler(Handler<Buffer> handler)
```
    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 ReadStream, it sets the buffer in fetch mode and clears the actual demand.
    While it's paused, no data will be sent to the data handler.
    
    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
  - fetch
```
public HttpServerRequest fetch(long amount)
```
    Description copied from interface: ReadStream
    
    Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
    
    Specified by:
    
    fetch in interface HttpServerRequest
    
    Specified by:
    
    fetch 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, and sets the buffer in flowing mode.
    If the ReadStream 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
  - scheme
```
public String scheme()
```
    Specified by:
    
    scheme in interface HttpServerRequest
    
    Returns:
    
    the scheme of the request
  - absoluteURI
```
public String absoluteURI()
```
    Specified by:
    
    absoluteURI in interface HttpServerRequest
    
    Specified by:
    
    absoluteURI in interface HttpRequest
    
    Returns:
    
    the absolute URI corresponding to the the HTTP request
  - remoteAddress
```
public SocketAddress remoteAddress()
```
    Specified by:
    
    remoteAddress in interface HttpServerRequest
    
    Specified by:
    
    remoteAddress in interface HttpRequest
    
    Returns:
    
    the remote address for this connection, possibly null (e.g a server bound on a domain socket). If useProxyProtocol is set to true, the address returned will be of the actual connecting client.
  - peerCertificateChain
```
public X509Certificate[] peerCertificateChain()
                                       throws SSLPeerUnverifiedException
```
    Description copied from interface: HttpServerRequest
    
    Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on. Use HttpServerRequest.sslSession() to access that method.
    
    Specified by:
    
    peerCertificateChain in interface HttpServerRequest
    
    Returns:
    
    an ordered array of the peer certificates. Returns null if connection is not SSL.
    
    Throws:
    
    SSLPeerUnverifiedException - SSL peer's identity has not been verified.
    
    See Also:
    
    SSLSession.getPeerCertificateChain(), HttpServerRequest.sslSession()
  - toNetSocket
```
public Future<NetSocket> toNetSocket()
```
    Description copied from interface: HttpServerRequest
    
    Like HttpServerRequest.toNetSocket(Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    toNetSocket in interface HttpServerRequest
  - 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
  - toWebSocket
```
public Future<ServerWebSocket> toWebSocket()
```
    Description copied from interface: HttpServerRequest
    
    Like HttpServerRequest.toWebSocket(Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    toWebSocket in interface HttpServerRequest
  - 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).
  - 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
  - customFrameHandler
```
public HttpServerRequest customFrameHandler(Handler<HttpFrame> handler)
```
    Description copied from interface: HttpServerRequest
    
    Set a custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 frame. HTTP/2 permits extension of the protocol.
    
    Specified by:
    
    customFrameHandler in interface HttpServerRequest
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - connection
```
public HttpConnection connection()
```
    Specified by:
    
    connection in interface HttpServerRequest
    
    Returns:
    
    the HttpConnection associated with this request
  - body
```
public Future<Buffer> body()
```
    Description copied from interface: HttpServerRequest
    
    Convenience method for receiving the entire request body in one piece.
    This saves you having to manually set a dataHandler and an endHandler 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:
    
    body in interface HttpServerRequest
    
    Returns:
    
    a future completed with the body result
  - end
```
public Future<Void> end()
```
    Description copied from interface: HttpServerRequest
    
    Returns a future signaling when the request has been fully received successfully or failed.
    
    Specified by:
    
    end in interface HttpServerRequest
    
    Returns:
    
    a future completed with the body result
  - streamPriorityHandler
```
public HttpServerRequest streamPriorityHandler(Handler<StreamPriority> handler)
```
    Description copied from interface: HttpServerRequest
    
    Set an handler for stream priority changes
    This is not implemented for HTTP/1.x.
    
    Specified by:
    
    streamPriorityHandler in interface HttpServerRequest
    
    Parameters:
    
    handler - the handler to be called when stream priority changes
  - cookieMap
```
public Map<String,Cookie> cookieMap()
```
    Specified by:
    
    cookieMap in interface HttpServerRequest
    
    Returns:
    
    a map of all the cookies.
  - routed
```
public HttpServerRequest routed(String route)
```
    Description copied from interface: HttpServerRequest
    
    Marks this request as being routed to the given route. This is purely informational and is being provided to metrics.
    
    Specified by:
    
    routed in interface HttpServerRequest
    
    Parameters:
    
    route - The route this request has been routed to.

Class Http1xServerRequest

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.core.http.HttpServerRequest

Methods inherited from interface io.vertx.core.streams.ReadStream

Method Detail

metric

context

id

version

method

uri

path

query

host

bytesRead

response

headers

params

handler

exceptionHandler

pause

fetch

resume

endHandler

scheme

absoluteURI

remoteAddress

peerCertificateChain

toNetSocket

uploadHandler

formAttributes

getFormAttribute

toWebSocket

setExpectMultipart

isExpectMultipart

isEnded

customFrameHandler

connection

body

end

streamPriorityHandler

cookieMap

routed