Class/Object

io.backchat.hookup.http

Request

Related Docs: object Request | package http

Permalink

abstract class Request extends Message with HttpRequestProxy

Rich HttpRequest.

Use RequestProxy to created an even richer subclass.

Linear Supertypes
HttpRequestProxy, HttpMessageProxy, HttpRequest, Message, HttpMessage, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Request
  2. HttpRequestProxy
  3. HttpMessageProxy
  4. HttpRequest
  5. Message
  6. HttpMessage
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Request()

    Permalink

Abstract Value Members

  1. abstract def headers(): HttpHeaders

    Permalink
    Definition Classes
    HttpMessage
  2. abstract def httpRequest: HttpRequest

    Permalink
    Definition Classes
    HttpRequestProxy
  3. abstract def remoteSocketAddress: InetSocketAddress

    Permalink

    Remote InetSocketAddress

    Remote InetSocketAddress

    Annotations
    @BeanProperty()

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 addHeader(name: String, value: AnyRef): Unit

    Permalink
    Definition Classes
    HttpMessageProxy
  10. def allow: Option[String]

    Permalink

    Allow header

    Allow header

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

    Permalink

    Set Authorization header

    Set Authorization header

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

    Permalink

    Set Authorization header

    Set Authorization header

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

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

    Permalink

    Get Authorization header

    Get Authorization header

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

    Permalink

    Set Authorization header

    Set Authorization header

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

    Permalink

    Get Cache-Control header

    Get Cache-Control header

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

    Permalink

    Set Cache-Control header

    Set Cache-Control header

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

    Permalink

    Get charset from Content-Type header

    Get charset from Content-Type header

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

    Permalink

    Clear content (set to "").

    Clear content (set to "").

    Definition Classes
    Message
  22. def clearHeaders(): Unit

    Permalink
    Definition Classes
    HttpMessageProxy
  23. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. def containsHeader(name: String): Boolean

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

    Permalink

    Check if parameter exists.

  26. def content: ChannelBuffer

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

    Permalink

    Get the content as a string.

    Get the content as a string.

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

    Permalink

    Set the content as a string.

    Set the content as a string.

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

    Permalink

    Get Content-Type header

    Get Content-Type header

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

    Permalink

    Set Content-Type header

    Set Content-Type header

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

    Permalink
    Definition Classes
    Message
  34. lazy val cookies: CookieSet

    Permalink

    Cookies.

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

    Definition Classes
    Message
  35. def date: Option[String]

    Permalink

    Get Date header

    Get Date header

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

    Permalink

    Set Date header by Date

    Set Date header by Date

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

    Permalink

    Set Date header

    Set Date header

    Definition Classes
    Message
  38. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  39. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  40. def expires: Option[String]

    Permalink

    Get Expires header

    Get Expires header

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

    Permalink

    Set Expires header by Date

    Set Expires header by Date

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

    Permalink

    Set Expires header

    Set Expires header

    Definition Classes
    Message
  43. def fileExtension: String

    Permalink

    File extension.

    File extension. Empty string if none.

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

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

    Permalink

    Get Boolean param.

    Get Boolean param. Returns value or default.

  46. def getBooleanParam(name: String): Boolean

    Permalink

    Get Boolean param.

    Get Boolean param. Returns value or false.

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

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

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

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

    Permalink

    Get iterator over Cookies

    Get iterator over Cookies

    Definition Classes
    Message
  51. def getHeader(name: String): String

    Permalink
    Definition Classes
    HttpMessageProxy
  52. def getHeaderNames(): Set[String]

    Permalink
    Definition Classes
    HttpMessageProxy
  53. def getHeaders(): List[Entry[String, String]]

    Permalink
    Definition Classes
    HttpMessageProxy
  54. def getHeaders(name: String): List[String]

    Permalink
    Definition Classes
    HttpMessageProxy
  55. def getHttpMessage(): HttpMessage

    Permalink
    Definition Classes
    HttpMessageProxy
  56. def getHttpRequest(): HttpRequest

    Permalink
    Definition Classes
    HttpRequestProxy
  57. 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
  58. def getIntParam(name: String, default: Int): Int

    Permalink

    Get Int param.

    Get Int param. Returns value or default.

  59. def getIntParam(name: String): Int

    Permalink

    Get Int param.

    Get Int param. Returns value or 0.

  60. def getLength(): Int

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

    Permalink

    Get Long param.

    Get Long param. Returns value or default.

  62. def getLongParam(name: String): Long

    Permalink

    Get Long param.

    Get Long param. Returns value or 0.

  63. def getMethod(): HttpMethod

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

    Permalink

    Get parameter value.

    Get parameter value. Returns value or default.

  65. def getParam(name: String): String

    Permalink

    Get parameter value.

    Get parameter value. Returns value or null.

  66. def getParamNames(): Set[String]

    Permalink

    Get parameters names.

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

    Permalink

    Get all parameters.

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

    Permalink

    Get all values of parameter.

    Get all values of parameter. Returns list of values.

  69. def getProtocolVersion(): HttpVersion

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

    Permalink

    Get Reader for content.

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

    Definition Classes
    Message
  71. def getResponse(): Response

    Permalink

    Get response associated with request.

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

    Permalink

    Get Short param.

    Get Short param. Returns value or default.

  73. def getShortParam(name: String): Short

    Permalink

    Get Short param.

    Get Short param. Returns value or 0.

  74. def getUri(): String

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

    Permalink
    Definition Classes
    AnyRef → Any
  76. def host: Option[String]

    Permalink

    Get Host header

    Get Host header

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

    Permalink

    Set Host header

    Set Host header

    Definition Classes
    Message
  78. def httpMessage: HttpMessage

    Permalink
    Definition Classes
    HttpRequestProxyHttpMessageProxy
  79. def isChunked(): Boolean

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

    Permalink
    Definition Classes
    Any
  81. def isRequest: Boolean

    Permalink
    Definition Classes
    RequestMessage
  82. def isResponse: Boolean

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

    Permalink

    Get Last-Modified header

    Get Last-Modified header

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

    Permalink

    Set Last-Modified header by Date

    Set Last-Modified header by Date

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

    Permalink

    Set Last-Modified header

    Set Last-Modified header

    Definition Classes
    Message
  87. def length: Int

    Permalink

    Get length of content.

    Get length of content.

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

    Permalink

    Get Location header

    Get Location header

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

    Permalink

    Set Location header

    Set Location header

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

    Permalink

    Get media-type from Content-Type header

    Get media-type from Content-Type header

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

    Permalink
  93. def method_=(method: HttpMethod): Unit

    Permalink
  94. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  97. lazy val params: ParamMap

    Permalink
  98. def path: String

    Permalink

    Path from URI.

    Path from URI.

    Annotations
    @BeanProperty()
  99. def referer: Option[String]

    Permalink

    Get Referer [sic] header

    Get Referer [sic] header

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

    Permalink

    Set Referer [sic] header

    Set Referer [sic] header

    Definition Classes
    Message
  101. def remoteAddress: InetAddress

    Permalink

    Remote InetAddress

    Remote InetAddress

    Annotations
    @BeanProperty()
  102. def remoteHost: String

    Permalink

    Remote host - a dotted quad

    Remote host - a dotted quad

    Annotations
    @BeanProperty()
  103. def remotePort: Int

    Permalink

    Remote port

    Remote port

    Annotations
    @BeanProperty()
  104. def removeCookie(cookie: Cookie): Unit

    Permalink

    Remove a cookie

    Remove a cookie

    Definition Classes
    Message
  105. def removeHeader(name: String): Unit

    Permalink
    Definition Classes
    HttpMessageProxy
  106. lazy val response: Response

    Permalink

    Response associated with request

  107. def retryAfter: Option[String]

    Permalink

    Get Retry-After header

    Get Retry-After header

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

    Permalink

    Set Retry-After header by seconds

    Set Retry-After header by seconds

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

    Permalink

    Set Retry-After header

    Set Retry-After header

    Definition Classes
    Message
  110. def server: Option[String]

    Permalink

    Get Server header

    Get Server header

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

    Permalink

    Set Server header

    Set Server header

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

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

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

    Permalink
    Definition Classes
    Message
  115. 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
  116. 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
  117. def setHeader(name: String, values: Iterable[_]): Unit

    Permalink
    Definition Classes
    HttpMessageProxy
  118. def setHeader(name: String, value: AnyRef): Unit

    Permalink
    Definition Classes
    HttpMessageProxy
  119. def setMethod(method: HttpMethod): Unit

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

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

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

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

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

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

    Permalink
  126. def userAgent: Option[String]

    Permalink

    Get User-Agent header

    Get User-Agent header

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

    Permalink

    Set User-Agent header

    Set User-Agent header

    Definition Classes
    Message
  128. def version: HttpVersion

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. 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
  134. 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
  135. 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
  136. 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
  137. def write(buffer: ChannelBuffer): Unit

    Permalink

    Append ChannelBuffer to content.

    Append ChannelBuffer to content.

    Definition Classes
    Message
  138. def write(bytes: Array[Byte]): Unit

    Permalink

    Append bytes to content.

    Append bytes to content.

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

    Permalink

    Append string to content.

    Append string to content.

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

    Permalink

    Get WWW-Authenticate header

    Get WWW-Authenticate header

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

    Permalink

    Set WWW-Authenticate header

    Set WWW-Authenticate header

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

    Permalink

    Get X-Forwarded-For header

    Get X-Forwarded-For header

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

    Permalink

    Set X-Forwarded-For header

    Set X-Forwarded-For header

    Definition Classes
    Message

Inherited from HttpRequestProxy

Inherited from HttpMessageProxy

Inherited from HttpRequest

Inherited from Message

Inherited from HttpMessage

Inherited from AnyRef

Inherited from Any

Ungrouped