Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 19e9b7df6 -> 145378ede
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/145378ed/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UrlEncodingSerializer.PlainText.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UrlEncodingSerializer.PlainText.html b/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UrlEncodingSerializer.PlainText.html new file mode 100644 index 0000000..409861a --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/urlencoding/UrlEncodingSerializer.PlainText.html @@ -0,0 +1,540 @@ +<!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.urlencoding;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.serializer.SerializerContext.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import static org.apache.juneau.uon.UonSerializerContext.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.io.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.lang.reflect.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.net.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.juneau.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.juneau.annotation.*;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.juneau.http.*;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.juneau.internal.*;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.juneau.serializer.*;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.juneau.transform.*;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.juneau.uon.*;<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> +<span class="sourceLineNo">032</span> * Serializes POJO models to URL-encoded notation with UON-encoded values (a notation for URL-encoded query paramter values).<a name="line.32"></a> +<span class="sourceLineNo">033</span> *<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <h5 class='section'>Media types:</h5><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * Handles <code>Accept</code> types: <code>application/x-www-form-urlencoded</code><a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * Produces <code>Content-Type</code> types: <code>application/x-www-form-urlencoded</code><a name="line.38"></a> +<span class="sourceLineNo">039</span> *<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <h5 class='section'>Description:</h5><a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * However, custom serializers can be constructed to fine-tune behavior.<a name="line.43"></a> +<span class="sourceLineNo">044</span> *<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <h5 class='section'>Configurable properties:</h5><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <p><a name="line.46"></a> +<span class="sourceLineNo">047</span> * This class has the following properties associated with it:<a name="line.47"></a> +<span class="sourceLineNo">048</span> * <ul><a name="line.48"></a> +<span class="sourceLineNo">049</span> * <li>{@link UonSerializerContext}<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <li>{@link BeanContext}<a name="line.50"></a> +<span class="sourceLineNo">051</span> * </ul><a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> +<span class="sourceLineNo">053</span> * The following shows a sample object defined in Javascript:<a name="line.53"></a> +<span class="sourceLineNo">054</span> * </p><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <p class='bcode'><a name="line.55"></a> +<span class="sourceLineNo">056</span> * {<a name="line.56"></a> +<span class="sourceLineNo">057</span> * id: 1,<a name="line.57"></a> +<span class="sourceLineNo">058</span> * name: <js>'John Smith'</js>,<a name="line.58"></a> +<span class="sourceLineNo">059</span> * uri: <js>'http://sample/addressBook/person/1'</js>,<a name="line.59"></a> +<span class="sourceLineNo">060</span> * addressBookUri: <js>'http://sample/addressBook'</js>,<a name="line.60"></a> +<span class="sourceLineNo">061</span> * birthDate: <js>'1946-08-12T00:00:00Z'</js>,<a name="line.61"></a> +<span class="sourceLineNo">062</span> * otherIds: <jk>null</jk>,<a name="line.62"></a> +<span class="sourceLineNo">063</span> * addresses: [<a name="line.63"></a> +<span class="sourceLineNo">064</span> * {<a name="line.64"></a> +<span class="sourceLineNo">065</span> * uri: <js>'http://sample/addressBook/address/1'</js>,<a name="line.65"></a> +<span class="sourceLineNo">066</span> * personUri: <js>'http://sample/addressBook/person/1'</js>,<a name="line.66"></a> +<span class="sourceLineNo">067</span> * id: 1,<a name="line.67"></a> +<span class="sourceLineNo">068</span> * street: <js>'100 Main Street'</js>,<a name="line.68"></a> +<span class="sourceLineNo">069</span> * city: <js>'Anywhereville'</js>,<a name="line.69"></a> +<span class="sourceLineNo">070</span> * state: <js>'NY'</js>,<a name="line.70"></a> +<span class="sourceLineNo">071</span> * zip: 12345,<a name="line.71"></a> +<span class="sourceLineNo">072</span> * isCurrent: <jk>true</jk>,<a name="line.72"></a> +<span class="sourceLineNo">073</span> * }<a name="line.73"></a> +<span class="sourceLineNo">074</span> * ]<a name="line.74"></a> +<span class="sourceLineNo">075</span> * }<a name="line.75"></a> +<span class="sourceLineNo">076</span> * </p><a name="line.76"></a> +<span class="sourceLineNo">077</span> * <p><a name="line.77"></a> +<span class="sourceLineNo">078</span> * Using the "strict" syntax defined in this document, the equivalent<a name="line.78"></a> +<span class="sourceLineNo">079</span> * URL-encoded notation would be as follows:<a name="line.79"></a> +<span class="sourceLineNo">080</span> * </p><a name="line.80"></a> +<span class="sourceLineNo">081</span> * <p class='bcode'><a name="line.81"></a> +<span class="sourceLineNo">082</span> * <ua>id</ua>=<un>1</un><a name="line.82"></a> +<span class="sourceLineNo">083</span> * &amp;<ua>name</ua>=<us>'John+Smith'</us>,<a name="line.83"></a> +<span class="sourceLineNo">084</span> * &amp;<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,<a name="line.84"></a> +<span class="sourceLineNo">085</span> * &amp;<ua>addressBookUri</ua>=<us>http://sample/addressBook</us>,<a name="line.85"></a> +<span class="sourceLineNo">086</span> * &amp;<ua>birthDate</ua>=<us>1946-08-12T00:00:00Z</us>,<a name="line.86"></a> +<span class="sourceLineNo">087</span> * &amp;<ua>otherIds</ua>=<uk>null</uk>,<a name="line.87"></a> +<span class="sourceLineNo">088</span> * &amp;<ua>addresses</ua>=@(<a name="line.88"></a> +<span class="sourceLineNo">089</span> * (<a name="line.89"></a> +<span class="sourceLineNo">090</span> * <ua>uri</ua>=<us>http://sample/addressBook/address/1</us>,<a name="line.90"></a> +<span class="sourceLineNo">091</span> * <ua>personUri</ua>=<us>http://sample/addressBook/person/1</us>,<a name="line.91"></a> +<span class="sourceLineNo">092</span> * <ua>id</ua>=<un>1</un>,<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <ua>street</ua>=<us>'100+Main+Street'</us>,<a name="line.93"></a> +<span class="sourceLineNo">094</span> * <ua>city</ua>=<us>Anywhereville</us>,<a name="line.94"></a> +<span class="sourceLineNo">095</span> * <ua>state</ua>=<us>NY</us>,<a name="line.95"></a> +<span class="sourceLineNo">096</span> * <ua>zip</ua>=<un>12345</un>,<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <ua>isCurrent</ua>=<uk>true</uk><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">100</span> * </p><a name="line.100"></a> +<span class="sourceLineNo">101</span> *<a name="line.101"></a> +<span class="sourceLineNo">102</span> * <h5 class='section'>Example:</h5><a name="line.102"></a> +<span class="sourceLineNo">103</span> * <p class='bcode'><a name="line.103"></a> +<span class="sourceLineNo">104</span> * <jc>// Serialize a Map</jc><a name="line.104"></a> +<span class="sourceLineNo">105</span> * Map m = <jk>new</jk> ObjectMap(<js>"{a:'b',c:1,d:false,e:['f',1,false],g:{h:'i'}}"</js>);<a name="line.105"></a> +<span class="sourceLineNo">106</span> *<a name="line.106"></a> +<span class="sourceLineNo">107</span> * <jc>// Serialize to value equivalent to JSON.</jc><a name="line.107"></a> +<span class="sourceLineNo">108</span> * <jc>// Produces "a=b&amp;c=1&amp;d=false&amp;e=@(f,1,false)&amp;g=(h=i)"</jc><a name="line.108"></a> +<span class="sourceLineNo">109</span> * String s = UrlEncodingSerializer.<jsf>DEFAULT</jsf>.serialize(s);<a name="line.109"></a> +<span class="sourceLineNo">110</span> *<a name="line.110"></a> +<span class="sourceLineNo">111</span> * <jc>// Serialize a bean</jc><a name="line.111"></a> +<span class="sourceLineNo">112</span> * <jk>public class</jk> Person {<a name="line.112"></a> +<span class="sourceLineNo">113</span> * <jk>public</jk> Person(String s);<a name="line.113"></a> +<span class="sourceLineNo">114</span> * <jk>public</jk> String getName();<a name="line.114"></a> +<span class="sourceLineNo">115</span> * <jk>public int</jk> getAge();<a name="line.115"></a> +<span class="sourceLineNo">116</span> * <jk>public</jk> Address getAddress();<a name="line.116"></a> +<span class="sourceLineNo">117</span> * <jk>public boolean</jk> deceased;<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> * <jk>public class</jk> Address {<a name="line.120"></a> +<span class="sourceLineNo">121</span> * <jk>public</jk> String getStreet();<a name="line.121"></a> +<span class="sourceLineNo">122</span> * <jk>public</jk> String getCity();<a name="line.122"></a> +<span class="sourceLineNo">123</span> * <jk>public</jk> String getState();<a name="line.123"></a> +<span class="sourceLineNo">124</span> * <jk>public int</jk> getZip();<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> * Person p = <jk>new</jk> Person(<js>"John Doe"</js>, 23, <js>"123 Main St"</js>, <js>"Anywhere"</js>, <js>"NY"</js>, 12345, <jk>false</jk>);<a name="line.127"></a> +<span class="sourceLineNo">128</span> *<a name="line.128"></a> +<span class="sourceLineNo">129</span> * <jc>// Produces "name=John+Doe&amp;age=23&amp;address=(street='123+Main+St',city=Anywhere,state=NY,zip=12345)&amp;deceased=false"</jc><a name="line.129"></a> +<span class="sourceLineNo">130</span> * String s = UrlEncodingSerializer.<jsf>DEFAULT</jsf>.serialize(s);<a name="line.130"></a> +<span class="sourceLineNo">131</span> * </p><a name="line.131"></a> +<span class="sourceLineNo">132</span> */<a name="line.132"></a> +<span class="sourceLineNo">133</span>@Produces("application/x-www-form-urlencoded")<a name="line.133"></a> +<span class="sourceLineNo">134</span>@SuppressWarnings("hiding")<a name="line.134"></a> +<span class="sourceLineNo">135</span>public class UrlEncodingSerializer extends UonSerializer implements PartSerializer {<a name="line.135"></a> +<span class="sourceLineNo">136</span><a name="line.136"></a> +<span class="sourceLineNo">137</span> /** Reusable instance of {@link UrlEncodingSerializer}, all default settings. */<a name="line.137"></a> +<span class="sourceLineNo">138</span> public static final UrlEncodingSerializer DEFAULT = new UrlEncodingSerializer(PropertyStore.create());<a name="line.138"></a> +<span class="sourceLineNo">139</span><a name="line.139"></a> +<span class="sourceLineNo">140</span> /** Reusable instance of {@link UrlEncodingSerializer.PlainText}. */<a name="line.140"></a> +<span class="sourceLineNo">141</span> public static final UrlEncodingSerializer DEFAULT_PLAINTEXT = new PlainText(PropertyStore.create());<a name="line.141"></a> +<span class="sourceLineNo">142</span><a name="line.142"></a> +<span class="sourceLineNo">143</span> /** Reusable instance of {@link UrlEncodingSerializer.Expanded}. */<a name="line.143"></a> +<span class="sourceLineNo">144</span> public static final UrlEncodingSerializer DEFAULT_EXPANDED = new Expanded(PropertyStore.create());<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> /** Reusable instance of {@link UrlEncodingSerializer.Readable}. */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public static final UrlEncodingSerializer DEFAULT_READABLE = new Readable(PropertyStore.create());<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> * Equivalent to <code><jk>new</jk> UrlEncodingSerializerBuilder().expandedParams(<jk>true</jk>).build();</code>.<a name="line.150"></a> +<span class="sourceLineNo">151</span> */<a name="line.151"></a> +<span class="sourceLineNo">152</span> @Produces(value="application/x-www-form-urlencoded",contentType="application/x-www-form-urlencoded")<a name="line.152"></a> +<span class="sourceLineNo">153</span> public static class Expanded extends UrlEncodingSerializer {<a name="line.153"></a> +<span class="sourceLineNo">154</span><a name="line.154"></a> +<span class="sourceLineNo">155</span> /**<a name="line.155"></a> +<span class="sourceLineNo">156</span> * Constructor.<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @param propertyStore The property store containing all the settings for this object.<a name="line.157"></a> +<span class="sourceLineNo">158</span> */<a name="line.158"></a> +<span class="sourceLineNo">159</span> public Expanded(PropertyStore propertyStore) {<a name="line.159"></a> +<span class="sourceLineNo">160</span> super(propertyStore);<a name="line.160"></a> +<span class="sourceLineNo">161</span> }<a name="line.161"></a> +<span class="sourceLineNo">162</span><a name="line.162"></a> +<span class="sourceLineNo">163</span> @Override /* CoreObject */<a name="line.163"></a> +<span class="sourceLineNo">164</span> protected ObjectMap getOverrideProperties() {<a name="line.164"></a> +<span class="sourceLineNo">165</span> return super.getOverrideProperties().append(UrlEncodingContext.URLENC_expandedParams, true);<a name="line.165"></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><a name="line.168"></a> +<span class="sourceLineNo">169</span> /**<a name="line.169"></a> +<span class="sourceLineNo">170</span> * Equivalent to <code><jk>new</jk> UrlEncodingSerializerBuilder().useWhitespace(<jk>true</jk>).build();</code>.<a name="line.170"></a> +<span class="sourceLineNo">171</span> */<a name="line.171"></a> +<span class="sourceLineNo">172</span> public static class Readable extends UrlEncodingSerializer {<a name="line.172"></a> +<span class="sourceLineNo">173</span><a name="line.173"></a> +<span class="sourceLineNo">174</span> /**<a name="line.174"></a> +<span class="sourceLineNo">175</span> * Constructor.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param propertyStore The property store containing all the settings for this object.<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> public Readable(PropertyStore propertyStore) {<a name="line.178"></a> +<span class="sourceLineNo">179</span> super(propertyStore);<a name="line.179"></a> +<span class="sourceLineNo">180</span> }<a name="line.180"></a> +<span class="sourceLineNo">181</span><a name="line.181"></a> +<span class="sourceLineNo">182</span> @Override /* CoreObject */<a name="line.182"></a> +<span class="sourceLineNo">183</span> protected ObjectMap getOverrideProperties() {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return super.getOverrideProperties().append(SERIALIZER_useWhitespace, true);<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> * Equivalent to <code><jk>new</jk> UrlEncodingSerializerBuilder().plainTextParts().build();</code>.<a name="line.189"></a> +<span class="sourceLineNo">190</span> */<a name="line.190"></a> +<span class="sourceLineNo">191</span> public static class PlainText extends UrlEncodingSerializer {<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> * Constructor.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @param propertyStore The property store containing all the settings for this object.<a name="line.195"></a> +<span class="sourceLineNo">196</span> */<a name="line.196"></a> +<span class="sourceLineNo">197</span> public PlainText(PropertyStore propertyStore) {<a name="line.197"></a> +<span class="sourceLineNo">198</span> super(propertyStore);<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> @Override /* CoreObject */<a name="line.201"></a> +<span class="sourceLineNo">202</span> protected ObjectMap getOverrideProperties() {<a name="line.202"></a> +<span class="sourceLineNo">203</span> return super.getOverrideProperties().append(UonSerializerContext.UON_paramFormat, "PLAINTEXT");<a name="line.203"></a> +<span class="sourceLineNo">204</span> }<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> +<span class="sourceLineNo">207</span> private final UrlEncodingSerializerContext ctx;<a name="line.207"></a> +<span class="sourceLineNo">208</span><a name="line.208"></a> +<span class="sourceLineNo">209</span> /**<a name="line.209"></a> +<span class="sourceLineNo">210</span> * Constructor.<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @param propertyStore The property store containing all the settings for this object.<a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> public UrlEncodingSerializer(PropertyStore propertyStore) {<a name="line.213"></a> +<span class="sourceLineNo">214</span> super(propertyStore);<a name="line.214"></a> +<span class="sourceLineNo">215</span> this.ctx = createContext(UrlEncodingSerializerContext.class);<a name="line.215"></a> +<span class="sourceLineNo">216</span> }<a name="line.216"></a> +<span class="sourceLineNo">217</span><a name="line.217"></a> +<span class="sourceLineNo">218</span> @Override /* CoreObject */<a name="line.218"></a> +<span class="sourceLineNo">219</span> public UrlEncodingSerializerBuilder builder() {<a name="line.219"></a> +<span class="sourceLineNo">220</span> return new UrlEncodingSerializerBuilder(propertyStore);<a name="line.220"></a> +<span class="sourceLineNo">221</span> }<a name="line.221"></a> +<span class="sourceLineNo">222</span><a name="line.222"></a> +<span class="sourceLineNo">223</span> @Override /* CoreObject */<a name="line.223"></a> +<span class="sourceLineNo">224</span> protected ObjectMap getOverrideProperties() {<a name="line.224"></a> +<span class="sourceLineNo">225</span> return super.getOverrideProperties().append(UON_encodeChars, true);<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<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> * Workhorse method. Determines the type of object, and then calls the<a name="line.229"></a> +<span class="sourceLineNo">230</span> * appropriate type-specific serialization method.<a name="line.230"></a> +<span class="sourceLineNo">231</span> */<a name="line.231"></a> +<span class="sourceLineNo">232</span> @SuppressWarnings({ "rawtypes", "unchecked" })<a name="line.232"></a> +<span class="sourceLineNo">233</span> private SerializerWriter serializeAnything(UrlEncodingSerializerSession session, UonWriter out, Object o) throws Exception {<a name="line.233"></a> +<span class="sourceLineNo">234</span><a name="line.234"></a> +<span class="sourceLineNo">235</span> ClassMeta<?> aType; // The actual type<a name="line.235"></a> +<span class="sourceLineNo">236</span> ClassMeta<?> sType; // The serialized type<a name="line.236"></a> +<span class="sourceLineNo">237</span><a name="line.237"></a> +<span class="sourceLineNo">238</span> aType = session.push("root", o, object());<a name="line.238"></a> +<span class="sourceLineNo">239</span> session.indent--;<a name="line.239"></a> +<span class="sourceLineNo">240</span> if (aType == null)<a name="line.240"></a> +<span class="sourceLineNo">241</span> aType = object();<a name="line.241"></a> +<span class="sourceLineNo">242</span><a name="line.242"></a> +<span class="sourceLineNo">243</span> sType = aType.getSerializedClassMeta();<a name="line.243"></a> +<span class="sourceLineNo">244</span> String typeName = session.getBeanTypeName(session.object(), aType, null);<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> // Swap if necessary<a name="line.246"></a> +<span class="sourceLineNo">247</span> PojoSwap swap = aType.getPojoSwap();<a name="line.247"></a> +<span class="sourceLineNo">248</span> if (swap != null) {<a name="line.248"></a> +<span class="sourceLineNo">249</span> o = swap.swap(session, o);<a name="line.249"></a> +<span class="sourceLineNo">250</span><a name="line.250"></a> +<span class="sourceLineNo">251</span> // If the getSwapClass() method returns Object, we need to figure out<a name="line.251"></a> +<span class="sourceLineNo">252</span> // the actual type now.<a name="line.252"></a> +<span class="sourceLineNo">253</span> if (sType.isObject())<a name="line.253"></a> +<span class="sourceLineNo">254</span> sType = session.getClassMetaForObject(o);<a name="line.254"></a> +<span class="sourceLineNo">255</span> }<a name="line.255"></a> +<span class="sourceLineNo">256</span><a name="line.256"></a> +<span class="sourceLineNo">257</span> if (sType.isMap()) {<a name="line.257"></a> +<span class="sourceLineNo">258</span> if (o instanceof BeanMap)<a name="line.258"></a> +<span class="sourceLineNo">259</span> serializeBeanMap(session, out, (BeanMap)o, typeName);<a name="line.259"></a> +<span class="sourceLineNo">260</span> else<a name="line.260"></a> +<span class="sourceLineNo">261</span> serializeMap(session, out, (Map)o, sType);<a name="line.261"></a> +<span class="sourceLineNo">262</span> } else if (sType.isBean()) {<a name="line.262"></a> +<span class="sourceLineNo">263</span> serializeBeanMap(session, out, session.toBeanMap(o), typeName);<a name="line.263"></a> +<span class="sourceLineNo">264</span> } else if (sType.isCollection() || sType.isArray()) {<a name="line.264"></a> +<span class="sourceLineNo">265</span> Map m = sType.isCollection() ? getCollectionMap((Collection)o) : getCollectionMap(o);<a name="line.265"></a> +<span class="sourceLineNo">266</span> serializeCollectionMap(session, out, m, session.getClassMeta(Map.class, Integer.class, Object.class));<a name="line.266"></a> +<span class="sourceLineNo">267</span> } else {<a name="line.267"></a> +<span class="sourceLineNo">268</span> // All other types can't be serialized as key/value pairs, so we create a<a name="line.268"></a> +<span class="sourceLineNo">269</span> // mock key/value pair with a "_value" key.<a name="line.269"></a> +<span class="sourceLineNo">270</span> out.append("_value=");<a name="line.270"></a> +<span class="sourceLineNo">271</span> super.serializeAnything(session, out, o, null, null, null);<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> session.pop();<a name="line.274"></a> +<span class="sourceLineNo">275</span> return out;<a name="line.275"></a> +<span class="sourceLineNo">276</span> }<a name="line.276"></a> +<span class="sourceLineNo">277</span><a name="line.277"></a> +<span class="sourceLineNo">278</span> /**<a name="line.278"></a> +<span class="sourceLineNo">279</span> * Converts a Collection into an integer-indexed map.<a name="line.279"></a> +<span class="sourceLineNo">280</span> */<a name="line.280"></a> +<span class="sourceLineNo">281</span> private static Map<Integer,Object> getCollectionMap(Collection<?> c) {<a name="line.281"></a> +<span class="sourceLineNo">282</span> Map<Integer,Object> m = new TreeMap<Integer,Object>();<a name="line.282"></a> +<span class="sourceLineNo">283</span> int i = 0;<a name="line.283"></a> +<span class="sourceLineNo">284</span> for (Object o : c)<a name="line.284"></a> +<span class="sourceLineNo">285</span> m.put(i++, o);<a name="line.285"></a> +<span class="sourceLineNo">286</span> return m;<a name="line.286"></a> +<span class="sourceLineNo">287</span> }<a name="line.287"></a> +<span class="sourceLineNo">288</span><a name="line.288"></a> +<span class="sourceLineNo">289</span> /**<a name="line.289"></a> +<span class="sourceLineNo">290</span> * Converts an array into an integer-indexed map.<a name="line.290"></a> +<span class="sourceLineNo">291</span> */<a name="line.291"></a> +<span class="sourceLineNo">292</span> private static Map<Integer,Object> getCollectionMap(Object array) {<a name="line.292"></a> +<span class="sourceLineNo">293</span> Map<Integer,Object> m = new TreeMap<Integer,Object>();<a name="line.293"></a> +<span class="sourceLineNo">294</span> for (int i = 0; i < Array.getLength(array); i++)<a name="line.294"></a> +<span class="sourceLineNo">295</span> m.put(i, Array.get(array, i));<a name="line.295"></a> +<span class="sourceLineNo">296</span> return m;<a name="line.296"></a> +<span class="sourceLineNo">297</span> }<a name="line.297"></a> +<span class="sourceLineNo">298</span><a name="line.298"></a> +<span class="sourceLineNo">299</span> @SuppressWarnings({ "rawtypes", "unchecked" })<a name="line.299"></a> +<span class="sourceLineNo">300</span> private SerializerWriter serializeMap(UrlEncodingSerializerSession session, UonWriter out, Map m, ClassMeta<?> type) throws Exception {<a name="line.300"></a> +<span class="sourceLineNo">301</span><a name="line.301"></a> +<span class="sourceLineNo">302</span> m = session.sort(m);<a name="line.302"></a> +<span class="sourceLineNo">303</span><a name="line.303"></a> +<span class="sourceLineNo">304</span> ClassMeta<?> keyType = type.getKeyType(), valueType = type.getValueType();<a name="line.304"></a> +<span class="sourceLineNo">305</span><a name="line.305"></a> +<span class="sourceLineNo">306</span> int depth = session.getIndent();<a name="line.306"></a> +<span class="sourceLineNo">307</span> boolean addAmp = false;<a name="line.307"></a> +<span class="sourceLineNo">308</span><a name="line.308"></a> +<span class="sourceLineNo">309</span> for (Map.Entry e : (Set<Map.Entry>)m.entrySet()) {<a name="line.309"></a> +<span class="sourceLineNo">310</span> Object key = session.generalize(e.getKey(), keyType);<a name="line.310"></a> +<span class="sourceLineNo">311</span> Object value = e.getValue();<a name="line.311"></a> +<span class="sourceLineNo">312</span><a name="line.312"></a> +<span class="sourceLineNo">313</span> if (session.shouldUseExpandedParams(value)) {<a name="line.313"></a> +<span class="sourceLineNo">314</span> Iterator i = value instanceof Collection ? ((Collection)value).iterator() : ArrayUtils.iterator(value);<a name="line.314"></a> +<span class="sourceLineNo">315</span> while (i.hasNext()) {<a name="line.315"></a> +<span class="sourceLineNo">316</span> if (addAmp)<a name="line.316"></a> +<span class="sourceLineNo">317</span> out.cr(depth).append('&');<a name="line.317"></a> +<span class="sourceLineNo">318</span> out.appendObject(key, true).append('=');<a name="line.318"></a> +<span class="sourceLineNo">319</span> super.serializeAnything(session, out, i.next(), null, (key == null ? null : key.toString()), null);<a name="line.319"></a> +<span class="sourceLineNo">320</span> addAmp = true;<a name="line.320"></a> +<span class="sourceLineNo">321</span> }<a name="line.321"></a> +<span class="sourceLineNo">322</span> } else {<a name="line.322"></a> +<span class="sourceLineNo">323</span> if (addAmp)<a name="line.323"></a> +<span class="sourceLineNo">324</span> out.cr(depth).append('&');<a name="line.324"></a> +<span class="sourceLineNo">325</span> out.appendObject(key, true).append('=');<a name="line.325"></a> +<span class="sourceLineNo">326</span> super.serializeAnything(session, out, value, valueType, (key == null ? null : key.toString()), null);<a name="line.326"></a> +<span class="sourceLineNo">327</span> addAmp = true;<a name="line.327"></a> +<span class="sourceLineNo">328</span> }<a name="line.328"></a> +<span class="sourceLineNo">329</span> }<a name="line.329"></a> +<span class="sourceLineNo">330</span><a name="line.330"></a> +<span class="sourceLineNo">331</span> return out;<a name="line.331"></a> +<span class="sourceLineNo">332</span> }<a name="line.332"></a> +<span class="sourceLineNo">333</span><a name="line.333"></a> +<span class="sourceLineNo">334</span> @SuppressWarnings({ "rawtypes", "unchecked" })<a name="line.334"></a> +<span class="sourceLineNo">335</span> private SerializerWriter serializeCollectionMap(UrlEncodingSerializerSession session, UonWriter out, Map m, ClassMeta<?> type) throws Exception {<a name="line.335"></a> +<span class="sourceLineNo">336</span><a name="line.336"></a> +<span class="sourceLineNo">337</span> ClassMeta<?> valueType = type.getValueType();<a name="line.337"></a> +<span class="sourceLineNo">338</span><a name="line.338"></a> +<span class="sourceLineNo">339</span> int depth = session.getIndent();<a name="line.339"></a> +<span class="sourceLineNo">340</span> boolean addAmp = false;<a name="line.340"></a> +<span class="sourceLineNo">341</span><a name="line.341"></a> +<span class="sourceLineNo">342</span> for (Map.Entry e : (Set<Map.Entry>)m.entrySet()) {<a name="line.342"></a> +<span class="sourceLineNo">343</span> if (addAmp)<a name="line.343"></a> +<span class="sourceLineNo">344</span> out.cr(depth).append('&');<a name="line.344"></a> +<span class="sourceLineNo">345</span> out.append(e.getKey()).append('=');<a name="line.345"></a> +<span class="sourceLineNo">346</span> super.serializeAnything(session, out, e.getValue(), valueType, null, null);<a name="line.346"></a> +<span class="sourceLineNo">347</span> addAmp = true;<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> return out;<a name="line.350"></a> +<span class="sourceLineNo">351</span> }<a name="line.351"></a> +<span class="sourceLineNo">352</span><a name="line.352"></a> +<span class="sourceLineNo">353</span> @SuppressWarnings({ "rawtypes" })<a name="line.353"></a> +<span class="sourceLineNo">354</span> private SerializerWriter serializeBeanMap(UrlEncodingSerializerSession session, UonWriter out, BeanMap<?> m, String typeName) throws Exception {<a name="line.354"></a> +<span class="sourceLineNo">355</span> int depth = session.getIndent();<a name="line.355"></a> +<span class="sourceLineNo">356</span><a name="line.356"></a> +<span class="sourceLineNo">357</span> boolean addAmp = false;<a name="line.357"></a> +<span class="sourceLineNo">358</span><a name="line.358"></a> +<span class="sourceLineNo">359</span> for (BeanPropertyValue p : m.getValues(session.isTrimNulls(), typeName != null ? session.createBeanTypeNameProperty(m, typeName) : null)) {<a name="line.359"></a> +<span class="sourceLineNo">360</span> BeanPropertyMeta pMeta = p.getMeta();<a name="line.360"></a> +<span class="sourceLineNo">361</span> ClassMeta<?> cMeta = p.getClassMeta();<a name="line.361"></a> +<span class="sourceLineNo">362</span><a name="line.362"></a> +<span class="sourceLineNo">363</span> String key = p.getName();<a name="line.363"></a> +<span class="sourceLineNo">364</span> Object value = p.getValue();<a name="line.364"></a> +<span class="sourceLineNo">365</span> Throwable t = p.getThrown();<a name="line.365"></a> +<span class="sourceLineNo">366</span> if (t != null)<a name="line.366"></a> +<span class="sourceLineNo">367</span> session.addBeanGetterWarning(pMeta, t);<a name="line.367"></a> +<span class="sourceLineNo">368</span><a name="line.368"></a> +<span class="sourceLineNo">369</span> if (session.canIgnoreValue(cMeta, key, value))<a name="line.369"></a> +<span class="sourceLineNo">370</span> continue;<a name="line.370"></a> +<span class="sourceLineNo">371</span><a name="line.371"></a> +<span class="sourceLineNo">372</span> if (value != null && session.shouldUseExpandedParams(pMeta)) {<a name="line.372"></a> +<span class="sourceLineNo">373</span> // Transformed object array bean properties may be transformed resulting in ArrayLists,<a name="line.373"></a> +<span class="sourceLineNo">374</span> // so we need to check type if we think it's an array.<a name="line.374"></a> +<span class="sourceLineNo">375</span> Iterator i = (cMeta.isCollection() || value instanceof Collection) ? ((Collection)value).iterator() : ArrayUtils.iterator(value);<a name="line.375"></a> +<span class="sourceLineNo">376</span> while (i.hasNext()) {<a name="line.376"></a> +<span class="sourceLineNo">377</span> if (addAmp)<a name="line.377"></a> +<span class="sourceLineNo">378</span> out.cr(depth).append('&');<a name="line.378"></a> +<span class="sourceLineNo">379</span><a name="line.379"></a> +<span class="sourceLineNo">380</span> out.appendObject(key, true).append('=');<a name="line.380"></a> +<span class="sourceLineNo">381</span><a name="line.381"></a> +<span class="sourceLineNo">382</span> super.serializeAnything(session, out, i.next(), cMeta.getElementType(), key, pMeta);<a name="line.382"></a> +<span class="sourceLineNo">383</span><a name="line.383"></a> +<span class="sourceLineNo">384</span> addAmp = true;<a name="line.384"></a> +<span class="sourceLineNo">385</span> }<a name="line.385"></a> +<span class="sourceLineNo">386</span> } else {<a name="line.386"></a> +<span class="sourceLineNo">387</span> if (addAmp)<a name="line.387"></a> +<span class="sourceLineNo">388</span> out.cr(depth).append('&');<a name="line.388"></a> +<span class="sourceLineNo">389</span><a name="line.389"></a> +<span class="sourceLineNo">390</span> out.appendObject(key, true).append('=');<a name="line.390"></a> +<span class="sourceLineNo">391</span><a name="line.391"></a> +<span class="sourceLineNo">392</span> super.serializeAnything(session, out, value, cMeta, key, pMeta);<a name="line.392"></a> +<span class="sourceLineNo">393</span><a name="line.393"></a> +<span class="sourceLineNo">394</span> addAmp = true;<a name="line.394"></a> +<span class="sourceLineNo">395</span> }<a name="line.395"></a> +<span class="sourceLineNo">396</span><a name="line.396"></a> +<span class="sourceLineNo">397</span> }<a name="line.397"></a> +<span class="sourceLineNo">398</span> return out;<a name="line.398"></a> +<span class="sourceLineNo">399</span> }<a name="line.399"></a> +<span class="sourceLineNo">400</span><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> // Methods for constructing individual parameter values.<a name="line.403"></a> +<span class="sourceLineNo">404</span> //--------------------------------------------------------------------------------<a name="line.404"></a> +<span class="sourceLineNo">405</span><a name="line.405"></a> +<span class="sourceLineNo">406</span> /**<a name="line.406"></a> +<span class="sourceLineNo">407</span> * Converts the specified object to a string using this serializers {@link BeanSession#convertToType(Object, Class)} method<a name="line.407"></a> +<span class="sourceLineNo">408</span> * and runs {@link URLEncoder#encode(String,String)} against the results.<a name="line.408"></a> +<span class="sourceLineNo">409</span> * Useful for constructing URL parts.<a name="line.409"></a> +<span class="sourceLineNo">410</span> *<a name="line.410"></a> +<span class="sourceLineNo">411</span> * @param o The object to serialize.<a name="line.411"></a> +<span class="sourceLineNo">412</span> * @param urlEncode URL-encode the string if necessary.<a name="line.412"></a> +<span class="sourceLineNo">413</span> * If <jk>null</jk>, then uses the value of the {@link UonSerializerContext#UON_encodeChars} setting.<a name="line.413"></a> +<span class="sourceLineNo">414</span> * @param plainTextParams Whether we're using plain-text params.<a name="line.414"></a> +<span class="sourceLineNo">415</span> * If <jk>null</jk>, then uses the value from the {@link UrlEncodingSerializerContext#URLENC_paramFormat} setting.<a name="line.415"></a> +<span class="sourceLineNo">416</span> * @return The serialized object.<a name="line.416"></a> +<span class="sourceLineNo">417</span> */<a name="line.417"></a> +<span class="sourceLineNo">418</span> private String serializePart(Object o, Boolean urlEncode, Boolean plainTextParams) {<a name="line.418"></a> +<span class="sourceLineNo">419</span> try {<a name="line.419"></a> +<span class="sourceLineNo">420</span> // Shortcut for simple types.<a name="line.420"></a> +<span class="sourceLineNo">421</span> ClassMeta<?> cm = getBeanContext().getClassMetaForObject(o);<a name="line.421"></a> +<span class="sourceLineNo">422</span> if (cm != null) {<a name="line.422"></a> +<span class="sourceLineNo">423</span> if (cm.isNumber() || cm.isBoolean())<a name="line.423"></a> +<span class="sourceLineNo">424</span> return o.toString();<a name="line.424"></a> +<span class="sourceLineNo">425</span> if (cm.isCharSequence()) {<a name="line.425"></a> +<span class="sourceLineNo">426</span> String s = o.toString();<a name="line.426"></a> +<span class="sourceLineNo">427</span> boolean ptt = (plainTextParams != null ? plainTextParams : ctx.plainTextParams());<a name="line.427"></a> +<span class="sourceLineNo">428</span> if (ptt || s.isEmpty() || ! UonUtils.needsQuotes(s))<a name="line.428"></a> +<span class="sourceLineNo">429</span> return (urlEncode ? StringUtils.urlEncode(s) : s);<a name="line.429"></a> +<span class="sourceLineNo">430</span> }<a name="line.430"></a> +<span class="sourceLineNo">431</span> }<a name="line.431"></a> +<span class="sourceLineNo">432</span><a name="line.432"></a> +<span class="sourceLineNo">433</span> StringWriter w = new StringWriter();<a name="line.433"></a> +<span class="sourceLineNo">434</span> UonSerializerSession s = new UrlEncodingSerializerSession(ctx, urlEncode, null, w, null, null, null, MediaType.UON, null);<a name="line.434"></a> +<span class="sourceLineNo">435</span> super.doSerialize(s, o);<a name="line.435"></a> +<span class="sourceLineNo">436</span> return w.toString();<a name="line.436"></a> +<span class="sourceLineNo">437</span> } catch (Exception e) {<a name="line.437"></a> +<span class="sourceLineNo">438</span> throw new RuntimeException(e);<a name="line.438"></a> +<span class="sourceLineNo">439</span> }<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> //--------------------------------------------------------------------------------<a name="line.443"></a> +<span class="sourceLineNo">444</span> // Entry point methods<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> @Override /* Serializer */<a name="line.447"></a> +<span class="sourceLineNo">448</span> public UrlEncodingSerializerSession createSession(Object output, ObjectMap op, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) {<a name="line.448"></a> +<span class="sourceLineNo">449</span> return new UrlEncodingSerializerSession(ctx, null, op, output, javaMethod, locale, timeZone, mediaType, uriContext);<a name="line.449"></a> +<span class="sourceLineNo">450</span> }<a name="line.450"></a> +<span class="sourceLineNo">451</span><a name="line.451"></a> +<span class="sourceLineNo">452</span> @Override /* Serializer */<a name="line.452"></a> +<span class="sourceLineNo">453</span> protected void doSerialize(SerializerSession session, Object o) throws Exception {<a name="line.453"></a> +<span class="sourceLineNo">454</span> UrlEncodingSerializerSession s = (UrlEncodingSerializerSession)session;<a name="line.454"></a> +<span class="sourceLineNo">455</span> serializeAnything(s, s.getWriter(), o);<a name="line.455"></a> +<span class="sourceLineNo">456</span> }<a name="line.456"></a> +<span class="sourceLineNo">457</span><a name="line.457"></a> +<span class="sourceLineNo">458</span> @Override /* PartSerializer */<a name="line.458"></a> +<span class="sourceLineNo">459</span> public String serialize(PartType type, Object value) {<a name="line.459"></a> +<span class="sourceLineNo">460</span> switch(type) {<a name="line.460"></a> +<span class="sourceLineNo">461</span> case HEADER: return serializePart(value, false, true);<a name="line.461"></a> +<span class="sourceLineNo">462</span> case FORM_DATA: return serializePart(value, false, null);<a name="line.462"></a> +<span class="sourceLineNo">463</span> case PATH: return serializePart(value, false, null);<a name="line.463"></a> +<span class="sourceLineNo">464</span> case QUERY: return serializePart(value, false, null);<a name="line.464"></a> +<span class="sourceLineNo">465</span> default: return StringUtils.toString(value);<a name="line.465"></a> +<span class="sourceLineNo">466</span> }<a name="line.466"></a> +<span class="sourceLineNo">467</span> }<a name="line.467"></a> +<span class="sourceLineNo">468</span>}<a name="line.468"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
