com.twitter.finagle.http

Request

abstract class Request extends Message with HttpRequestProxy

Rich HttpRequest.

Use RequestProxy to created an even richer subclass.

Linear Supertypes
HttpRequestProxy, HttpMessageProxy, HttpRequest, Message, HttpMessage, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Request
  2. HttpRequestProxy
  3. HttpMessageProxy
  4. HttpRequest
  5. Message
  6. HttpMessage
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Request()

Abstract Value Members

  1. abstract def httpRequest: HttpRequest

    Definition Classes
    HttpRequestProxy
  2. abstract def remoteSocketAddress: InetSocketAddress

    Remote InetSocketAddress

    Remote InetSocketAddress

    Annotations
    @BeanProperty()

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def accept: Seq[String]

    Accept header

    Accept header

    Definition Classes
    Message
  7. def acceptMediaTypes: Seq[String]

    Accept header media types (normalized, no parameters)

    Accept header media types (normalized, no parameters)

    Definition Classes
    Message
  8. def accept_=(values: Iterable[String]): Unit

    Set Accept header with list of values

    Set Accept header with list of values

    Definition Classes
    Message
  9. def accept_=(value: String): Unit

    Set Accept header

    Set Accept header

    Definition Classes
    Message
  10. def addCookie(cookie: Cookie): Unit

    Add a cookie

    Add a cookie

    Definition Classes
    Message
  11. def addHeader(name: String, value: AnyRef): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  12. def allow: Option[String]

    Allow header

    Allow header

    Definition Classes
    Message
  13. def allow_=(values: Iterable[HttpMethod]): Unit

    Set Authorization header

    Set Authorization header

    Definition Classes
    Message
  14. def allow_=(value: String): Unit

    Set Authorization header

    Set Authorization header

    Definition Classes
    Message
  15. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  16. def authorization: Option[String]

    Get Authorization header

    Get Authorization header

    Definition Classes
    Message
  17. def authorization_=(value: String): Unit

    Set Authorization header

    Set Authorization header

    Definition Classes
    Message
  18. def cacheControl: Option[String]

    Get Cache-Control header

    Get Cache-Control header

    Definition Classes
    Message
  19. def cacheControl_=(maxAge: Duration): Unit

    Set Cache-Control header with a max-age (and must-revalidate).

    Set Cache-Control header with a max-age (and must-revalidate).

    Definition Classes
    Message
  20. def cacheControl_=(value: String): Unit

    Set Cache-Control header

    Set Cache-Control header

    Definition Classes
    Message
  21. def charset: Option[String]

    Get charset from Content-Type header

    Get charset from Content-Type header

    Definition Classes
    Message
  22. def charset_=(value: String): Unit

    Set charset in Content-Type header.

    Set charset in Content-Type header. This does not change the content.

    Definition Classes
    Message
  23. def clearContent(): Unit

    Clear content (set to "").

    Clear content (set to "").

    Definition Classes
    Message
  24. def clearHeaders(): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  25. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  26. def close(): Unit

    End the response stream.

    End the response stream.

    Definition Classes
    Message
  27. def containsHeader(name: String): Boolean

    Definition Classes
    HttpMessageProxy → HttpMessage
  28. def containsParam(name: String): Boolean

    Check if parameter exists.

  29. def content: ChannelBuffer

    Definition Classes
    Message
  30. def contentLength: Option[Long]

    Get Content-Length header.

    Get Content-Length header. Use length to get the length of actual content.

    Definition Classes
    Message
  31. def contentLength_=(value: Long): Unit

    Set Content-Length header.

    Set Content-Length header. Normally, this is automatically set by the Codec, but this method allows you to override that.

    Definition Classes
    Message
  32. def contentString: String

    Get the content as a string.

    Get the content as a string.

    Definition Classes
    Message
  33. def contentString_=(value: String): Unit

    Set the content as a string.

    Set the content as a string.

    Definition Classes
    Message
  34. def contentType: Option[String]

    Get Content-Type header

    Get Content-Type header

    Definition Classes
    Message
  35. def contentType_=(value: String): Unit

    Set Content-Type header

    Set Content-Type header

    Definition Classes
    Message
  36. def content_=(content: ChannelBuffer): Unit

    Definition Classes
    Message
  37. lazy val cookies: CookieMap

    Cookies.

    Cookies. In a request, this uses the Cookie headers. In a response, it uses the Set-Cookie headers.

    Definition Classes
    Message
  38. def date: Option[String]

    Get Date header

    Get Date header

    Definition Classes
    Message
  39. def date_=(value: Date): Unit

    Set Date header by Date

    Set Date header by Date

    Definition Classes
    Message
  40. def date_=(value: String): Unit

    Set Date header

    Set Date header

    Definition Classes
    Message
  41. def encodeBytes(): Array[Byte]

    Encode an HTTP message to Array[Byte]

  42. def encodeString(): String

    Encode an HTTP message to String

  43. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  44. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  45. def expires: Option[String]

    Get Expires header

    Get Expires header

    Definition Classes
    Message
  46. def expires_=(value: Date): Unit

    Set Expires header by Date

    Set Expires header by Date

    Definition Classes
    Message
  47. def expires_=(value: String): Unit

    Set Expires header

    Set Expires header

    Definition Classes
    Message
  48. def fileExtension: String

    File extension.

    File extension. Empty string if none.

    Annotations
    @BeanProperty()
  49. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  50. def getBooleanParam(name: String, default: Boolean): Boolean

    Get Boolean param.

    Get Boolean param. Returns value or default.

  51. def getBooleanParam(name: String): Boolean

    Get Boolean param.

    Get Boolean param. Returns value or false.

  52. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  53. def getContent(): ChannelBuffer

    Definition Classes
    HttpMessageProxy → HttpMessage
  54. def getContentString(): String

    Definition Classes
    Message
  55. def getCookies(): Iterator[Cookie]

    Get iterator over Cookies

    Get iterator over Cookies

    Definition Classes
    Message
  56. def getHeader(name: String): String

    Definition Classes
    HttpMessageProxy → HttpMessage
  57. def getHeaderNames(): Set[String]

    Definition Classes
    HttpMessageProxy → HttpMessage
  58. def getHeaders(): List[Entry[String, String]]

    Definition Classes
    HttpMessageProxy → HttpMessage
  59. def getHeaders(name: String): List[String]

    Definition Classes
    HttpMessageProxy → HttpMessage
  60. def getHttpMessage(): HttpMessage

    Definition Classes
    HttpMessageProxy
  61. def getHttpRequest(): HttpRequest

    Definition Classes
    HttpRequestProxy
  62. def getInputStream(): InputStream

    Get InputStream for content.

    Get InputStream for content. Caller must close. (Java interface. Scala users should use withInputStream.)

    Definition Classes
    Message
  63. def getIntParam(name: String, default: Int): Int

    Get Int param.

    Get Int param. Returns value or default.

  64. def getIntParam(name: String): Int

    Get Int param.

    Get Int param. Returns value or 0.

  65. def getLength(): Int

    Definition Classes
    Message
  66. def getLongParam(name: String, default: Long = 0L): Long

    Get Long param.

    Get Long param. Returns value or default.

  67. def getLongParam(name: String): Long

    Get Long param.

    Get Long param. Returns value or 0.

  68. def getMethod(): HttpMethod

    Definition Classes
    HttpRequestProxy → HttpRequest
  69. def getParam(name: String, default: String): String

    Get parameter value.

    Get parameter value. Returns value or default.

  70. def getParam(name: String): String

    Get parameter value.

    Get parameter value. Returns value or null.

  71. def getParamNames(): Set[String]

    Get parameters names.

  72. def getParams(): List[Entry[String, String]]

    Get all parameters.

  73. def getParams(name: String): List[String]

    Get all values of parameter.

    Get all values of parameter. Returns list of values.

  74. def getProtocolVersion(): HttpVersion

    Definition Classes
    HttpMessageProxy → HttpMessage
  75. def getReader(): Reader

    Get Reader for content.

    Get Reader for content. (Java interface. Scala users should use withReader.)

    Definition Classes
    Message
  76. def getResponse(): Response

    Get response associated with request.

  77. def getShortParam(name: String, default: Short): Short

    Get Short param.

    Get Short param. Returns value or default.

  78. def getShortParam(name: String): Short

    Get Short param.

    Get Short param. Returns value or 0.

  79. def getUri(): String

    Definition Classes
    HttpRequestProxy → HttpRequest
  80. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  81. lazy val headers: HeaderMap

    Definition Classes
    Message
  82. def host: Option[String]

    Get Host header

    Get Host header

    Definition Classes
    Message
  83. def host_=(value: String): Unit

    Set Host header

    Set Host header

    Definition Classes
    Message
  84. def httpMessage: HttpMessage

    Definition Classes
    HttpRequestProxyHttpMessageProxy
  85. def isChunked(): Boolean

    Definition Classes
    HttpMessageProxy → HttpMessage
  86. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  87. def isRequest: Boolean

    Definition Classes
    RequestMessage
  88. def isResponse: Boolean

    Definition Classes
    Message
  89. def isXmlHttpRequest: Boolean

    Check if X-Requested-With contains XMLHttpRequest, usually signalling a request from a JavaScript AJAX libraries.

    Check if X-Requested-With contains XMLHttpRequest, usually signalling a request from a JavaScript AJAX libraries. Some servers treat these requests specially. For example, an endpoint might render JSON or XML instead HTML if it's an XmlHttpRequest. (Tip: don't do this - it's gross.)

    Definition Classes
    Message
  90. def lastModified: Option[String]

    Get Last-Modified header

    Get Last-Modified header

    Definition Classes
    Message
  91. def lastModified_=(value: Date): Unit

    Set Last-Modified header by Date

    Set Last-Modified header by Date

    Definition Classes
    Message
  92. def lastModified_=(value: String): Unit

    Set Last-Modified header

    Set Last-Modified header

    Definition Classes
    Message
  93. def length: Int

    Get length of content.

    Get length of content.

    Definition Classes
    Message
  94. def location: Option[String]

    Get Location header

    Get Location header

    Definition Classes
    Message
  95. def location_=(value: String): Unit

    Set Location header

    Set Location header

    Definition Classes
    Message
  96. def mediaType: Option[String]

    Get media-type from Content-Type header

    Get media-type from Content-Type header

    Definition Classes
    Message
  97. def mediaType_=(value: String): Unit

    Set media-type in Content-Type header.

    Set media-type in Content-Type header. Charset and parameter values are preserved, though may not be appropriate for the new media type.

    Definition Classes
    Message
  98. def method: HttpMethod

  99. def method_=(method: HttpMethod): Unit

  100. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  101. final def notify(): Unit

    Definition Classes
    AnyRef
  102. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  103. lazy val params: ParamMap

  104. def path: String

    Path from URI.

    Path from URI.

    Annotations
    @BeanProperty()
  105. def readChunk(): Future[HttpChunk]

    Read a chunk.

    Read a chunk.

    Definition Classes
    Message
  106. def referer: Option[String]

    Get Referer [sic] header

    Get Referer [sic] header

    Definition Classes
    Message
  107. def referer_=(value: String): Unit

    Set Referer [sic] header

    Set Referer [sic] header

    Definition Classes
    Message
  108. def remoteAddress: InetAddress

    Remote InetAddress

    Remote InetAddress

    Annotations
    @BeanProperty()
  109. def remoteHost: String

    Remote host - a dotted quad

    Remote host - a dotted quad

    Annotations
    @BeanProperty()
  110. def remotePort: Int

    Remote port

    Remote port

    Annotations
    @BeanProperty()
  111. def removeCookie(name: String): Unit

    Remove a cookie

    Remove a cookie

    Definition Classes
    Message
  112. def removeHeader(name: String): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  113. lazy val response: Response

    Response associated with request

  114. def retryAfter: Option[String]

    Get Retry-After header

    Get Retry-After header

    Definition Classes
    Message
  115. def retryAfter_=(value: Long): Unit

    Set Retry-After header by seconds

    Set Retry-After header by seconds

    Definition Classes
    Message
  116. def retryAfter_=(value: String): Unit

    Set Retry-After header

    Set Retry-After header

    Definition Classes
    Message
  117. def server: Option[String]

    Get Server header

    Get Server header

    Definition Classes
    Message
  118. def server_=(value: String): Unit

    Set Server header

    Set Server header

    Definition Classes
    Message
  119. def setChunked(chunked: Boolean): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  120. def setContent(content: ChannelBuffer): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  121. def setContentString(value: String): Unit

    Definition Classes
    Message
  122. def setContentType(mediaType: String, charset: String = "utf-8"): Unit

    Set Content-Type header by media-type and charset

    Set Content-Type header by media-type and charset

    Definition Classes
    Message
  123. def setContentTypeJson(): Unit

    Set Content-Type header to application/json;charset=utf-8

    Set Content-Type header to application/json;charset=utf-8

    Definition Classes
    Message
  124. def setHeader(name: String, values: Iterable[_]): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  125. def setHeader(name: String, value: AnyRef): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  126. def setMethod(method: HttpMethod): Unit

    Definition Classes
    HttpRequestProxy → HttpRequest
  127. def setProtocolVersion(version: HttpVersion): Unit

    Definition Classes
    HttpMessageProxy → HttpMessage
  128. def setUri(uri: String): Unit

    Definition Classes
    HttpRequestProxy → HttpRequest
  129. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  130. def toString(): String

    Definition Classes
    Request → AnyRef → Any
  131. def uri: String

  132. def uri_=(uri: String): Unit

  133. def userAgent: Option[String]

    Get User-Agent header

    Get User-Agent header

    Definition Classes
    Message
  134. def userAgent_=(value: String): Unit

    Set User-Agent header

    Set User-Agent header

    Definition Classes
    Message
  135. def version: HttpVersion

    Definition Classes
    Message
  136. def version_=(version: HttpVersion): Unit

    Definition Classes
    Message
  137. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  138. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  139. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  140. def withInputStream[T](f: (InputStream) ⇒ T): T

    Use content as InputStream.

    Use content as InputStream. The underlying channel buffer's reader index is advanced. (Scala interface. Java users can use getInputStream().)

    Definition Classes
    Message
  141. def withOutputStream[T](f: (OutputStream) ⇒ T): T

    Use content as OutputStream.

    Use content as OutputStream. Content is replaced with stream contents. (Java users can use this with a Function, or use Netty's ChannelBufferOutputStream and then call setContent() with the underlying buffer.)

    Definition Classes
    Message
  142. def withReader[T](f: (Reader) ⇒ T): T

    Use content as Reader.

    Use content as Reader. (Scala interface. Java usrs can use getReader().)

    Definition Classes
    Message
  143. def withWriter[T](f: (Writer) ⇒ T): T

    Use as a Writer.

    Use as a Writer. Content is replaced with writer contents.

    Definition Classes
    Message
  144. def write(buffer: ChannelBuffer): Unit

    Append ChannelBuffer to content.

    Append ChannelBuffer to content.

    Definition Classes
    Message
  145. def write(bytes: Array[Byte]): Unit

    Append bytes to content.

    Append bytes to content.

    Definition Classes
    Message
  146. def write(string: String): Unit

    Append string to content.

    Append string to content.

    Definition Classes
    Message
  147. def writeChunk(buf: ChannelBuffer): Unit

    Write to the response stream.

    Write to the response stream.

    Definition Classes
    Message
  148. def wwwAuthenticate: Option[String]

    Get WWW-Authenticate header

    Get WWW-Authenticate header

    Definition Classes
    Message
  149. def wwwAuthenticate_=(value: String): Unit

    Set WWW-Authenticate header

    Set WWW-Authenticate header

    Definition Classes
    Message
  150. def xForwardedFor: Option[String]

    Get X-Forwarded-For header

    Get X-Forwarded-For header

    Definition Classes
    Message
  151. def xForwardedFor_=(value: String): Unit

    Set X-Forwarded-For header

    Set X-Forwarded-For header

    Definition Classes
    Message

Deprecated Value Members

  1. def getContentLength(defaultValue: Long): Long

    Definition Classes
    HttpMessageProxy → HttpMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 6.1.5) deprecated in netty

  2. def getContentLength(): Long

    Definition Classes
    HttpMessageProxy → HttpMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 6.1.5) deprecated in netty

  3. def isKeepAlive(): Boolean

    Definition Classes
    HttpMessageProxy → HttpMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 6.1.5) deprecated in netty

Inherited from HttpRequestProxy

Inherited from HttpMessageProxy

Inherited from HttpRequest

Inherited from Message

Inherited from HttpMessage

Inherited from AnyRef

Inherited from Any

Ungrouped