abstract class Message extends AnyRef

Rich Message

Base class for Request and Response. There are both input and output methods, though only one set of methods should be used.

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

Instance Constructors

  1. new Message()

Abstract Value Members

  1. abstract def httpMessage: HttpMessage
    Attributes
    protected[com.twitter.finagle]
  2. abstract def isRequest: Boolean

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

  9. def allow: Option[String]

    Allow header

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

    Set Authorization header

  11. def allow_=(value: String): Unit

    Set Authorization header

  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

  16. def cacheControl_=(maxAge: Duration): Unit

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

  17. def cacheControl_=(value: String): Unit

    Set Cache-Control header

  18. def charset: Option[String]

    Get charset from Content-Type header

  19. def charset_=(value: String): Unit

    Set charset in Content-Type header.

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

  20. def clearContent(): Unit

    Clear content (set to "").

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

    End the response stream.

  23. final def content(content: Buf): Message.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.

    Annotations
    @throws( ... )
    See also

    content_=(Buf) for Scala users

  24. 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.

  25. def contentLength: Option[Long]

    Get Content-Length header.

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

  26. 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.

  27. def contentString: String

    Get the content as a string.

  28. def contentString_=(value: String): Unit

    Set the content as a string.

  29. def contentType: Option[String]

    Get Content-Type header

  30. def contentType_=(value: String): Unit

    Set Content-Type header

  31. 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.

    Annotations
    @throws( ... )
    See also

    content(Buf) for Java users

  32. lazy val cookies: CookieMap

    Cookies.

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

  33. def date: Option[String]

    Get Date header

  34. def date_=(value: Date): Unit

    Set Date header by Date

  35. def date_=(value: String): Unit

    Set Date header

  36. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  38. def expires: Option[String]

    Get Expires header

  39. def expires_=(value: Date): Unit

    Set Expires header by Date

  40. def expires_=(value: String): Unit

    Set Expires header

  41. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  43. def getContentString(): String
  44. def getCookies(): Iterator[Cookie]

    Get iterator over Cookies

  45. def getInputStream(): InputStream

    Get InputStream for content.

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

  46. def getLength(): Int
  47. def getReader(): Reader

    Get Reader for content.

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

  48. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  49. lazy val headerMap: HeaderMap
  50. def host: Option[String]

    Get Host header

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

    Set Host header

  52. def isChunked: Boolean
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def isResponse: Boolean
  55. 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.)

  56. def lastModified: Option[String]

    Get Last-Modified header

  57. def lastModified_=(value: Date): Unit

    Set Last-Modified header by Date

  58. def lastModified_=(value: String): Unit

    Set Last-Modified header

  59. def length: Int

    Get length of content.

  60. def location: Option[String]

    Get Location header

  61. def location_=(value: String): Unit

    Set Location header

  62. def mediaType: Option[String]

    Get media-type from Content-Type header

  63. 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.

  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  67. 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.

  68. def referer: Option[String]

    Get Referer [sic] header

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

    Set Referer [sic] header

  70. def removeCookie(name: String): Unit

    Remove a cookie

  71. def retryAfter: Option[String]

    Get Retry-After header

  72. def retryAfter_=(value: Long): Unit

    Set Retry-After header by seconds

  73. def retryAfter_=(value: String): Unit

    Set Retry-After header

  74. def server: Option[String]

    Get Server header

  75. def server_=(value: String): Unit

    Set Server header

  76. 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.

  77. def setContentString(value: String): Unit
  78. def setContentType(mediaType: String, charset: String = "utf-8"): Unit

    Set Content-Type header by media-type and charset

  79. def setContentTypeJson(): Unit

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

  80. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  81. def toString(): String
    Definition Classes
    AnyRef → Any
  82. def userAgent: Option[String]

    Get User-Agent header

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

    Set User-Agent header

  84. def version: Version
  85. def version_=(version: Version): Unit
  86. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. 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().)

  90. 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.

    Annotations
    @throws( classOf[IllegalStateException] )
  91. def withReader[T](f: (Reader) ⇒ T): T

    Use content as Reader.

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

  92. 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.

    Annotations
    @throws( classOf[IllegalStateException] )
  93. 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.

    Annotations
    @throws( classOf[IllegalStateException] )
  94. def write(buf: Buf): Unit

    Append a Buf to content.

    Append a Buf to content.

    An IllegalStateException is thrown if this message is chunked.

    Annotations
    @throws( classOf[IllegalStateException] )
  95. def write(string: String): Unit

    Append string to content.

    Append string to content.

    An IllegalStateException is thrown if this message is chunked.

    Annotations
    @throws( classOf[IllegalStateException] )
  96. 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.

  97. def wwwAuthenticate: Option[String]

    Get WWW-Authenticate header

  98. def wwwAuthenticate_=(value: String): Unit

    Set WWW-Authenticate header

  99. def xForwardedFor: Option[String]

    Get X-Forwarded-For header

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

    Set X-Forwarded-For header

Deprecated Value Members

  1. def getContent(): ChannelBuffer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-01-23) Use content instead

  2. def headers(): HttpHeaders
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-01-24) Use headerMap instead

  3. def setContent(content: ChannelBuffer): Unit
    Attributes
    protected
    Annotations
    @deprecated @throws( ... )
    Deprecated

    (Since version 2017-01-23) Use content(Buf) instead

Inherited from AnyRef

Inherited from Any

Ungrouped