Request

Instance Constructors

new Request(serverPort: Int, serverName: String, remoteAddr: String, uri: String, queryString: Option[String] = None, scheme: Scheme = Scheme.Http, requestMethod: HttpMethod = HttpMethod.Get, protocol: String = "HTTP/1.1", sslClientCert: Option[X509Certificate] = None, headers: Map[String, String] = Map.empty, body: Option[InputStream] = None, attrs: Map[String, AnyRef] = Map.empty)

serverPort
The port on which the request is being handled.
serverName
The resolved server name, or the server IP address.
remoteAddr
The IP address of the client or the last proxy that sent the request.
uri
The request URI, excluding the query string and the "?" separator. Must start with "/".
queryString
The query string, if present.
scheme
The transport protocol.
requestMethod
The transport protocol.
protocol
The protocol the request was made with, e.g. "HTTP/1.1"
sslClientCert
The SSL client certificate, if supplied.
headers
A map of lowercased header names to corresponding values.
body
The request body, if present.
attrs
Other info tacked on to the request.

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

Helper to add a header to this Request.
Helper to add a header to this Request. Returns a new Request containing a header with name/value. NB: the header name is converted to lowercase before being stored.
name
Name of the header to add, e.g. "Content-type".
value
Value of the header, e.g. "text/html"
final def asInstanceOf[T0]: T0

Definition Classes
Any
val attrs: Map[String, AnyRef]

Other info tacked on to the request.
val body: Option[InputStream]

The request body, if present.
def bodyString(encoding: Charset = StandardCharsets.UTF_8): Option[String]

Helper to convert body into a String.
Helper to convert body into a String. Beware using it on huge bodies.
def characterEncoding: Option[Charset]

Get the Charset of the request, if any.
Get the Charset of the request, if any. Looks in the Content-Type header. Requests may actually have a Content-Type header for POSTs and PUTs.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contentLength: Option[Long]

Helper to get content length since it is so commonly used.
def contentType: Option[String]

Helper to get content type since it is so commonly used.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def getHeader(name: String): Option[String]

Helper to get a header from the request.
val headers: Map[String, String]

A map of lowercased header names to corresponding values.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val protocol: String

The protocol the request was made with, e.g.
The protocol the request was made with, e.g. "HTTP/1.1"
val queryString: Option[String]

The query string, if present.
val remoteAddr: String

The IP address of the client or the last proxy that sent the request.
val requestMethod: HttpMethod

The transport protocol.
val scheme: Scheme

The transport protocol.
val serverName: String

The resolved server name, or the server IP address.
val serverPort: Int

The port on which the request is being handled.
def setContentLength(value: Long): Request

Helper to set content length since it is so commonly used.
Helper to set content length since it is so commonly used. Returns new Request.
def setContentType(value: String): Request

Helper to set content type since it is so commonly used.
Helper to set content type since it is so commonly used. Returns new Request.
val sslClientCert: Option[X509Certificate]

The SSL client certificate, if supplied.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def updated(key: String, value: AnyRef): Request

Helper for easily adding things to the attrs map.
Helper for easily adding things to the attrs map.
key
Name of the thing to add
value
The thing to add
returns
A new HttpRequest with key/value added to attrs.
val uri: String

The request URI, excluding the query string and the "?" separator.
The request URI, excluding the query string and the "?" separator. Must start with "/".
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Request | package circlet

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addHeader(name: String, value: String): Request

final def asInstanceOf[T0]: T0

val attrs: Map[String, AnyRef]

val body: Option[InputStream]

def bodyString(encoding: Charset = StandardCharsets.UTF_8): Option[String]

def characterEncoding: Option[Charset]

def clone(): AnyRef

def contentLength: Option[Long]

def contentType: Option[String]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getHeader(name: String): Option[String]

val headers: Map[String, String]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val protocol: String

val queryString: Option[String]

val remoteAddr: String

val requestMethod: HttpMethod

val scheme: Scheme

val serverName: String

val serverPort: Int

def setContentLength(value: Long): Request

def setContentType(value: String): Request

val sslClientCert: Option[X509Certificate]

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

def updated(key: String, value: AnyRef): Request

val uri: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped