logo

abstract class

web::WebRes

sys::Obj
  web::WebRes

WebRes encapsulates a response to a web request.

See docLib::Web

Slots

cookies

abstract Cookie[] cookies()

Get the list of cookies to set via header fields. Add a a Cookie to this list to set a cookie. Throw an err if response is already committed.

Example:

res.cookies.add(Cookie { name="foo"; value="123"; maxAge=3day })
done

abstract Void done()

Done is called to indicate that that response is complete to terminate pipeline processing. Once called, no further WebSteps in the pipeline are executed.

headers

abstract Str:Str headers()

Map of HTTP response headers. You must set all headers before you access out() for the first time, which commits the response. Throw an err if response is already committed.

isCommitted

abstract Bool isCommitted()

Return true if this response has been commmited. A committed response has written its response headers, and can no longer modify its status code or headers. A response is committed the first time that out is called.

isDone

abstract Bool isDone()

Return if this response is complete - see done.

out

abstract WebOutStream out()

Return the WebOutStream for this response. The first time this method is accessed the response is committed: all headers currently set will be written to the stream, and can no longer be modified.

redirect

abstract Void redirect(Uri uri, Int statusCode := 303)

Send a redirect response to the client using the specified status code and url. If this response has already been committed this method throws an Err. This method implicitly calls done.

sendError

abstract Void sendError(Int statusCode, Str msg := null)

Send an error response to client using the specified status and HTML formatted message. If this response has already been committed this method throws an Err. If the server has a preconfigured page for this error code, it will trump the message passed in. This method implicitly calls done.

service

abstract WebService service()

Get the WebService managing the request.

statusCode

abstract Int statusCode

Get or set the HTTP status code for this response. Status code defaults to 200. Throw an err if status code passed in is not recognized, or if the response has already been committed.

statusMsg

static Int:Str statusMsg

Map of HTTP status codes to status messages.