URI Parameters

The following query parameters are understood by all Dream features that operate in XML. The processing parameters can be used to convert data formats, select subsets from responses, and modify response headers.

For example, an iCalendar file could be converted to JSONP message by posting its contents to the following URI:

http://myserver/host/convert?dream.in.format=versit&dream.out.format=jsonp

Pre-Processing

Parameter	Value Type	Description
dream.in.format	{html, versit, xpost, xspan, xhtml, xml}	alternative input format for the request to be converted to an XML document (default is xml)
dream.in.host	string	override HTTP host header (allows tunneling through proxies without losing the original host information)
dream.in.root	string	root tag applied to XML document (default is "list")
dream.in.verb	string	override HTTP verb (allows use of PUT and DELETE over POST)
dream.in.uri	uri	public URI base to use for all generated URI reference

Post-Processing

Parameter	Value Type	Description
dream.out.type	string	content-type of response
dream.out.format	{json, jsonp, php, versit, xspan, xhml, xml}	output format for the request (default is xml)
dream.out.pre	string	prefix used by the output format (used by json, jsonp)
dream.out.post	string	postfix used by the output format (used by json)
dream.out.saveas	string	trigger save dialog in browser with suggested filename
dream.out.callback	string	callback usedb by output format (used by json)
dream.out.select	xpath	xpath for selecting the first subset of the response document

Dream Headers

Parameter	Value Type	Description
X-Forwarded-Host	string	override Host header (allows redirection through Apache mod_proxy)
X-HTTP-Method-Override	string	override HTTP verb (allows use of PUT and DELETE over POST)
X-Dream-Transport	string	Transport name on which the request was received on (for HttpTransport this is host:port)
X-Dream-Service	uri	Service URI that made the request; this information is only available within Dream runtime; the header is cleared when sending or receiving messages over a transport.
X-Dream-Public-Uri	uri	Public URI base to use for all generated URI reference.
X-Dream-User-Host	string	Requesting host name (i.e. most recent origin of request, could be a proxy)
X-Dream-Origin	string	Origin of request (i.e. user agent to initiated the request)