ReqRespData

Represents the request being sent by the client as well as the response built by the resource

A Note about Headers: framework implementations ensure that only headers that Scalamachine knows about (defined via scalamachine.core.HTTPHeaders.createHeader) are present in header collections. Additionally, header collections do not currenlty support the same header appearing more than once in a request although allowed by the HTTP spec Support for this will be added shortly.

Still missing from the original implementation:

HTTP Version
Peer (Client) IP
Cookies
"App Root" - see webmachine documentation (http://wiki.basho.com/Webmachine-Request.html)

baseUri: The base of the requested URI. Includes the scheme and host without the trailing slash (e.g. http://example.com)
pathParts: List of string tokens, the request URI path split by "/"
rawPath: The entire path part of the URI, including any query string present.
query: parsed query string. duplicate keys will have multiple elements in the values list otherwise the values list will only have one element
method: The request's scalamachine.core.HTTPMethod
statusCode: integer response status code
requestHeaders: Request headers
responseHeaders: Response headers
requestBody: The body of the request. See scalamachine.core.HTTPBody for more
responseBody: The body of the response to be set by this resource. See scalamachine.core.HTTPBody for more
doRedirect: If true some responses will return 303 instead of 2xx

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new ReqRespData(baseUri: String = "", pathParts: List[String] = immutable.this.Nil, rawPath: String = "", query: Map[String, List[String]] = ..., hostParts: List[String] = immutable.this.Nil, method: HTTPMethod = HTTPMethods.GET, statusCode: Int = 200, requestHeaders: Map[HTTPHeader, String] = ..., responseHeaders: Map[HTTPHeader, String] = ..., requestBody: HTTPBody = HTTPBody.Empty, responseBody: HTTPBody = HTTPBody.Empty, doRedirect: Boolean = false, pathData: PathData = ..., hostData: HostData = ..., metadata: Metadata = ...)

baseUri
The base of the requested URI. Includes the scheme and host without the trailing slash (e.g. http://example.com)
pathParts
List of string tokens, the request URI path split by "/"
rawPath
The entire path part of the URI, including any query string present.
query
parsed query string. duplicate keys will have multiple elements in the values list otherwise the values list will only have one element
method
The request's scalamachine.core.HTTPMethod
statusCode
integer response status code
requestHeaders
Request headers
responseHeaders
Response headers
requestBody
The body of the request. See scalamachine.core.HTTPBody for more
responseBody
The body of the response to be set by this resource. See scalamachine.core.HTTPBody for more
doRedirect
If true some responses will return 303 instead of 2xx

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val baseUri: String

The base of the requested URI.
The base of the requested URI. Includes the scheme and host without the trailing slash (e.g. http://example.com)
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
val dispPath: String
val dispSubdomain: String
val doRedirect: Boolean

If true some responses will return 303 instead of 2xx
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val host: String
val hostInfo: Map[Symbol, String]
val hostParts: List[String]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mergeResponseHeaders(newHeaders: Map[HTTPHeader, String]): ReqRespData
val method: HTTPMethod

The request's scalamachine.core.HTTPMethod
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: String
val pathInfo: Map[Symbol, String]
val pathParts: List[String]

List of string tokens, the request URI path split by "/"
val pathTokens: Seq[String]
val query: Map[String, List[String]]

parsed query string.
parsed query string. duplicate keys will have multiple elements in the values list otherwise the values list will only have one element
val rawPath: String

The entire path part of the URI, including any query string present.
val requestBody: HTTPBody

The body of the request.
The body of the request. See scalamachine.core.HTTPBody for more
def requestHeader(header: HTTPHeader): Option[String]
val requestHeaders: Map[HTTPHeader, String]

Request headers
val responseBody: HTTPBody

The body of the response to be set by this resource.
The body of the response to be set by this resource. See scalamachine.core.HTTPBody for more
def responseHeader(header: HTTPHeader): Option[String]
val responseHeaders: Map[HTTPHeader, String]

Response headers
def setResponseHeader(header: HTTPHeader, value: String): ReqRespData
def setStatusCode(code: Int): ReqRespData
val statusCode: Int

integer response status code
val subdomainTokens: Seq[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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()

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val baseUri: String

def clone(): AnyRef

val dispPath: String

val dispSubdomain: String

val doRedirect: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val host: String

val hostInfo: Map[Symbol, String]

val hostParts: List[String]

final def isInstanceOf[T0]: Boolean

def mergeResponseHeaders(newHeaders: Map[HTTPHeader, String]): ReqRespData

val method: HTTPMethod

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: String

val pathInfo: Map[Symbol, String]

val pathParts: List[String]

val pathTokens: Seq[String]

val query: Map[String, List[String]]

val rawPath: String

val requestBody: HTTPBody

def requestHeader(header: HTTPHeader): Option[String]

val requestHeaders: Map[HTTPHeader, String]

val responseBody: HTTPBody

def responseHeader(header: HTTPHeader): Option[String]

val responseHeaders: Map[HTTPHeader, String]

def setResponseHeader(header: HTTPHeader, value: String): ReqRespData

def setStatusCode(code: Int): ReqRespData

val statusCode: Int

val subdomainTokens: Seq[String]

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

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