Packages

abstract class Request extends Message

Rich HttpRequest.

Use RequestProxy to create an even richer subclass.

Linear Supertypes
Message, AnyRef, Any
Known Subclasses
Proxy, RequestProxy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. Message
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def chunkReader: Reader[Chunk]

    A read-only handle to a stream of Chunk, representing the message body.

    A read-only handle to a stream of Chunk, representing the message body. This stream is only populated on chunked messages (isChunked == true). Use content to access a payload of a fully-buffered message (isChunked == false).

    Prefer this API over reader when application needs to receive trailing headers (trailers). Trailers are transmitted in the very last chunk (chunk.isLast == true) of the stream and can be retrieved via Chunk.trailers.

    Definition Classes
    Message
    See also

    Reader and Chunk

  2. abstract def chunkWriter: Writer[Chunk]

    A write-only handle to a stream of Chunk, representing the message body.

    A write-only handle to a stream of Chunk, representing the message body. Only chunked messages (isChunked == true) use this stream as their payload, fully-buffered messages (isChunked == false) use content instead.

    Prefer this API over writer when application needs to send trailing headers (trailers). Trailers are transmitted in the very last chunk of the stream and can be populated via Chunk.last factory method.

    Definition Classes
    Message
    See also

    Reader and Chunk

  3. abstract 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.

  4. abstract def headerMap: HeaderMap

    HTTP headers associated with this message.

    HTTP headers associated with this message.

    Definition Classes
    Message
    Note

    HeaderMap isn't thread-safe. Any concurrent access should be synchronized externally.

  5. abstract def method: Method

    Returns the HTTP method of this request.

  6. abstract def method_=(method: Method): Unit

    Sets the HTTP method of this request to the given method.

    Sets the HTTP method of this request to the given method.

    * @see method(Method) for Java users.

  7. abstract def remoteSocketAddress: InetSocketAddress

    The InetSocketAddress of the client or a place-holder ephemeral address for requests that have yet to be dispatched.

    The InetSocketAddress of the client or a place-holder ephemeral address for requests that have yet to be dispatched.

    Annotations
    @BeanProperty()
  8. abstract def trailers: HeaderMap

    Trailing headers (trailers) associated with this message.

    Trailing headers (trailers) associated with this message.

    These are only populated on fully-buffered inbound messages that were aggregated (see withStreaming(false)) from HTTP streams terminating with trailers.

    Definition Classes
    Message
    Note

    HeaderMap isn't thread-safe. Any concurrent access should be synchronized externally.

  9. abstract def uri: String

    Returns the URI of this request.

  10. abstract def uri_=(uri: String): Unit

    Set the URI of this request to the given uri.

    Set the URI of this request to the given uri.

    See also

    uri(String) for Java users.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def accept: Seq[String]

    Accept header

  5. def acceptMediaTypes: Seq[String]

    Accept header media types (normalized, no parameters)

  6. def accept_=(values: Iterable[String]): Unit

    Set Accept header with list of values

  7. def accept_=(value: String): Unit

    Set Accept header

  8. def addCookie(cookie: Cookie): Unit

    Add a cookie

    Add a cookie

    Definition Classes
    Message
  9. def allow: Option[String]

    Allow header

    Allow header

    Definition Classes
    Message
  10. def allow_=(values: Iterable[Method]): Unit

    Set Allow header

    Set Allow header

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

    Set Allow header

    Set Allow header

    Definition Classes
    Message
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def authorization: Option[String]

    Get Authorization header

  14. def authorization_=(value: String): Unit

    Set Authorization header

  15. def cacheControl: Option[String]

    Get Cache-Control header

    Get Cache-Control header

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

    Set Cache-Control header

    Set Cache-Control header

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

    Get charset from Content-Type header

    Get charset from Content-Type header

    Definition Classes
    Message
  19. 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
  20. final def clearContent(): Unit

    Clear content (set to "").

    Clear content (set to "").

    Definition Classes
    Message
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  22. def close(): Future[Unit]

    End the response stream.

    End the response stream.

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

    Check if parameter exists.

    Check if parameter exists.

    See also

    params for details of which parameters are considered.

  24. final def content(content: Buf): Request.this.type

    Set the content of this Message.

    Set the content of this Message.

    Any existing content is discarded. If this Message is set to chunked, an IllegalStateException is thrown.

    Definition Classes
    Message
    Annotations
    @throws(scala.this.throws.<init>$default$1[IllegalStateException])
    See also

    content_=(Buf) for Scala users

  25. def content: Buf

    Retrieve the current content of this Message.

    Retrieve the current content of this Message.

    If this message is chunked, the resulting Buf will always be empty.

    Definition Classes
    Message
  26. final def contentLength(value: Long): Request.this.type

    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
    See also

    contentLength_=(Long) for Scala users.

  27. def contentLength: Option[Long]

    Get the value of the Content-Length header.

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

    Definition Classes
    Message
    See also

    Long for Java users.

  28. final def contentLengthOrElse(default: Long): Long

    Get the value of the Content-Length header, or the provided default if it doesn't exist.

    Get the value of the Content-Length header, or the provided default if it doesn't exist.

    Definition Classes
    Message
    See also

    Option(Long) for Scala users.

  29. 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
    See also

    contentLength(Long) for Java users.

  30. def contentString: String

    Get the content as a string.

    Get the content as a string.

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

    Set the content as a string.

    Set the content as a string.

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

    Get Content-Type header

    Get Content-Type header

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

    Set Content-Type header

    Set Content-Type header

    Definition Classes
    Message
  34. def content_=(content: Buf): Unit

    Set the content of this Message.

    Set the content of this Message.

    Any existing content is discarded. If this Message is set to chunked, an IllegalStateException is thrown.

    Definition Classes
    Message
    Annotations
    @throws(scala.this.throws.<init>$default$1[IllegalStateException])
    See also

    content(Buf) for Java users

  35. 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
  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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  41. def expires: Option[String]

    Get Expires header

    Get Expires header

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

    Set Expires header by Date

    Set Expires header by Date

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

    Set Expires header

    Set Expires header

    Definition Classes
    Message
  44. def fileExtension: String

    File extension.

    File extension. Empty string if none.

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

    Get Boolean param.

    Get Boolean param. Returns value or default.

    See also

    params for details of which parameters are considered.

  47. def getBooleanParam(name: String): Boolean

    Get Boolean param.

    Get Boolean param. Returns value or false.

    See also

    params for details of which parameters are considered.

  48. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. def getContentString(): String
    Definition Classes
    Message
  50. def getCookies(): Iterator[Cookie]

    Get iterator over Cookies

    Get iterator over Cookies

    Definition Classes
    Message
  51. final def getInputStream(): InputStream

    Get InputStream for content.

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

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

    Get Int param.

    Get Int param. Returns value or default.

    See also

    params for details of which parameters are considered.

  53. def getIntParam(name: String): Int

    Get Int param.

    Get Int param. Returns value or 0.

    See also

    params for details of which parameters are considered.

  54. final def getLength(): Int

    Get length of content.

    Get length of content.

    Definition Classes
    Message
  55. def getLongParam(name: String, default: Long): Long

    Get Long param.

    Get Long param. Returns value or default.

    See also

    params for details of which parameters are considered.

  56. def getLongParam(name: String): Long

    Get Long param.

    Get Long param. Returns value or 0.

    See also

    params for details of which parameters are considered.

  57. def getParam(name: String, default: String): String

    Get parameter value.

    Get parameter value. Returns value or default.

    See also

    params for details of which parameters are considered.

  58. def getParam(name: String): String

    Get parameter value.

    Get parameter value. Returns value or null.

    See also

    params for details of which parameters are considered.

  59. def getParamNames(): Set[String]

    Get parameters names.

    Get parameters names.

    See also

    params for details of which parameters are considered.

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

    Get all parameters.

    Get all parameters.

    See also

    params for details of which parameters are considered.

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

    Get all values of parameter.

    Get all values of parameter. Returns list of values.

    See also

    params for details of which parameters are considered.

  62. final def getReader(): Reader

    Get Reader for content.

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

    Definition Classes
    Message
  63. def getShortParam(name: String, default: Short): Short

    Get Short param.

    Get Short param. Returns value or default.

    See also

    params for details of which parameters are considered.

  64. def getShortParam(name: String): Short

    Get Short param.

    Get Short param. Returns value or 0.

    See also

    params for details of which parameters are considered.

  65. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  66. final def host(value: String): Request.this.type

    Set the Host header

    Set the Host header

    See also

    host_=(String) for Scala users

  67. def host: Option[String]

    Get Host header

  68. def host_=(value: String): Unit

    Set Host header

    Set Host header

    See also

    host(String) for Java users

  69. def isChunked: Boolean
    Definition Classes
    Message
  70. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  71. final def isRequest: Boolean
    Definition Classes
    Request → Message
  72. def isResponse: Boolean
    Definition Classes
    Message
  73. 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
  74. final def keepAlive: Boolean
    Definition Classes
    Message
  75. final def keepAlive(keepAlive: Boolean): Request.this.type
    Definition Classes
    Message
  76. def lastModified: Option[String]

    Get Last-Modified header

    Get Last-Modified header

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

    Set Last-Modified header by Date

    Set Last-Modified header by Date

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

    Set Last-Modified header

    Set Last-Modified header

    Definition Classes
    Message
  79. final def length: Int

    Get length of content.

    Get length of content.

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

    Get media-type from Content-Type header

    Get media-type from Content-Type header

    Definition Classes
    Message
  81. 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
  82. final def method(method: Method): Request.this.type

    Sets the HTTP method of this request to the given method.

    Sets the HTTP method of this request to the given method.

    See also

    method_=(Method) for Scala users.

  83. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  84. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. def params: ParamMap

    Returns a ParamMap instance, which contains both parameters provided as part of the request URI and parameters provided as part of the request body.

    Returns a ParamMap instance, which contains both parameters provided as part of the request URI and parameters provided as part of the request body.

    Note

    Request body parameters are considered if the following criteria are true:

    1. The request is not a TRACE request. 2. The request media type is 'application/x-www-form-urlencoded' 3. The content length is greater than 0.
    import com.twitter.finagle.http.{MediaType, Method, Request}

