abstract class RequestProxy extends Proxy
Proxy for Request. This can be used to create a richer request class.
- Alphabetic
- By Inheritance
- RequestProxy
- Proxy
- Request
- Message
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new RequestProxy()
Abstract Value Members
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def accept: Seq[String]
Accept header
Accept header
- Definition Classes
- Request
- def acceptMediaTypes: Seq[String]
Accept header media types (normalized, no parameters)
Accept header media types (normalized, no parameters)
- Definition Classes
- Request
- def accept_=(values: Iterable[String]): Unit
Set Accept header with list of values
Set Accept header with list of values
- Definition Classes
- Request
- def accept_=(value: String): Unit
Set Accept header
Set Accept header
- Definition Classes
- Request
- def addCookie(cookie: Cookie): Unit
Add a cookie
Add a cookie
- Definition Classes
- Message
- def allow: Option[String]
Allow header
Allow header
- Definition Classes
- Message
- def allow_=(values: Iterable[Method]): Unit
Set Allow header
Set Allow header
- Definition Classes
- Message
- def allow_=(value: String): Unit
Set Allow header
Set Allow header
- Definition Classes
- Message
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authorization: Option[String]
Get Authorization header
Get Authorization header
- Definition Classes
- Request
- def authorization_=(value: String): Unit
Set Authorization header
Set Authorization header
- Definition Classes
- Request
- def cacheControl: Option[String]
Get Cache-Control header
Get Cache-Control header
- Definition Classes
- Message
- 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
- def cacheControl_=(value: String): Unit
Set Cache-Control header
Set Cache-Control header
- Definition Classes
- Message
- def charset: Option[String]
Get charset from Content-Type header
Get charset from Content-Type header
- Definition Classes
- Message
- 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
- 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. - 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.lastfactory method. - final def clearContent(): Unit
Clear content (set to "").
Clear content (set to "").
- Definition Classes
- Message
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def close(): Future[Unit]
End the response stream.
End the response stream.
- Definition Classes
- Message
- def containsParam(name: String): Boolean
Check if parameter exists.
- final def content: Buf
Retrieve the current content of this
Message. - final def content(content: Buf): RequestProxy.this.type
Set the content of this
Message.Set the content of this
Message.Any existing content is discarded. If this
Messageis set to chunked, anIllegalStateExceptionis thrown.- Definition Classes
- Message
- Annotations
- @throws(scala.this.throws.<init>$default$1[IllegalStateException])
- See also
content_=(Buf) for Scala users
- final def contentLength(value: Long): RequestProxy.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.
- 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.
- 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.
- 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.
- def contentString: String
Get the content as a string.
Get the content as a string.
- Definition Classes
- Message
- def contentString_=(value: String): Unit
Set the content as a string.
Set the content as a string.
- Definition Classes
- Message
- def contentType: Option[String]
Get Content-Type header
Get Content-Type header
- Definition Classes
- Message
- def contentType_=(value: String): Unit
Set Content-Type header
Set Content-Type header
- Definition Classes
- Message
- final def content_=(content: Buf): Unit
Set the content of this
Message. - lazy val cookies: CookieMap
Cookies.
- 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.
- def date: Option[String]
Get Date header
Get Date header
- Definition Classes
- Message
- def date_=(value: Date): Unit
Set Date header by Date
Set Date header by Date
- Definition Classes
- Message
- def date_=(value: String): Unit
Set Date header
Set Date header
- Definition Classes
- Message
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def expires: Option[String]
Get Expires header
Get Expires header
- Definition Classes
- Message
- def expires_=(value: Date): Unit
Set Expires header by Date
Set Expires header by Date
- Definition Classes
- Message
- def expires_=(value: String): Unit
Set Expires header
Set Expires header
- Definition Classes
- Message
- def fileExtension: String
File extension.
File extension. Empty string if none.
- Definition Classes
- Request
- Annotations
- @BeanProperty()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def getBooleanParam(name: String, default: Boolean): Boolean
Get Boolean param.
- def getBooleanParam(name: String): Boolean
Get Boolean param.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getContentString(): String
- Definition Classes
- Message
- def getCookies(): Iterator[Cookie]
Get iterator over Cookies
Get iterator over Cookies
- Definition Classes
- Message
- 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
- def getIntParam(name: String, default: Int): Int
Get Int param.
- def getIntParam(name: String): Int
Get Int param.
- final def getLength(): Int
Get length of content.
Get length of content.
- Definition Classes
- Message
- def getLongParam(name: String, default: Long): Long
Get Long param.
- def getLongParam(name: String): Long
Get Long param.
- def getParam(name: String, default: String): String
Get parameter value.
- def getParam(name: String): String
Get parameter value.
- def getParamNames(): Set[String]
Get parameters names.
- def getParams(): List[Entry[String, String]]
Get all parameters.
- def getParams(name: String): List[String]
Get all values of parameter.
- final def getReader(): Reader
Get Reader for content.
Get Reader for content. (Java interface. Scala users should use withReader.)
- Definition Classes
- Message
- def getShortParam(name: String, default: Short): Short
Get Short param.
- def getShortParam(name: String): Short
Get Short param.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def headerMap: HeaderMap
HTTP headers associated with this message.
- final def host(value: String): RequestProxy.this.type
Set the Host header
Set the Host header
- Definition Classes
- Request
- See also
host_=(String) for Scala users
- def host: Option[String]
Get Host header
Get Host header
- Definition Classes
- Request
- def host_=(value: String): Unit
Set Host header
Set Host header
- Definition Classes
- Request
- See also
host(String) for Java users
- final def isChunked: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def isRequest: Boolean
- def isResponse: Boolean
- Definition Classes
- Message
- 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
- final def keepAlive: Boolean
- Definition Classes
- Message
- final def keepAlive(keepAlive: Boolean): RequestProxy.this.type
- Definition Classes
- Message
- def lastModified: Option[String]
Get Last-Modified header
Get Last-Modified header
- Definition Classes
- Message
- def lastModified_=(value: Date): Unit
Set Last-Modified header by Date
Set Last-Modified header by Date
- Definition Classes
- Message
- def lastModified_=(value: String): Unit
Set Last-Modified header
Set Last-Modified header
- Definition Classes
- Message
- final def length: Int
Get length of content.
Get length of content.
- Definition Classes
- Message
- def mediaType: Option[String]
Get media-type from Content-Type header
Get media-type from Content-Type header
- Definition Classes
- Message
- 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
- final def method: Method
Returns the HTTP method of this request.
- final def method(method: Method): RequestProxy.this.type
Sets the HTTP method of this request to the given
method.Sets the HTTP method of this request to the given
method.- Definition Classes
- Request
- See also
method_=(Method) for Scala users.
- final def method_=(method: Method): Unit
Sets the HTTP method of this request to the given
method. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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.
- Definition Classes
- Proxy → Request
- Note
Request body parameters are considered if the following criteria are true:
- 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.
- def path: String
Path from URI.
Path from URI.
- Definition Classes
- Request
- Annotations
- @BeanProperty()
- 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
- def referer: Option[String]
Get Referer [sic] header
Get Referer [sic] header
- Definition Classes
- Request
- def referer_=(value: String): Unit
Set Referer [sic] header
Set Referer [sic] header
- Definition Classes
- Request
- def remoteAddress: InetAddress
Remote InetAddress
Remote InetAddress
- Definition Classes
- Request
- Annotations
- @BeanProperty()
- def remoteHost: String
Remote host - a dotted quad
Remote host - a dotted quad
- Definition Classes
- Request
- Annotations
- @BeanProperty()
- def remotePort: Int
Remote port
Remote port
- Definition Classes
- Request
- Annotations
- @BeanProperty()
- def remoteSocketAddress: InetSocketAddress
The InetSocketAddress of the client or a place-holder ephemeral address for requests that have yet to be dispatched.
- def removeCookie(name: String): Unit
Remove a cookie
Remove a cookie
- Definition Classes
- Message
- lazy val response: Response
Response associated with request.
- final def setChunked(chunked: Boolean): Unit
Manipulate the
Messagecontent mode.Manipulate the
Messagecontent mode.If
chunkedistrue, any existing content will be discarded and further attempts to manipulate the synchronous content will result in anIllegalStateException.If
chunkedisfalse, the synchronous content methods will become available and theReader/Writerof the message will be ignored by Finagle. - final def setContentString(value: String): Unit
Set the content as a string.
Set the content as a string.
- Definition Classes
- Message
- 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
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Request → AnyRef → Any
- 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. - def uri: String
Returns the URI of this request.
- final def uri(value: String): RequestProxy.this.type
Set the URI of this request.
Set the URI of this request.
- Definition Classes
- Request
- See also
uri_=(String) for Scala users.
- final def uri_=(uri: String): Unit
Set the URI of this request to the given
uri. - def userAgent: Option[String]
Get User-Agent header
Get User-Agent header
- Definition Classes
- Request
- def userAgent_=(value: String): Unit
Set User-Agent header
Set User-Agent header
- Definition Classes
- Request
- final def version: Version
Get the HTTP version
- final def version(version: Version): RequestProxy.this.type
Set the HTTP version
Set the HTTP version
* @see version_=(Version) for Scala users
- Definition Classes
- Message
- final def version_=(version: Version): Unit
Set the HTTP version
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- 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
- final def withOutputStream[T](f: (OutputStream) => T): T
Append content via an OutputStream.
Append content via an OutputStream.
An
IllegalStateExceptionis thrown if this message is chunked.- Definition Classes
- Message
- Annotations
- @throws(classOf[IllegalStateException])
- 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
- final def withWriter[T](f: (Writer) => T): T
Append content via a Writer.
Append content via a Writer.
An
IllegalStateExceptionis thrown if this message is chunked.- Definition Classes
- Message
- Annotations
- @throws(classOf[IllegalStateException])
- 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.Ownedand using thewrite(Buf)method.An
IllegalStateExceptionis thrown if this message is chunked.- Definition Classes
- Message
- Annotations
- @throws(classOf[IllegalStateException])
- final def write(buf: Buf): Unit
Append a Buf to content.
Append a Buf to content.
An
IllegalStateExceptionis thrown if this message is chunked.- Definition Classes
- Message
- Annotations
- @throws(classOf[IllegalStateException])
- final def write(string: String): Unit
Append string to content.
Append string to content.
An
IllegalStateExceptionis thrown if this message is chunked.- Definition Classes
- Message
- Annotations
- @throws(classOf[IllegalStateException])
- 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
- def xForwardedFor: Option[String]
Get X-Forwarded-For header
Get X-Forwarded-For header
- Definition Classes
- Request
- def xForwardedFor_=(value: String): Unit
Set X-Forwarded-For header
Set X-Forwarded-For header
- Definition Classes
- Request