http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/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 9607459..2022dd3 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 @@ -69,423 +69,436 @@ <span class="sourceLineNo">061</span> UrlEncodingSerializer urlEncodingSerializer; // The serializer used to convert arguments passed into Redirect objects.<a name="line.61"></a> <span class="sourceLineNo">062</span> private EncoderGroup encoders;<a name="line.62"></a> <span class="sourceLineNo">063</span> private ServletOutputStream os;<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> /**<a name="line.65"></a> -<span class="sourceLineNo">066</span> * Constructor.<a name="line.66"></a> -<span class="sourceLineNo">067</span> */<a name="line.67"></a> -<span class="sourceLineNo">068</span> RestResponse(RestContext context, RestRequest req, HttpServletResponse res) {<a name="line.68"></a> -<span class="sourceLineNo">069</span> super(res);<a name="line.69"></a> -<span class="sourceLineNo">070</span> this.request = req;<a name="line.70"></a> -<span class="sourceLineNo">071</span><a name="line.71"></a> -<span class="sourceLineNo">072</span> for (Map.Entry<String,Object> e : context.getDefaultResponseHeaders().entrySet())<a name="line.72"></a> -<span class="sourceLineNo">073</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.73"></a> -<span class="sourceLineNo">074</span><a name="line.74"></a> -<span class="sourceLineNo">075</span> try {<a name="line.75"></a> -<span class="sourceLineNo">076</span> String passThroughHeaders = req.getHeader("x-response-headers");<a name="line.76"></a> -<span class="sourceLineNo">077</span> if (passThroughHeaders != null) {<a name="line.77"></a> -<span class="sourceLineNo">078</span> UrlEncodingParser p = context.getUrlEncodingParser();<a name="line.78"></a> -<span class="sourceLineNo">079</span> ObjectMap m = p.parsePart(passThroughHeaders, p.getBeanContext().getClassMeta(ObjectMap.class));<a name="line.79"></a> -<span class="sourceLineNo">080</span> for (Map.Entry<String,Object> e : m.entrySet())<a name="line.80"></a> -<span class="sourceLineNo">081</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.81"></a> -<span class="sourceLineNo">082</span> }<a name="line.82"></a> -<span class="sourceLineNo">083</span> } catch (Exception e1) {<a name="line.83"></a> -<span class="sourceLineNo">084</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.84"></a> -<span class="sourceLineNo">085</span> }<a name="line.85"></a> -<span class="sourceLineNo">086</span> }<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /*<a name="line.88"></a> -<span class="sourceLineNo">089</span> * Called from RestServlet after a match has been made but before the guard or method invocation.<a name="line.89"></a> -<span class="sourceLineNo">090</span> */<a name="line.90"></a> -<span class="sourceLineNo">091</span> @SuppressWarnings("hiding")<a name="line.91"></a> -<span class="sourceLineNo">092</span> final void init(ObjectMap properties, String defaultCharset, SerializerGroup mSerializers, UrlEncodingSerializer mUrlEncodingSerializer, EncoderGroup encoders) {<a name="line.92"></a> -<span class="sourceLineNo">093</span> this.properties = properties;<a name="line.93"></a> -<span class="sourceLineNo">094</span> this.serializerGroup = mSerializers;<a name="line.94"></a> -<span class="sourceLineNo">095</span> this.urlEncodingSerializer = mUrlEncodingSerializer;<a name="line.95"></a> -<span class="sourceLineNo">096</span> this.encoders = encoders;<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> // Find acceptable charset<a name="line.98"></a> -<span class="sourceLineNo">099</span> String h = request.getHeader("accept-charset");<a name="line.99"></a> -<span class="sourceLineNo">100</span> String charset = null;<a name="line.100"></a> -<span class="sourceLineNo">101</span> if (h == null)<a name="line.101"></a> -<span class="sourceLineNo">102</span> charset = defaultCharset;<a name="line.102"></a> -<span class="sourceLineNo">103</span> else for (MediaTypeRange r : MediaTypeRange.parse(h)) {<a name="line.103"></a> -<span class="sourceLineNo">104</span> if (r.getQValue() > 0) {<a name="line.104"></a> -<span class="sourceLineNo">105</span> MediaType mt = r.getMediaType();<a name="line.105"></a> -<span class="sourceLineNo">106</span> if (mt.getType().equals("*"))<a name="line.106"></a> -<span class="sourceLineNo">107</span> charset = defaultCharset;<a name="line.107"></a> -<span class="sourceLineNo">108</span> else if (Charset.isSupported(mt.getType()))<a name="line.108"></a> -<span class="sourceLineNo">109</span> charset = mt.getType();<a name="line.109"></a> -<span class="sourceLineNo">110</span> if (charset != null)<a name="line.110"></a> -<span class="sourceLineNo">111</span> break;<a name="line.111"></a> -<span class="sourceLineNo">112</span> }<a name="line.112"></a> -<span class="sourceLineNo">113</span> }<a name="line.113"></a> -<span class="sourceLineNo">114</span><a name="line.114"></a> -<span class="sourceLineNo">115</span> if (charset == null)<a name="line.115"></a> -<span class="sourceLineNo">116</span> throw new RestException(SC_NOT_ACCEPTABLE, "No supported charsets in header ''Accept-Charset'': ''{0}''", request.getHeader("Accept-Charset"));<a name="line.116"></a> -<span class="sourceLineNo">117</span> super.setCharacterEncoding(charset);<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> * Gets the serializer group for the response.<a name="line.121"></a> -<span class="sourceLineNo">122</span> *<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @return The serializer group for the response.<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> public SerializerGroup getSerializerGroup() {<a name="line.125"></a> -<span class="sourceLineNo">126</span> return serializerGroup;<a name="line.126"></a> -<span class="sourceLineNo">127</span> }<a name="line.127"></a> -<span class="sourceLineNo">128</span><a name="line.128"></a> -<span class="sourceLineNo">129</span> /**<a name="line.129"></a> -<span class="sourceLineNo">130</span> * Returns the media types that are valid for <code>Accept</code> headers on the request.<a name="line.130"></a> -<span class="sourceLineNo">131</span> *<a name="line.131"></a> -<span class="sourceLineNo">132</span> * @return The set of media types registered in the parser group of this request.<a name="line.132"></a> -<span class="sourceLineNo">133</span> */<a name="line.133"></a> -<span class="sourceLineNo">134</span> public List<MediaType> getSupportedMediaTypes() {<a name="line.134"></a> -<span class="sourceLineNo">135</span> return serializerGroup.getSupportedMediaTypes();<a name="line.135"></a> -<span class="sourceLineNo">136</span> }<a name="line.136"></a> -<span class="sourceLineNo">137</span><a name="line.137"></a> -<span class="sourceLineNo">138</span> /**<a name="line.138"></a> -<span class="sourceLineNo">139</span> * Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on the request.<a name="line.139"></a> -<span class="sourceLineNo">140</span> *<a name="line.140"></a> -<span class="sourceLineNo">141</span> * @return The set of media types registered in the parser group of this request.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @throws RestServletException<a name="line.142"></a> -<span class="sourceLineNo">143</span> */<a name="line.143"></a> -<span class="sourceLineNo">144</span> public List<String> getSupportedEncodings() throws RestServletException {<a name="line.144"></a> -<span class="sourceLineNo">145</span> return encoders.getSupportedEncodings();<a name="line.145"></a> -<span class="sourceLineNo">146</span> }<a name="line.146"></a> -<span class="sourceLineNo">147</span><a name="line.147"></a> -<span class="sourceLineNo">148</span> /**<a name="line.148"></a> -<span class="sourceLineNo">149</span> * Sets the HTTP output on the response.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * <p><a name="line.150"></a> -<span class="sourceLineNo">151</span> * Calling this method is functionally equivalent to returning the object in the REST Java method.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * <p><a name="line.152"></a> -<span class="sourceLineNo">153</span> * Can be of any of the following types:<a name="line.153"></a> -<span class="sourceLineNo">154</span> * <ul><a name="line.154"></a> -<span class="sourceLineNo">155</span> * <li> {@link InputStream}<a name="line.155"></a> -<span class="sourceLineNo">156</span> * <li> {@link Reader}<a name="line.156"></a> -<span class="sourceLineNo">157</span> * <li> Any serializable type defined in <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a><a name="line.157"></a> -<span class="sourceLineNo">158</span> * </ul><a name="line.158"></a> -<span class="sourceLineNo">159</span> * <p><a name="line.159"></a> -<span class="sourceLineNo">160</span> * If it's an {@link InputStream} or {@link Reader}, you must also specify the <code>Content-Type</code> using the {@link #setContentType(String)} method.<a name="line.160"></a> -<span class="sourceLineNo">161</span> *<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @param output The output to serialize to the connection.<a name="line.162"></a> -<span class="sourceLineNo">163</span> * @return This object (for method chaining).<a name="line.163"></a> -<span class="sourceLineNo">164</span> */<a name="line.164"></a> -<span class="sourceLineNo">165</span> public RestResponse setOutput(Object output) {<a name="line.165"></a> -<span class="sourceLineNo">166</span> this.output = output;<a name="line.166"></a> -<span class="sourceLineNo">167</span> this.isNullOutput = output == null;<a name="line.167"></a> -<span class="sourceLineNo">168</span> return this;<a name="line.168"></a> -<span class="sourceLineNo">169</span> }<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> /**<a name="line.171"></a> -<span class="sourceLineNo">172</span> * Add a serializer property to send to the serializers to override a default value.<a name="line.172"></a> -<span class="sourceLineNo">173</span> * <p><a name="line.173"></a> -<span class="sourceLineNo">174</span> * Can be any value specified in the following classes:<a name="line.174"></a> -<span class="sourceLineNo">175</span> * <ul><a name="line.175"></a> -<span class="sourceLineNo">176</span> * <li>{@link SerializerContext}<a name="line.176"></a> -<span class="sourceLineNo">177</span> * <li>{@link JsonSerializerContext}<a name="line.177"></a> -<span class="sourceLineNo">178</span> * <li>{@link XmlSerializerContext}<a name="line.178"></a> -<span class="sourceLineNo">179</span> * <li>{@link RdfSerializerContext}<a name="line.179"></a> -<span class="sourceLineNo">180</span> * </ul><a name="line.180"></a> -<span class="sourceLineNo">181</span> *<a name="line.181"></a> -<span class="sourceLineNo">182</span> * @param key The setting name.<a name="line.182"></a> -<span class="sourceLineNo">183</span> * @param value The setting value.<a name="line.183"></a> -<span class="sourceLineNo">184</span> * @return This object (for method chaining).<a name="line.184"></a> -<span class="sourceLineNo">185</span> */<a name="line.185"></a> -<span class="sourceLineNo">186</span> public RestResponse setProperty(String key, Object value) {<a name="line.186"></a> -<span class="sourceLineNo">187</span> properties.put(key, value);<a name="line.187"></a> -<span class="sourceLineNo">188</span> return this;<a name="line.188"></a> -<span class="sourceLineNo">189</span> }<a name="line.189"></a> -<span class="sourceLineNo">190</span><a name="line.190"></a> -<span class="sourceLineNo">191</span> /**<a name="line.191"></a> -<span class="sourceLineNo">192</span> * Returns the properties set via {@link #setProperty(String, Object)}.<a name="line.192"></a> -<span class="sourceLineNo">193</span> *<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @return A map of all the property values set.<a name="line.194"></a> -<span class="sourceLineNo">195</span> */<a name="line.195"></a> -<span class="sourceLineNo">196</span> public ObjectMap getProperties() {<a name="line.196"></a> -<span class="sourceLineNo">197</span> return properties;<a name="line.197"></a> -<span class="sourceLineNo">198</span> }<a name="line.198"></a> -<span class="sourceLineNo">199</span><a name="line.199"></a> -<span class="sourceLineNo">200</span> /**<a name="line.200"></a> -<span class="sourceLineNo">201</span> * Shortcut method that allows you to use varargs to simplify setting array output.<a name="line.201"></a> -<span class="sourceLineNo">202</span> *<a name="line.202"></a> -<span class="sourceLineNo">203</span> * <h5 class='section'>Example:</h5><a name="line.203"></a> -<span class="sourceLineNo">204</span> * <p class='bcode'><a name="line.204"></a> -<span class="sourceLineNo">205</span> * <jc>// Instead of...</jc><a name="line.205"></a> -<span class="sourceLineNo">206</span> * response.setOutput(<jk>new</jk> Object[]{x,y,z});<a name="line.206"></a> -<span class="sourceLineNo">207</span> *<a name="line.207"></a> -<span class="sourceLineNo">208</span> * <jc>// ...call this...</jc><a name="line.208"></a> -<span class="sourceLineNo">209</span> * response.setOutput(x,y,z);<a name="line.209"></a> -<span class="sourceLineNo">210</span> * </p><a name="line.210"></a> -<span class="sourceLineNo">211</span> *<a name="line.211"></a> -<span class="sourceLineNo">212</span> * @param output The output to serialize to the connection.<a name="line.212"></a> -<span class="sourceLineNo">213</span> * @return This object (for method chaining).<a name="line.213"></a> -<span class="sourceLineNo">214</span> */<a name="line.214"></a> -<span class="sourceLineNo">215</span> public RestResponse setOutputs(Object...output) {<a name="line.215"></a> -<span class="sourceLineNo">216</span> this.output = output;<a name="line.216"></a> -<span class="sourceLineNo">217</span> return this;<a name="line.217"></a> -<span class="sourceLineNo">218</span> }<a name="line.218"></a> -<span class="sourceLineNo">219</span><a name="line.219"></a> -<span class="sourceLineNo">220</span> /**<a name="line.220"></a> -<span class="sourceLineNo">221</span> * Returns the output that was set by calling {@link #setOutput(Object)}.<a name="line.221"></a> -<span class="sourceLineNo">222</span> *<a name="line.222"></a> -<span class="sourceLineNo">223</span> * @return The output object.<a name="line.223"></a> -<span class="sourceLineNo">224</span> */<a name="line.224"></a> -<span class="sourceLineNo">225</span> public Object getOutput() {<a name="line.225"></a> -<span class="sourceLineNo">226</span> return output;<a name="line.226"></a> -<span class="sourceLineNo">227</span> }<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> /**<a name="line.229"></a> -<span class="sourceLineNo">230</span> * Returns <jk>true</jk> if this response has any output associated with it.<a name="line.230"></a> -<span class="sourceLineNo">231</span> *<a name="line.231"></a> -<span class="sourceLineNo">232</span> * @return <jk>true</jk> if {@code setInput()} has been called.<a name="line.232"></a> -<span class="sourceLineNo">233</span> */<a name="line.233"></a> -<span class="sourceLineNo">234</span> public boolean hasOutput() {<a name="line.234"></a> -<span class="sourceLineNo">235</span> return output != null || isNullOutput;<a name="line.235"></a> -<span class="sourceLineNo">236</span> }<a name="line.236"></a> -<span class="sourceLineNo">237</span><a name="line.237"></a> -<span class="sourceLineNo">238</span> /**<a name="line.238"></a> -<span class="sourceLineNo">239</span> * Sets the output to a plain-text message regardless of the content type.<a name="line.239"></a> -<span class="sourceLineNo">240</span> *<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @param text The output text to send.<a name="line.241"></a> -<span class="sourceLineNo">242</span> * @return This object (for method chaining).<a name="line.242"></a> -<span class="sourceLineNo">243</span> * @throws IOException If a problem occurred trying to write to the writer.<a name="line.243"></a> -<span class="sourceLineNo">244</span> */<a name="line.244"></a> -<span class="sourceLineNo">245</span> public RestResponse sendPlainText(String text) throws IOException {<a name="line.245"></a> -<span class="sourceLineNo">246</span> setContentType("text/plain");<a name="line.246"></a> -<span class="sourceLineNo">247</span> getNegotiatedWriter().write(text);<a name="line.247"></a> -<span class="sourceLineNo">248</span> return this;<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> * Equivalent to {@link HttpServletResponse#getOutputStream()}, except<a name="line.252"></a> -<span class="sourceLineNo">253</span> * wraps the output stream if an {@link Encoder} was found that matched<a name="line.253"></a> -<span class="sourceLineNo">254</span> * the <code>Accept-Encoding</code> header.<a name="line.254"></a> -<span class="sourceLineNo">255</span> *<a name="line.255"></a> -<span class="sourceLineNo">256</span> * @return A negotiated output stream.<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @throws IOException<a name="line.257"></a> -<span class="sourceLineNo">258</span> */<a name="line.258"></a> -<span class="sourceLineNo">259</span> public ServletOutputStream getNegotiatedOutputStream() throws IOException {<a name="line.259"></a> -<span class="sourceLineNo">260</span> if (os == null) {<a name="line.260"></a> -<span class="sourceLineNo">261</span> Encoder encoder = null;<a name="line.261"></a> -<span class="sourceLineNo">262</span><a name="line.262"></a> -<span class="sourceLineNo">263</span> String ae = request.getHeader("Accept-Encoding");<a name="line.263"></a> -<span class="sourceLineNo">264</span> if (! (ae == null || ae.isEmpty())) {<a name="line.264"></a> -<span class="sourceLineNo">265</span> EncoderMatch match = encoders != null ? encoders.getEncoderMatch(ae) : null;<a name="line.265"></a> -<span class="sourceLineNo">266</span> if (match == null) {<a name="line.266"></a> -<span class="sourceLineNo">267</span> // Identity should always match unless "identity;q=0" or "*;q=0" is specified.<a name="line.267"></a> -<span class="sourceLineNo">268</span> if (ae.matches(".*(identity|\\*)\\s*;\\s*q\\s*=\\s*(0(?!\\.)|0\\.0).*")) {<a name="line.268"></a> -<span class="sourceLineNo">269</span> throw new RestException(SC_NOT_ACCEPTABLE,<a name="line.269"></a> -<span class="sourceLineNo">270</span> "Unsupported encoding in request header ''Accept-Encoding'': ''{0}''\n\tSupported codings: {1}",<a name="line.270"></a> -<span class="sourceLineNo">271</span> ae, encoders.getSupportedEncodings()<a name="line.271"></a> -<span class="sourceLineNo">272</span> );<a name="line.272"></a> -<span class="sourceLineNo">273</span> }<a name="line.273"></a> -<span class="sourceLineNo">274</span> } else {<a name="line.274"></a> -<span class="sourceLineNo">275</span> encoder = match.getEncoder();<a name="line.275"></a> -<span class="sourceLineNo">276</span> String encoding = match.getEncoding().toString();<a name="line.276"></a> -<span class="sourceLineNo">277</span><a name="line.277"></a> -<span class="sourceLineNo">278</span> // Some clients don't recognize identity as an encoding, so don't set it.<a name="line.278"></a> -<span class="sourceLineNo">279</span> if (! encoding.equals("identity"))<a name="line.279"></a> -<span class="sourceLineNo">280</span> setHeader("content-encoding", encoding);<a name="line.280"></a> -<span class="sourceLineNo">281</span> }<a name="line.281"></a> -<span class="sourceLineNo">282</span> }<a name="line.282"></a> -<span class="sourceLineNo">283</span> os = getOutputStream();<a name="line.283"></a> -<span class="sourceLineNo">284</span> if (encoder != null) {<a name="line.284"></a> -<span class="sourceLineNo">285</span> final OutputStream os2 = encoder.getOutputStream(os);<a name="line.285"></a> -<span class="sourceLineNo">286</span> os = new ServletOutputStream(){<a name="line.286"></a> -<span class="sourceLineNo">287</span> @Override /* OutputStream */<a name="line.287"></a> -<span class="sourceLineNo">288</span> public final void write(byte[] b, int off, int len) throws IOException {<a name="line.288"></a> -<span class="sourceLineNo">289</span> os2.write(b, off, len);<a name="line.289"></a> -<span class="sourceLineNo">290</span> }<a name="line.290"></a> -<span class="sourceLineNo">291</span> @Override /* OutputStream */<a name="line.291"></a> -<span class="sourceLineNo">292</span> public final void write(int b) throws IOException {<a name="line.292"></a> -<span class="sourceLineNo">293</span> os2.write(b);<a name="line.293"></a> -<span class="sourceLineNo">294</span> }<a name="line.294"></a> -<span class="sourceLineNo">295</span> @Override /* OutputStream */<a name="line.295"></a> -<span class="sourceLineNo">296</span> public final void flush() throws IOException {<a name="line.296"></a> -<span class="sourceLineNo">297</span> os2.flush();<a name="line.297"></a> -<span class="sourceLineNo">298</span> }<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 close() throws IOException {<a name="line.300"></a> -<span class="sourceLineNo">301</span> os2.close();<a name="line.301"></a> -<span class="sourceLineNo">302</span> }<a name="line.302"></a> -<span class="sourceLineNo">303</span> };<a name="line.303"></a> -<span class="sourceLineNo">304</span> }<a name="line.304"></a> -<span class="sourceLineNo">305</span> }<a name="line.305"></a> -<span class="sourceLineNo">306</span> return os;<a name="line.306"></a> -<span class="sourceLineNo">307</span> }<a name="line.307"></a> -<span class="sourceLineNo">308</span><a name="line.308"></a> -<span class="sourceLineNo">309</span> @Override /* ServletResponse */<a name="line.309"></a> -<span class="sourceLineNo">310</span> public ServletOutputStream getOutputStream() throws IOException {<a name="line.310"></a> -<span class="sourceLineNo">311</span> if (os == null)<a name="line.311"></a> -<span class="sourceLineNo">312</span> os = super.getOutputStream();<a name="line.312"></a> -<span class="sourceLineNo">313</span> return os;<a name="line.313"></a> -<span class="sourceLineNo">314</span> }<a name="line.314"></a> -<span class="sourceLineNo">315</span><a name="line.315"></a> -<span class="sourceLineNo">316</span> /**<a name="line.316"></a> -<span class="sourceLineNo">317</span> * Returns <jk>true</jk> if {@link #getOutputStream()} has been called.<a name="line.317"></a> -<span class="sourceLineNo">318</span> *<a name="line.318"></a> -<span class="sourceLineNo">319</span> * @return <jk>true</jk> if {@link #getOutputStream()} has been called.<a name="line.319"></a> -<span class="sourceLineNo">320</span> */<a name="line.320"></a> -<span class="sourceLineNo">321</span> public boolean getOutputStreamCalled() {<a name="line.321"></a> -<span class="sourceLineNo">322</span> return os != null;<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> * Returns the writer to the response body.<a name="line.326"></a> -<span class="sourceLineNo">327</span> * This methods bypasses any specified encoders and returns a regular unbuffered writer.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * Use the {@link #getNegotiatedWriter()} method if you want to use the matched encoder (if any).<a name="line.328"></a> -<span class="sourceLineNo">329</span> */<a name="line.329"></a> -<span class="sourceLineNo">330</span> @Override /* ServletResponse */<a name="line.330"></a> -<span class="sourceLineNo">331</span> public PrintWriter getWriter() throws IOException {<a name="line.331"></a> -<span class="sourceLineNo">332</span> return getWriter(true);<a name="line.332"></a> -<span class="sourceLineNo">333</span> }<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> * Convenience method meant to be used when rendering directly to a browser with no buffering.<a name="line.336"></a> -<span class="sourceLineNo">337</span> * Sets the header <js>"x-content-type-options=nosniff"</js> so that output is rendered<a name="line.337"></a> -<span class="sourceLineNo">338</span> * immediately on IE and Chrome without any buffering for content-type sniffing.<a name="line.338"></a> -<span class="sourceLineNo">339</span> *<a name="line.339"></a> -<span class="sourceLineNo">340</span> * @param contentType The value to set as the <code>Content-Type</code> on the response.<a name="line.340"></a> -<span class="sourceLineNo">341</span> * @return The raw writer.<a name="line.341"></a> -<span class="sourceLineNo">342</span> * @throws IOException<a name="line.342"></a> -<span class="sourceLineNo">343</span> */<a name="line.343"></a> -<span class="sourceLineNo">344</span> public PrintWriter getDirectWriter(String contentType) throws IOException {<a name="line.344"></a> -<span class="sourceLineNo">345</span> setContentType(contentType);<a name="line.345"></a> -<span class="sourceLineNo">346</span> setHeader("x-content-type-options", "nosniff");<a name="line.346"></a> -<span class="sourceLineNo">347</span> return getWriter();<a name="line.347"></a> -<span class="sourceLineNo">348</span> }<a name="line.348"></a> -<span class="sourceLineNo">349</span><a name="line.349"></a> -<span class="sourceLineNo">350</span> /**<a name="line.350"></a> -<span class="sourceLineNo">351</span> * Equivalent to {@link HttpServletResponse#getWriter()}, except<a name="line.351"></a> -<span class="sourceLineNo">352</span> * wraps the output stream if an {@link Encoder} was found that matched<a name="line.352"></a> -<span class="sourceLineNo">353</span> * the <code>Accept-Encoding</code> header and sets the <code>Content-Encoding</code><a name="line.353"></a> -<span class="sourceLineNo">354</span> * header to the appropriate value.<a name="line.354"></a> -<span class="sourceLineNo">355</span> *<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @return The negotiated writer.<a name="line.356"></a> -<span class="sourceLineNo">357</span> * @throws IOException<a name="line.357"></a> -<span class="sourceLineNo">358</span> */<a name="line.358"></a> -<span class="sourceLineNo">359</span> public PrintWriter getNegotiatedWriter() throws IOException {<a name="line.359"></a> -<span class="sourceLineNo">360</span> return getWriter(false);<a name="line.360"></a> -<span class="sourceLineNo">361</span> }<a name="line.361"></a> -<span class="sourceLineNo">362</span><a name="line.362"></a> -<span class="sourceLineNo">363</span> private PrintWriter getWriter(boolean raw) throws IOException {<a name="line.363"></a> -<span class="sourceLineNo">364</span> // If plain text requested, override it now.<a name="line.364"></a> -<span class="sourceLineNo">365</span> if (request.isPlainText()) {<a name="line.365"></a> -<span class="sourceLineNo">366</span> setHeader("Content-Type", "text/plain");<a name="line.366"></a> -<span class="sourceLineNo">367</span> }<a name="line.367"></a> -<span class="sourceLineNo">368</span><a name="line.368"></a> -<span class="sourceLineNo">369</span> try {<a name="line.369"></a> -<span class="sourceLineNo">370</span> OutputStream out = (raw ? getOutputStream() : getNegotiatedOutputStream());<a name="line.370"></a> -<span class="sourceLineNo">371</span> return new PrintWriter(new OutputStreamWriter(out, getCharacterEncoding()));<a name="line.371"></a> -<span class="sourceLineNo">372</span> } catch (UnsupportedEncodingException e) {<a name="line.372"></a> -<span class="sourceLineNo">373</span> String ce = getCharacterEncoding();<a name="line.373"></a> -<span class="sourceLineNo">374</span> setCharacterEncoding("UTF-8");<a name="line.374"></a> -<span class="sourceLineNo">375</span> throw new RestException(SC_NOT_ACCEPTABLE, "Unsupported charset in request header ''Accept-Charset'': ''{0}''", ce);<a name="line.375"></a> -<span class="sourceLineNo">376</span> }<a name="line.376"></a> -<span class="sourceLineNo">377</span> }<a name="line.377"></a> -<span class="sourceLineNo">378</span><a name="line.378"></a> -<span class="sourceLineNo">379</span> /**<a name="line.379"></a> -<span class="sourceLineNo">380</span> * Returns the <code>Content-Type</code> header stripped of the charset attribute if present.<a name="line.380"></a> -<span class="sourceLineNo">381</span> *<a name="line.381"></a> -<span class="sourceLineNo">382</span> * @return The <code>media-type</code> portion of the <code>Content-Type</code> header.<a name="line.382"></a> -<span class="sourceLineNo">383</span> */<a name="line.383"></a> -<span class="sourceLineNo">384</span> public MediaType getMediaType() {<a name="line.384"></a> -<span class="sourceLineNo">385</span> return MediaType.forString(getContentType());<a name="line.385"></a> -<span class="sourceLineNo">386</span> }<a name="line.386"></a> -<span class="sourceLineNo">387</span><a name="line.387"></a> -<span class="sourceLineNo">388</span> /**<a name="line.388"></a> -<span class="sourceLineNo">389</span> * Redirects to the specified URI.<a name="line.389"></a> -<span class="sourceLineNo">390</span> * <p><a name="line.390"></a> -<span class="sourceLineNo">391</span> * Relative URIs are always interpreted as relative to the context root.<a name="line.391"></a> -<span class="sourceLineNo">392</span> * This is similar to how WAS handles redirect requests, and is different from how Tomcat<a name="line.392"></a> -<span class="sourceLineNo">393</span> * handles redirect requests.<a name="line.393"></a> -<span class="sourceLineNo">394</span> */<a name="line.394"></a> -<span class="sourceLineNo">395</span> @Override /* ServletResponse */<a name="line.395"></a> -<span class="sourceLineNo">396</span> public void sendRedirect(String uri) throws IOException {<a name="line.396"></a> -<span class="sourceLineNo">397</span> char c = (uri.length() > 0 ? uri.charAt(0) : 0);<a name="line.397"></a> -<span class="sourceLineNo">398</span> if (c != '/' && uri.indexOf("://") == -1)<a name="line.398"></a> -<span class="sourceLineNo">399</span> uri = request.getContextPath() + '/' + uri;<a name="line.399"></a> -<span class="sourceLineNo">400</span> super.sendRedirect(uri);<a name="line.400"></a> -<span class="sourceLineNo">401</span> }<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> * Returns the URL-encoding serializer associated with this response.<a name="line.404"></a> -<span class="sourceLineNo">405</span> *<a name="line.405"></a> -<span class="sourceLineNo">406</span> * @return The URL-encoding serializer associated with this response.<a name="line.406"></a> -<span class="sourceLineNo">407</span> */<a name="line.407"></a> -<span class="sourceLineNo">408</span> public UrlEncodingSerializer getUrlEncodingSerializer() {<a name="line.408"></a> -<span class="sourceLineNo">409</span> return urlEncodingSerializer;<a name="line.409"></a> -<span class="sourceLineNo">410</span> }<a name="line.410"></a> -<span class="sourceLineNo">411</span><a name="line.411"></a> -<span class="sourceLineNo">412</span> @Override /* ServletResponse */<a name="line.412"></a> -<span class="sourceLineNo">413</span> public void setHeader(String name, String value) {<a name="line.413"></a> -<span class="sourceLineNo">414</span> // Jetty doesn't set the content type correctly if set through this method.<a name="line.414"></a> -<span class="sourceLineNo">415</span> // Tomcat/WAS does.<a name="line.415"></a> -<span class="sourceLineNo">416</span> if (name.equalsIgnoreCase("Content-Type"))<a name="line.416"></a> -<span class="sourceLineNo">417</span> super.setContentType(value);<a name="line.417"></a> -<span class="sourceLineNo">418</span> else<a name="line.418"></a> -<span class="sourceLineNo">419</span> super.setHeader(name, value);<a name="line.419"></a> -<span class="sourceLineNo">420</span> }<a name="line.420"></a> -<span class="sourceLineNo">421</span><a name="line.421"></a> -<span class="sourceLineNo">422</span> /**<a name="line.422"></a> -<span class="sourceLineNo">423</span> * Sets the page title for HTML views.<a name="line.423"></a> -<span class="sourceLineNo">424</span> * <p><a name="line.424"></a> -<span class="sourceLineNo">425</span> * This is the programmatic equivalent to the {@link RestResource#pageTitle() @RestResource#pageTitle()}/<a name="line.425"></a> -<span class="sourceLineNo">426</span> * {@link RestMethod#pageTitle() @RestMethod#pageTitle()} annotations.<a name="line.426"></a> -<span class="sourceLineNo">427</span> * <p><a name="line.427"></a> -<span class="sourceLineNo">428</span> * This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_title</jsf>, title);</code><a name="line.428"></a> -<span class="sourceLineNo">429</span> * <p class='info'><a name="line.429"></a> -<span class="sourceLineNo">430</span> * <b>Tip:</b> Use {@link StringMessage} to generate a page title with delayed serialization so as not to<a name="line.430"></a> -<span class="sourceLineNo">431</span> * waste string concatenation cycles on non-HTML views.<a name="line.431"></a> -<span class="sourceLineNo">432</span> * </p><a name="line.432"></a> -<span class="sourceLineNo">433</span> *<a name="line.433"></a> -<span class="sourceLineNo">434</span> * @param title The localized page title to render on the page.<a name="line.434"></a> -<span class="sourceLineNo">435</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.435"></a> -<span class="sourceLineNo">436</span> * @return This object (for method chaining).<a name="line.436"></a> -<span class="sourceLineNo">437</span> */<a name="line.437"></a> -<span class="sourceLineNo">438</span> public RestResponse setPageTitle(Object title) {<a name="line.438"></a> -<span class="sourceLineNo">439</span> return setProperty(HtmlDocSerializerContext.HTMLDOC_title, title);<a name="line.439"></a> -<span class="sourceLineNo">440</span> }<a name="line.440"></a> -<span class="sourceLineNo">441</span><a name="line.441"></a> -<span class="sourceLineNo">442</span> /**<a name="line.442"></a> -<span class="sourceLineNo">443</span> * Sets the page text for HTML views.<a name="line.443"></a> -<span class="sourceLineNo">444</span> * <p><a name="line.444"></a> -<span class="sourceLineNo">445</span> * This is the programmatic equivalent to the {@link RestResource#pageText() @RestResource#pageText()}/<a name="line.445"></a> -<span class="sourceLineNo">446</span> * {@link RestMethod#pageText() @RestMethod#pageText()} annotations.<a name="line.446"></a> -<span class="sourceLineNo">447</span> * <p><a name="line.447"></a> -<span class="sourceLineNo">448</span> * This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_text</jsf>, text);</code><a name="line.448"></a> -<span class="sourceLineNo">449</span> * <p class='info'><a name="line.449"></a> -<span class="sourceLineNo">450</span> * <b>Tip:</b> Use {@link StringMessage} to generate page text with delayed serialization so as not to<a name="line.450"></a> -<span class="sourceLineNo">451</span> * waste string concatenation cycles on non-HTML views.<a name="line.451"></a> -<span class="sourceLineNo">452</span> * </p><a name="line.452"></a> -<span class="sourceLineNo">453</span> *<a name="line.453"></a> -<span class="sourceLineNo">454</span> * @param text The localized page text to render on the page.<a name="line.454"></a> -<span class="sourceLineNo">455</span> * @return This object (for method chaining).<a name="line.455"></a> -<span class="sourceLineNo">456</span> */<a name="line.456"></a> -<span class="sourceLineNo">457</span> public RestResponse setPageText(Object text) {<a name="line.457"></a> -<span class="sourceLineNo">458</span> return setProperty(HtmlDocSerializerContext.HTMLDOC_text, text);<a name="line.458"></a> -<span class="sourceLineNo">459</span> }<a name="line.459"></a> -<span class="sourceLineNo">460</span><a name="line.460"></a> -<span class="sourceLineNo">461</span> /**<a name="line.461"></a> -<span class="sourceLineNo">462</span> * Sets the page text for HTML views.<a name="line.462"></a> -<span class="sourceLineNo">463</span> * <p><a name="line.463"></a> -<span class="sourceLineNo">464</span> * This is the programmatic equivalent to the {@link RestResource#pageLinks() @RestResource#pageLinks()}/<a name="line.464"></a> -<span class="sourceLineNo">465</span> * {@link RestMethod#pageLinks() @RestMethod#pageLinks()} annotations.<a name="line.465"></a> -<span class="sourceLineNo">466</span> * <p><a name="line.466"></a> -<span class="sourceLineNo">467</span> * This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_links</jsf>, links);</code><a name="line.467"></a> -<span class="sourceLineNo">468</span> * <p class='info'><a name="line.468"></a> -<span class="sourceLineNo">469</span> * <b>Tip:</b> Use {@link StringMessage} to generate page links with delayed serialization so as not to<a name="line.469"></a> -<span class="sourceLineNo">470</span> * waste string concatenation cycles on non-HTML views.<a name="line.470"></a> -<span class="sourceLineNo">471</span> * </p><a name="line.471"></a> -<span class="sourceLineNo">472</span> *<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @param links The localized page links render on the page.<a name="line.473"></a> -<span class="sourceLineNo">474</span> * @return This object (for method chaining).<a name="line.474"></a> -<span class="sourceLineNo">475</span> */<a name="line.475"></a> -<span class="sourceLineNo">476</span> public RestResponse setPageLinks(Object links) {<a name="line.476"></a> -<span class="sourceLineNo">477</span> properties.put(HtmlDocSerializerContext.HTMLDOC_links, links);<a name="line.477"></a> -<span class="sourceLineNo">478</span> return this;<a name="line.478"></a> -<span class="sourceLineNo">479</span> }<a name="line.479"></a> -<span class="sourceLineNo">480</span>}<a name="line.480"></a> +<span class="sourceLineNo">064</span> private PrintWriter w;<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> /**<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Constructor.<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> RestResponse(RestContext context, RestRequest req, HttpServletResponse res) {<a name="line.69"></a> +<span class="sourceLineNo">070</span> super(res);<a name="line.70"></a> +<span class="sourceLineNo">071</span> this.request = req;<a name="line.71"></a> +<span class="sourceLineNo">072</span><a name="line.72"></a> +<span class="sourceLineNo">073</span> for (Map.Entry<String,Object> e : context.getDefaultResponseHeaders().entrySet())<a name="line.73"></a> +<span class="sourceLineNo">074</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> try {<a name="line.76"></a> +<span class="sourceLineNo">077</span> String passThroughHeaders = req.getHeader("x-response-headers");<a name="line.77"></a> +<span class="sourceLineNo">078</span> if (passThroughHeaders != null) {<a name="line.78"></a> +<span class="sourceLineNo">079</span> UrlEncodingParser p = context.getUrlEncodingParser();<a name="line.79"></a> +<span class="sourceLineNo">080</span> ObjectMap m = p.parsePart(passThroughHeaders, p.getBeanContext().getClassMeta(ObjectMap.class));<a name="line.80"></a> +<span class="sourceLineNo">081</span> for (Map.Entry<String,Object> e : m.entrySet())<a name="line.81"></a> +<span class="sourceLineNo">082</span> setHeader(e.getKey(), e.getValue().toString());<a name="line.82"></a> +<span class="sourceLineNo">083</span> }<a name="line.83"></a> +<span class="sourceLineNo">084</span> } catch (Exception e1) {<a name="line.84"></a> +<span class="sourceLineNo">085</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.85"></a> +<span class="sourceLineNo">086</span> }<a name="line.86"></a> +<span class="sourceLineNo">087</span> }<a name="line.87"></a> +<span class="sourceLineNo">088</span><a name="line.88"></a> +<span class="sourceLineNo">089</span> /*<a name="line.89"></a> +<span class="sourceLineNo">090</span> * Called from RestServlet after a match has been made but before the guard or method invocation.<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> @SuppressWarnings("hiding")<a name="line.92"></a> +<span class="sourceLineNo">093</span> final void init(ObjectMap properties, String defaultCharset, SerializerGroup mSerializers, UrlEncodingSerializer mUrlEncodingSerializer, EncoderGroup encoders) {<a name="line.93"></a> +<span class="sourceLineNo">094</span> this.properties = properties;<a name="line.94"></a> +<span class="sourceLineNo">095</span> this.serializerGroup = mSerializers;<a name="line.95"></a> +<span class="sourceLineNo">096</span> this.urlEncodingSerializer = mUrlEncodingSerializer;<a name="line.96"></a> +<span class="sourceLineNo">097</span> this.encoders = encoders;<a name="line.97"></a> +<span class="sourceLineNo">098</span><a name="line.98"></a> +<span class="sourceLineNo">099</span> // Find acceptable charset<a name="line.99"></a> +<span class="sourceLineNo">100</span> String h = request.getHeader("accept-charset");<a name="line.100"></a> +<span class="sourceLineNo">101</span> String charset = null;<a name="line.101"></a> +<span class="sourceLineNo">102</span> if (h == null)<a name="line.102"></a> +<span class="sourceLineNo">103</span> charset = defaultCharset;<a name="line.103"></a> +<span class="sourceLineNo">104</span> else for (MediaTypeRange r : MediaTypeRange.parse(h)) {<a name="line.104"></a> +<span class="sourceLineNo">105</span> if (r.getQValue() > 0) {<a name="line.105"></a> +<span class="sourceLineNo">106</span> MediaType mt = r.getMediaType();<a name="line.106"></a> +<span class="sourceLineNo">107</span> if (mt.getType().equals("*"))<a name="line.107"></a> +<span class="sourceLineNo">108</span> charset = defaultCharset;<a name="line.108"></a> +<span class="sourceLineNo">109</span> else if (Charset.isSupported(mt.getType()))<a name="line.109"></a> +<span class="sourceLineNo">110</span> charset = mt.getType();<a name="line.110"></a> +<span class="sourceLineNo">111</span> if (charset != null)<a name="line.111"></a> +<span class="sourceLineNo">112</span> break;<a name="line.112"></a> +<span class="sourceLineNo">113</span> }<a name="line.113"></a> +<span class="sourceLineNo">114</span> }<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> if (charset == null)<a name="line.116"></a> +<span class="sourceLineNo">117</span> throw new RestException(SC_NOT_ACCEPTABLE, "No supported charsets in header ''Accept-Charset'': ''{0}''", request.getHeader("Accept-Charset"));<a name="line.117"></a> +<span class="sourceLineNo">118</span> super.setCharacterEncoding(charset);<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> /**<a name="line.121"></a> +<span class="sourceLineNo">122</span> * Gets the serializer group for the response.<a name="line.122"></a> +<span class="sourceLineNo">123</span> *<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @return The serializer group for the response.<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> public SerializerGroup getSerializerGroup() {<a name="line.126"></a> +<span class="sourceLineNo">127</span> return serializerGroup;<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span><a name="line.129"></a> +<span class="sourceLineNo">130</span> /**<a name="line.130"></a> +<span class="sourceLineNo">131</span> * Returns the media types that are valid for <code>Accept</code> headers on the request.<a name="line.131"></a> +<span class="sourceLineNo">132</span> *<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @return The set of media types registered in the parser group of this request.<a name="line.133"></a> +<span class="sourceLineNo">134</span> */<a name="line.134"></a> +<span class="sourceLineNo">135</span> public List<MediaType> getSupportedMediaTypes() {<a name="line.135"></a> +<span class="sourceLineNo">136</span> return serializerGroup.getSupportedMediaTypes();<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> /**<a name="line.139"></a> +<span class="sourceLineNo">140</span> * Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on the request.<a name="line.140"></a> +<span class="sourceLineNo">141</span> *<a name="line.141"></a> +<span class="sourceLineNo">142</span> * @return The set of media types registered in the parser group of this request.<a name="line.142"></a> +<span class="sourceLineNo">143</span> * @throws RestServletException<a name="line.143"></a> +<span class="sourceLineNo">144</span> */<a name="line.144"></a> +<span class="sourceLineNo">145</span> public List<String> getSupportedEncodings() throws RestServletException {<a name="line.145"></a> +<span class="sourceLineNo">146</span> return encoders.getSupportedEncodings();<a name="line.146"></a> +<span class="sourceLineNo">147</span> }<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span> /**<a name="line.149"></a> +<span class="sourceLineNo">150</span> * Sets the HTTP output on the response.<a name="line.150"></a> +<span class="sourceLineNo">151</span> * <p><a name="line.151"></a> +<span class="sourceLineNo">152</span> * Calling this method is functionally equivalent to returning the object in the REST Java method.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * <p><a name="line.153"></a> +<span class="sourceLineNo">154</span> * Can be of any of the following types:<a name="line.154"></a> +<span class="sourceLineNo">155</span> * <ul><a name="line.155"></a> +<span class="sourceLineNo">156</span> * <li> {@link InputStream}<a name="line.156"></a> +<span class="sourceLineNo">157</span> * <li> {@link Reader}<a name="line.157"></a> +<span class="sourceLineNo">158</span> * <li> Any serializable type defined in <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a><a name="line.158"></a> +<span class="sourceLineNo">159</span> * </ul><a name="line.159"></a> +<span class="sourceLineNo">160</span> * <p><a name="line.160"></a> +<span class="sourceLineNo">161</span> * If it's an {@link InputStream} or {@link Reader}, you must also specify the <code>Content-Type</code> using the {@link #setContentType(String)} method.<a name="line.161"></a> +<span class="sourceLineNo">162</span> *<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @param output The output to serialize to the connection.<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @return This object (for method chaining).<a name="line.164"></a> +<span class="sourceLineNo">165</span> */<a name="line.165"></a> +<span class="sourceLineNo">166</span> public RestResponse setOutput(Object output) {<a name="line.166"></a> +<span class="sourceLineNo">167</span> this.output = output;<a name="line.167"></a> +<span class="sourceLineNo">168</span> this.isNullOutput = output == null;<a name="line.168"></a> +<span class="sourceLineNo">169</span> return this;<a name="line.169"></a> +<span class="sourceLineNo">170</span> }<a name="line.170"></a> +<span class="sourceLineNo">171</span><a name="line.171"></a> +<span class="sourceLineNo">172</span> /**<a name="line.172"></a> +<span class="sourceLineNo">173</span> * Add a serializer property to send to the serializers to override a default value.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * <p><a name="line.174"></a> +<span class="sourceLineNo">175</span> * Can be any value specified in the following classes:<a name="line.175"></a> +<span class="sourceLineNo">176</span> * <ul><a name="line.176"></a> +<span class="sourceLineNo">177</span> * <li>{@link SerializerContext}<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <li>{@link JsonSerializerContext}<a name="line.178"></a> +<span class="sourceLineNo">179</span> * <li>{@link XmlSerializerContext}<a name="line.179"></a> +<span class="sourceLineNo">180</span> * <li>{@link RdfSerializerContext}<a name="line.180"></a> +<span class="sourceLineNo">181</span> * </ul><a name="line.181"></a> +<span class="sourceLineNo">182</span> *<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @param key The setting name.<a name="line.183"></a> +<span class="sourceLineNo">184</span> * @param value The setting value.<a name="line.184"></a> +<span class="sourceLineNo">185</span> * @return This object (for method chaining).<a name="line.185"></a> +<span class="sourceLineNo">186</span> */<a name="line.186"></a> +<span class="sourceLineNo">187</span> public RestResponse setProperty(String key, Object value) {<a name="line.187"></a> +<span class="sourceLineNo">188</span> properties.put(key, value);<a name="line.188"></a> +<span class="sourceLineNo">189</span> return this;<a name="line.189"></a> +<span class="sourceLineNo">190</span> }<a name="line.190"></a> +<span class="sourceLineNo">191</span><a name="line.191"></a> +<span class="sourceLineNo">192</span> /**<a name="line.192"></a> +<span class="sourceLineNo">193</span> * Returns the properties set via {@link #setProperty(String, Object)}.<a name="line.193"></a> +<span class="sourceLineNo">194</span> *<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @return A map of all the property values set.<a name="line.195"></a> +<span class="sourceLineNo">196</span> */<a name="line.196"></a> +<span class="sourceLineNo">197</span> public ObjectMap getProperties() {<a name="line.197"></a> +<span class="sourceLineNo">198</span> return properties;<a name="line.198"></a> +<span class="sourceLineNo">199</span> }<a name="line.199"></a> +<span class="sourceLineNo">200</span><a name="line.200"></a> +<span class="sourceLineNo">201</span> /**<a name="line.201"></a> +<span class="sourceLineNo">202</span> * Shortcut method that allows you to use varargs to simplify setting array output.<a name="line.202"></a> +<span class="sourceLineNo">203</span> *<a name="line.203"></a> +<span class="sourceLineNo">204</span> * <h5 class='section'>Example:</h5><a name="line.204"></a> +<span class="sourceLineNo">205</span> * <p class='bcode'><a name="line.205"></a> +<span class="sourceLineNo">206</span> * <jc>// Instead of...</jc><a name="line.206"></a> +<span class="sourceLineNo">207</span> * response.setOutput(<jk>new</jk> Object[]{x,y,z});<a name="line.207"></a> +<span class="sourceLineNo">208</span> *<a name="line.208"></a> +<span class="sourceLineNo">209</span> * <jc>// ...call this...</jc><a name="line.209"></a> +<span class="sourceLineNo">210</span> * response.setOutput(x,y,z);<a name="line.210"></a> +<span class="sourceLineNo">211</span> * </p><a name="line.211"></a> +<span class="sourceLineNo">212</span> *<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @param output The output to serialize to the connection.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @return This object (for method chaining).<a name="line.214"></a> +<span class="sourceLineNo">215</span> */<a name="line.215"></a> +<span class="sourceLineNo">216</span> public RestResponse setOutputs(Object...output) {<a name="line.216"></a> +<span class="sourceLineNo">217</span> this.output = output;<a name="line.217"></a> +<span class="sourceLineNo">218</span> return this;<a name="line.218"></a> +<span class="sourceLineNo">219</span> }<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> /**<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Returns the output that was set by calling {@link #setOutput(Object)}.<a name="line.222"></a> +<span class="sourceLineNo">223</span> *<a name="line.223"></a> +<span class="sourceLineNo">224</span> * @return The output object.<a name="line.224"></a> +<span class="sourceLineNo">225</span> */<a name="line.225"></a> +<span class="sourceLineNo">226</span> public Object getOutput() {<a name="line.226"></a> +<span class="sourceLineNo">227</span> return output;<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Returns <jk>true</jk> if this response has any output associated with it.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @return <jk>true</jk> if {@code setInput()} has been called.<a name="line.233"></a> +<span class="sourceLineNo">234</span> */<a name="line.234"></a> +<span class="sourceLineNo">235</span> public boolean hasOutput() {<a name="line.235"></a> +<span class="sourceLineNo">236</span> return output != null || isNullOutput;<a name="line.236"></a> +<span class="sourceLineNo">237</span> }<a name="line.237"></a> +<span class="sourceLineNo">238</span><a name="line.238"></a> +<span class="sourceLineNo">239</span> /**<a name="line.239"></a> +<span class="sourceLineNo">240</span> * Sets the output to a plain-text message regardless of the content type.<a name="line.240"></a> +<span class="sourceLineNo">241</span> *<a name="line.241"></a> +<span class="sourceLineNo">242</span> * @param text The output text to send.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @return This object (for method chaining).<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @throws IOException If a problem occurred trying to write to the writer.<a name="line.244"></a> +<span class="sourceLineNo">245</span> */<a name="line.245"></a> +<span class="sourceLineNo">246</span> public RestResponse sendPlainText(String text) throws IOException {<a name="line.246"></a> +<span class="sourceLineNo">247</span> setContentType("text/plain");<a name="line.247"></a> +<span class="sourceLineNo">248</span> getNegotiatedWriter().write(text);<a name="line.248"></a> +<span class="sourceLineNo">249</span> return this;<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> /**<a name="line.252"></a> +<span class="sourceLineNo">253</span> * Equivalent to {@link HttpServletResponse#getOutputStream()}, except<a name="line.253"></a> +<span class="sourceLineNo">254</span> * wraps the output stream if an {@link Encoder} was found that matched<a name="line.254"></a> +<span class="sourceLineNo">255</span> * the <code>Accept-Encoding</code> header.<a name="line.255"></a> +<span class="sourceLineNo">256</span> *<a name="line.256"></a> +<span class="sourceLineNo">257</span> * @return A negotiated output stream.<a name="line.257"></a> +<span class="sourceLineNo">258</span> * @throws IOException<a name="line.258"></a> +<span class="sourceLineNo">259</span> */<a name="line.259"></a> +<span class="sourceLineNo">260</span> public ServletOutputStream getNegotiatedOutputStream() throws IOException {<a name="line.260"></a> +<span class="sourceLineNo">261</span> if (os == null) {<a name="line.261"></a> +<span class="sourceLineNo">262</span> Encoder encoder = null;<a name="line.262"></a> +<span class="sourceLineNo">263</span><a name="line.263"></a> +<span class="sourceLineNo">264</span> String ae = request.getHeader("Accept-Encoding");<a name="line.264"></a> +<span class="sourceLineNo">265</span> if (! (ae == null || ae.isEmpty())) {<a name="line.265"></a> +<span class="sourceLineNo">266</span> EncoderMatch match = encoders != null ? encoders.getEncoderMatch(ae) : null;<a name="line.266"></a> +<span class="sourceLineNo">267</span> if (match == null) {<a name="line.267"></a> +<span class="sourceLineNo">268</span> // Identity should always match unless "identity;q=0" or "*;q=0" is specified.<a name="line.268"></a> +<span class="sourceLineNo">269</span> if (ae.matches(".*(identity|\\*)\\s*;\\s*q\\s*=\\s*(0(?!\\.)|0\\.0).*")) {<a name="line.269"></a> +<span class="sourceLineNo">270</span> throw new RestException(SC_NOT_ACCEPTABLE,<a name="line.270"></a> +<span class="sourceLineNo">271</span> "Unsupported encoding in request header ''Accept-Encoding'': ''{0}''\n\tSupported codings: {1}",<a name="line.271"></a> +<span class="sourceLineNo">272</span> ae, encoders.getSupportedEncodings()<a name="line.272"></a> +<span class="sourceLineNo">273</span> );<a name="line.273"></a> +<span class="sourceLineNo">274</span> }<a name="line.274"></a> +<span class="sourceLineNo">275</span> } else {<a name="line.275"></a> +<span class="sourceLineNo">276</span> encoder = match.getEncoder();<a name="line.276"></a> +<span class="sourceLineNo">277</span> String encoding = match.getEncoding().toString();<a name="line.277"></a> +<span class="sourceLineNo">278</span><a name="line.278"></a> +<span class="sourceLineNo">279</span> // Some clients don't recognize identity as an encoding, so don't set it.<a name="line.279"></a> +<span class="sourceLineNo">280</span> if (! encoding.equals("identity"))<a name="line.280"></a> +<span class="sourceLineNo">281</span> setHeader("content-encoding", encoding);<a name="line.281"></a> +<span class="sourceLineNo">282</span> }<a name="line.282"></a> +<span class="sourceLineNo">283</span> }<a name="line.283"></a> +<span class="sourceLineNo">284</span> os = getOutputStream();<a name="line.284"></a> +<span class="sourceLineNo">285</span> if (encoder != null) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> final OutputStream os2 = encoder.getOutputStream(os);<a name="line.286"></a> +<span class="sourceLineNo">287</span> os = new ServletOutputStream(){<a name="line.287"></a> +<span class="sourceLineNo">288</span> @Override /* OutputStream */<a name="line.288"></a> +<span class="sourceLineNo">289</span> public final void write(byte[] b, int off, int len) throws IOException {<a name="line.289"></a> +<span class="sourceLineNo">290</span> os2.write(b, off, len);<a name="line.290"></a> +<span class="sourceLineNo">291</span> }<a name="line.291"></a> +<span class="sourceLineNo">292</span> @Override /* OutputStream */<a name="line.292"></a> +<span class="sourceLineNo">293</span> public final void write(int b) throws IOException {<a name="line.293"></a> +<span class="sourceLineNo">294</span> os2.write(b);<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<a name="line.295"></a> +<span class="sourceLineNo">296</span> @Override /* OutputStream */<a name="line.296"></a> +<span class="sourceLineNo">297</span> public final void flush() throws IOException {<a name="line.297"></a> +<span class="sourceLineNo">298</span> os2.flush();<a name="line.298"></a> +<span class="sourceLineNo">299</span> }<a name="line.299"></a> +<span class="sourceLineNo">300</span> @Override /* OutputStream */<a name="line.300"></a> +<span class="sourceLineNo">301</span> public final void close() throws IOException {<a name="line.301"></a> +<span class="sourceLineNo">302</span> os2.close();<a name="line.302"></a> +<span class="sourceLineNo">303</span> }<a name="line.303"></a> +<span class="sourceLineNo">304</span> };<a name="line.304"></a> +<span class="sourceLineNo">305</span> }<a name="line.305"></a> +<span class="sourceLineNo">306</span> }<a name="line.306"></a> +<span class="sourceLineNo">307</span> return os;<a name="line.307"></a> +<span class="sourceLineNo">308</span> }<a name="line.308"></a> +<span class="sourceLineNo">309</span><a name="line.309"></a> +<span class="sourceLineNo">310</span> @Override /* ServletResponse */<a name="line.310"></a> +<span class="sourceLineNo">311</span> public ServletOutputStream getOutputStream() throws IOException {<a name="line.311"></a> +<span class="sourceLineNo">312</span> if (os == null)<a name="line.312"></a> +<span class="sourceLineNo">313</span> os = super.getOutputStream();<a name="line.313"></a> +<span class="sourceLineNo">314</span> return os;<a name="line.314"></a> +<span class="sourceLineNo">315</span> }<a name="line.315"></a> +<span class="sourceLineNo">316</span><a name="line.316"></a> +<span class="sourceLineNo">317</span> /**<a name="line.317"></a> +<span class="sourceLineNo">318</span> * Returns <jk>true</jk> if {@link #getOutputStream()} has been called.<a name="line.318"></a> +<span class="sourceLineNo">319</span> *<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @return <jk>true</jk> if {@link #getOutputStream()} has been called.<a name="line.320"></a> +<span class="sourceLineNo">321</span> */<a name="line.321"></a> +<span class="sourceLineNo">322</span> public boolean getOutputStreamCalled() {<a name="line.322"></a> +<span class="sourceLineNo">323</span> return os != null;<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> /**<a name="line.326"></a> +<span class="sourceLineNo">327</span> * Returns the writer to the response body.<a name="line.327"></a> +<span class="sourceLineNo">328</span> * This methods bypasses any specified encoders and returns a regular unbuffered writer.<a name="line.328"></a> +<span class="sourceLineNo">329</span> * Use the {@link #getNegotiatedWriter()} method if you want to use the matched encoder (if any).<a name="line.329"></a> +<span class="sourceLineNo">330</span> */<a name="line.330"></a> +<span class="sourceLineNo">331</span> @Override /* ServletResponse */<a name="line.331"></a> +<span class="sourceLineNo">332</span> public PrintWriter getWriter() throws IOException {<a name="line.332"></a> +<span class="sourceLineNo">333</span> return getWriter(true);<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> * Convenience method meant to be used when rendering directly to a browser with no buffering.<a name="line.337"></a> +<span class="sourceLineNo">338</span> * Sets the header <js>"x-content-type-options=nosniff"</js> so that output is rendered<a name="line.338"></a> +<span class="sourceLineNo">339</span> * immediately on IE and Chrome without any buffering for content-type sniffing.<a name="line.339"></a> +<span class="sourceLineNo">340</span> *<a name="line.340"></a> +<span class="sourceLineNo">341</span> * @param contentType The value to set as the <code>Content-Type</code> on the response.<a name="line.341"></a> +<span class="sourceLineNo">342</span> * @return The raw writer.<a name="line.342"></a> +<span class="sourceLineNo">343</span> * @throws IOException<a name="line.343"></a> +<span class="sourceLineNo">344</span> */<a name="line.344"></a> +<span class="sourceLineNo">345</span> public PrintWriter getDirectWriter(String contentType) throws IOException {<a name="line.345"></a> +<span class="sourceLineNo">346</span> setContentType(contentType);<a name="line.346"></a> +<span class="sourceLineNo">347</span> setHeader("x-content-type-options", "nosniff");<a name="line.347"></a> +<span class="sourceLineNo">348</span> return getWriter();<a name="line.348"></a> +<span class="sourceLineNo">349</span> }<a name="line.349"></a> +<span class="sourceLineNo">350</span><a name="line.350"></a> +<span class="sourceLineNo">351</span> /**<a name="line.351"></a> +<span class="sourceLineNo">352</span> * Equivalent to {@link HttpServletResponse#getWriter()}, except<a name="line.352"></a> +<span class="sourceLineNo">353</span> * wraps the output stream if an {@link Encoder} was found that matched<a name="line.353"></a> +<span class="sourceLineNo">354</span> * the <code>Accept-Encoding</code> header and sets the <code>Content-Encoding</code><a name="line.354"></a> +<span class="sourceLineNo">355</span> * header to the appropriate value.<a name="line.355"></a> +<span class="sourceLineNo">356</span> *<a name="line.356"></a> +<span class="sourceLineNo">357</span> * @return The negotiated writer.<a name="line.357"></a> +<span class="sourceLineNo">358</span> * @throws IOException<a name="line.358"></a> +<span class="sourceLineNo">359</span> */<a name="line.359"></a> +<span class="sourceLineNo">360</span> public PrintWriter getNegotiatedWriter() throws IOException {<a name="line.360"></a> +<span class="sourceLineNo">361</span> return getWriter(false);<a name="line.361"></a> +<span class="sourceLineNo">362</span> }<a name="line.362"></a> +<span class="sourceLineNo">363</span><a name="line.363"></a> +<span class="sourceLineNo">364</span> private PrintWriter getWriter(boolean raw) throws IOException {<a name="line.364"></a> +<span class="sourceLineNo">365</span> if (w != null)<a name="line.365"></a> +<span class="sourceLineNo">366</span> return w;<a name="line.366"></a> +<span class="sourceLineNo">367</span><a name="line.367"></a> +<span class="sourceLineNo">368</span> // If plain text requested, override it now.<a name="line.368"></a> +<span class="sourceLineNo">369</span> if (request.isPlainText()) <a name="line.369"></a> +<span class="sourceLineNo">370</span> setHeader("Content-Type", "text/plain");<a name="line.370"></a> +<span class="sourceLineNo">371</span><a name="line.371"></a> +<span class="sourceLineNo">372</span> try {<a name="line.372"></a> +<span class="sourceLineNo">373</span> OutputStream out = (raw ? getOutputStream() : getNegotiatedOutputStream());<a name="line.373"></a> +<span class="sourceLineNo">374</span> w = new PrintWriter(new OutputStreamWriter(out, getCharacterEncoding()));<a name="line.374"></a> +<span class="sourceLineNo">375</span> return w;<a name="line.375"></a> +<span class="sourceLineNo">376</span> } catch (UnsupportedEncodingException e) {<a name="line.376"></a> +<span class="sourceLineNo">377</span> String ce = getCharacterEncoding();<a name="line.377"></a> +<span class="sourceLineNo">378</span> setCharacterEncoding("UTF-8");<a name="line.378"></a> +<span class="sourceLineNo">379</span> throw new RestException(SC_NOT_ACCEPTABLE, "Unsupported charset in request header ''Accept-Charset'': ''{0}''", ce);<a name="line.379"></a> +<span class="sourceLineNo">380</span> }<a name="line.380"></a> +<span class="sourceLineNo">381</span> }<a name="line.381"></a> +<span class="sourceLineNo">382</span><a name="line.382"></a> +<span class="sourceLineNo">383</span> /**<a name="line.383"></a> +<span class="sourceLineNo">384</span> * Returns the <code>Content-Type</code> header stripped of the charset attribute if present.<a name="line.384"></a> +<span class="sourceLineNo">385</span> *<a name="line.385"></a> +<span class="sourceLineNo">386</span> * @return The <code>media-type</code> portion of the <code>Content-Type</code> header.<a name="line.386"></a> +<span class="sourceLineNo">387</span> */<a name="line.387"></a> +<span class="sourceLineNo">388</span> public MediaType getMediaType() {<a name="line.388"></a> +<span class="sourceLineNo">389</span> return MediaType.forString(getContentType());<a name="line.389"></a> +<span class="sourceLineNo">390</span> }<a name="line.390"></a> +<span class="sourceLineNo">391</span><a name="line.391"></a> +<span class="sourceLineNo">392</span> /**<a name="line.392"></a> +<span class="sourceLineNo">393</span> * Redirects to the specified URI.<a name="line.393"></a> +<span class="sourceLineNo">394</span> * <p><a name="line.394"></a> +<span class="sourceLineNo">395</span> * Relative URIs are always interpreted as relative to the context root.<a name="line.395"></a> +<span class="sourceLineNo">396</span> * This is similar to how WAS handles redirect requests, and is different from how Tomcat<a name="line.396"></a> +<span class="sourceLineNo">397</span> * handles redirect requests.<a name="line.397"></a> +<span class="sourceLineNo">398</span> */<a name="line.398"></a> +<span class="sourceLineNo">399</span> @Override /* ServletResponse */<a name="line.399"></a> +<span class="sourceLineNo">400</span> public void sendRedirect(String uri) throws IOException {<a name="line.400"></a> +<span class="sourceLineNo">401</span> char c = (uri.length() > 0 ? uri.charAt(0) : 0);<a name="line.401"></a> +<span class="sourceLineNo">402</span> if (c != '/' && uri.indexOf("://") == -1)<a name="line.402"></a> +<span class="sourceLineNo">403</span> uri = request.getContextPath() + '/' + uri;<a name="line.403"></a> +<span class="sourceLineNo">404</span> super.sendRedirect(uri);<a name="line.404"></a> +<span class="sourceLineNo">405</span> }<a name="line.405"></a> +<span class="sourceLineNo">406</span><a name="line.406"></a> +<span class="sourceLineNo">407</span> /**<a name="line.407"></a> +<span class="sourceLineNo">408</span> * Returns the URL-encoding serializer associated with this response.<a name="line.408"></a> +<span class="sourceLineNo">409</span> *<a name="line.409"></a> +<span class="sourceLineNo">410</span> * @return The URL-encoding serializer associated with this response.<a name="line.410"></a> +<span class="sourceLineNo">411</span> */<a name="line.411"></a> +<span class="sourceLineNo">412</span> public UrlEncodingSerializer getUrlEncodingSerializer() {<a name="line.412"></a> +<span class="sourceLineNo">413</span> return urlEncodingSerializer;<a name="line.413"></a> +<span class="sourceLineNo">414</span> }<a name="line.414"></a> +<span class="sourceLineNo">415</span><a name="line.415"></a> +<span class="sourceLineNo">416</span> @Override /* ServletResponse */<a name="line.416"></a> +<span class="sourceLineNo">417</span> public void setHeader(String name, String value) {<a name="line.417"></a> +<span class="sourceLineNo">418</span> // Jetty doesn't set the content type correctly if set through this method.<a name="line.418"></a> +<span class="sourceLineNo">419</span> // Tomcat/WAS does.<a name="line.419"></a> +<span class="sourceLineNo">420</span> if (name.equalsIgnoreCase("Content-Type"))<a name="line.420"></a> +<span class="sourceLineNo">421</span> super.setContentType(value);<a name="line.421"></a> +<span class="sourceLineNo">422</span> else<a name="line.422"></a> +<span class="sourceLineNo">423</span> super.setHeader(name, value);<a name="line.423"></a> +<span class="sourceLineNo">424</span> }<a name="line.424"></a> +<span class="sourceLineNo">425</span><a name="line.425"></a> +<span class="sourceLineNo">426</span> /**<a name="line.426"></a> +<span class="sourceLineNo">427</span> * Sets the page title for HTML views.<a name="line.427"></a> +<span class="sourceLineNo">428</span> * <p><a name="line.428"></a> +<span class="sourceLineNo">429</span> * This is the programmatic equivalent to the {@link RestResource#pageTitle() @RestResource#pageTitle()}/<a name="line.429"></a> +<span class="sourceLineNo">430</span> * {@link RestMethod#pageTitle() @RestMethod#pageTitle()} annotations.<a name="line.430"></a> +<span class="sourceLineNo">431</span> * <p><a name="line.431"></a> +<span class="sourceLineNo">432</span> * This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_title</jsf>, title);</code><a name="line.432"></a> +<span class="sourceLineNo">433</span> * <p class='info'><a name="line.433"></a> +<span class="sourceLineNo">434</span> * <b>Tip:</b> Use {@link StringMessage} to generate a page title with delayed serialization so as not to<a name="line.434"></a> +<span class="sourceLineNo">435</span> * waste string concatenation cycles on non-HTML views.<a name="line.435"></a> +<span class="sourceLineNo">436</span> * </p><a name="line.436"></a> +<span class="sourceLineNo">437</span> *<a name="line.437"></a> +<span class="sourceLineNo">438</span> * @param title The localized page title to render on the page.<a name="line.438"></a> +<span class="sourceLineNo">439</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.439"></a> +<span class="sourceLineNo">440</span> * @return This object (for method chaining).<a name="line.440"></a> +<span class="sourceLineNo">441</span> */<a name="line.441"></a> +<span class="sourceLineNo">442</span> public RestResponse setPageTitle(Object title) {<a name="line.442"></a> +<span class="sourceLineNo">443</span> return setProperty(HtmlDocSerializerContext.HTMLDOC_title, title);<a name="line.443"></a> +<span class="sourceLineNo">444</span> }<a name="line.444"></a> +<span class="sourceLineNo">445</span><a name="line.445"></a> +<span class="sourceLineNo">446</span> /**<a name="line.446"></a> +<span class="sourceLineNo">447</span> * Sets the page text for HTML views.<a name="line.447"></a> +<span class="sourceLineNo">448</span> * <p><a name="line.448"></a> +<span class="sourceLineNo">449</span> * This is the programmatic equivalent to the {@link RestResource#pageText() @RestResource#pageText()}/<a name="line.449"></a> +<span class="sourceLineNo">450</span> * {@link RestMethod#pageText() @RestMethod#pageText()} annotations.<a name="line.450"></a> +<span class="sourceLineNo">451</span> * <p><a name="line.451"></a> +<span class="sourceLineNo">452</span> * This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_text</jsf>, text);</code><a name="line.452"></a> +<span class="sourceLineNo">453</span> * <p class='info'><a name="line.453"></a> +<span class="sourceLineNo">454</span> * <b>Tip:</b> Use {@link StringMessage} to generate page text with delayed serialization so as not to<a name="line.454"></a> +<span class="sourceLineNo">455</span> * waste string concatenation cycles on non-HTML views.<a name="line.455"></a> +<span class="sourceLineNo">456</span> * </p><a name="line.456"></a> +<span class="sourceLineNo">457</span> *<a name="line.457"></a> +<span class="sourceLineNo">458</span> * @param text The localized page text to render on the page.<a name="line.458"></a> +<span class="sourceLineNo">459</span> * @return This object (for method chaining).<a name="line.459"></a> +<span class="sourceLineNo">460</span> */<a name="line.460"></a> +<span class="sourceLineNo">461</span> public RestResponse setPageText(Object text) {<a name="line.461"></a> +<span class="sourceLineNo">462</span> return setProperty(HtmlDocSerializerContext.HTMLDOC_text, text);<a name="line.462"></a> +<span class="sourceLineNo">463</span> }<a name="line.463"></a> +<span class="sourceLineNo">464</span><a name="line.464"></a> +<span class="sourceLineNo">465</span> /**<a name="line.465"></a> +<span class="sourceLineNo">466</span> * Sets the page text for HTML views.<a name="line.466"></a> +<span class="sourceLineNo">467</span> * <p><a name="line.467"></a> +<span class="sourceLineNo">468</span> * This is the programmatic equivalent to the {@link RestResource#pageLinks() @RestResource#pageLinks()}/<a name="line.468"></a> +<span class="sourceLineNo">469</span> * {@link RestMethod#pageLinks() @RestMethod#pageLinks()} annotations.<a name="line.469"></a> +<span class="sourceLineNo">470</span> * <p><a name="line.470"></a> +<span class="sourceLineNo">471</span> * This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_links</jsf>, links);</code><a name="line.471"></a> +<span class="sourceLineNo">472</span> * <p class='info'><a name="line.472"></a> +<span class="sourceLineNo">473</span> * <b>Tip:</b> Use {@link StringMessage} to generate page links with delayed serialization so as not to<a name="line.473"></a> +<span class="sourceLineNo">474</span> * waste string concatenation cycles on non-HTML views.<a name="line.474"></a> +<span class="sourceLineNo">475</span> * </p><a name="line.475"></a> +<span class="sourceLineNo">476</span> *<a name="line.476"></a> +<span class="sourceLineNo">477</span> * @param links The localized page links render on the page.<a name="line.477"></a> +<span class="sourceLineNo">478</span> * @return This object (for method chaining).<a name="line.478"></a> +<span class="sourceLineNo">479</span> */<a name="line.479"></a> +<span class="sourceLineNo">480</span> public RestResponse setPageLinks(Object links) {<a name="line.480"></a> +<span class="sourceLineNo">481</span> properties.put(HtmlDocSerializerContext.HTMLDOC_links, links);<a name="line.481"></a> +<span class="sourceLineNo">482</span> return this;<a name="line.482"></a> +<span class="sourceLineNo">483</span> }<a name="line.483"></a> +<span class="sourceLineNo">484</span><a name="line.484"></a> +<span class="sourceLineNo">485</span> @Override /* ServletResponse */<a name="line.485"></a> +<span class="sourceLineNo">486</span> public void flushBuffer() throws IOException {<a name="line.486"></a> +<span class="sourceLineNo">487</span> if (w != null)<a name="line.487"></a> +<span class="sourceLineNo">488</span> w.flush();<a name="line.488"></a> +<span class="sourceLineNo">489</span> if (os != null)<a name="line.489"></a> +<span class="sourceLineNo">490</span> os.flush();<a name="line.490"></a> +<span class="sourceLineNo">491</span> super.flushBuffer();<a name="line.491"></a> +<span class="sourceLineNo">492</span> }<a name="line.492"></a> +<span class="sourceLineNo">493</span>}<a name="line.493"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html index 0452a5e..6475805 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html @@ -171,7 +171,24 @@ <span class="sourceLineNo">163</span> String val = s.substring(i+1).trim();<a name="line.163"></a> <span class="sourceLineNo">164</span> return new String[]{name,val};<a name="line.164"></a> <span class="sourceLineNo">165</span> }<a name="line.165"></a> -<span class="sourceLineNo">166</span>}<a name="line.166"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> /**<a name="line.167"></a> +<span class="sourceLineNo">168</span> * Parses key/value pairs separated by either : or =<a name="line.168"></a> +<span class="sourceLineNo">169</span> */<a name="line.169"></a> +<span class="sourceLineNo">170</span> static String[] parseKeyValuePair(String s) {<a name="line.170"></a> +<span class="sourceLineNo">171</span> int i = -1;<a name="line.171"></a> +<span class="sourceLineNo">172</span> for (int j = 0; j < s.length() && i < 0; j++) { s.indexOf(':');<a name="line.172"></a> +<span class="sourceLineNo">173</span> char c = s.charAt(j);<a name="line.173"></a> +<span class="sourceLineNo">174</span> if (c == '=' || c == ':')<a name="line.174"></a> +<span class="sourceLineNo">175</span> i = j;<a name="line.175"></a> +<span class="sourceLineNo">176</span> }<a name="line.176"></a> +<span class="sourceLineNo">177</span> if (i == -1)<a name="line.177"></a> +<span class="sourceLineNo">178</span> return null;<a name="line.178"></a> +<span class="sourceLineNo">179</span> String name = s.substring(0, i).trim();<a name="line.179"></a> +<span class="sourceLineNo">180</span> String val = s.substring(i+1).trim();<a name="line.180"></a> +<span class="sourceLineNo">181</span> return new String[]{name,val};<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Body.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Body.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Body.html index 1d71e3b..888506f 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Body.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Body.html @@ -43,7 +43,7 @@ <span class="sourceLineNo">035</span> * <p class='bcode'><a name="line.35"></a> <span class="sourceLineNo">036</span> * <ja>@RestMethod</ja>(name=<js>"POST"</js>)<a name="line.36"></a> <span class="sourceLineNo">037</span> * <jk>public void</jk> doPostPerson(RestRequest req, RestResponse res) {<a name="line.37"></a> -<span class="sourceLineNo">038</span> * Person person = req.getBody(Person.<jk>class</jk>);<a name="line.38"></a> +<span class="sourceLineNo">038</span> * Person person = req.getBody().asType(Person.<jk>class</jk>);<a name="line.38"></a> <span class="sourceLineNo">039</span> * ...<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/FormData.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/FormData.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/FormData.html index 595f492..9027a9f 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/FormData.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/FormData.html @@ -101,7 +101,12 @@ <span class="sourceLineNo">093</span> * <js>"foo"</js> when using UON mode.<a name="line.93"></a> <span class="sourceLineNo">094</span> */<a name="line.94"></a> <span class="sourceLineNo">095</span> String format() default "INHERIT";<a name="line.95"></a> -<span class="sourceLineNo">096</span>}<a name="line.96"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * The default value for this form-data parameter if it's not present in the request.<a name="line.98"></a> +<span class="sourceLineNo">099</span> */<a name="line.99"></a> +<span class="sourceLineNo">100</span> String def() default "";<a name="line.100"></a> +<span class="sourceLineNo">101</span>}<a name="line.101"></a>
