You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/09/02 17:21:37 UTC
[05/19] incubator-juneau-website git commit: Update javadocs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4cba2c2c/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html
index 8de320a..71cf60d 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html
@@ -31,786 +31,784 @@
<span class="sourceLineNo">023</span>import org.apache.juneau.encoders.*;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.juneau.html.*;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.juneau.http.*;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import org.apache.juneau.jena.*;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import org.apache.juneau.json.*;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.apache.juneau.parser.*;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import org.apache.juneau.rest.annotation.*;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.juneau.serializer.*;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.juneau.urlencoding.*;<a name="line.31"></a>
-<span class="sourceLineNo">032</span>import org.apache.juneau.utils.*;<a name="line.32"></a>
-<span class="sourceLineNo">033</span>import org.apache.juneau.xml.*;<a name="line.33"></a>
-<span class="sourceLineNo">034</span><a name="line.34"></a>
-<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
-<span class="sourceLineNo">036</span> * Represents an HTTP response for a REST resource.<a name="line.36"></a>
-<span class="sourceLineNo">037</span> *<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * <p><a name="line.38"></a>
-<span class="sourceLineNo">039</span> * Essentially an extended {@link HttpServletResponse} with some special convenience methods that allow you to easily<a name="line.39"></a>
-<span class="sourceLineNo">040</span> * output POJOs as responses.<a name="line.40"></a>
-<span class="sourceLineNo">041</span> *<a name="line.41"></a>
-<span class="sourceLineNo">042</span> * <p><a name="line.42"></a>
-<span class="sourceLineNo">043</span> * Since this class extends {@link HttpServletResponse}, developers are free to use these convenience methods, or<a name="line.43"></a>
-<span class="sourceLineNo">044</span> * revert to using lower level methods like any other servlet response.<a name="line.44"></a>
-<span class="sourceLineNo">045</span> *<a name="line.45"></a>
-<span class="sourceLineNo">046</span> * <h5 class='section'>Example:</h5><a name="line.46"></a>
-<span class="sourceLineNo">047</span> * <p class='bcode'><a name="line.47"></a>
-<span class="sourceLineNo">048</span> * <ja>@RestMethod</ja>(name=<js>"GET"</js>)<a name="line.48"></a>
-<span class="sourceLineNo">049</span> * <jk>public void</jk> doGet(RestRequest req, RestResponse res) {<a name="line.49"></a>
-<span class="sourceLineNo">050</span> * res.setPageTitle(<js>"My title"</js>)<a name="line.50"></a>
-<span class="sourceLineNo">051</span> * .setOutput(<js>"Simple string response"</js>);<a name="line.51"></a>
-<span class="sourceLineNo">052</span> * }<a name="line.52"></a>
-<span class="sourceLineNo">053</span> * </p><a name="line.53"></a>
-<span class="sourceLineNo">054</span> *<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * <p><a name="line.55"></a>
-<span class="sourceLineNo">056</span> * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * class.<a name="line.57"></a>
-<span class="sourceLineNo">058</span> */<a name="line.58"></a>
-<span class="sourceLineNo">059</span>public final class RestResponse extends HttpServletResponseWrapper {<a name="line.59"></a>
-<span class="sourceLineNo">060</span><a name="line.60"></a>
-<span class="sourceLineNo">061</span> private final RestRequest request;<a name="line.61"></a>
-<span class="sourceLineNo">062</span> private Object output; // The POJO being sent to the output.<a name="line.62"></a>
-<span class="sourceLineNo">063</span> private boolean isNullOutput; // The output is null (as opposed to not being set at all)<a name="line.63"></a>
-<span class="sourceLineNo">064</span> private ObjectMap properties; // Response properties<a name="line.64"></a>
-<span class="sourceLineNo">065</span> SerializerGroup serializerGroup;<a name="line.65"></a>
-<span class="sourceLineNo">066</span> UrlEncodingSerializer urlEncodingSerializer; // The serializer used to convert arguments passed into Redirect objects.<a name="line.66"></a>
-<span class="sourceLineNo">067</span> private EncoderGroup encoders;<a name="line.67"></a>
-<span class="sourceLineNo">068</span> private ServletOutputStream os;<a name="line.68"></a>
-<span class="sourceLineNo">069</span> private PrintWriter w;<a name="line.69"></a>
-<span class="sourceLineNo">070</span><a name="line.70"></a>
-<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
-<span class="sourceLineNo">072</span> * Constructor.<a name="line.72"></a>
-<span class="sourceLineNo">073</span> */<a name="line.73"></a>
-<span class="sourceLineNo">074</span> RestResponse(RestContext context, RestRequest req, HttpServletResponse res) {<a name="line.74"></a>
-<span class="sourceLineNo">075</span> super(res);<a name="line.75"></a>
-<span class="sourceLineNo">076</span> this.request = req;<a name="line.76"></a>
-<span class="sourceLineNo">077</span><a name="line.77"></a>
-<span class="sourceLineNo">078</span> for (Map.Entry<String,Object> e : context.getDefaultResponseHeaders().entrySet())<a name="line.78"></a>
-<span class="sourceLineNo">079</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.79"></a>
-<span class="sourceLineNo">080</span><a name="line.80"></a>
-<span class="sourceLineNo">081</span> try {<a name="line.81"></a>
-<span class="sourceLineNo">082</span> String passThroughHeaders = req.getHeader("x-response-headers");<a name="line.82"></a>
-<span class="sourceLineNo">083</span> if (passThroughHeaders != null) {<a name="line.83"></a>
-<span class="sourceLineNo">084</span> PartParser p = context.getUrlEncodingParser();<a name="line.84"></a>
-<span class="sourceLineNo">085</span> ObjectMap m = p.parse(PartType.HEADER, passThroughHeaders, context.getBeanContext().getClassMeta(ObjectMap.class));<a name="line.85"></a>
-<span class="sourceLineNo">086</span> for (Map.Entry<String,Object> e : m.entrySet())<a name="line.86"></a>
-<span class="sourceLineNo">087</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.87"></a>
-<span class="sourceLineNo">088</span> }<a name="line.88"></a>
-<span class="sourceLineNo">089</span> } catch (Exception e1) {<a name="line.89"></a>
-<span class="sourceLineNo">090</span> throw new RestException(SC_BAD_REQUEST, "Invalid format for header 'x-response-headers'. Must be in URL-encoded format.").initCause(e1);<a name="line.90"></a>
-<span class="sourceLineNo">091</span> }<a name="line.91"></a>
-<span class="sourceLineNo">092</span> }<a name="line.92"></a>
-<span class="sourceLineNo">093</span><a name="line.93"></a>
-<span class="sourceLineNo">094</span> /*<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * Called from RestServlet after a match has been made but before the guard or method invocation.<a name="line.95"></a>
-<span class="sourceLineNo">096</span> */<a name="line.96"></a>
-<span class="sourceLineNo">097</span> @SuppressWarnings("hiding")<a name="line.97"></a>
-<span class="sourceLineNo">098</span> final void init(ObjectMap properties, String defaultCharset, SerializerGroup mSerializers, UrlEncodingSerializer mUrlEncodingSerializer, EncoderGroup encoders) {<a name="line.98"></a>
-<span class="sourceLineNo">099</span> this.properties = properties;<a name="line.99"></a>
-<span class="sourceLineNo">100</span> this.serializerGroup = mSerializers;<a name="line.100"></a>
-<span class="sourceLineNo">101</span> this.urlEncodingSerializer = mUrlEncodingSerializer;<a name="line.101"></a>
-<span class="sourceLineNo">102</span> this.encoders = encoders;<a name="line.102"></a>
-<span class="sourceLineNo">103</span><a name="line.103"></a>
-<span class="sourceLineNo">104</span> // Find acceptable charset<a name="line.104"></a>
-<span class="sourceLineNo">105</span> String h = request.getHeader("accept-charset");<a name="line.105"></a>
-<span class="sourceLineNo">106</span> String charset = null;<a name="line.106"></a>
-<span class="sourceLineNo">107</span> if (h == null)<a name="line.107"></a>
-<span class="sourceLineNo">108</span> charset = defaultCharset;<a name="line.108"></a>
-<span class="sourceLineNo">109</span> else for (MediaTypeRange r : MediaTypeRange.parse(h)) {<a name="line.109"></a>
-<span class="sourceLineNo">110</span> if (r.getQValue() > 0) {<a name="line.110"></a>
-<span class="sourceLineNo">111</span> MediaType mt = r.getMediaType();<a name="line.111"></a>
-<span class="sourceLineNo">112</span> if (mt.getType().equals("*"))<a name="line.112"></a>
-<span class="sourceLineNo">113</span> charset = defaultCharset;<a name="line.113"></a>
-<span class="sourceLineNo">114</span> else if (Charset.isSupported(mt.getType()))<a name="line.114"></a>
-<span class="sourceLineNo">115</span> charset = mt.getType();<a name="line.115"></a>
-<span class="sourceLineNo">116</span> if (charset != null)<a name="line.116"></a>
-<span class="sourceLineNo">117</span> break;<a name="line.117"></a>
-<span class="sourceLineNo">118</span> }<a name="line.118"></a>
-<span class="sourceLineNo">119</span> }<a name="line.119"></a>
-<span class="sourceLineNo">120</span><a name="line.120"></a>
-<span class="sourceLineNo">121</span> if (charset == null)<a name="line.121"></a>
-<span class="sourceLineNo">122</span> throw new RestException(SC_NOT_ACCEPTABLE, "No supported charsets in header ''Accept-Charset'': ''{0}''", request.getHeader("Accept-Charset"));<a name="line.122"></a>
-<span class="sourceLineNo">123</span> super.setCharacterEncoding(charset);<a name="line.123"></a>
-<span class="sourceLineNo">124</span> }<a name="line.124"></a>
-<span class="sourceLineNo">125</span><a name="line.125"></a>
-<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
-<span class="sourceLineNo">127</span> * Gets the serializer group for the response.<a name="line.127"></a>
-<span class="sourceLineNo">128</span> *<a name="line.128"></a>
-<span class="sourceLineNo">129</span> * @return The serializer group for the response.<a name="line.129"></a>
-<span class="sourceLineNo">130</span> */<a name="line.130"></a>
-<span class="sourceLineNo">131</span> public SerializerGroup getSerializerGroup() {<a name="line.131"></a>
-<span class="sourceLineNo">132</span> return serializerGroup;<a name="line.132"></a>
-<span class="sourceLineNo">133</span> }<a name="line.133"></a>
-<span class="sourceLineNo">134</span><a name="line.134"></a>
-<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
-<span class="sourceLineNo">136</span> * Returns the media types that are valid for <code>Accept</code> headers on the request.<a name="line.136"></a>
-<span class="sourceLineNo">137</span> *<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * @return The set of media types registered in the parser group of this request.<a name="line.138"></a>
-<span class="sourceLineNo">139</span> */<a name="line.139"></a>
-<span class="sourceLineNo">140</span> public List<MediaType> getSupportedMediaTypes() {<a name="line.140"></a>
-<span class="sourceLineNo">141</span> return serializerGroup.getSupportedMediaTypes();<a name="line.141"></a>
-<span class="sourceLineNo">142</span> }<a name="line.142"></a>
-<span class="sourceLineNo">143</span><a name="line.143"></a>
-<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
-<span class="sourceLineNo">145</span> * Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * the request.<a name="line.146"></a>
-<span class="sourceLineNo">147</span> *<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * @return The set of media types registered in the parser group of this request.<a name="line.148"></a>
-<span class="sourceLineNo">149</span> * @throws RestServletException<a name="line.149"></a>
-<span class="sourceLineNo">150</span> */<a name="line.150"></a>
-<span class="sourceLineNo">151</span> public List<String> getSupportedEncodings() throws RestServletException {<a name="line.151"></a>
-<span class="sourceLineNo">152</span> return encoders.getSupportedEncodings();<a name="line.152"></a>
-<span class="sourceLineNo">153</span> }<a name="line.153"></a>
-<span class="sourceLineNo">154</span><a name="line.154"></a>
-<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * Sets the HTTP output on the response.<a name="line.156"></a>
-<span class="sourceLineNo">157</span> *<a name="line.157"></a>
-<span class="sourceLineNo">158</span> * <p><a name="line.158"></a>
-<span class="sourceLineNo">159</span> * Calling this method is functionally equivalent to returning the object in the REST Java method.<a name="line.159"></a>
-<span class="sourceLineNo">160</span> *<a name="line.160"></a>
-<span class="sourceLineNo">161</span> * <p><a name="line.161"></a>
-<span class="sourceLineNo">162</span> * Can be of any of the following types:<a name="line.162"></a>
-<span class="sourceLineNo">163</span> * <ul><a name="line.163"></a>
-<span class="sourceLineNo">164</span> * <li> {@link InputStream}<a name="line.164"></a>
-<span class="sourceLineNo">165</span> * <li> {@link Reader}<a name="line.165"></a>
-<span class="sourceLineNo">166</span> * <li> Any serializable type defined in <a class="doclink"<a name="line.166"></a>
-<span class="sourceLineNo">167</span> * href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a><a name="line.167"></a>
-<span class="sourceLineNo">168</span> * </ul><a name="line.168"></a>
-<span class="sourceLineNo">169</span> *<a name="line.169"></a>
-<span class="sourceLineNo">170</span> * <p><a name="line.170"></a>
-<span class="sourceLineNo">171</span> * If it's an {@link InputStream} or {@link Reader}, you must also specify the <code>Content-Type</code> using the<a name="line.171"></a>
-<span class="sourceLineNo">172</span> * {@link #setContentType(String)} method.<a name="line.172"></a>
-<span class="sourceLineNo">173</span> *<a name="line.173"></a>
-<span class="sourceLineNo">174</span> * @param output The output to serialize to the connection.<a name="line.174"></a>
-<span class="sourceLineNo">175</span> * @return This object (for method chaining).<a name="line.175"></a>
-<span class="sourceLineNo">176</span> */<a name="line.176"></a>
-<span class="sourceLineNo">177</span> public RestResponse setOutput(Object output) {<a name="line.177"></a>
-<span class="sourceLineNo">178</span> this.output = output;<a name="line.178"></a>
-<span class="sourceLineNo">179</span> this.isNullOutput = output == null;<a name="line.179"></a>
-<span class="sourceLineNo">180</span> return this;<a name="line.180"></a>
-<span class="sourceLineNo">181</span> }<a name="line.181"></a>
-<span class="sourceLineNo">182</span><a name="line.182"></a>
-<span class="sourceLineNo">183</span> /**<a name="line.183"></a>
-<span class="sourceLineNo">184</span> * Add a serializer property to send to the serializers to override a default value.<a name="line.184"></a>
-<span class="sourceLineNo">185</span> *<a name="line.185"></a>
-<span class="sourceLineNo">186</span> * <p><a name="line.186"></a>
-<span class="sourceLineNo">187</span> * Can be any value specified in the following classes:<a name="line.187"></a>
-<span class="sourceLineNo">188</span> * <ul><a name="line.188"></a>
-<span class="sourceLineNo">189</span> * <li>{@link SerializerContext}<a name="line.189"></a>
-<span class="sourceLineNo">190</span> * <li>{@link JsonSerializerContext}<a name="line.190"></a>
-<span class="sourceLineNo">191</span> * <li>{@link XmlSerializerContext}<a name="line.191"></a>
-<span class="sourceLineNo">192</span> * <li>{@link RdfSerializerContext}<a name="line.192"></a>
-<span class="sourceLineNo">193</span> * </ul><a name="line.193"></a>
-<span class="sourceLineNo">194</span> *<a name="line.194"></a>
-<span class="sourceLineNo">195</span> * @param key The setting name.<a name="line.195"></a>
-<span class="sourceLineNo">196</span> * @param value The setting value.<a name="line.196"></a>
-<span class="sourceLineNo">197</span> * @return This object (for method chaining).<a name="line.197"></a>
-<span class="sourceLineNo">198</span> */<a name="line.198"></a>
-<span class="sourceLineNo">199</span> public RestResponse setProperty(String key, Object value) {<a name="line.199"></a>
-<span class="sourceLineNo">200</span> properties.put(key, value);<a name="line.200"></a>
-<span class="sourceLineNo">201</span> return this;<a name="line.201"></a>
-<span class="sourceLineNo">202</span> }<a name="line.202"></a>
-<span class="sourceLineNo">203</span><a name="line.203"></a>
-<span class="sourceLineNo">204</span> /**<a name="line.204"></a>
-<span class="sourceLineNo">205</span> * Returns the properties set via {@link #setProperty(String, Object)}.<a name="line.205"></a>
-<span class="sourceLineNo">206</span> *<a name="line.206"></a>
-<span class="sourceLineNo">207</span> * @return A map of all the property values set.<a name="line.207"></a>
-<span class="sourceLineNo">208</span> */<a name="line.208"></a>
-<span class="sourceLineNo">209</span> public ObjectMap getProperties() {<a name="line.209"></a>
-<span class="sourceLineNo">210</span> return properties;<a name="line.210"></a>
-<span class="sourceLineNo">211</span> }<a name="line.211"></a>
-<span class="sourceLineNo">212</span><a name="line.212"></a>
-<span class="sourceLineNo">213</span> /**<a name="line.213"></a>
-<span class="sourceLineNo">214</span> * Shortcut method that allows you to use var-args to simplify setting array output.<a name="line.214"></a>
-<span class="sourceLineNo">215</span> *<a name="line.215"></a>
-<span class="sourceLineNo">216</span> * <h5 class='section'>Example:</h5><a name="line.216"></a>
-<span class="sourceLineNo">217</span> * <p class='bcode'><a name="line.217"></a>
-<span class="sourceLineNo">218</span> * <jc>// Instead of...</jc><a name="line.218"></a>
-<span class="sourceLineNo">219</span> * response.setOutput(<jk>new</jk> Object[]{x,y,z});<a name="line.219"></a>
-<span class="sourceLineNo">220</span> *<a name="line.220"></a>
-<span class="sourceLineNo">221</span> * <jc>// ...call this...</jc><a name="line.221"></a>
-<span class="sourceLineNo">222</span> * response.setOutput(x,y,z);<a name="line.222"></a>
-<span class="sourceLineNo">223</span> * </p><a name="line.223"></a>
-<span class="sourceLineNo">224</span> *<a name="line.224"></a>
-<span class="sourceLineNo">225</span> * @param output The output to serialize to the connection.<a name="line.225"></a>
-<span class="sourceLineNo">226</span> * @return This object (for method chaining).<a name="line.226"></a>
-<span class="sourceLineNo">227</span> */<a name="line.227"></a>
-<span class="sourceLineNo">228</span> public RestResponse setOutputs(Object...output) {<a name="line.228"></a>
-<span class="sourceLineNo">229</span> this.output = output;<a name="line.229"></a>
-<span class="sourceLineNo">230</span> return this;<a name="line.230"></a>
-<span class="sourceLineNo">231</span> }<a name="line.231"></a>
-<span class="sourceLineNo">232</span><a name="line.232"></a>
-<span class="sourceLineNo">233</span> /**<a name="line.233"></a>
-<span class="sourceLineNo">234</span> * Returns the output that was set by calling {@link #setOutput(Object)}.<a name="line.234"></a>
-<span class="sourceLineNo">235</span> *<a name="line.235"></a>
-<span class="sourceLineNo">236</span> * @return The output object.<a name="line.236"></a>
-<span class="sourceLineNo">237</span> */<a name="line.237"></a>
-<span class="sourceLineNo">238</span> public Object getOutput() {<a name="line.238"></a>
-<span class="sourceLineNo">239</span> return output;<a name="line.239"></a>
-<span class="sourceLineNo">240</span> }<a name="line.240"></a>
-<span class="sourceLineNo">241</span><a name="line.241"></a>
-<span class="sourceLineNo">242</span> /**<a name="line.242"></a>
-<span class="sourceLineNo">243</span> * Returns <jk>true</jk> if this response has any output associated with it.<a name="line.243"></a>
-<span class="sourceLineNo">244</span> *<a name="line.244"></a>
-<span class="sourceLineNo">245</span> * @return <jk>true</jk> if {@code setInput()} has been called.<a name="line.245"></a>
-<span class="sourceLineNo">246</span> */<a name="line.246"></a>
-<span class="sourceLineNo">247</span> public boolean hasOutput() {<a name="line.247"></a>
-<span class="sourceLineNo">248</span> return output != null || isNullOutput;<a name="line.248"></a>
-<span class="sourceLineNo">249</span> }<a name="line.249"></a>
-<span class="sourceLineNo">250</span><a name="line.250"></a>
-<span class="sourceLineNo">251</span> /**<a name="line.251"></a>
-<span class="sourceLineNo">252</span> * Sets the output to a plain-text message regardless of the content type.<a name="line.252"></a>
-<span class="sourceLineNo">253</span> *<a name="line.253"></a>
-<span class="sourceLineNo">254</span> * @param text The output text to send.<a name="line.254"></a>
-<span class="sourceLineNo">255</span> * @return This object (for method chaining).<a name="line.255"></a>
-<span class="sourceLineNo">256</span> * @throws IOException If a problem occurred trying to write to the writer.<a name="line.256"></a>
-<span class="sourceLineNo">257</span> */<a name="line.257"></a>
-<span class="sourceLineNo">258</span> public RestResponse sendPlainText(String text) throws IOException {<a name="line.258"></a>
-<span class="sourceLineNo">259</span> setContentType("text/plain");<a name="line.259"></a>
-<span class="sourceLineNo">260</span> getNegotiatedWriter().write(text);<a name="line.260"></a>
-<span class="sourceLineNo">261</span> return this;<a name="line.261"></a>
-<span class="sourceLineNo">262</span> }<a name="line.262"></a>
-<span class="sourceLineNo">263</span><a name="line.263"></a>
-<span class="sourceLineNo">264</span> /**<a name="line.264"></a>
-<span class="sourceLineNo">265</span> * Equivalent to {@link HttpServletResponse#getOutputStream()}, except wraps the output stream if an {@link Encoder}<a name="line.265"></a>
-<span class="sourceLineNo">266</span> * was found that matched the <code>Accept-Encoding</code> header.<a name="line.266"></a>
-<span class="sourceLineNo">267</span> *<a name="line.267"></a>
-<span class="sourceLineNo">268</span> * @return A negotiated output stream.<a name="line.268"></a>
-<span class="sourceLineNo">269</span> * @throws IOException<a name="line.269"></a>
-<span class="sourceLineNo">270</span> */<a name="line.270"></a>
-<span class="sourceLineNo">271</span> public ServletOutputStream getNegotiatedOutputStream() throws IOException {<a name="line.271"></a>
-<span class="sourceLineNo">272</span> if (os == null) {<a name="line.272"></a>
-<span class="sourceLineNo">273</span> Encoder encoder = null;<a name="line.273"></a>
-<span class="sourceLineNo">274</span><a name="line.274"></a>
-<span class="sourceLineNo">275</span> String ae = request.getHeader("Accept-Encoding");<a name="line.275"></a>
-<span class="sourceLineNo">276</span> if (! (ae == null || ae.isEmpty())) {<a name="line.276"></a>
-<span class="sourceLineNo">277</span> EncoderMatch match = encoders != null ? encoders.getEncoderMatch(ae) : null;<a name="line.277"></a>
-<span class="sourceLineNo">278</span> if (match == null) {<a name="line.278"></a>
-<span class="sourceLineNo">279</span> // Identity should always match unless "identity;q=0" or "*;q=0" is specified.<a name="line.279"></a>
-<span class="sourceLineNo">280</span> if (ae.matches(".*(identity|\\*)\\s*;\\s*q\\s*=\\s*(0(?!\\.)|0\\.0).*")) {<a name="line.280"></a>
-<span class="sourceLineNo">281</span> throw new RestException(SC_NOT_ACCEPTABLE,<a name="line.281"></a>
-<span class="sourceLineNo">282</span> "Unsupported encoding in request header ''Accept-Encoding'': ''{0}''\n\tSupported codings: {1}",<a name="line.282"></a>
-<span class="sourceLineNo">283</span> ae, encoders.getSupportedEncodings()<a name="line.283"></a>
-<span class="sourceLineNo">284</span> );<a name="line.284"></a>
-<span class="sourceLineNo">285</span> }<a name="line.285"></a>
-<span class="sourceLineNo">286</span> } else {<a name="line.286"></a>
-<span class="sourceLineNo">287</span> encoder = match.getEncoder();<a name="line.287"></a>
-<span class="sourceLineNo">288</span> String encoding = match.getEncoding().toString();<a name="line.288"></a>
-<span class="sourceLineNo">289</span><a name="line.289"></a>
-<span class="sourceLineNo">290</span> // Some clients don't recognize identity as an encoding, so don't set it.<a name="line.290"></a>
-<span class="sourceLineNo">291</span> if (! encoding.equals("identity"))<a name="line.291"></a>
-<span class="sourceLineNo">292</span> setHeader("content-encoding", encoding);<a name="line.292"></a>
-<span class="sourceLineNo">293</span> }<a name="line.293"></a>
-<span class="sourceLineNo">294</span> }<a name="line.294"></a>
-<span class="sourceLineNo">295</span> os = getOutputStream();<a name="line.295"></a>
-<span class="sourceLineNo">296</span> if (encoder != null) {<a name="line.296"></a>
-<span class="sourceLineNo">297</span> final OutputStream os2 = encoder.getOutputStream(os);<a name="line.297"></a>
-<span class="sourceLineNo">298</span> os = new ServletOutputStream(){<a name="line.298"></a>
-<span class="sourceLineNo">299</span> @Override /* OutputStream */<a name="line.299"></a>
-<span class="sourceLineNo">300</span> public final void write(byte[] b, int off, int len) throws IOException {<a name="line.300"></a>
-<span class="sourceLineNo">301</span> os2.write(b, off, len);<a name="line.301"></a>
-<span class="sourceLineNo">302</span> }<a name="line.302"></a>
-<span class="sourceLineNo">303</span> @Override /* OutputStream */<a name="line.303"></a>
-<span class="sourceLineNo">304</span> public final void write(int b) throws IOException {<a name="line.304"></a>
-<span class="sourceLineNo">305</span> os2.write(b);<a name="line.305"></a>
-<span class="sourceLineNo">306</span> }<a name="line.306"></a>
-<span class="sourceLineNo">307</span> @Override /* OutputStream */<a name="line.307"></a>
-<span class="sourceLineNo">308</span> public final void flush() throws IOException {<a name="line.308"></a>
-<span class="sourceLineNo">309</span> os2.flush();<a name="line.309"></a>
-<span class="sourceLineNo">310</span> }<a name="line.310"></a>
-<span class="sourceLineNo">311</span> @Override /* OutputStream */<a name="line.311"></a>
-<span class="sourceLineNo">312</span> public final void close() throws IOException {<a name="line.312"></a>
-<span class="sourceLineNo">313</span> os2.close();<a name="line.313"></a>
-<span class="sourceLineNo">314</span> }<a name="line.314"></a>
-<span class="sourceLineNo">315</span> @Override /* ServletOutputStream */<a name="line.315"></a>
-<span class="sourceLineNo">316</span> public boolean isReady() {<a name="line.316"></a>
-<span class="sourceLineNo">317</span> return true;<a name="line.317"></a>
-<span class="sourceLineNo">318</span> }<a name="line.318"></a>
-<span class="sourceLineNo">319</span> @Override /* ServletOutputStream */<a name="line.319"></a>
-<span class="sourceLineNo">320</span> public void setWriteListener(WriteListener arg0) {<a name="line.320"></a>
-<span class="sourceLineNo">321</span> throw new NoSuchMethodError();<a name="line.321"></a>
-<span class="sourceLineNo">322</span> }<a name="line.322"></a>
-<span class="sourceLineNo">323</span> };<a name="line.323"></a>
-<span class="sourceLineNo">324</span> }<a name="line.324"></a>
-<span class="sourceLineNo">325</span> }<a name="line.325"></a>
-<span class="sourceLineNo">326</span> return os;<a name="line.326"></a>
-<span class="sourceLineNo">327</span> }<a name="line.327"></a>
-<span class="sourceLineNo">328</span><a name="line.328"></a>
-<span class="sourceLineNo">329</span> @Override /* ServletResponse */<a name="line.329"></a>
-<span class="sourceLineNo">330</span> public ServletOutputStream getOutputStream() throws IOException {<a name="line.330"></a>
-<span class="sourceLineNo">331</span> if (os == null)<a name="line.331"></a>
-<span class="sourceLineNo">332</span> os = super.getOutputStream();<a name="line.332"></a>
-<span class="sourceLineNo">333</span> return os;<a name="line.333"></a>
-<span class="sourceLineNo">334</span> }<a name="line.334"></a>
-<span class="sourceLineNo">335</span><a name="line.335"></a>
-<span class="sourceLineNo">336</span> /**<a name="line.336"></a>
-<span class="sourceLineNo">337</span> * Returns <jk>true</jk> if {@link #getOutputStream()} has been called.<a name="line.337"></a>
-<span class="sourceLineNo">338</span> *<a name="line.338"></a>
-<span class="sourceLineNo">339</span> * @return <jk>true</jk> if {@link #getOutputStream()} has been called.<a name="line.339"></a>
-<span class="sourceLineNo">340</span> */<a name="line.340"></a>
-<span class="sourceLineNo">341</span> public boolean getOutputStreamCalled() {<a name="line.341"></a>
-<span class="sourceLineNo">342</span> return os != null;<a name="line.342"></a>
-<span class="sourceLineNo">343</span> }<a name="line.343"></a>
-<span class="sourceLineNo">344</span><a name="line.344"></a>
-<span class="sourceLineNo">345</span> /**<a name="line.345"></a>
-<span class="sourceLineNo">346</span> * Returns the writer to the response body.<a name="line.346"></a>
-<span class="sourceLineNo">347</span> *<a name="line.347"></a>
-<span class="sourceLineNo">348</span> * <p><a name="line.348"></a>
-<span class="sourceLineNo">349</span> * This methods bypasses any specified encoders and returns a regular unbuffered writer.<a name="line.349"></a>
-<span class="sourceLineNo">350</span> * Use the {@link #getNegotiatedWriter()} method if you want to use the matched encoder (if any).<a name="line.350"></a>
-<span class="sourceLineNo">351</span> */<a name="line.351"></a>
-<span class="sourceLineNo">352</span> @Override /* ServletResponse */<a name="line.352"></a>
-<span class="sourceLineNo">353</span> public PrintWriter getWriter() throws IOException {<a name="line.353"></a>
-<span class="sourceLineNo">354</span> return getWriter(true);<a name="line.354"></a>
-<span class="sourceLineNo">355</span> }<a name="line.355"></a>
-<span class="sourceLineNo">356</span><a name="line.356"></a>
-<span class="sourceLineNo">357</span> /**<a name="line.357"></a>
-<span class="sourceLineNo">358</span> * Convenience method meant to be used when rendering directly to a browser with no buffering.<a name="line.358"></a>
-<span class="sourceLineNo">359</span> *<a name="line.359"></a>
-<span class="sourceLineNo">360</span> * <p><a name="line.360"></a>
-<span class="sourceLineNo">361</span> * Sets the header <js>"x-content-type-options=nosniff"</js> so that output is rendered immediately on IE and Chrome<a name="line.361"></a>
-<span class="sourceLineNo">362</span> * without any buffering for content-type sniffing.<a name="line.362"></a>
-<span class="sourceLineNo">363</span> *<a name="line.363"></a>
-<span class="sourceLineNo">364</span> * @param contentType The value to set as the <code>Content-Type</code> on the response.<a name="line.364"></a>
-<span class="sourceLineNo">365</span> * @return The raw writer.<a name="line.365"></a>
-<span class="sourceLineNo">366</span> * @throws IOException<a name="line.366"></a>
-<span class="sourceLineNo">367</span> */<a name="line.367"></a>
-<span class="sourceLineNo">368</span> public PrintWriter getDirectWriter(String contentType) throws IOException {<a name="line.368"></a>
-<span class="sourceLineNo">369</span> setContentType(contentType);<a name="line.369"></a>
-<span class="sourceLineNo">370</span> setHeader("x-content-type-options", "nosniff");<a name="line.370"></a>
-<span class="sourceLineNo">371</span> return getWriter();<a name="line.371"></a>
-<span class="sourceLineNo">372</span> }<a name="line.372"></a>
-<span class="sourceLineNo">373</span><a name="line.373"></a>
-<span class="sourceLineNo">374</span> /**<a name="line.374"></a>
-<span class="sourceLineNo">375</span> * Equivalent to {@link HttpServletResponse#getWriter()}, except wraps the output stream if an {@link Encoder} was<a name="line.375"></a>
-<span class="sourceLineNo">376</span> * found that matched the <code>Accept-Encoding</code> header and sets the <code>Content-Encoding</code><a name="line.376"></a>
-<span class="sourceLineNo">377</span> * header to the appropriate value.<a name="line.377"></a>
-<span class="sourceLineNo">378</span> *<a name="line.378"></a>
-<span class="sourceLineNo">379</span> * @return The negotiated writer.<a name="line.379"></a>
-<span class="sourceLineNo">380</span> * @throws IOException<a name="line.380"></a>
-<span class="sourceLineNo">381</span> */<a name="line.381"></a>
-<span class="sourceLineNo">382</span> public PrintWriter getNegotiatedWriter() throws IOException {<a name="line.382"></a>
-<span class="sourceLineNo">383</span> return getWriter(false);<a name="line.383"></a>
-<span class="sourceLineNo">384</span> }<a name="line.384"></a>
-<span class="sourceLineNo">385</span><a name="line.385"></a>
-<span class="sourceLineNo">386</span> private PrintWriter getWriter(boolean raw) throws IOException {<a name="line.386"></a>
-<span class="sourceLineNo">387</span> if (w != null)<a name="line.387"></a>
-<span class="sourceLineNo">388</span> return w;<a name="line.388"></a>
-<span class="sourceLineNo">389</span><a name="line.389"></a>
-<span class="sourceLineNo">390</span> // If plain text requested, override it now.<a name="line.390"></a>
-<span class="sourceLineNo">391</span> if (request.isPlainText())<a name="line.391"></a>
-<span class="sourceLineNo">392</span> setHeader("Content-Type", "text/plain");<a name="line.392"></a>
-<span class="sourceLineNo">393</span><a name="line.393"></a>
-<span class="sourceLineNo">394</span> try {<a name="line.394"></a>
-<span class="sourceLineNo">395</span> OutputStream out = (raw ? getOutputStream() : getNegotiatedOutputStream());<a name="line.395"></a>
-<span class="sourceLineNo">396</span> w = new PrintWriter(new OutputStreamWriter(out, getCharacterEncoding()));<a name="line.396"></a>
-<span class="sourceLineNo">397</span> return w;<a name="line.397"></a>
-<span class="sourceLineNo">398</span> } catch (UnsupportedEncodingException e) {<a name="line.398"></a>
-<span class="sourceLineNo">399</span> String ce = getCharacterEncoding();<a name="line.399"></a>
-<span class="sourceLineNo">400</span> setCharacterEncoding("UTF-8");<a name="line.400"></a>
-<span class="sourceLineNo">401</span> throw new RestException(SC_NOT_ACCEPTABLE, "Unsupported charset in request header ''Accept-Charset'': ''{0}''", ce);<a name="line.401"></a>
-<span class="sourceLineNo">402</span> }<a name="line.402"></a>
-<span class="sourceLineNo">403</span> }<a name="line.403"></a>
-<span class="sourceLineNo">404</span><a name="line.404"></a>
-<span class="sourceLineNo">405</span> /**<a name="line.405"></a>
-<span class="sourceLineNo">406</span> * Returns the <code>Content-Type</code> header stripped of the charset attribute if present.<a name="line.406"></a>
-<span class="sourceLineNo">407</span> *<a name="line.407"></a>
-<span class="sourceLineNo">408</span> * @return The <code>media-type</code> portion of the <code>Content-Type</code> header.<a name="line.408"></a>
-<span class="sourceLineNo">409</span> */<a name="line.409"></a>
-<span class="sourceLineNo">410</span> public MediaType getMediaType() {<a name="line.410"></a>
-<span class="sourceLineNo">411</span> return MediaType.forString(getContentType());<a name="line.411"></a>
-<span class="sourceLineNo">412</span> }<a name="line.412"></a>
-<span class="sourceLineNo">413</span><a name="line.413"></a>
-<span class="sourceLineNo">414</span> /**<a name="line.414"></a>
-<span class="sourceLineNo">415</span> * Redirects to the specified URI.<a name="line.415"></a>
-<span class="sourceLineNo">416</span> *<a name="line.416"></a>
-<span class="sourceLineNo">417</span> * <p><a name="line.417"></a>
-<span class="sourceLineNo">418</span> * Relative URIs are always interpreted as relative to the context root.<a name="line.418"></a>
-<span class="sourceLineNo">419</span> * This is similar to how WAS handles redirect requests, and is different from how Tomcat handles redirect requests.<a name="line.419"></a>
-<span class="sourceLineNo">420</span> */<a name="line.420"></a>
-<span class="sourceLineNo">421</span> @Override /* ServletResponse */<a name="line.421"></a>
-<span class="sourceLineNo">422</span> public void sendRedirect(String uri) throws IOException {<a name="line.422"></a>
-<span class="sourceLineNo">423</span> char c = (uri.length() > 0 ? uri.charAt(0) : 0);<a name="line.423"></a>
-<span class="sourceLineNo">424</span> if (c != '/' && uri.indexOf("://") == -1)<a name="line.424"></a>
-<span class="sourceLineNo">425</span> uri = request.getContextPath() + '/' + uri;<a name="line.425"></a>
-<span class="sourceLineNo">426</span> super.sendRedirect(uri);<a name="line.426"></a>
-<span class="sourceLineNo">427</span> }<a name="line.427"></a>
-<span class="sourceLineNo">428</span><a name="line.428"></a>
-<span class="sourceLineNo">429</span> /**<a name="line.429"></a>
-<span class="sourceLineNo">430</span> * Returns the URL-encoding serializer associated with this response.<a name="line.430"></a>
-<span class="sourceLineNo">431</span> *<a name="line.431"></a>
-<span class="sourceLineNo">432</span> * @return The URL-encoding serializer associated with this response.<a name="line.432"></a>
-<span class="sourceLineNo">433</span> */<a name="line.433"></a>
-<span class="sourceLineNo">434</span> public UrlEncodingSerializer getUrlEncodingSerializer() {<a name="line.434"></a>
-<span class="sourceLineNo">435</span> return urlEncodingSerializer;<a name="line.435"></a>
-<span class="sourceLineNo">436</span> }<a name="line.436"></a>
-<span class="sourceLineNo">437</span><a name="line.437"></a>
-<span class="sourceLineNo">438</span> @Override /* ServletResponse */<a name="line.438"></a>
-<span class="sourceLineNo">439</span> public void setHeader(String name, String value) {<a name="line.439"></a>
-<span class="sourceLineNo">440</span> // Jetty doesn't set the content type correctly if set through this method.<a name="line.440"></a>
-<span class="sourceLineNo">441</span> // Tomcat/WAS does.<a name="line.441"></a>
-<span class="sourceLineNo">442</span> if (name.equalsIgnoreCase("Content-Type"))<a name="line.442"></a>
-<span class="sourceLineNo">443</span> super.setContentType(value);<a name="line.443"></a>
-<span class="sourceLineNo">444</span> else<a name="line.444"></a>
-<span class="sourceLineNo">445</span> super.setHeader(name, value);<a name="line.445"></a>
-<span class="sourceLineNo">446</span> }<a name="line.446"></a>
-<span class="sourceLineNo">447</span><a name="line.447"></a>
-<span class="sourceLineNo">448</span> /**<a name="line.448"></a>
-<span class="sourceLineNo">449</span> * Sets the HTML header section contents.<a name="line.449"></a>
-<span class="sourceLineNo">450</span> *<a name="line.450"></a>
-<span class="sourceLineNo">451</span> * <p><a name="line.451"></a>
-<span class="sourceLineNo">452</span> * The format of this value is HTML.<a name="line.452"></a>
-<span class="sourceLineNo">453</span> *<a name="line.453"></a>
-<span class="sourceLineNo">454</span> * <p><a name="line.454"></a>
-<span class="sourceLineNo">455</span> * The page header normally contains the title and description, but this value can be used to override the contents<a name="line.455"></a>
-<span class="sourceLineNo">456</span> * to be whatever you want.<a name="line.456"></a>
-<span class="sourceLineNo">457</span> *<a name="line.457"></a>
-<span class="sourceLineNo">458</span> * <p><a name="line.458"></a>
-<span class="sourceLineNo">459</span> * A value of <js>"NONE"</js> can be used to force no header.<a name="line.459"></a>
-<span class="sourceLineNo">460</span> *<a name="line.460"></a>
-<span class="sourceLineNo">461</span> * <p><a name="line.461"></a>
-<span class="sourceLineNo">462</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.462"></a>
-<span class="sourceLineNo">463</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.463"></a>
-<span class="sourceLineNo">464</span> *<a name="line.464"></a>
-<span class="sourceLineNo">465</span> * <p><a name="line.465"></a>
-<span class="sourceLineNo">466</span> * This is the programmatic equivalent to the {@link HtmlDoc#header() @HtmlDoc.header()} annotation.<a name="line.466"></a>
-<span class="sourceLineNo">467</span> *<a name="line.467"></a>
-<span class="sourceLineNo">468</span> * @param value<a name="line.468"></a>
-<span class="sourceLineNo">469</span> * The HTML header section contents.<a name="line.469"></a>
-<span class="sourceLineNo">470</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.470"></a>
-<span class="sourceLineNo">471</span> * <p><a name="line.471"></a>
-<span class="sourceLineNo">472</span> * <ul class='doctree'><a name="line.472"></a>
-<span class="sourceLineNo">473</span> * <li class='info'><a name="line.473"></a>
-<span class="sourceLineNo">474</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.474"></a>
-<span class="sourceLineNo">475</span> * waste string concatenation cycles on non-HTML views.<a name="line.475"></a>
-<span class="sourceLineNo">476</span> * </ul><a name="line.476"></a>
-<span class="sourceLineNo">477</span> * @return This object (for method chaining).<a name="line.477"></a>
-<span class="sourceLineNo">478</span> */<a name="line.478"></a>
-<span class="sourceLineNo">479</span> public RestResponse setHtmlHeader(Object value) {<a name="line.479"></a>
-<span class="sourceLineNo">480</span> return setProperty(HtmlDocSerializerContext.HTMLDOC_header, value);<a name="line.480"></a>
-<span class="sourceLineNo">481</span> }<a name="line.481"></a>
-<span class="sourceLineNo">482</span><a name="line.482"></a>
-<span class="sourceLineNo">483</span> /**<a name="line.483"></a>
-<span class="sourceLineNo">484</span> * Sets the links in the HTML nav section.<a name="line.484"></a>
-<span class="sourceLineNo">485</span> *<a name="line.485"></a>
-<span class="sourceLineNo">486</span> * <p><a name="line.486"></a>
-<span class="sourceLineNo">487</span> * The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are<a name="line.487"></a>
-<span class="sourceLineNo">488</span> * relative (to the servlet) or absolute URLs.<a name="line.488"></a>
-<span class="sourceLineNo">489</span> *<a name="line.489"></a>
-<span class="sourceLineNo">490</span> * <p><a name="line.490"></a>
-<span class="sourceLineNo">491</span> * The page links are positioned immediately under the title and text.<a name="line.491"></a>
-<span class="sourceLineNo">492</span> *<a name="line.492"></a>
-<span class="sourceLineNo">493</span> * <p><a name="line.493"></a>
-<span class="sourceLineNo">494</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.494"></a>
-<span class="sourceLineNo">495</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.495"></a>
-<span class="sourceLineNo">496</span> *<a name="line.496"></a>
-<span class="sourceLineNo">497</span> * <p><a name="line.497"></a>
-<span class="sourceLineNo">498</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.498"></a>
-<span class="sourceLineNo">499</span> *<a name="line.499"></a>
-<span class="sourceLineNo">500</span> * <p><a name="line.500"></a>
-<span class="sourceLineNo">501</span> * This field can also use URIs of any support type in {@link UriResolver}.<a name="line.501"></a>
-<span class="sourceLineNo">502</span> *<a name="line.502"></a>
-<span class="sourceLineNo">503</span> * <p><a name="line.503"></a>
-<span class="sourceLineNo">504</span> * This is the programmatic equivalent to the {@link HtmlDoc#links() @HtmlDoc.links()} annotation.<a name="line.504"></a>
-<span class="sourceLineNo">505</span> *<a name="line.505"></a>
-<span class="sourceLineNo">506</span> * @param value<a name="line.506"></a>
-<span class="sourceLineNo">507</span> * The HTML nav section links links.<a name="line.507"></a>
-<span class="sourceLineNo">508</span> * <p><a name="line.508"></a>
-<span class="sourceLineNo">509</span> * <ul class='doctree'><a name="line.509"></a>
-<span class="sourceLineNo">510</span> * <li class='info'><a name="line.510"></a>
-<span class="sourceLineNo">511</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.511"></a>
-<span class="sourceLineNo">512</span> * waste string concatenation cycles on non-HTML views.<a name="line.512"></a>
-<span class="sourceLineNo">513</span> * </ul><a name="line.513"></a>
-<span class="sourceLineNo">514</span> * @return This object (for method chaining).<a name="line.514"></a>
-<span class="sourceLineNo">515</span> */<a name="line.515"></a>
-<span class="sourceLineNo">516</span> public RestResponse setHtmlLinks(String[] value) {<a name="line.516"></a>
-<span class="sourceLineNo">517</span> properties.put(HtmlDocSerializerContext.HTMLDOC_links, value);<a name="line.517"></a>
-<span class="sourceLineNo">518</span> return this;<a name="line.518"></a>
-<span class="sourceLineNo">519</span> }<a name="line.519"></a>
-<span class="sourceLineNo">520</span><a name="line.520"></a>
-<span class="sourceLineNo">521</span> /**<a name="line.521"></a>
-<span class="sourceLineNo">522</span> * Sets the HTML nav section contents.<a name="line.522"></a>
-<span class="sourceLineNo">523</span> *<a name="line.523"></a>
-<span class="sourceLineNo">524</span> * <p><a name="line.524"></a>
-<span class="sourceLineNo">525</span> * The format of this value is HTML.<a name="line.525"></a>
-<span class="sourceLineNo">526</span> *<a name="line.526"></a>
-<span class="sourceLineNo">527</span> * <p><a name="line.527"></a>
-<span class="sourceLineNo">528</span> * The nav section of the page contains the links.<a name="line.528"></a>
-<span class="sourceLineNo">529</span> *<a name="line.529"></a>
-<span class="sourceLineNo">530</span> * <p><a name="line.530"></a>
-<span class="sourceLineNo">531</span> * The format of this value is HTML.<a name="line.531"></a>
-<span class="sourceLineNo">532</span> *<a name="line.532"></a>
-<span class="sourceLineNo">533</span> * <p><a name="line.533"></a>
-<span class="sourceLineNo">534</span> * When a value is specified, the {@link #setHtmlLinks(String[])} value will be ignored.<a name="line.534"></a>
-<span class="sourceLineNo">535</span> *<a name="line.535"></a>
-<span class="sourceLineNo">536</span> * <p><a name="line.536"></a>
-<span class="sourceLineNo">537</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.537"></a>
-<span class="sourceLineNo">538</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.538"></a>
-<span class="sourceLineNo">539</span> *<a name="line.539"></a>
-<span class="sourceLineNo">540</span> * <p><a name="line.540"></a>
-<span class="sourceLineNo">541</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.541"></a>
-<span class="sourceLineNo">542</span> *<a name="line.542"></a>
-<span class="sourceLineNo">543</span> * <p><a name="line.543"></a>
-<span class="sourceLineNo">544</span> * This is the programmatic equivalent to the {@link HtmlDoc#nav() @HtmlDoc.nav()} annotation.<a name="line.544"></a>
-<span class="sourceLineNo">545</span> *<a name="line.545"></a>
-<span class="sourceLineNo">546</span> * @param value<a name="line.546"></a>
-<span class="sourceLineNo">547</span> * The HTML nav section contents.<a name="line.547"></a>
-<span class="sourceLineNo">548</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.548"></a>
-<span class="sourceLineNo">549</span> * <p><a name="line.549"></a>
-<span class="sourceLineNo">550</span> * <ul class='doctree'><a name="line.550"></a>
-<span class="sourceLineNo">551</span> * <li class='info'><a name="line.551"></a>
-<span class="sourceLineNo">552</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.552"></a>
-<span class="sourceLineNo">553</span> * waste string concatenation cycles on non-HTML views.<a name="line.553"></a>
-<span class="sourceLineNo">554</span> * </ul><a name="line.554"></a>
-<span class="sourceLineNo">555</span> * @return This object (for method chaining).<a name="line.555"></a>
-<span class="sourceLineNo">556</span> */<a name="line.556"></a>
-<span class="sourceLineNo">557</span> public RestResponse setHtmlNav(Object value) {<a name="line.557"></a>
-<span class="sourceLineNo">558</span> properties.put(HtmlDocSerializerContext.HTMLDOC_nav, value);<a name="line.558"></a>
-<span class="sourceLineNo">559</span> return this;<a name="line.559"></a>
-<span class="sourceLineNo">560</span> }<a name="line.560"></a>
-<span class="sourceLineNo">561</span><a name="line.561"></a>
-<span class="sourceLineNo">562</span> /**<a name="line.562"></a>
-<span class="sourceLineNo">563</span> * Sets the HTML aside section contents.<a name="line.563"></a>
-<span class="sourceLineNo">564</span> *<a name="line.564"></a>
-<span class="sourceLineNo">565</span> * <p><a name="line.565"></a>
-<span class="sourceLineNo">566</span> * The format of this value is HTML.<a name="line.566"></a>
-<span class="sourceLineNo">567</span> *<a name="line.567"></a>
-<span class="sourceLineNo">568</span> * <p><a name="line.568"></a>
-<span class="sourceLineNo">569</span> * The aside section typically floats on the right side of the page.<a name="line.569"></a>
-<span class="sourceLineNo">570</span> *<a name="line.570"></a>
-<span class="sourceLineNo">571</span> * <p><a name="line.571"></a>
-<span class="sourceLineNo">572</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.572"></a>
-<span class="sourceLineNo">573</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.573"></a>
-<span class="sourceLineNo">574</span> *<a name="line.574"></a>
-<span class="sourceLineNo">575</span> * <p><a name="line.575"></a>
-<span class="sourceLineNo">576</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.576"></a>
-<span class="sourceLineNo">577</span> *<a name="line.577"></a>
-<span class="sourceLineNo">578</span> * <p><a name="line.578"></a>
-<span class="sourceLineNo">579</span> * This is the programmatic equivalent to the {@link HtmlDoc#aside() @HtmlDoc.aside()} annotation.<a name="line.579"></a>
-<span class="sourceLineNo">580</span> *<a name="line.580"></a>
-<span class="sourceLineNo">581</span> * @param value<a name="line.581"></a>
-<span class="sourceLineNo">582</span> * The HTML aside section contents.<a name="line.582"></a>
-<span class="sourceLineNo">583</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.583"></a>
-<span class="sourceLineNo">584</span> * <p><a name="line.584"></a>
-<span class="sourceLineNo">585</span> * <ul class='doctree'><a name="line.585"></a>
-<span class="sourceLineNo">586</span> * <li class='info'><a name="line.586"></a>
-<span class="sourceLineNo">587</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to waste<a name="line.587"></a>
-<span class="sourceLineNo">588</span> * string concatenation cycles on non-HTML views.<a name="line.588"></a>
-<span class="sourceLineNo">589</span> * </ul><a name="line.589"></a>
-<span class="sourceLineNo">590</span> * @return This object (for method chaining).<a name="line.590"></a>
-<span class="sourceLineNo">591</span> */<a name="line.591"></a>
-<span class="sourceLineNo">592</span> public RestResponse setHtmlAside(Object value) {<a name="line.592"></a>
-<span class="sourceLineNo">593</span> properties.put(HtmlDocSerializerContext.HTMLDOC_aside, value);<a name="line.593"></a>
-<span class="sourceLineNo">594</span> return this;<a name="line.594"></a>
-<span class="sourceLineNo">595</span> }<a name="line.595"></a>
-<span class="sourceLineNo">596</span><a name="line.596"></a>
-<span class="sourceLineNo">597</span> /**<a name="line.597"></a>
-<span class="sourceLineNo">598</span> * Sets the HTML footer section contents.<a name="line.598"></a>
-<span class="sourceLineNo">599</span> *<a name="line.599"></a>
-<span class="sourceLineNo">600</span> * <p><a name="line.600"></a>
-<span class="sourceLineNo">601</span> * The format of this value is HTML.<a name="line.601"></a>
-<span class="sourceLineNo">602</span> *<a name="line.602"></a>
-<span class="sourceLineNo">603</span> * <p><a name="line.603"></a>
-<span class="sourceLineNo">604</span> * The footer section typically floats on the bottom of the page.<a name="line.604"></a>
-<span class="sourceLineNo">605</span> *<a name="line.605"></a>
-<span class="sourceLineNo">606</span> * <p><a name="line.606"></a>
-<span class="sourceLineNo">607</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.607"></a>
-<span class="sourceLineNo">608</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.608"></a>
-<span class="sourceLineNo">609</span> *<a name="line.609"></a>
-<span class="sourceLineNo">610</span> * <p><a name="line.610"></a>
-<span class="sourceLineNo">611</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.611"></a>
-<span class="sourceLineNo">612</span> *<a name="line.612"></a>
-<span class="sourceLineNo">613</span> * <p><a name="line.613"></a>
-<span class="sourceLineNo">614</span> * This is the programmatic equivalent to the {@link HtmlDoc#footer() @HtmlDoc.footer()} annotation.<a name="line.614"></a>
-<span class="sourceLineNo">615</span> *<a name="line.615"></a>
-<span class="sourceLineNo">616</span> * @param value<a name="line.616"></a>
-<span class="sourceLineNo">617</span> * The HTML footer section contents.<a name="line.617"></a>
-<span class="sourceLineNo">618</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.618"></a>
-<span class="sourceLineNo">619</span> * <p><a name="line.619"></a>
-<span class="sourceLineNo">620</span> * <ul class='doctree'><a name="line.620"></a>
-<span class="sourceLineNo">621</span> * <li class='info'><a name="line.621"></a>
-<span class="sourceLineNo">622</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.622"></a>
-<span class="sourceLineNo">623</span> * waste string concatenation cycles on non-HTML views.<a name="line.623"></a>
-<span class="sourceLineNo">624</span> * </ul><a name="line.624"></a>
-<span class="sourceLineNo">625</span> * @return This object (for method chaining).<a name="line.625"></a>
-<span class="sourceLineNo">626</span> */<a name="line.626"></a>
-<span class="sourceLineNo">627</span> public RestResponse setHtmlFooter(Object value) {<a name="line.627"></a>
-<span class="sourceLineNo">628</span> properties.put(HtmlDocSerializerContext.HTMLDOC_footer, value);<a name="line.628"></a>
-<span class="sourceLineNo">629</span> return this;<a name="line.629"></a>
-<span class="sourceLineNo">630</span> }<a name="line.630"></a>
-<span class="sourceLineNo">631</span><a name="line.631"></a>
-<span class="sourceLineNo">632</span> /**<a name="line.632"></a>
-<span class="sourceLineNo">633</span> * Sets the HTML CSS style section contents.<a name="line.633"></a>
-<span class="sourceLineNo">634</span> *<a name="line.634"></a>
-<span class="sourceLineNo">635</span> * <p><a name="line.635"></a>
-<span class="sourceLineNo">636</span> * The format of this value is CSS.<a name="line.636"></a>
-<span class="sourceLineNo">637</span> *<a name="line.637"></a>
-<span class="sourceLineNo">638</span> * <p><a name="line.638"></a>
-<span class="sourceLineNo">639</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.639"></a>
-<span class="sourceLineNo">640</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.640"></a>
-<span class="sourceLineNo">641</span> *<a name="line.641"></a>
-<span class="sourceLineNo">642</span> * <p><a name="line.642"></a>
-<span class="sourceLineNo">643</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.643"></a>
-<span class="sourceLineNo">644</span> *<a name="line.644"></a>
-<span class="sourceLineNo">645</span> * <p><a name="line.645"></a>
-<span class="sourceLineNo">646</span> * This is the programmatic equivalent to the {@link HtmlDoc#style() @HtmlDoc.style()} annotation.<a name="line.646"></a>
-<span class="sourceLineNo">647</span> *<a name="line.647"></a>
-<span class="sourceLineNo">648</span> * @param value<a name="line.648"></a>
-<span class="sourceLineNo">649</span> * The HTML CSS style section contents.<a name="line.649"></a>
-<span class="sourceLineNo">650</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.650"></a>
-<span class="sourceLineNo">651</span> * <p><a name="line.651"></a>
-<span class="sourceLineNo">652</span> * <ul class='doctree'><a name="line.652"></a>
-<span class="sourceLineNo">653</span> * <li class='info'><a name="line.653"></a>
-<span class="sourceLineNo">654</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.654"></a>
-<span class="sourceLineNo">655</span> * waste string concatenation cycles on non-HTML views.<a name="line.655"></a>
-<span class="sourceLineNo">656</span> * </ul><a name="line.656"></a>
-<span class="sourceLineNo">657</span> * @return This object (for method chaining).<a name="line.657"></a>
-<span class="sourceLineNo">658</span> */<a name="line.658"></a>
-<span class="sourceLineNo">659</span> public RestResponse setHtmlStyle(Object value) {<a name="line.659"></a>
-<span class="sourceLineNo">660</span> properties.put(HtmlDocSerializerContext.HTMLDOC_style, value);<a name="line.660"></a>
-<span class="sourceLineNo">661</span> return this;<a name="line.661"></a>
-<span class="sourceLineNo">662</span> }<a name="line.662"></a>
-<span class="sourceLineNo">663</span><a name="line.663"></a>
-<span class="sourceLineNo">664</span> /**<a name="line.664"></a>
-<span class="sourceLineNo">665</span> * Sets the CSS URL in the HTML CSS style section.<a name="line.665"></a>
-<span class="sourceLineNo">666</span> *<a name="line.666"></a>
-<span class="sourceLineNo">667</span> * <p><a name="line.667"></a>
-<span class="sourceLineNo">668</span> * The format of this value is a comma-delimited list of URLs.<a name="line.668"></a>
-<span class="sourceLineNo">669</span> *<a name="line.669"></a>
-<span class="sourceLineNo">670</span> * <p><a name="line.670"></a>
-<span class="sourceLineNo">671</span> * Specifies the URL to the stylesheet to add as a link in the style tag in the header.<a name="line.671"></a>
-<span class="sourceLineNo">672</span> *<a name="line.672"></a>
-<span class="sourceLineNo">673</span> * <p><a name="line.673"></a>
-<span class="sourceLineNo">674</span> * The format of this value is CSS.<a name="line.674"></a>
-<span class="sourceLineNo">675</span> *<a name="line.675"></a>
-<span class="sourceLineNo">676</span> * <p><a name="line.676"></a>
-<span class="sourceLineNo">677</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined<a name="line.677"></a>
-<span class="sourceLineNo">678</span> * by {@link UriResolver}.<a name="line.678"></a>
-<span class="sourceLineNo">679</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.679"></a>
-<span class="sourceLineNo">680</span> *<a name="line.680"></a>
-<span class="sourceLineNo">681</span> * <p><a name="line.681"></a>
-<span class="sourceLineNo">682</span> * This is the programmatic equivalent to the {@link HtmlDoc#stylesheet() @HtmlDoc.stylesheet()} annotation.<a name="line.682"></a>
-<span class="sourceLineNo">683</span> *<a name="line.683"></a>
-<span class="sourceLineNo">684</span> * @param value<a name="line.684"></a>
-<span class="sourceLineNo">685</span> * The CSS URL in the HTML CSS style section.<a name="line.685"></a>
-<span class="sourceLineNo">686</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.686"></a>
-<span class="sourceLineNo">687</span> * <p><a name="line.687"></a>
-<span class="sourceLineNo">688</span> * <ul class='doctree'><a name="line.688"></a>
-<span class="sourceLineNo">689</span> * <li class='info'><a name="line.689"></a>
-<span class="sourceLineNo">690</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.690"></a>
-<span class="sourceLineNo">691</span> * waste string concatenation cycles on non-HTML views.<a name="line.691"></a>
-<span class="sourceLineNo">692</span> * </ul><a name="line.692"></a>
-<span class="sourceLineNo">693</span> * @return This object (for method chaining).<a name="line.693"></a>
-<span class="sourceLineNo">694</span> */<a name="line.694"></a>
-<span class="sourceLineNo">695</span> public RestResponse setHtmlStylesheet(Object value) {<a name="line.695"></a>
-<span class="sourceLineNo">696</span> properties.put(HtmlDocSerializerContext.HTMLDOC_stylesheet, value);<a name="line.696"></a>
-<span class="sourceLineNo">697</span> return this;<a name="line.697"></a>
-<span class="sourceLineNo">698</span> }<a name="line.698"></a>
-<span class="sourceLineNo">699</span><a name="line.699"></a>
-<span class="sourceLineNo">700</span> /**<a name="line.700"></a>
-<span class="sourceLineNo">701</span> * Sets the HTML script section contents.<a name="line.701"></a>
-<span class="sourceLineNo">702</span> *<a name="line.702"></a>
-<span class="sourceLineNo">703</span> * <p><a name="line.703"></a>
-<span class="sourceLineNo">704</span> * The format of this value is Javascript.<a name="line.704"></a>
-<span class="sourceLineNo">705</span> *<a name="line.705"></a>
-<span class="sourceLineNo">706</span> * <p><a name="line.706"></a>
-<span class="sourceLineNo">707</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.707"></a>
-<span class="sourceLineNo">708</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.708"></a>
-<span class="sourceLineNo">709</span> *<a name="line.709"></a>
-<span class="sourceLineNo">710</span> * <p><a name="line.710"></a>
-<span class="sourceLineNo">711</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.711"></a>
-<span class="sourceLineNo">712</span> *<a name="line.712"></a>
-<span class="sourceLineNo">713</span> * <p><a name="line.713"></a>
-<span class="sourceLineNo">714</span> * This is the programmatic equivalent to the {@link HtmlDoc#script() @HtmlDoc.script()} annotation.<a name="line.714"></a>
-<span class="sourceLineNo">715</span> *<a name="line.715"></a>
-<span class="sourceLineNo">716</span> * @param value<a name="line.716"></a>
-<span class="sourceLineNo">717</span> * The HTML script section contents.<a name="line.717"></a>
-<span class="sourceLineNo">718</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.718"></a>
-<span class="sourceLineNo">719</span> * <p><a name="line.719"></a>
-<span class="sourceLineNo">720</span> * <ul class='doctree'><a name="line.720"></a>
-<span class="sourceLineNo">721</span> * <li class='info'><a name="line.721"></a>
-<span class="sourceLineNo">722</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.722"></a>
-<span class="sourceLineNo">723</span> * waste string concatenation cycles on non-HTML views.<a name="line.723"></a>
-<span class="sourceLineNo">724</span> * </ul><a name="line.724"></a>
-<span class="sourceLineNo">725</span> * @return This object (for method chaining).<a name="line.725"></a>
-<span class="sourceLineNo">726</span> */<a name="line.726"></a>
-<span class="sourceLineNo">727</span> public RestResponse setHtmlScript(Object value) {<a name="line.727"></a>
-<span class="sourceLineNo">728</span> properties.put(HtmlDocSerializerContext.HTMLDOC_script, value);<a name="line.728"></a>
-<span class="sourceLineNo">729</span> return this;<a name="line.729"></a>
-<span class="sourceLineNo">730</span> }<a name="line.730"></a>
-<span class="sourceLineNo">731</span><a name="line.731"></a>
-<span class="sourceLineNo">732</span> /**<a name="line.732"></a>
-<span class="sourceLineNo">733</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.733"></a>
-<span class="sourceLineNo">734</span> *<a name="line.734"></a>
-<span class="sourceLineNo">735</span> * <p><a name="line.735"></a>
-<span class="sourceLineNo">736</span> * This is the programmatic equivalent to the {@link HtmlDoc#nowrap() @HtmlDoc.nowrap()} annotation.<a name="line.736"></a>
-<span class="sourceLineNo">737</span> *<a name="line.737"></a>
-<span class="sourceLineNo">738</span> * @param value The new nowrap setting.<a name="line.738"></a>
-<span class="sourceLineNo">739</span> * @return This object (for method chaining).<a name="line.739"></a>
-<span class="sourceLineNo">740</span> */<a name="line.740"></a>
-<span class="sourceLineNo">741</span> public RestResponse setHtmlNoWrap(boolean value) {<a name="line.741"></a>
-<span class="sourceLineNo">742</span> properties.put(HtmlDocSerializerContext.HTMLDOC_nowrap, value);<a name="line.742"></a>
-<span class="sourceLineNo">743</span> return this;<a name="line.743"></a>
-<span class="sourceLineNo">744</span> }<a name="line.744"></a>
-<span class="sourceLineNo">745</span><a name="line.745"></a>
-<span class="sourceLineNo">746</span> /**<a name="line.746"></a>
-<span class="sourceLineNo">747</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.747"></a>
-<span class="sourceLineNo">748</span> *<a name="line.748"></a>
-<span class="sourceLineNo">749</span> * <p><a name="line.749"></a>
-<span class="sourceLineNo">750</span> * This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()}<a name="line.750"></a>
-<span class="sourceLineNo">751</span> * annotation.<a name="line.751"></a>
-<span class="sourceLineNo">752</span> *<a name="line.752"></a>
-<span class="sourceLineNo">753</span> * @param value The text to display when serializing an empty array or collection.<a name="line.753"></a>
-<span class="sourceLineNo">754</span> * @return This object (for method chaining).<a name="line.754"></a>
-<span class="sourceLineNo">755</span> */<a name="line.755"></a>
-<span class="sourceLineNo">756</span> public RestResponse setHtmlNoResultsMessage(Object value) {<a name="line.756"></a>
-<span class="sourceLineNo">757</span> properties.put(HtmlDocSerializerContext.HTMLDOC_noResultsMessage, value);<a name="line.757"></a>
-<span class="sourceLineNo">758</span> return this;<a name="line.758"></a>
-<span class="sourceLineNo">759</span> }<a name="line.759"></a>
-<span class="sourceLineNo">760</span><a name="line.760"></a>
-<span class="sourceLineNo">761</span> /**<a name="line.761"></a>
-<span class="sourceLineNo">762</span> * Specifies the template class to use for rendering the HTML page.<a name="line.762"></a>
-<span class="sourceLineNo">763</span> *<a name="line.763"></a>
-<span class="sourceLineNo">764</span> * <p><a name="line.764"></a>
-<span class="sourceLineNo">765</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.765"></a>
-<span class="sourceLineNo">766</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.766"></a>
-<span class="sourceLineNo">767</span> *<a name="line.767"></a>
-<span class="sourceLineNo">768</span> * <p><a name="line.768"></a>
-<span class="sourceLineNo">769</span> * This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.<a name="line.769"></a>
-<span class="sourceLineNo">770</span> *<a name="line.770"></a>
-<span class="sourceLineNo">771</span> * @param value The HTML page template to use to render the HTML page.<a name="line.771"></a>
-<span class="sourceLineNo">772</span> * @return This object (for method chaining).<a name="line.772"></a>
-<span class="sourceLineNo">773</span> */<a name="line.773"></a>
-<span class="sourceLineNo">774</span> public RestResponse setHtmlTemplate(Class<? extends HtmlDocTemplate> value) {<a name="line.774"></a>
-<span class="sourceLineNo">775</span> properties.put(HtmlDocSerializerContext.HTMLDOC_template, value);<a name="line.775"></a>
-<span class="sourceLineNo">776</span> return this;<a name="line.776"></a>
-<span class="sourceLineNo">777</span> }<a name="line.777"></a>
-<span class="sourceLineNo">778</span><a name="line.778"></a>
-<span class="sourceLineNo">779</span> /**<a name="line.779"></a>
-<span class="sourceLineNo">780</span> * Specifies the template class to use for rendering the HTML page.<a name="line.780"></a>
-<span class="sourceLineNo">781</span> *<a name="line.781"></a>
-<span class="sourceLineNo">782</span> * <p><a name="line.782"></a>
-<span class="sourceLineNo">783</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.783"></a>
-<span class="sourceLineNo">784</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.784"></a>
-<span class="sourceLineNo">785</span> *<a name="line.785"></a>
-<span class="sourceLineNo">786</span> * <p><a name="line.786"></a>
-<span class="sourceLineNo">787</span> * This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.<a name="line.787"></a>
-<span class="sourceLineNo">788</span> *<a name="line.788"></a>
-<span class="sourceLineNo">789</span> * @param value The HTML page template to use to render the HTML page.<a name="line.789"></a>
-<span class="sourceLineNo">790</span> * @return This object (for method chaining).<a name="line.790"></a>
-<span class="sourceLineNo">791</span> */<a name="line.791"></a>
-<span class="sourceLineNo">792</span> public RestResponse setHtmlTemplate(HtmlDocTemplate value) {<a name="line.792"></a>
-<span class="sourceLineNo">793</span> properties.put(HtmlDocSerializerContext.HTMLDOC_template, value);<a name="line.793"></a>
-<span class="sourceLineNo">794</span> return this;<a name="line.794"></a>
-<span class="sourceLineNo">795</span> }<a name="line.795"></a>
-<span class="sourceLineNo">796</span><a name="line.796"></a>
-<span class="sourceLineNo">797</span> @Override /* ServletResponse */<a name="line.797"></a>
-<span class="sourceLineNo">798</span> public void flushBuffer() throws IOException {<a name="line.798"></a>
-<span class="sourceLineNo">799</span> if (w != null)<a name="line.799"></a>
-<span class="sourceLineNo">800</span> w.flush();<a name="line.800"></a>
-<span class="sourceLineNo">801</span> if (os != null)<a name="line.801"></a>
-<span class="sourceLineNo">802</span> os.flush();<a name="line.802"></a>
-<span class="sourceLineNo">803</span> super.flushBuffer();<a name="line.803"></a>
-<span class="sourceLineNo">804</span> }<a name="line.804"></a>
-<span class="sourceLineNo">805</span>}<a name="line.805"></a>
+<span class="sourceLineNo">026</span>import org.apache.juneau.json.*;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.juneau.parser.*;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.juneau.rest.annotation.*;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.juneau.serializer.*;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import org.apache.juneau.urlencoding.*;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.juneau.utils.*;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.juneau.xml.*;<a name="line.32"></a>
+<span class="sourceLineNo">033</span><a name="line.33"></a>
+<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * Represents an HTTP response for a REST resource.<a name="line.35"></a>
+<span class="sourceLineNo">036</span> *<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * <p><a name="line.37"></a>
+<span class="sourceLineNo">038</span> * Essentially an extended {@link HttpServletResponse} with some special convenience methods that allow you to easily<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * output POJOs as responses.<a name="line.39"></a>
+<span class="sourceLineNo">040</span> *<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * <p><a name="line.41"></a>
+<span class="sourceLineNo">042</span> * Since this class extends {@link HttpServletResponse}, developers are free to use these convenience methods, or<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * revert to using lower level methods like any other servlet response.<a name="line.43"></a>
+<span class="sourceLineNo">044</span> *<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * <h5 class='section'>Example:</h5><a name="line.45"></a>
+<span class="sourceLineNo">046</span> * <p class='bcode'><a name="line.46"></a>
+<span class="sourceLineNo">047</span> * <ja>@RestMethod</ja>(name=<js>"GET"</js>)<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * <jk>public void</jk> doGet(RestRequest req, RestResponse res) {<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * res.setPageTitle(<js>"My title"</js>)<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * .setOutput(<js>"Simple string response"</js>);<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * }<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * </p><a name="line.52"></a>
+<span class="sourceLineNo">053</span> *<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * <p><a name="line.54"></a>
+<span class="sourceLineNo">055</span> * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * class.<a name="line.56"></a>
+<span class="sourceLineNo">057</span> */<a name="line.57"></a>
+<span class="sourceLineNo">058</span>public final class RestResponse extends HttpServletResponseWrapper {<a name="line.58"></a>
+<span class="sourceLineNo">059</span><a name="line.59"></a>
+<span class="sourceLineNo">060</span> private final RestRequest request;<a name="line.60"></a>
+<span class="sourceLineNo">061</span> private Object output; // The POJO being sent to the output.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> private boolean isNullOutput; // The output is null (as opposed to not being set at all)<a name="line.62"></a>
+<span class="sourceLineNo">063</span> private ObjectMap properties; // Response properties<a name="line.63"></a>
+<span class="sourceLineNo">064</span> SerializerGroup serializerGroup;<a name="line.64"></a>
+<span class="sourceLineNo">065</span> UrlEncodingSerializer urlEncodingSerializer; // The serializer used to convert arguments passed into Redirect objects.<a name="line.65"></a>
+<span class="sourceLineNo">066</span> private EncoderGroup encoders;<a name="line.66"></a>
+<span class="sourceLineNo">067</span> private ServletOutputStream os;<a name="line.67"></a>
+<span class="sourceLineNo">068</span> private PrintWriter w;<a name="line.68"></a>
+<span class="sourceLineNo">069</span><a name="line.69"></a>
+<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * Constructor.<a name="line.71"></a>
+<span class="sourceLineNo">072</span> */<a name="line.72"></a>
+<span class="sourceLineNo">073</span> RestResponse(RestContext context, RestRequest req, HttpServletResponse res) {<a name="line.73"></a>
+<span class="sourceLineNo">074</span> super(res);<a name="line.74"></a>
+<span class="sourceLineNo">075</span> this.request = req;<a name="line.75"></a>
+<span class="sourceLineNo">076</span><a name="line.76"></a>
+<span class="sourceLineNo">077</span> for (Map.Entry<String,Object> e : context.getDefaultResponseHeaders().entrySet())<a name="line.77"></a>
+<span class="sourceLineNo">078</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.78"></a>
+<span class="sourceLineNo">079</span><a name="line.79"></a>
+<span class="sourceLineNo">080</span> try {<a name="line.80"></a>
+<span class="sourceLineNo">081</span> String passThroughHeaders = req.getHeader("x-response-headers");<a name="line.81"></a>
+<span class="sourceLineNo">082</span> if (passThroughHeaders != null) {<a name="line.82"></a>
+<span class="sourceLineNo">083</span> PartParser p = context.getUrlEncodingParser();<a name="line.83"></a>
+<span class="sourceLineNo">084</span> ObjectMap m = p.parse(PartType.HEADER, passThroughHeaders, context.getBeanContext().getClassMeta(ObjectMap.class));<a name="line.84"></a>
+<span class="sourceLineNo">085</span> for (Map.Entry<String,Object> e : m.entrySet())<a name="line.85"></a>
+<span class="sourceLineNo">086</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.86"></a>
+<span class="sourceLineNo">087</span> }<a name="line.87"></a>
+<span class="sourceLineNo">088</span> } catch (Exception e1) {<a name="line.88"></a>
+<span class="sourceLineNo">089</span> throw new RestException(SC_BAD_REQUEST, "Invalid format for header 'x-response-headers'. Must be in URL-encoded format.").initCause(e1);<a name="line.89"></a>
+<span class="sourceLineNo">090</span> }<a name="line.90"></a>
+<span class="sourceLineNo">091</span> }<a name="line.91"></a>
+<span class="sourceLineNo">092</span><a name="line.92"></a>
+<span class="sourceLineNo">093</span> /*<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * Called from RestServlet after a match has been made but before the guard or method invocation.<a name="line.94"></a>
+<span class="sourceLineNo">095</span> */<a name="line.95"></a>
+<span class="sourceLineNo">096</span> @SuppressWarnings("hiding")<a name="line.96"></a>
+<span class="sourceLineNo">097</span> final void init(ObjectMap properties, String defaultCharset, SerializerGroup mSerializers, UrlEncodingSerializer mUrlEncodingSerializer, EncoderGroup encoders) {<a name="line.97"></a>
+<span class="sourceLineNo">098</span> this.properties = properties;<a name="line.98"></a>
+<span class="sourceLineNo">099</span> this.serializerGroup = mSerializers;<a name="line.99"></a>
+<span class="sourceLineNo">100</span> this.urlEncodingSerializer = mUrlEncodingSerializer;<a name="line.100"></a>
+<span class="sourceLineNo">101</span> this.encoders = encoders;<a name="line.101"></a>
+<span class="sourceLineNo">102</span><a name="line.102"></a>
+<span class="sourceLineNo">103</span> // Find acceptable charset<a name="line.103"></a>
+<span class="sourceLineNo">104</span> String h = request.getHeader("accept-charset");<a name="line.104"></a>
+<span class="sourceLineNo">105</span> String charset = null;<a name="line.105"></a>
+<span class="sourceLineNo">106</span> if (h == null)<a name="line.106"></a>
+<span class="sourceLineNo">107</span> charset = defaultCharset;<a name="line.107"></a>
+<span class="sourceLineNo">108</span> else for (MediaTypeRange r : MediaTypeRange.parse(h)) {<a name="line.108"></a>
+<span class="sourceLineNo">109</span> if (r.getQValue() > 0) {<a name="line.109"></a>
+<span class="sourceLineNo">110</span> MediaType mt = r.getMediaType();<a name="line.110"></a>
+<span class="sourceLineNo">111</span> if (mt.getType().equals("*"))<a name="line.111"></a>
+<span class="sourceLineNo">112</span> charset = defaultCharset;<a name="line.112"></a>
+<span class="sourceLineNo">113</span> else if (Charset.isSupported(mt.getType()))<a name="line.113"></a>
+<span class="sourceLineNo">114</span> charset = mt.getType();<a name="line.114"></a>
+<span class="sourceLineNo">115</span> if (charset != null)<a name="line.115"></a>
+<span class="sourceLineNo">116</span> break;<a name="line.116"></a>
+<span class="sourceLineNo">117</span> }<a name="line.117"></a>
+<span class="sourceLineNo">118</span> }<a name="line.118"></a>
+<span class="sourceLineNo">119</span><a name="line.119"></a>
+<span class="sourceLineNo">120</span> if (charset == null)<a name="line.120"></a>
+<span class="sourceLineNo">121</span> throw new RestException(SC_NOT_ACCEPTABLE, "No supported charsets in header ''Accept-Charset'': ''{0}''", request.getHeader("Accept-Charset"));<a name="line.121"></a>
+<span class="sourceLineNo">122</span> super.setCharacterEncoding(charset);<a name="line.122"></a>
+<span class="sourceLineNo">123</span> }<a name="line.123"></a>
+<span class="sourceLineNo">124</span><a name="line.124"></a>
+<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * Gets the serializer group for the response.<a name="line.126"></a>
+<span class="sourceLineNo">127</span> *<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * @return The serializer group for the response.<a name="line.128"></a>
+<span class="sourceLineNo">129</span> */<a name="line.129"></a>
+<span class="sourceLineNo">130</span> public SerializerGroup getSerializerGroup() {<a name="line.130"></a>
+<span class="sourceLineNo">131</span> return serializerGroup;<a name="line.131"></a>
+<span class="sourceLineNo">132</span> }<a name="line.132"></a>
+<span class="sourceLineNo">133</span><a name="line.133"></a>
+<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * Returns the media types that are valid for <code>Accept</code> headers on the request.<a name="line.135"></a>
+<span class="sourceLineNo">136</span> *<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * @return The set of media types registered in the parser group of this request.<a name="line.137"></a>
+<span class="sourceLineNo">138</span> */<a name="line.138"></a>
+<span class="sourceLineNo">139</span> public List<MediaType> getSupportedMediaTypes() {<a name="line.139"></a>
+<span class="sourceLineNo">140</span> return serializerGroup.getSupportedMediaTypes();<a name="line.140"></a>
+<span class="sourceLineNo">141</span> }<a name="line.141"></a>
+<span class="sourceLineNo">142</span><a name="line.142"></a>
+<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * the request.<a name="line.145"></a>
+<span class="sourceLineNo">146</span> *<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * @return The set of media types registered in the parser group of this request.<a name="l
<TRUNCATED>