com.twitter.finagle.http

Message

Related Docs: object Message | package http

abstract class Message extends HttpMessage

Rich HttpMessage

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

Linear Supertypes
HttpMessage, AnyRef, Any
Known Subclasses
MockRequest, MockResponse, Request, RequestProxy, Response, RichHttp
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Message
  2. HttpMessage
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Message()

Abstract Value Members

  1. abstract def getContent(): ChannelBuffer

    Definition Classes
    HttpMessage

  2. abstract def getProtocolVersion(): HttpVersion

    Definition Classes
    HttpMessage

  3. abstract def headers(): HttpHeaders

    Definition Classes
    HttpMessage

  4. abstract def isChunked(): Boolean

    Definition Classes
    HttpMessage

  5. abstract def isRequest: Boolean

  6. abstract def setChunked(arg0: Boolean): Unit

    Definition Classes
    HttpMessage

  7. abstract def setContent(arg0: ChannelBuffer): Unit

    Definition Classes
    HttpMessage

  8. abstract def setProtocolVersion(arg0: HttpVersion): Unit

    Definition Classes
    HttpMessage

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[HttpMethod]): 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. def content: ChannelBuffer

  24. def contentLength: Option[Long]

    Get Content-Length header.

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

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

  26. def contentString: String

    Get the content as a string.

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

    Set the content as a string.

  28. def contentType: Option[String]

    Get Content-Type header

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

    Set Content-Type header

  30. def content_=(content: ChannelBuffer): Unit

  31. lazy val cookies: CookieMap

    Cookies.

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

  32. def date: Option[String]

    Get Date header

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

    Set Date header by Date

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

    Set Date header

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

    Definition Classes
    AnyRef

  36. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  37. def expires: Option[String]

    Get Expires header

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

    Set Expires header by Date

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

    Set Expires header

  40. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Definition Classes
    AnyRef → Any

  42. def getContentString(): String

  43. def getCookies(): Iterator[Cookie]

    Get iterator over Cookies

  44. def getInputStream(): InputStream

    Get InputStream for content.

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

  45. def getLength(): Int

  46. def getReader(): Reader

    Get Reader for content.

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

  47. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  48. lazy val headerMap: HeaderMap

  49. def host: Option[String]

    Get Host header

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

    Set Host header

  51. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  52. def isResponse: Boolean

  53. 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.)

  54. def lastModified: Option[String]

    Get Last-Modified header

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

    Set Last-Modified header by Date

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

    Set Last-Modified header

  57. def length: Int

    Get length of content.

  58. def location: Option[String]

    Get Location header

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

    Set Location header

  60. def mediaType: Option[String]

    Get media-type from Content-Type header

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

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

    Definition Classes
    AnyRef

  63. final def notify(): Unit

    Definition Classes
    AnyRef

  64. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

  66. def referer: Option[String]

    Get Referer [sic] header

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

    Set Referer [sic] header

  68. def removeCookie(name: String): Unit

    Remove a cookie

  69. def retryAfter: Option[String]

    Get Retry-After header

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

    Set Retry-After header by seconds

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

    Set Retry-After header

  72. def server: Option[String]

    Get Server header

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

    Set Server header

  74. def setContentString(value: String): Unit

  75. def setContentType(mediaType: String, charset: String = "utf-8"): Unit

    Set Content-Type header by media-type and charset

  76. def setContentTypeJson(): Unit

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

  77. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  78. def toString(): String

    Definition Classes
    AnyRef → Any

  79. def userAgent: Option[String]

    Get User-Agent header

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

    Set User-Agent header

  81. def version: HttpVersion

  82. def version_=(version: HttpVersion): Unit

  83. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  84. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  85. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  86. 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().)

  87. 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.)

  88. def withReader[T](f: (Reader) ⇒ T): T

    Use content as Reader.

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

  89. def withWriter[T](f: (Writer) ⇒ T): T

    Use as a Writer.

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

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

    Annotations
    @throws( classOf[BufReader.ReaderDiscarded] ) @throws( classOf[IllegalStateException] )

  91. def write(bytes: Array[Byte]): Unit

    Append bytes to content.

  92. def write(string: String): Unit

    Append string to content.

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

  94. def wwwAuthenticate: Option[String]

    Get WWW-Authenticate header

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

    Set WWW-Authenticate header

  96. def xForwardedFor: Option[String]

    Get X-Forwarded-For header

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

    Set X-Forwarded-For header

Inherited from HttpMessage

Inherited from AnyRef

Inherited from Any

Ungrouped