Class/Object

com.twitter.finagle.http

Response

Related Docs: object Response | package http

Permalink

abstract class Response extends Message with HttpResponseProxy

Rich HttpResponse

Linear Supertypes
HttpResponseProxy, HttpMessageProxy, Proxy, HttpResponse, Message, HttpMessage, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Response
  2. HttpResponseProxy
  3. HttpMessageProxy
  4. Proxy
  5. HttpResponse
  6. Message
  7. HttpMessage
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Response()

    Permalink

Abstract Value Members

  1. abstract def httpResponse: HttpResponse

    Permalink
    Definition Classes
    HttpResponseProxy

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def accept: Seq[String]

    Permalink

    Accept header

    Accept header

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

    Permalink

    Accept header media types (normalized, no parameters)

    Accept header media types (normalized, no parameters)

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

    Permalink

    Set Accept header with list of values

    Set Accept header with list of values

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

    Permalink

    Set Accept header

    Set Accept header

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

    Permalink

    Add a cookie

    Add a cookie

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

    Permalink

    Allow header

    Allow header

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

    Permalink

    Set Authorization header

    Set Authorization header

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

    Permalink

    Set Authorization header

    Set Authorization header

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

    Permalink
    Definition Classes
    Any
  13. def authorization: Option[String]

    Permalink

    Get Authorization header

    Get Authorization header

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

    Permalink

    Set Authorization header

    Set Authorization header

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

    Permalink

    Get Cache-Control header

    Get Cache-Control header

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

    Permalink

    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

    Permalink

    Set Cache-Control header

    Set Cache-Control header

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

    Permalink

    Get charset from Content-Type header

    Get charset from Content-Type header

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

    Permalink

    Set charset in Content-Type header.

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

    Definition Classes
    Message
  20. def clearContent(): Unit

    Permalink

    Clear content (set to "").

    Clear content (set to "").

    Definition Classes
    Message
  21. def clone(): AnyRef

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

    Permalink

    End the response stream.

    End the response stream.

    Definition Classes
    Message
  23. def content: ChannelBuffer

    Permalink
    Definition Classes
    Message
  24. def contentLength: Option[Long]

    Permalink

    Get Content-Length header.

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

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

    Permalink

    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
  26. def contentString: String

    Permalink

    Get the content as a string.

    Get the content as a string.

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

    Permalink

    Set the content as a string.

    Set the content as a string.

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

    Permalink

    Get Content-Type header

    Get Content-Type header

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

    Permalink

    Set Content-Type header

    Set Content-Type header

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

    Permalink
    Definition Classes
    Message
  31. lazy val cookies: CookieMap

    Permalink

    Cookies.

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

    Definition Classes
    Message
  32. val ctx: Record

    Permalink

    Arbitrary user-defined context associated with this response object.

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

  33. def date: Option[String]

    Permalink

    Get Date header

    Get Date header

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

    Permalink

    Set Date header by Date

    Set Date header by Date

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

    Permalink

    Set Date header

    Set Date header

    Definition Classes
    Message
  36. def encodeString(): String

    Permalink

    Encode as an HTTP message

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

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

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

    Permalink

    Get Expires header

    Get Expires header

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

    Permalink

    Set Expires header by Date

    Set Expires header by Date

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

    Permalink

    Set Expires header

    Set Expires header

    Definition Classes
    Message
  42. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. final def getClass(): Class[_]

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

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

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

    Permalink

    Get iterator over Cookies

    Get iterator over Cookies

    Definition Classes
    Message
  47. def getHttpMessage(): HttpMessage

    Permalink
    Definition Classes
    HttpMessageProxy
  48. def getHttpResponse(): HttpResponse

    Permalink
    Definition Classes
    HttpResponseProxy
  49. def getInputStream(): InputStream

    Permalink

    Get InputStream for content.

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

    Definition Classes
    Message
  50. def getLength(): Int

    Permalink
    Definition Classes
    Message
  51. def getProtocolVersion(): HttpVersion

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

    Permalink

    Get Reader for content.

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

    Definition Classes
    Message
  53. def getStatus(): HttpResponseStatus

    Permalink
    Definition Classes
    HttpResponseProxy → HttpResponse
  54. def getStatusCode(): Int

    Permalink
  55. def hashCode(): Int

    Permalink
    Definition Classes
    Proxy → Any
  56. lazy val headerMap: HeaderMap

    Permalink
    Definition Classes
    Message
  57. def headers(): HttpHeaders

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

    Permalink

    Get Host header

    Get Host header

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

    Permalink

    Set Host header

    Set Host header

    Definition Classes
    Message
  60. def httpMessage: HttpMessage

    Permalink
    Definition Classes
    HttpResponseProxyHttpMessageProxy
  61. def isChunked(): Boolean

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

    Permalink
    Definition Classes
    Any
  63. def isRequest: Boolean

    Permalink
    Definition Classes
    ResponseMessage
  64. def isResponse: Boolean

    Permalink
    Definition Classes
    Message
  65. def isXmlHttpRequest: Boolean

    Permalink

    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
  66. def lastModified: Option[String]

    Permalink

    Get Last-Modified header

    Get Last-Modified header

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

    Permalink

    Set Last-Modified header by Date

    Set Last-Modified header by Date

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

    Permalink

    Set Last-Modified header

    Set Last-Modified header

    Definition Classes
    Message
  69. def length: Int

    Permalink

    Get length of content.

    Get length of content.

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

    Permalink

    Get Location header

    Get Location header

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

    Permalink

    Set Location header

    Set Location header

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

    Permalink

    Get media-type from Content-Type header

    Get media-type from Content-Type header

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

    Permalink

    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
  74. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  75. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  76. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  77. def reader: Reader

    Permalink

    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
  78. def referer: Option[String]

    Permalink

    Get Referer [sic] header

    Get Referer [sic] header

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

    Permalink

    Set Referer [sic] header

    Set Referer [sic] header

    Definition Classes
    Message
  80. def removeCookie(name: String): Unit

    Permalink

    Remove a cookie

    Remove a cookie

    Definition Classes
    Message
  81. def retryAfter: Option[String]

    Permalink

    Get Retry-After header

    Get Retry-After header

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

    Permalink

    Set Retry-After header by seconds

    Set Retry-After header by seconds

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

    Permalink

    Set Retry-After header

    Set Retry-After header

    Definition Classes
    Message
  84. def self: HttpMessage

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

    Permalink

    Get Server header

    Get Server header

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

    Permalink

    Set Server header

    Set Server header

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

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

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

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

    Permalink

    Set Content-Type header by media-type and charset

    Set Content-Type header by media-type and charset

    Definition Classes
    Message
  91. def setContentTypeJson(): Unit

    Permalink

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

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

    Definition Classes
    Message
  92. def setProtocolVersion(version: HttpVersion): Unit

    Permalink
    Definition Classes
    HttpMessageProxy → HttpMessage
  93. def setStatus(status: HttpResponseStatus): Unit

    Permalink
    Definition Classes
    HttpResponseProxy → HttpResponse
  94. def setStatusCode(value: Int): Unit

    Permalink
  95. def status: HttpResponseStatus

    Permalink
  96. def statusCode: Int

    Permalink
  97. def statusCode_=(value: Int): Unit

    Permalink
  98. def status_=(value: HttpResponseStatus): Unit

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

    Permalink
    Definition Classes
    AnyRef
  100. def toString(): String

    Permalink
    Definition Classes
    Response → Proxy → AnyRef → Any
  101. def userAgent: Option[String]

    Permalink

    Get User-Agent header

    Get User-Agent header

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

    Permalink

    Set User-Agent header

    Set User-Agent header

    Definition Classes
    Message
  103. def version: HttpVersion

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

    Permalink
    Definition Classes
    Message
  105. final def wait(): Unit

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

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

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

    Permalink

    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
  109. def withOutputStream[T](f: (OutputStream) ⇒ T): T

    Permalink

    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
  110. def withReader[T](f: (Reader) ⇒ T): T

    Permalink

    Use content as Reader.

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

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

    Permalink

    Use as a Writer.

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

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

    Permalink

    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] )
  113. def write(bytes: Array[Byte]): Unit

    Permalink

    Append bytes to content.

    Append bytes to content.

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

    Permalink

    Append string to content.

    Append string to content.

    Definition Classes
    Message
  115. def writer: Writer with Closable

    Permalink

    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
  116. def wwwAuthenticate: Option[String]

    Permalink

    Get WWW-Authenticate header

    Get WWW-Authenticate header

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

    Permalink

    Set WWW-Authenticate header

    Set WWW-Authenticate header

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

    Permalink

    Get X-Forwarded-For header

    Get X-Forwarded-For header

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

    Permalink

    Set X-Forwarded-For header

    Set X-Forwarded-For header

    Definition Classes
    Message

Inherited from HttpResponseProxy

Inherited from HttpMessageProxy

Inherited from Proxy

Inherited from HttpResponse

Inherited from Message

Inherited from HttpMessage

Inherited from AnyRef

Inherited from Any

Ungrouped