val request = Request(Method.Post, "/search?a=yes")
request.mediaType = MediaType.WwwForm
request.contentString = "a=no&b=yes&c=no"
request.params

// Result
// com.twitter.finagle.http.ParamMap = ?c=no&a=no&b=yes&a=yes

    To get just query parameters from the URI, use Uri.

  87. def path: String

    Path from URI.

    Path from URI.

    Annotations
    @BeanProperty()
  88. final lazy val reader: Reader[Buf]

    A read-only handle to a stream of Buf, representing the message body.

    A read-only handle to a stream of Buf, representing the message body. This stream is only * populated on chunked messages (isChunked == true). Use content to access a payload of a fully-buffered message (isChunked == false).

    Prefer this API over chunkReader when application doesn't need access to trailing headers (trailers).

    Definition Classes
    Message
    See also

    Reader

  89. def referer: Option[String]

    Get Referer [sic] header

  90. def referer_=(value: String): Unit

    Set Referer [sic] header

  91. def remoteAddress: InetAddress

    Remote InetAddress

    Remote InetAddress

    Annotations
    @BeanProperty()
  92. def remoteHost: String

    Remote host - a dotted quad

    Remote host - a dotted quad

    Annotations
    @BeanProperty()
  93. def remotePort: Int

    Remote port

    Remote port

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

    Remove a cookie

    Remove a cookie

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

    Manipulate the Message content mode.

    Manipulate the Message content mode.

    If chunked is true, any existing content will be discarded and further attempts to manipulate the synchronous content will result in an IllegalStateException.

    If chunked is false, the synchronous content methods will become available and the Reader/Writer of the message will be ignored by Finagle.

    Definition Classes
    Message
  96. final def setContentString(value: String): Unit

    Set the content as a string.

    Set the content as a string.

    Definition Classes
    Message
  97. 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
  98. 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
  99. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  100. def toString(): String
    Definition Classes
    Request → AnyRef → Any
  101. final def uri(value: String): Request.this.type

    Set the URI of this request.

    Set the URI of this request.

    See also

    uri_=(String) for Scala users.

  102. def userAgent: Option[String]

    Get User-Agent header

  103. def userAgent_=(value: String): Unit

    Set User-Agent header

  104. final def version(version: Version): Request.this.type

    Set the HTTP version

    Set the HTTP version

    * @see version_=(Version) for Scala users

    Definition Classes
    Message
  105. def version: Version

    Get the HTTP version

    Get the HTTP version

    Definition Classes
    Message
  106. def version_=(version: Version): Unit

    Set the HTTP version

    Set the HTTP version

    Definition Classes
    Message
    See also

    version(Version) for Java users

  107. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  108. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  109. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  110. 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
  111. final def withOutputStream[T](f: (OutputStream) => T): T

    Append content via an OutputStream.

    Append content via an OutputStream.

    An IllegalStateException is thrown if this message is chunked.

    Definition Classes
    Message
    Annotations
    @throws(classOf[IllegalStateException])
  112. final def withReader[T](f: (Reader) => T): T

    Use content as Reader.

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

    Definition Classes
    Message
  113. final def withWriter[T](f: (Writer) => T): T

    Append content via a Writer.

    Append content via a Writer.

    An IllegalStateException is thrown if this message is chunked.

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

    Append bytes to content.

    Append bytes to content.

    This method makes a defensive copy of the provided byte array. This can be avoided by wrapping the byte array via Buf.ByteArray.Owned and using the write(Buf) method.

    An IllegalStateException is thrown if this message is chunked.

    Definition Classes
    Message
    Annotations
    @throws(classOf[IllegalStateException])
  115. final def write(buf: Buf): Unit

    Append a Buf to content.

    Append a Buf to content.

    An IllegalStateException is thrown if this message is chunked.

    Definition Classes
    Message
    Annotations
    @throws(classOf[IllegalStateException])
  116. final def write(string: String): Unit

    Append string to content.

    Append string to content.

    An IllegalStateException is thrown if this message is chunked.

    Definition Classes
    Message
    Annotations
    @throws(classOf[IllegalStateException])
  117. final lazy val writer: Writer[Buf]

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

    A write-only handle to the stream of Buf, representing the message body. Only chunked messages (isChunked == true) use this stream as their payload, fully-buffered messages (isChunked == false) use content instead.

    Prefer this API over chunkWriter when application doesn't need to send trailing headers (trailers).

    Definition Classes
    Message
    See also

    Writer

  118. def xForwardedFor: Option[String]

    Get X-Forwarded-For header

  119. def xForwardedFor_=(value: String): Unit

    Set X-Forwarded-For header

Deprecated Value Members

  1. def getResponse(): Response

    Get response associated with request.

    Get response associated with request.

    Annotations
    @deprecated
    Deprecated

    (Since version 2016-12-29) Use the Response constructor functions

  2. lazy val response: Response

    Response associated with request.

    Response associated with request.

    Annotations
    @deprecated
    Deprecated

    (Since version 2016-12-29) Use the Response constructor functions

Inherited from Message

Inherited from AnyRef

Inherited from Any

Ungrouped