Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 756ffe72d -> 70077347e
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/70077347/content/site/apidocs/src-html/org/apache/juneau/rest/StreamResource.Builder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/StreamResource.Builder.html b/content/site/apidocs/src-html/org/apache/juneau/rest/StreamResource.Builder.html new file mode 100644 index 0000000..c4099ee --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/StreamResource.Builder.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.rest;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import java.util.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.internal.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.rest.response.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Represents the contents of a byte stream file with convenience methods for adding HTTP response headers.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * The purpose of this class is to maintain an in-memory reusable byte array of a streamed resource for<a name="line.25"></a> +<span class="sourceLineNo">026</span> * the fastest possible streaming.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * Therefore, this object is designed to be reused and thread-safe.<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * This class is handled special by the {@link StreamableHandler} class.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * This allows these objects to be returned as responses by REST methods.<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span>public class StreamResource implements Streamable {<a name="line.32"></a> +<span class="sourceLineNo">033</span><a name="line.33"></a> +<span class="sourceLineNo">034</span> private final MediaType mediaType;<a name="line.34"></a> +<span class="sourceLineNo">035</span> private final byte[][] contents;<a name="line.35"></a> +<span class="sourceLineNo">036</span> private final Map<String,String> headers;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Constructor.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @param mediaType The resource media type.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @param contents The resource contents.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <br>Contents can be any of the following:<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <ul><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li><code><jk>byte</jk>[]</code><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li><code>InputStream</code><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <li><code>Reader</code> - Converted to UTF-8 bytes.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * <li><code>File</code><a name="line.48"></a> +<span class="sourceLineNo">049</span> * <li><code>CharSequence</code> - Converted to UTF-8 bytes.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * </ul><a name="line.50"></a> +<span class="sourceLineNo">051</span> * @throws IOException<a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span> public StreamResource(MediaType mediaType, Object...contents) throws IOException {<a name="line.53"></a> +<span class="sourceLineNo">054</span> this(mediaType, null, contents);<a name="line.54"></a> +<span class="sourceLineNo">055</span> }<a name="line.55"></a> +<span class="sourceLineNo">056</span><a name="line.56"></a> +<span class="sourceLineNo">057</span> /**<a name="line.57"></a> +<span class="sourceLineNo">058</span> * Constructor.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param mediaType The resource media type.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param headers The HTTP response headers for this streamed resource.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param contents The resource contents.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <br>Contents can be any of the following:<a name="line.63"></a> +<span class="sourceLineNo">064</span> * <ul><a name="line.64"></a> +<span class="sourceLineNo">065</span> * <li><code><jk>byte</jk>[]</code><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <li><code>InputStream</code><a name="line.66"></a> +<span class="sourceLineNo">067</span> * <li><code>Reader</code> - Converted to UTF-8 bytes.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * <li><code>File</code><a name="line.68"></a> +<span class="sourceLineNo">069</span> * <li><code>CharSequence</code> - Converted to UTF-8 bytes.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * </ul><a name="line.70"></a> +<span class="sourceLineNo">071</span> * @throws IOException<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> public StreamResource(MediaType mediaType, Map<String,Object> headers, Object...contents) throws IOException {<a name="line.73"></a> +<span class="sourceLineNo">074</span> this.mediaType = mediaType;<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> Map<String,String> m = new LinkedHashMap<String,String>();<a name="line.76"></a> +<span class="sourceLineNo">077</span> if (headers != null)<a name="line.77"></a> +<span class="sourceLineNo">078</span> for (Map.Entry<String,Object> e : headers.entrySet())<a name="line.78"></a> +<span class="sourceLineNo">079</span> m.put(e.getKey(), StringUtils.toString(e.getValue()));<a name="line.79"></a> +<span class="sourceLineNo">080</span> this.headers = Collections.unmodifiableMap(m);<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span> this.contents = new byte[contents.length][];<a name="line.82"></a> +<span class="sourceLineNo">083</span> for (int i = 0; i < contents.length; i++) {<a name="line.83"></a> +<span class="sourceLineNo">084</span> Object c = contents[i];<a name="line.84"></a> +<span class="sourceLineNo">085</span> if (c == null)<a name="line.85"></a> +<span class="sourceLineNo">086</span> this.contents[i] = new byte[0];<a name="line.86"></a> +<span class="sourceLineNo">087</span> else if (c instanceof byte[])<a name="line.87"></a> +<span class="sourceLineNo">088</span> this.contents[i] = (byte[])c;<a name="line.88"></a> +<span class="sourceLineNo">089</span> else if (c instanceof InputStream)<a name="line.89"></a> +<span class="sourceLineNo">090</span> this.contents[i] = IOUtils.readBytes((InputStream)c, 1024);<a name="line.90"></a> +<span class="sourceLineNo">091</span> else if (c instanceof File)<a name="line.91"></a> +<span class="sourceLineNo">092</span> this.contents[i] = IOUtils.readBytes((File)c);<a name="line.92"></a> +<span class="sourceLineNo">093</span> else if (c instanceof Reader)<a name="line.93"></a> +<span class="sourceLineNo">094</span> this.contents[i] = IOUtils.read((Reader)c).getBytes(IOUtils.UTF8);<a name="line.94"></a> +<span class="sourceLineNo">095</span> else if (c instanceof CharSequence)<a name="line.95"></a> +<span class="sourceLineNo">096</span> this.contents[i] = ((CharSequence)c).toString().getBytes(IOUtils.UTF8);<a name="line.96"></a> +<span class="sourceLineNo">097</span> else<a name="line.97"></a> +<span class="sourceLineNo">098</span> throw new IOException("Invalid class type passed to StreamResource: " + c.getClass().getName());<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span> }<a name="line.100"></a> +<span class="sourceLineNo">101</span><a name="line.101"></a> +<span class="sourceLineNo">102</span> /**<a name="line.102"></a> +<span class="sourceLineNo">103</span> * Builder class for constructing {@link StreamResource} objects.<a name="line.103"></a> +<span class="sourceLineNo">104</span> */<a name="line.104"></a> +<span class="sourceLineNo">105</span> @SuppressWarnings("hiding")<a name="line.105"></a> +<span class="sourceLineNo">106</span> public static class Builder {<a name="line.106"></a> +<span class="sourceLineNo">107</span> ArrayList<Object> contents = new ArrayList<Object>();<a name="line.107"></a> +<span class="sourceLineNo">108</span> MediaType mediaType;<a name="line.108"></a> +<span class="sourceLineNo">109</span> Map<String,String> headers = new LinkedHashMap<String,String>();<a name="line.109"></a> +<span class="sourceLineNo">110</span><a name="line.110"></a> +<span class="sourceLineNo">111</span> /**<a name="line.111"></a> +<span class="sourceLineNo">112</span> * Specifies the resource media type string.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @param mediaType The resource media type string.<a name="line.113"></a> +<span class="sourceLineNo">114</span> * @return This object (for method chaining).<a name="line.114"></a> +<span class="sourceLineNo">115</span> */<a name="line.115"></a> +<span class="sourceLineNo">116</span> public Builder mediaType(String mediaType) {<a name="line.116"></a> +<span class="sourceLineNo">117</span> this.mediaType = MediaType.forString(mediaType);<a name="line.117"></a> +<span class="sourceLineNo">118</span> return this;<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> * Specifies the resource media type string.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @param mediaType The resource media type string.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @return This object (for method chaining).<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> public Builder mediaType(MediaType mediaType) {<a name="line.126"></a> +<span class="sourceLineNo">127</span> this.mediaType = mediaType;<a name="line.127"></a> +<span class="sourceLineNo">128</span> return this;<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> /**<a name="line.131"></a> +<span class="sourceLineNo">132</span> * Specifies the contents for this resource.<a name="line.132"></a> +<span class="sourceLineNo">133</span> * <p><a name="line.133"></a> +<span class="sourceLineNo">134</span> * This method can be called multiple times to add more content.<a name="line.134"></a> +<span class="sourceLineNo">135</span> *<a name="line.135"></a> +<span class="sourceLineNo">136</span> * @param contents The resource contents.<a name="line.136"></a> +<span class="sourceLineNo">137</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <br>Contents can be any of the following:<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <ul><a name="line.139"></a> +<span class="sourceLineNo">140</span> * <li><code><jk>byte</jk>[]</code><a name="line.140"></a> +<span class="sourceLineNo">141</span> * <li><code>InputStream</code><a name="line.141"></a> +<span class="sourceLineNo">142</span> * <li><code>Reader</code> - Converted to UTF-8 bytes.<a name="line.142"></a> +<span class="sourceLineNo">143</span> * <li><code>File</code><a name="line.143"></a> +<span class="sourceLineNo">144</span> * <li><code>CharSequence</code> - Converted to UTF-8 bytes.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * </ul><a name="line.145"></a> +<span class="sourceLineNo">146</span> * @return This object (for method chaining).<a name="line.146"></a> +<span class="sourceLineNo">147</span> */<a name="line.147"></a> +<span class="sourceLineNo">148</span> public Builder contents(Object...contents) {<a name="line.148"></a> +<span class="sourceLineNo">149</span> this.contents.addAll(Arrays.asList(contents));<a name="line.149"></a> +<span class="sourceLineNo">150</span> return this;<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> /**<a name="line.153"></a> +<span class="sourceLineNo">154</span> * Specifies an HTTP response header value.<a name="line.154"></a> +<span class="sourceLineNo">155</span> *<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @param name The HTTP header name.<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @param value The HTTP header value. Will be converted to a <code>String</code> using {@link Object#toString()}.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @return This object (for method chaining).<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> public Builder header(String name, Object value) {<a name="line.160"></a> +<span class="sourceLineNo">161</span> this.headers.put(name, StringUtils.toString(value));<a name="line.161"></a> +<span class="sourceLineNo">162</span> return this;<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Specifies HTTP response header values.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param headers The HTTP headers. Values will be converted to <code>Strings</code> using {@link Object#toString()}.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @return This object (for method chaining).<a name="line.169"></a> +<span class="sourceLineNo">170</span> */<a name="line.170"></a> +<span class="sourceLineNo">171</span> public Builder headers(Map<String,Object> headers) {<a name="line.171"></a> +<span class="sourceLineNo">172</span> for (Map.Entry<String,Object> e : headers.entrySet())<a name="line.172"></a> +<span class="sourceLineNo">173</span> header(e.getKey(), e.getValue());<a name="line.173"></a> +<span class="sourceLineNo">174</span> return this;<a name="line.174"></a> +<span class="sourceLineNo">175</span> }<a name="line.175"></a> +<span class="sourceLineNo">176</span><a name="line.176"></a> +<span class="sourceLineNo">177</span> /**<a name="line.177"></a> +<span class="sourceLineNo">178</span> * Create a new {@link StreamResource} using values in this builder.<a name="line.178"></a> +<span class="sourceLineNo">179</span> *<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @return A new immutable {@link StreamResource} object.<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @throws IOException<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> public StreamResource build() throws IOException {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return new StreamResource(mediaType, headers, contents.toArray());<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<a name="line.185"></a> +<span class="sourceLineNo">186</span> }<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> /**<a name="line.188"></a> +<span class="sourceLineNo">189</span> * Get the HTTP response headers.<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @return The HTTP response headers. An unmodifiable map. Never <jk>null</jk>.<a name="line.190"></a> +<span class="sourceLineNo">191</span> */<a name="line.191"></a> +<span class="sourceLineNo">192</span> public Map<String,String> getHeaders() {<a name="line.192"></a> +<span class="sourceLineNo">193</span> return headers;<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> @Override /* Streamable */<a name="line.196"></a> +<span class="sourceLineNo">197</span> public void streamTo(OutputStream os) throws IOException {<a name="line.197"></a> +<span class="sourceLineNo">198</span> for (byte[] b : contents)<a name="line.198"></a> +<span class="sourceLineNo">199</span> os.write(b);<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> @Override /* Streamable */<a name="line.202"></a> +<span class="sourceLineNo">203</span> public MediaType getMediaType() {<a name="line.203"></a> +<span class="sourceLineNo">204</span> return mediaType;<a name="line.204"></a> +<span class="sourceLineNo">205</span> }<a name="line.205"></a> +<span class="sourceLineNo">206</span>}<a name="line.206"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
