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, Proxy, HttpRequest, Message, HttpMessage, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Request
  2. HttpRequestProxy
  3. HttpMessageProxy
  4. Proxy
  5. HttpRequest
  6. Message
  7. HttpMessage
  8. AnyRef
  9. 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 allow: Option[String]

    Allow header

    Allow header

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

    Set Authorization header

    Set Authorization header

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

    Set Authorization header

    Set Authorization header

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

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

    Get Authorization header

    Get Authorization header

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

    Set Authorization header

    Set Authorization header

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

    Get Cache-Control header

    Get Cache-Control header

    Definition Classes
    Message
  18. 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
  19. def cacheControl_=(value: String): Unit

    Set Cache-Control header

    Set Cache-Control header

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

    Get charset from Content-Type header

    Get charset from Content-Type header

    Definition Classes
    Message
  21. 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
  22. def clearContent(): Unit

    Clear content (set to "").

    Clear content (set to "").

    Definition Classes
    Message
  23. def clone(): AnyRef

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

    End the response stream.

    End the response stream.

    Definition Classes
    Message
  25. def containsParam(name: String): Boolean

    Check if parameter exists.

  26. def content: ChannelBuffer

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

    Get Content-Length header.

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

    Definition Classes
    Message
  28. 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
  29. def contentString: String

    Get the content as a string.

    Get the content as a string.

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

    Set the content as a string.

    Set the content as a string.

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

    Get Content-Type header

    Get Content-Type header

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

    Set Content-Type header

    Set Content-Type header

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

    Definition Classes
    Message
  34. 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
  35. def ctx: Record

    Arbitrary user-defined context associated with this request object.

    Arbitrary user-defined context associated with this request object. RecordSchema.Record is used here, rather than Context or similar out-of-band mechanisms, to make the connection between the request and its associated context explicit.

  36. def date: Option[String]

    Get Date header

    Get Date header

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

    Set Date header by Date

    Set Date header by Date

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

    Set Date header

    Set Date header

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

    Encode an HTTP message to Array[Byte]

  40. def encodeString(): String

    Encode an HTTP message to String

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

    Definition Classes
    AnyRef
  42. def equals(that: Any): Boolean

    Definition Classes
    Proxy → Any
  43. def expires: Option[String]

    Get Expires header

    Get Expires header

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

    Set Expires header by Date

    Set Expires header by Date

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

    Set Expires header

    Set Expires header

    Definition Classes
    Message
  46. def fileExtension: String

    File extension.

    File extension. Empty string if none.

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

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

    Get Boolean param.

    Get Boolean param. Returns value or default.

  49. def getBooleanParam(name: String): Boolean

    Get Boolean param.

    Get Boolean param. Returns value or false.

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

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

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

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

    Get iterator over Cookies

    Get iterator over Cookies

    Definition Classes
    Message
  54. def getHttpMessage(): HttpMessage

    Definition Classes
    HttpMessageProxy
  55. def getHttpRequest(): HttpRequest

    Definition Classes
    HttpRequestProxy
  56. def getInputStream(): InputStream

    Get InputStream for content.

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

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

    Get Int param.

    Get Int param. Returns value or default.

  58. def getIntParam(name: String): Int

    Get Int param.

    Get Int param. Returns value or 0.

  59. def getLength(): Int

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

    Get Long param.

    Get Long param. Returns value or default.

  61. def getLongParam(name: String): Long

    Get Long param.

    Get Long param. Returns value or 0.

  62. def getMethod(): HttpMethod

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

    Get parameter value.

    Get parameter value. Returns value or default.

  64. def getParam(name: String): String

    Get parameter value.

    Get parameter value. Returns value or null.

  65. def getParamNames(): Set[String]

    Get parameters names.

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

    Get all parameters.

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

    Get all values of parameter.

    Get all values of parameter. Returns list of values.

  68. def getProtocolVersion(): HttpVersion

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

    Get Reader for content.

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

    Definition Classes
    Message
  70. def getResponse(): Response

    Get response associated with request.

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

    Get Short param.

    Get Short param. Returns value or default.

  72. def getShortParam(name: String): Short

    Get Short param.

    Get Short param. Returns value or 0.

  73. def getUri(): String

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

    Definition Classes
    Proxy → Any
  75. lazy val headerMap: HeaderMap

    Definition Classes
    Message
  76. def headers(): HttpHeaders

    Definition Classes
    HttpMessageProxy → HttpMessage
  77. def host: Option[String]

    Get Host header

    Get Host header

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

    Set Host header

    Set Host header

    Definition Classes
    Message
  79. def httpMessage: HttpMessage

    Definition Classes
    HttpRequestProxyHttpMessageProxy
  80. def isChunked(): Boolean

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

    Definition Classes
    Any
  82. def isRequest: Boolean

    Definition Classes
    RequestMessage
  83. def isResponse: Boolean

    Definition Classes
    Message
  84. 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
  85. def lastModified: Option[String]

    Get Last-Modified header

    Get Last-Modified header

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

    Set Last-Modified header by Date

    Set Last-Modified header by Date

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

    Set Last-Modified header

    Set Last-Modified header

    Definition Classes
    Message
  88. def length: Int

    Get length of content.

    Get length of content.

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

    Get Location header

    Get Location header

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

    Set Location header

    Set Location header

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

    Get media-type from Content-Type header

    Get media-type from Content-Type header

    Definition Classes
    Message
  92. 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
  93. def method: HttpMethod

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

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

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

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

    Definition Classes
    AnyRef
  98. def params: ParamMap

  99. def path: String

    Path from URI.

    Path from URI.

    Annotations
    @BeanProperty()
  100. def reader: Reader

    A read-only handle to the internal stream of bytes, representing the message body.

    A read-only handle to the internal stream of bytes, representing the message body. See com.twitter.io.Reader for more information.

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

    Get Referer [sic] header

    Get Referer [sic] header

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

    Set Referer [sic] header

    Set Referer [sic] header

    Definition Classes
    Message
  103. def remoteAddress: InetAddress

    Remote InetAddress

    Remote InetAddress

    Annotations
    @BeanProperty()
  104. def remoteHost: String

    Remote host - a dotted quad

    Remote host - a dotted quad

    Annotations
    @BeanProperty()
  105. def remotePort: Int

    Remote port

    Remote port

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

    Remove a cookie

    Remove a cookie

    Definition Classes
    Message
  107. lazy val response: Response

    Response associated with request

  108. def retryAfter: Option[String]

    Get Retry-After header

    Get Retry-After header

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

    Set Retry-After header by seconds

    Set Retry-After header by seconds

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

    Set Retry-After header

    Set Retry-After header

    Definition Classes
    Message
  111. def self: HttpMessage

    Definition Classes
    HttpMessageProxy → Proxy
  112. def server: Option[String]

    Get Server header

    Get Server header

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

    Set Server header

    Set Server header

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

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

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

    Definition Classes
    Message
  117. 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
  118. 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
  119. def setMethod(method: HttpMethod): Unit

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

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

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

    Definition Classes
    AnyRef
  123. def toString(): String

    Definition Classes
    Request → Proxy → AnyRef → Any
  124. def uri: String

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

  126. def userAgent: Option[String]

    Get User-Agent header

    Get User-Agent header

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

    Set User-Agent header

    Set User-Agent header

    Definition Classes
    Message
  128. def version: HttpVersion

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

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. 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
  134. 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
  135. 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
  136. def withWriter[T](f: (Writer) ⇒ T): T

    Use as a Writer.

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

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

    Append ChannelBuffer to content.

    Append ChannelBuffer to content.

    If isChunked then multiple writes must be composed using writer and flatMap to have the appropriate backpressure semantics.

    Attempting to write after calling close will result in a thrown com.twitter.io.Reader.ReaderDiscarded.

    Definition Classes
    Message
    Annotations
    @throws( classOf[BufReader.ReaderDiscarded] ) @throws( classOf[IllegalStateException] )
  138. def write(bytes: Array[Byte]): Unit

    Append bytes to content.

    Append bytes to content.

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

    Append string to content.

    Append string to content.

    Definition Classes
    Message
  140. def writer: Writer with Closable

    A write-only handle to the internal stream of bytes, representing the message body.

    A write-only handle to the internal stream of bytes, representing the message body. See com.twitter.io.Writer for more information.

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

    Get WWW-Authenticate header

    Get WWW-Authenticate header

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

    Set WWW-Authenticate header

    Set WWW-Authenticate header

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

    Get X-Forwarded-For header

    Get X-Forwarded-For header

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

    Set X-Forwarded-For header

    Set X-Forwarded-For header

    Definition Classes
    Message

Inherited from HttpRequestProxy

Inherited from HttpMessageProxy

Inherited from Proxy

Inherited from HttpRequest

Inherited from Message

Inherited from HttpMessage

Inherited from AnyRef

Inherited from Any

Ungrouped