http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.html b/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.html index 4b25035..10bb134 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.html @@ -24,87 +24,219 @@ <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.rest.annotation.*;<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>import org.apache.juneau.svl.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>/**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * Represents the contents of a text file with convenience methods for resolving<a name="line.24"></a> -<span class="sourceLineNo">025</span> * {@link Parameter} variables and adding HTTP response headers.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * This class is handled special by the {@link WritableHandler} class.<a name="line.27"></a> -<span class="sourceLineNo">028</span> */<a name="line.28"></a> -<span class="sourceLineNo">029</span>public class ReaderResource implements Writable {<a name="line.29"></a> -<span class="sourceLineNo">030</span><a name="line.30"></a> -<span class="sourceLineNo">031</span> private String contents;<a name="line.31"></a> -<span class="sourceLineNo">032</span> private MediaType mediaType;<a name="line.32"></a> -<span class="sourceLineNo">033</span> private VarResolverSession varSession;<a name="line.33"></a> -<span class="sourceLineNo">034</span> private Map<String,String> headers = new LinkedHashMap<String,String>();<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> /**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Constructor.<a name="line.37"></a> -<span class="sourceLineNo">038</span> *<a name="line.38"></a> -<span class="sourceLineNo">039</span> * @param contents The contents of this resource.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * @param mediaType The HTTP media type.<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span> protected ReaderResource(String contents, MediaType mediaType) {<a name="line.42"></a> -<span class="sourceLineNo">043</span> this.contents = contents;<a name="line.43"></a> -<span class="sourceLineNo">044</span> this.mediaType = mediaType;<a name="line.44"></a> -<span class="sourceLineNo">045</span> }<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span> /**<a name="line.47"></a> -<span class="sourceLineNo">048</span> * Add an HTTP response header.<a name="line.48"></a> -<span class="sourceLineNo">049</span> *<a name="line.49"></a> -<span class="sourceLineNo">050</span> * @param name The header name.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * @param value The header value converted to a string using {@link Object#toString()}.<a name="line.51"></a> -<span class="sourceLineNo">052</span> * @return This object (for method chaining).<a name="line.52"></a> -<span class="sourceLineNo">053</span> */<a name="line.53"></a> -<span class="sourceLineNo">054</span> public ReaderResource setHeader(String name, Object value) {<a name="line.54"></a> -<span class="sourceLineNo">055</span> headers.put(name, value == null ? "" : value.toString());<a name="line.55"></a> -<span class="sourceLineNo">056</span> return this;<a name="line.56"></a> -<span class="sourceLineNo">057</span> }<a name="line.57"></a> -<span class="sourceLineNo">058</span><a name="line.58"></a> -<span class="sourceLineNo">059</span> /**<a name="line.59"></a> -<span class="sourceLineNo">060</span> * Use the specified {@link VarResolver} to resolve any {@link Parameter StringVars} in the<a name="line.60"></a> -<span class="sourceLineNo">061</span> * contents of this file when the {@link #writeTo(Writer)} or {@link #toString()} methods are called.<a name="line.61"></a> -<span class="sourceLineNo">062</span> *<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @param varSession The string variable resolver to use to resolve string variables.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * @return This object (for method chaining).<a name="line.64"></a> -<span class="sourceLineNo">065</span> */<a name="line.65"></a> -<span class="sourceLineNo">066</span> public ReaderResource setVarSession(VarResolverSession varSession) {<a name="line.66"></a> -<span class="sourceLineNo">067</span> this.varSession = varSession;<a name="line.67"></a> -<span class="sourceLineNo">068</span> return this;<a name="line.68"></a> -<span class="sourceLineNo">069</span> }<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /**<a name="line.71"></a> -<span class="sourceLineNo">072</span> * Get the HTTP response headers.<a name="line.72"></a> -<span class="sourceLineNo">073</span> *<a name="line.73"></a> -<span class="sourceLineNo">074</span> * @return The HTTP response headers.<a name="line.74"></a> -<span class="sourceLineNo">075</span> */<a name="line.75"></a> -<span class="sourceLineNo">076</span> public Map<String,String> getHeaders() {<a name="line.76"></a> -<span class="sourceLineNo">077</span> return headers;<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></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.annotation.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.rest.response.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.svl.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>/**<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Represents the contents of a text file with convenience methods for resolving<a name="line.25"></a> +<span class="sourceLineNo">026</span> * {@link Parameter} variables and adding HTTP response headers.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * This class is handled special by the {@link WritableHandler} class.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>public class ReaderResource implements Writable {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> private final MediaType mediaType;<a name="line.32"></a> +<span class="sourceLineNo">033</span> private final String[] contents;<a name="line.33"></a> +<span class="sourceLineNo">034</span> private final VarResolverSession varSession;<a name="line.34"></a> +<span class="sourceLineNo">035</span> private final Map<String,String> headers;<a name="line.35"></a> +<span class="sourceLineNo">036</span><a name="line.36"></a> +<span class="sourceLineNo">037</span> /**<a name="line.37"></a> +<span class="sourceLineNo">038</span> * Constructor.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * @param mediaType The HTTP media type.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @param contents The contents of this resource.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <br>Contents can be any of the following:<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <ul><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li><code>CharSequence</code><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li><code>Reader</code><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li><code>File</code><a name="line.46"></a> +<span class="sourceLineNo">047</span> * </ul><a name="line.47"></a> +<span class="sourceLineNo">048</span> * @throws IOException<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> protected ReaderResource(MediaType mediaType, Object...contents) throws IOException {<a name="line.50"></a> +<span class="sourceLineNo">051</span> this(mediaType, null, null, contents);<a name="line.51"></a> +<span class="sourceLineNo">052</span> }<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Constructor.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @param mediaType The resource media type.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param headers The HTTP response headers for this streamed resource.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param varSession Optional variable resolver for resolving variables in the string.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param contents The resource contents.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * <br>Contents can be any of the following:<a name="line.61"></a> +<span class="sourceLineNo">062</span> * <ul><a name="line.62"></a> +<span class="sourceLineNo">063</span> * <li><code>InputStream</code><a name="line.63"></a> +<span class="sourceLineNo">064</span> * <li><code>Reader</code> - Converted to UTF-8 bytes.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * <li><code>File</code><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <li><code>CharSequence</code> - Converted to UTF-8 bytes.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * </ul><a name="line.67"></a> +<span class="sourceLineNo">068</span> * @throws IOException<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> public ReaderResource(MediaType mediaType, Map<String,Object> headers, VarResolverSession varSession, Object...contents) throws IOException {<a name="line.70"></a> +<span class="sourceLineNo">071</span> this.mediaType = mediaType;<a name="line.71"></a> +<span class="sourceLineNo">072</span> this.varSession = varSession;<a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> Map<String,String> m = new LinkedHashMap<String,String>();<a name="line.74"></a> +<span class="sourceLineNo">075</span> if (headers != null)<a name="line.75"></a> +<span class="sourceLineNo">076</span> for (Map.Entry<String,Object> e : headers.entrySet())<a name="line.76"></a> +<span class="sourceLineNo">077</span> m.put(e.getKey(), StringUtils.toString(e.getValue()));<a name="line.77"></a> +<span class="sourceLineNo">078</span> this.headers = Collections.unmodifiableMap(m);<a name="line.78"></a> <span class="sourceLineNo">079</span><a name="line.79"></a> -<span class="sourceLineNo">080</span> @Override /* Writeable */<a name="line.80"></a> -<span class="sourceLineNo">081</span> public void writeTo(Writer w) throws IOException {<a name="line.81"></a> -<span class="sourceLineNo">082</span> if (varSession != null)<a name="line.82"></a> -<span class="sourceLineNo">083</span> varSession.resolveTo(contents, w);<a name="line.83"></a> -<span class="sourceLineNo">084</span> else<a name="line.84"></a> -<span class="sourceLineNo">085</span> w.write(contents);<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> @Override /* Streamable */<a name="line.88"></a> -<span class="sourceLineNo">089</span> public MediaType getMediaType() {<a name="line.89"></a> -<span class="sourceLineNo">090</span> return mediaType;<a name="line.90"></a> -<span class="sourceLineNo">091</span> }<a name="line.91"></a> -<span class="sourceLineNo">092</span><a name="line.92"></a> -<span class="sourceLineNo">093</span> @Override /* Object */<a name="line.93"></a> -<span class="sourceLineNo">094</span> public String toString() {<a name="line.94"></a> -<span class="sourceLineNo">095</span> if (varSession != null)<a name="line.95"></a> -<span class="sourceLineNo">096</span> return varSession.resolve(contents);<a name="line.96"></a> -<span class="sourceLineNo">097</span> return contents;<a name="line.97"></a> -<span class="sourceLineNo">098</span> }<a name="line.98"></a> -<span class="sourceLineNo">099</span>}<a name="line.99"></a> +<span class="sourceLineNo">080</span> this.contents = new String[contents.length];<a name="line.80"></a> +<span class="sourceLineNo">081</span> for (int i = 0; i < contents.length; i++) {<a name="line.81"></a> +<span class="sourceLineNo">082</span> Object c = contents[i];<a name="line.82"></a> +<span class="sourceLineNo">083</span> if (c == null)<a name="line.83"></a> +<span class="sourceLineNo">084</span> this.contents[i] = "";<a name="line.84"></a> +<span class="sourceLineNo">085</span> else if (c instanceof InputStream)<a name="line.85"></a> +<span class="sourceLineNo">086</span> this.contents[i] = IOUtils.read((InputStream)c);<a name="line.86"></a> +<span class="sourceLineNo">087</span> else if (c instanceof File)<a name="line.87"></a> +<span class="sourceLineNo">088</span> this.contents[i] = IOUtils.read((File)c);<a name="line.88"></a> +<span class="sourceLineNo">089</span> else if (c instanceof Reader)<a name="line.89"></a> +<span class="sourceLineNo">090</span> this.contents[i] = IOUtils.read((Reader)c);<a name="line.90"></a> +<span class="sourceLineNo">091</span> else if (c instanceof CharSequence)<a name="line.91"></a> +<span class="sourceLineNo">092</span> this.contents[i] = ((CharSequence)c).toString();<a name="line.92"></a> +<span class="sourceLineNo">093</span> else<a name="line.93"></a> +<span class="sourceLineNo">094</span> throw new IOException("Invalid class type passed to ReaderResource: " + c.getClass().getName());<a name="line.94"></a> +<span class="sourceLineNo">095</span> }<a name="line.95"></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> /**<a name="line.98"></a> +<span class="sourceLineNo">099</span> * Builder class for constructing {@link ReaderResource} objects.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> @SuppressWarnings("hiding")<a name="line.101"></a> +<span class="sourceLineNo">102</span> public static class Builder {<a name="line.102"></a> +<span class="sourceLineNo">103</span> ArrayList<Object> contents = new ArrayList<Object>();<a name="line.103"></a> +<span class="sourceLineNo">104</span> MediaType mediaType;<a name="line.104"></a> +<span class="sourceLineNo">105</span> VarResolverSession varResolver;<a name="line.105"></a> +<span class="sourceLineNo">106</span> Map<String,String> headers = new LinkedHashMap<String,String>();<a name="line.106"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> /**<a name="line.108"></a> +<span class="sourceLineNo">109</span> * Specifies the resource media type string.<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @param mediaType The resource media type string.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @return This object (for method chaining).<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> public Builder mediaType(String mediaType) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> this.mediaType = MediaType.forString(mediaType);<a name="line.114"></a> +<span class="sourceLineNo">115</span> return this;<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Specifies the resource media type string.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param mediaType The resource media type string.<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @return This object (for method chaining).<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> public Builder mediaType(MediaType mediaType) {<a name="line.123"></a> +<span class="sourceLineNo">124</span> this.mediaType = mediaType;<a name="line.124"></a> +<span class="sourceLineNo">125</span> return this;<a name="line.125"></a> +<span class="sourceLineNo">126</span> }<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> * Specifies the contents for this resource.<a name="line.129"></a> +<span class="sourceLineNo">130</span> * <p><a name="line.130"></a> +<span class="sourceLineNo">131</span> * This method can be called multiple times to add more content.<a name="line.131"></a> +<span class="sourceLineNo">132</span> *<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @param contents The resource contents.<a name="line.133"></a> +<span class="sourceLineNo">134</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.134"></a> +<span class="sourceLineNo">135</span> * <br>Contents can be any of the following:<a name="line.135"></a> +<span class="sourceLineNo">136</span> * <ul><a name="line.136"></a> +<span class="sourceLineNo">137</span> * <li><code>InputStream</code><a name="line.137"></a> +<span class="sourceLineNo">138</span> * <li><code>Reader</code> - Converted to UTF-8 bytes.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <li><code>File</code><a name="line.139"></a> +<span class="sourceLineNo">140</span> * <li><code>CharSequence</code> - Converted to UTF-8 bytes.<a name="line.140"></a> +<span class="sourceLineNo">141</span> * </ul><a name="line.141"></a> +<span class="sourceLineNo">142</span> * @return This object (for method chaining).<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> public Builder contents(Object...contents) {<a name="line.144"></a> +<span class="sourceLineNo">145</span> this.contents.addAll(Arrays.asList(contents));<a name="line.145"></a> +<span class="sourceLineNo">146</span> return this;<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> * Specifies an HTTP response header value.<a name="line.150"></a> +<span class="sourceLineNo">151</span> *<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param name The HTTP header name.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @param value The HTTP header value. Will be converted to a <code>String</code> using {@link Object#toString()}.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * @return This object (for method chaining).<a name="line.154"></a> +<span class="sourceLineNo">155</span> */<a name="line.155"></a> +<span class="sourceLineNo">156</span> public Builder header(String name, Object value) {<a name="line.156"></a> +<span class="sourceLineNo">157</span> this.headers.put(name, StringUtils.toString(value));<a name="line.157"></a> +<span class="sourceLineNo">158</span> return this;<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> /**<a name="line.161"></a> +<span class="sourceLineNo">162</span> * Specifies HTTP response header values.<a name="line.162"></a> +<span class="sourceLineNo">163</span> *<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @param headers The HTTP headers. Values will be converted to <code>Strings</code> using {@link Object#toString()}.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * @return This object (for method chaining).<a name="line.165"></a> +<span class="sourceLineNo">166</span> */<a name="line.166"></a> +<span class="sourceLineNo">167</span> public Builder headers(Map<String,Object> headers) {<a name="line.167"></a> +<span class="sourceLineNo">168</span> for (Map.Entry<String,Object> e : headers.entrySet())<a name="line.168"></a> +<span class="sourceLineNo">169</span> header(e.getKey(), e.getValue());<a name="line.169"></a> +<span class="sourceLineNo">170</span> return this;<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> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Specifies the variable resolver to use for this resource.<a name="line.174"></a> +<span class="sourceLineNo">175</span> *<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param varResolver The variable resolver.<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @return This object (for method chaining).<a name="line.177"></a> +<span class="sourceLineNo">178</span> */<a name="line.178"></a> +<span class="sourceLineNo">179</span> public Builder varResolver(VarResolverSession varResolver) {<a name="line.179"></a> +<span class="sourceLineNo">180</span> this.varResolver = varResolver;<a name="line.180"></a> +<span class="sourceLineNo">181</span> return this;<a name="line.181"></a> +<span class="sourceLineNo">182</span> }<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> /**<a name="line.184"></a> +<span class="sourceLineNo">185</span> * Create a new {@link ReaderResource} using values in this builder.<a name="line.185"></a> +<span class="sourceLineNo">186</span> *<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @return A new immutable {@link ReaderResource} object.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @throws IOException<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> public ReaderResource build() throws IOException {<a name="line.190"></a> +<span class="sourceLineNo">191</span> return new ReaderResource(mediaType, headers, varResolver, contents.toArray());<a name="line.191"></a> +<span class="sourceLineNo">192</span> }<a name="line.192"></a> +<span class="sourceLineNo">193</span> }<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> * Get the HTTP response headers.<a name="line.196"></a> +<span class="sourceLineNo">197</span> *<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @return The HTTP response headers.<a name="line.198"></a> +<span class="sourceLineNo">199</span> */<a name="line.199"></a> +<span class="sourceLineNo">200</span> public Map<String,String> getHeaders() {<a name="line.200"></a> +<span class="sourceLineNo">201</span> return headers;<a name="line.201"></a> +<span class="sourceLineNo">202</span> }<a name="line.202"></a> +<span class="sourceLineNo">203</span><a name="line.203"></a> +<span class="sourceLineNo">204</span> @Override /* Writeable */<a name="line.204"></a> +<span class="sourceLineNo">205</span> public void writeTo(Writer w) throws IOException {<a name="line.205"></a> +<span class="sourceLineNo">206</span> for (String s : contents) {<a name="line.206"></a> +<span class="sourceLineNo">207</span> if (varSession != null)<a name="line.207"></a> +<span class="sourceLineNo">208</span> varSession.resolveTo(s, w);<a name="line.208"></a> +<span class="sourceLineNo">209</span> else<a name="line.209"></a> +<span class="sourceLineNo">210</span> w.write(s);<a name="line.210"></a> +<span class="sourceLineNo">211</span> }<a name="line.211"></a> +<span class="sourceLineNo">212</span> }<a name="line.212"></a> +<span class="sourceLineNo">213</span><a name="line.213"></a> +<span class="sourceLineNo">214</span> @Override /* Writeable */<a name="line.214"></a> +<span class="sourceLineNo">215</span> public MediaType getMediaType() {<a name="line.215"></a> +<span class="sourceLineNo">216</span> return mediaType;<a name="line.216"></a> +<span class="sourceLineNo">217</span> }<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> @Override /* Object */<a name="line.219"></a> +<span class="sourceLineNo">220</span> public String toString() {<a name="line.220"></a> +<span class="sourceLineNo">221</span> if (contents.length == 1 && varSession == null)<a name="line.221"></a> +<span class="sourceLineNo">222</span> return contents[0];<a name="line.222"></a> +<span class="sourceLineNo">223</span> StringWriter sw = new StringWriter();<a name="line.223"></a> +<span class="sourceLineNo">224</span> for (String s : contents) {<a name="line.224"></a> +<span class="sourceLineNo">225</span> if (varSession != null)<a name="line.225"></a> +<span class="sourceLineNo">226</span> return varSession.resolve(s);<a name="line.226"></a> +<span class="sourceLineNo">227</span> sw.write(s);<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span> return sw.toString();<a name="line.229"></a> +<span class="sourceLineNo">230</span> }<a name="line.230"></a> +<span class="sourceLineNo">231</span>}<a name="line.231"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html b/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html index 7160806..5c706eb 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html @@ -74,76 +74,94 @@ <span class="sourceLineNo">066</span> */<a name="line.66"></a> <span class="sourceLineNo">067</span>public final class Redirect {<a name="line.67"></a> <span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> private int httpResponseCode;<a name="line.69"></a> -<span class="sourceLineNo">070</span> private String url;<a name="line.70"></a> -<span class="sourceLineNo">071</span> private Object[] args;<a name="line.71"></a> +<span class="sourceLineNo">069</span> private final int httpResponseCode;<a name="line.69"></a> +<span class="sourceLineNo">070</span> private final String url;<a name="line.70"></a> +<span class="sourceLineNo">071</span> private final Object[] args;<a name="line.71"></a> <span class="sourceLineNo">072</span><a name="line.72"></a> <span class="sourceLineNo">073</span> /**<a name="line.73"></a> <span class="sourceLineNo">074</span> * Redirect to the specified URL.<a name="line.74"></a> <span class="sourceLineNo">075</span> * Relative paths are interpreted as relative to the servlet path.<a name="line.75"></a> <span class="sourceLineNo">076</span> *<a name="line.76"></a> <span class="sourceLineNo">077</span> * @param url The URL to redirect to.<a name="line.77"></a> -<span class="sourceLineNo">078</span> * @param args Optional {@link MessageFormat}-style arguments.<a name="line.78"></a> -<span class="sourceLineNo">079</span> */<a name="line.79"></a> -<span class="sourceLineNo">080</span> public Redirect(CharSequence url, Object...args) {<a name="line.80"></a> -<span class="sourceLineNo">081</span> this.url = (url == null ? null : url.toString());<a name="line.81"></a> -<span class="sourceLineNo">082</span> this.args = args;<a name="line.82"></a> -<span class="sourceLineNo">083</span> }<a name="line.83"></a> -<span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span> /**<a name="line.85"></a> -<span class="sourceLineNo">086</span> * Convenience method for redirecting to instance of {@link URL} and {@link URI}.<a name="line.86"></a> -<span class="sourceLineNo">087</span> * Same as calling <code>toString()</code> on the object and using the other constructor.<a name="line.87"></a> -<span class="sourceLineNo">088</span> *<a name="line.88"></a> -<span class="sourceLineNo">089</span> * @param url The URL to redirect to.<a name="line.89"></a> -<span class="sourceLineNo">090</span> */<a name="line.90"></a> -<span class="sourceLineNo">091</span> public Redirect(Object url) {<a name="line.91"></a> -<span class="sourceLineNo">092</span> this.url = (url == null ? null : url.toString());<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span><a name="line.94"></a> -<span class="sourceLineNo">095</span> /**<a name="line.95"></a> -<span class="sourceLineNo">096</span> * Redirect to the specified URL.<a name="line.96"></a> -<span class="sourceLineNo">097</span> * Relative paths are interpreted as relative to the servlet path.<a name="line.97"></a> -<span class="sourceLineNo">098</span> *<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @param httpResponseCode The HTTP response code.<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @param url The URL to redirect to.<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @param args Optional {@link MessageFormat}-style arguments.<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> public Redirect(int httpResponseCode, CharSequence url, Object...args) {<a name="line.103"></a> -<span class="sourceLineNo">104</span> this.httpResponseCode = httpResponseCode;<a name="line.104"></a> -<span class="sourceLineNo">105</span> this.url = (url == null ? null : url.toString());<a name="line.105"></a> -<span class="sourceLineNo">106</span> this.args = args;<a name="line.106"></a> -<span class="sourceLineNo">107</span> }<a name="line.107"></a> -<span class="sourceLineNo">108</span><a name="line.108"></a> -<span class="sourceLineNo">109</span> /**<a name="line.109"></a> -<span class="sourceLineNo">110</span> * Shortcut for redirecting to the servlet root.<a name="line.110"></a> -<span class="sourceLineNo">111</span> */<a name="line.111"></a> -<span class="sourceLineNo">112</span> public Redirect() {<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> * Calculates the URL to redirect to.<a name="line.116"></a> -<span class="sourceLineNo">117</span> *<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @param s Use this serializer to encode arguments using the {@link UrlEncodingSerializer#serializeUrlPart(Object)} method.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @return The URL to redirect to.<a name="line.119"></a> -<span class="sourceLineNo">120</span> */<a name="line.120"></a> -<span class="sourceLineNo">121</span> public String toUrl(UrlEncodingSerializer s) {<a name="line.121"></a> -<span class="sourceLineNo">122</span> if (url != null && args != null && args.length > 0) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> for (int i = 0; i < args.length; i++)<a name="line.123"></a> -<span class="sourceLineNo">124</span> args[i] = s.serializeUrlPart(args[i]);<a name="line.124"></a> -<span class="sourceLineNo">125</span> url = MessageFormat.format(url, args);<a name="line.125"></a> -<span class="sourceLineNo">126</span> }<a name="line.126"></a> -<span class="sourceLineNo">127</span> return url;<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 response code passed in through the constructor.<a name="line.131"></a> -<span class="sourceLineNo">132</span> *<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @return The response code passed in through the constructor, or <code>0</code> if response code wasn't specified.<a name="line.133"></a> -<span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> public int getHttpResponseCode() {<a name="line.135"></a> -<span class="sourceLineNo">136</span> return httpResponseCode;<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">078</span> * <br>Can be any of the following:<a name="line.78"></a> +<span class="sourceLineNo">079</span> * <ul><a name="line.79"></a> +<span class="sourceLineNo">080</span> * <li><code>URL</code><a name="line.80"></a> +<span class="sourceLineNo">081</span> * <li><code>URI</code><a name="line.81"></a> +<span class="sourceLineNo">082</span> * <li><code>CharSequence</code><a name="line.82"></a> +<span class="sourceLineNo">083</span> * </ul><a name="line.83"></a> +<span class="sourceLineNo">084</span> * @param args Optional {@link MessageFormat}-style arguments.<a name="line.84"></a> +<span class="sourceLineNo">085</span> */<a name="line.85"></a> +<span class="sourceLineNo">086</span> public Redirect(Object url, Object...args) {<a name="line.86"></a> +<span class="sourceLineNo">087</span> this(0, url, args);<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> /**<a name="line.90"></a> +<span class="sourceLineNo">091</span> * Convenience method for redirecting to instance of {@link URL} and {@link URI}.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * Same as calling <code>toString()</code> on the object and using the other constructor.<a name="line.92"></a> +<span class="sourceLineNo">093</span> *<a name="line.93"></a> +<span class="sourceLineNo">094</span> * @param url The URL to redirect to.<a name="line.94"></a> +<span class="sourceLineNo">095</span> * <br>Can be any of the following:<a name="line.95"></a> +<span class="sourceLineNo">096</span> * <ul><a name="line.96"></a> +<span class="sourceLineNo">097</span> * <li><code>URL</code><a name="line.97"></a> +<span class="sourceLineNo">098</span> * <li><code>URI</code><a name="line.98"></a> +<span class="sourceLineNo">099</span> * <li><code>CharSequence</code><a name="line.99"></a> +<span class="sourceLineNo">100</span> * </ul><a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> public Redirect(Object url) {<a name="line.102"></a> +<span class="sourceLineNo">103</span> this(0, url, (Object[])null);<a name="line.103"></a> +<span class="sourceLineNo">104</span> }<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> /**<a name="line.106"></a> +<span class="sourceLineNo">107</span> * Redirect to the specified URL.<a name="line.107"></a> +<span class="sourceLineNo">108</span> * Relative paths are interpreted as relative to the servlet path.<a name="line.108"></a> +<span class="sourceLineNo">109</span> *<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @param httpResponseCode The HTTP response code.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @param url The URL to redirect to.<a name="line.111"></a> +<span class="sourceLineNo">112</span> * <br>Can be any of the following:<a name="line.112"></a> +<span class="sourceLineNo">113</span> * <ul><a name="line.113"></a> +<span class="sourceLineNo">114</span> * <li><code>URL</code><a name="line.114"></a> +<span class="sourceLineNo">115</span> * <li><code>URI</code><a name="line.115"></a> +<span class="sourceLineNo">116</span> * <li><code>CharSequence</code><a name="line.116"></a> +<span class="sourceLineNo">117</span> * </ul><a name="line.117"></a> +<span class="sourceLineNo">118</span> * @param args Optional {@link MessageFormat}-style arguments.<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> public Redirect(int httpResponseCode, Object url, Object...args) {<a name="line.120"></a> +<span class="sourceLineNo">121</span> this.httpResponseCode = httpResponseCode;<a name="line.121"></a> +<span class="sourceLineNo">122</span> this.url = (url == null ? null : url.toString());<a name="line.122"></a> +<span class="sourceLineNo">123</span> this.args = args;<a name="line.123"></a> +<span class="sourceLineNo">124</span> }<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> /**<a name="line.126"></a> +<span class="sourceLineNo">127</span> * Shortcut for redirecting to the servlet root.<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> public Redirect() {<a name="line.129"></a> +<span class="sourceLineNo">130</span> this(0, null, (Object[])null);<a name="line.130"></a> +<span class="sourceLineNo">131</span> }<a name="line.131"></a> +<span class="sourceLineNo">132</span><a name="line.132"></a> +<span class="sourceLineNo">133</span> /**<a name="line.133"></a> +<span class="sourceLineNo">134</span> * Calculates the URL to redirect to.<a name="line.134"></a> +<span class="sourceLineNo">135</span> *<a name="line.135"></a> +<span class="sourceLineNo">136</span> * @param s Use this serializer to encode arguments using the {@link UrlEncodingSerializer#serializeUrlPart(Object)} method.<a name="line.136"></a> +<span class="sourceLineNo">137</span> * @return The URL to redirect to.<a name="line.137"></a> +<span class="sourceLineNo">138</span> */<a name="line.138"></a> +<span class="sourceLineNo">139</span> public String toUrl(UrlEncodingSerializer s) {<a name="line.139"></a> +<span class="sourceLineNo">140</span> if (url != null && args != null && args.length > 0) {<a name="line.140"></a> +<span class="sourceLineNo">141</span> for (int i = 0; i < args.length; i++)<a name="line.141"></a> +<span class="sourceLineNo">142</span> args[i] = s.serializeUrlPart(args[i]);<a name="line.142"></a> +<span class="sourceLineNo">143</span> return MessageFormat.format(url, args);<a name="line.143"></a> +<span class="sourceLineNo">144</span> }<a name="line.144"></a> +<span class="sourceLineNo">145</span> return url;<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> * Returns the response code passed in through the constructor.<a name="line.149"></a> +<span class="sourceLineNo">150</span> *<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @return The response code passed in through the constructor, or <code>0</code> if response code wasn't specified.<a name="line.151"></a> +<span class="sourceLineNo">152</span> */<a name="line.152"></a> +<span class="sourceLineNo">153</span> public int getHttpResponseCode() {<a name="line.153"></a> +<span class="sourceLineNo">154</span> return httpResponseCode;<a name="line.154"></a> +<span class="sourceLineNo">155</span> }<a name="line.155"></a> +<span class="sourceLineNo">156</span>}<a name="line.156"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/src-html/org/apache/juneau/rest/RestException.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestException.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestException.html index 76f628d..bd45b67 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestException.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestException.html @@ -33,7 +33,7 @@ <span class="sourceLineNo">025</span><a name="line.25"></a> <span class="sourceLineNo">026</span> private static final long serialVersionUID = 1L;<a name="line.26"></a> <span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span> private int status;<a name="line.28"></a> +<span class="sourceLineNo">028</span> private final int status;<a name="line.28"></a> <span class="sourceLineNo">029</span> private int occurrence;<a name="line.29"></a> <span class="sourceLineNo">030</span><a name="line.30"></a> <span class="sourceLineNo">031</span> /**<a name="line.31"></a>
