http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html index 4da3c7d..27de48d 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html @@ -108,7 +108,7 @@ <span class="sourceLineNo">100</span> Object favIcon;<a name="line.100"></a> <span class="sourceLineNo">101</span> List<Object> staticFiles;<a name="line.101"></a> <span class="sourceLineNo">102</span> RestContext parentContext;<a name="line.102"></a> -<span class="sourceLineNo">103</span> String path;<a name="line.103"></a> +<span class="sourceLineNo">103</span> String path, pageTitle, pageText, pageLinks;<a name="line.103"></a> <span class="sourceLineNo">104</span> String clientVersionHeader = "X-Client-Version";<a name="line.104"></a> <span class="sourceLineNo">105</span><a name="line.105"></a> <span class="sourceLineNo">106</span> Object resourceResolver = RestResourceResolver.class;<a name="line.106"></a> @@ -127,1038 +127,1085 @@ <span class="sourceLineNo">119</span> this.parentContext = parentContext;<a name="line.119"></a> <span class="sourceLineNo">120</span> try {<a name="line.120"></a> <span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> properties = new ObjectMap();<a name="line.122"></a> -<span class="sourceLineNo">123</span> configFile = ConfigMgr.DEFAULT.create();<a name="line.123"></a> -<span class="sourceLineNo">124</span> varResolverBuilder = new VarResolverBuilder()<a name="line.124"></a> -<span class="sourceLineNo">125</span> .vars(<a name="line.125"></a> -<span class="sourceLineNo">126</span> SystemPropertiesVar.class,<a name="line.126"></a> -<span class="sourceLineNo">127</span> EnvVariablesVar.class,<a name="line.127"></a> -<span class="sourceLineNo">128</span> ConfigFileVar.class,<a name="line.128"></a> -<span class="sourceLineNo">129</span> IfVar.class,<a name="line.129"></a> -<span class="sourceLineNo">130</span> SwitchVar.class<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> VarResolver vr = varResolverBuilder.build();<a name="line.133"></a> +<span class="sourceLineNo">122</span> ConfigFileBuilder cfb = new ConfigFileBuilder();<a name="line.122"></a> +<span class="sourceLineNo">123</span><a name="line.123"></a> +<span class="sourceLineNo">124</span> properties = new ObjectMap();<a name="line.124"></a> +<span class="sourceLineNo">125</span> configFile = cfb.build();<a name="line.125"></a> +<span class="sourceLineNo">126</span> varResolverBuilder = new VarResolverBuilder()<a name="line.126"></a> +<span class="sourceLineNo">127</span> .vars(<a name="line.127"></a> +<span class="sourceLineNo">128</span> SystemPropertiesVar.class,<a name="line.128"></a> +<span class="sourceLineNo">129</span> EnvVariablesVar.class,<a name="line.129"></a> +<span class="sourceLineNo">130</span> ConfigFileVar.class,<a name="line.130"></a> +<span class="sourceLineNo">131</span> IfVar.class,<a name="line.131"></a> +<span class="sourceLineNo">132</span> SwitchVar.class<a name="line.132"></a> +<span class="sourceLineNo">133</span> );<a name="line.133"></a> <span class="sourceLineNo">134</span><a name="line.134"></a> -<span class="sourceLineNo">135</span> Map<Class<?>,RestResource> restResourceAnnotationsParentFirst = ReflectionUtils.findAnnotationsMapParentFirst(RestResource.class, resourceClass);<a name="line.135"></a> +<span class="sourceLineNo">135</span> VarResolver vr = varResolverBuilder.build();<a name="line.135"></a> <span class="sourceLineNo">136</span><a name="line.136"></a> -<span class="sourceLineNo">137</span> // Find our config file. It's the last non-empty @RestResource.config().<a name="line.137"></a> -<span class="sourceLineNo">138</span> String configPath = "";<a name="line.138"></a> -<span class="sourceLineNo">139</span> for (RestResource r : restResourceAnnotationsParentFirst.values())<a name="line.139"></a> -<span class="sourceLineNo">140</span> if (! r.config().isEmpty())<a name="line.140"></a> -<span class="sourceLineNo">141</span> configPath = r.config();<a name="line.141"></a> -<span class="sourceLineNo">142</span> String cf = vr.resolve(configPath);<a name="line.142"></a> -<span class="sourceLineNo">143</span> if (! cf.isEmpty())<a name="line.143"></a> -<span class="sourceLineNo">144</span> configFile = ConfigMgr.DEFAULT.get(cf);<a name="line.144"></a> -<span class="sourceLineNo">145</span> configFile = configFile.getResolving(vr);<a name="line.145"></a> -<span class="sourceLineNo">146</span><a name="line.146"></a> -<span class="sourceLineNo">147</span> // Add our config file to the variable resolver.<a name="line.147"></a> -<span class="sourceLineNo">148</span> varResolverBuilder.contextObject(ConfigFileVar.SESSION_config, configFile);<a name="line.148"></a> -<span class="sourceLineNo">149</span> vr = varResolverBuilder.build();<a name="line.149"></a> -<span class="sourceLineNo">150</span><a name="line.150"></a> -<span class="sourceLineNo">151</span> // Add our servlet URI to our properties.<a name="line.151"></a> -<span class="sourceLineNo">152</span> ServletContext ctx = config.getServletContext();<a name="line.152"></a> -<span class="sourceLineNo">153</span> String ctxPath = ctx.getContextPath();<a name="line.153"></a> -<span class="sourceLineNo">154</span> // Workaround for bug in Jetty that causes context path to always end in "null".<a name="line.154"></a> -<span class="sourceLineNo">155</span> if (ctxPath.endsWith("null"))<a name="line.155"></a> -<span class="sourceLineNo">156</span> ctxPath = ctxPath.substring(0, ctxPath.length()-4);<a name="line.156"></a> -<span class="sourceLineNo">157</span> properties.put(SERIALIZER_relativeUriBase, ctxPath);<a name="line.157"></a> -<span class="sourceLineNo">158</span><a name="line.158"></a> -<span class="sourceLineNo">159</span> // Add the servlet init parameters to our properties.<a name="line.159"></a> -<span class="sourceLineNo">160</span> for (Enumeration<String> ep = config.getInitParameterNames(); ep.hasMoreElements();) {<a name="line.160"></a> -<span class="sourceLineNo">161</span> String p = ep.nextElement();<a name="line.161"></a> -<span class="sourceLineNo">162</span> String initParam = config.getInitParameter(p);<a name="line.162"></a> -<span class="sourceLineNo">163</span> properties.put(vr.resolve(p), vr.resolve(initParam));<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> // Load stuff from parent-to-child order.<a name="line.166"></a> -<span class="sourceLineNo">167</span> // This allows child settings to overwrite parent settings.<a name="line.167"></a> -<span class="sourceLineNo">168</span> for (Map.Entry<Class<?>,RestResource> e : restResourceAnnotationsParentFirst.entrySet()) {<a name="line.168"></a> -<span class="sourceLineNo">169</span> Class<?> c = e.getKey();<a name="line.169"></a> -<span class="sourceLineNo">170</span> RestResource r = e.getValue();<a name="line.170"></a> -<span class="sourceLineNo">171</span> for (Property p : r.properties())<a name="line.171"></a> -<span class="sourceLineNo">172</span> properties.append(vr.resolve(p.name()), vr.resolve(p.value()));<a name="line.172"></a> -<span class="sourceLineNo">173</span> addSerializers(reverse(r.serializers())); // TODO - why reverse?<a name="line.173"></a> -<span class="sourceLineNo">174</span> addParsers(reverse(r.parsers())); // TODO - why reverse?<a name="line.174"></a> -<span class="sourceLineNo">175</span> addEncoders(reverse(r.encoders())); // TODO - why reverse?<a name="line.175"></a> -<span class="sourceLineNo">176</span> addDefaultRequestHeaders(r.defaultRequestHeaders());<a name="line.176"></a> -<span class="sourceLineNo">177</span> addDefaultResponseHeaders(r.defaultResponseHeaders());<a name="line.177"></a> -<span class="sourceLineNo">178</span> addResponseHandlers(r.responseHandlers());<a name="line.178"></a> -<span class="sourceLineNo">179</span> addConverters(r.converters());<a name="line.179"></a> -<span class="sourceLineNo">180</span> addGuards(reverse(r.guards()));<a name="line.180"></a> -<span class="sourceLineNo">181</span> addChildResources(r.children());<a name="line.181"></a> -<span class="sourceLineNo">182</span> addBeanFilters(r.beanFilters());<a name="line.182"></a> -<span class="sourceLineNo">183</span> addPojoSwaps(r.pojoSwaps());<a name="line.183"></a> -<span class="sourceLineNo">184</span> if (! r.stylesheet().isEmpty())<a name="line.184"></a> -<span class="sourceLineNo">185</span> setStyleSheet(c, r.stylesheet());<a name="line.185"></a> -<span class="sourceLineNo">186</span> if (! r.favicon().isEmpty())<a name="line.186"></a> -<span class="sourceLineNo">187</span> setFavIcon(c, r.favicon());<a name="line.187"></a> -<span class="sourceLineNo">188</span> if (! r.staticFiles().isEmpty())<a name="line.188"></a> -<span class="sourceLineNo">189</span> addStaticFiles(c, r.staticFiles());<a name="line.189"></a> -<span class="sourceLineNo">190</span> if (! r.path().isEmpty())<a name="line.190"></a> -<span class="sourceLineNo">191</span> setPath(r.path());<a name="line.191"></a> -<span class="sourceLineNo">192</span> if (! r.clientVersionHeader().isEmpty())<a name="line.192"></a> -<span class="sourceLineNo">193</span> setClientVersionHeader(r.clientVersionHeader());<a name="line.193"></a> -<span class="sourceLineNo">194</span> if (r.resourceResolver() != RestResourceResolver.class)<a name="line.194"></a> -<span class="sourceLineNo">195</span> setResourceResolver(r.resourceResolver());<a name="line.195"></a> -<span class="sourceLineNo">196</span> if (r.logger() != RestLogger.Normal.class)<a name="line.196"></a> -<span class="sourceLineNo">197</span> setLogger(r.logger());<a name="line.197"></a> -<span class="sourceLineNo">198</span> if (r.callHandler() != RestCallHandler.class)<a name="line.198"></a> -<span class="sourceLineNo">199</span> setCallHandler(r.callHandler());<a name="line.199"></a> -<span class="sourceLineNo">200</span> if (r.infoProvider() != RestInfoProvider.class)<a name="line.200"></a> -<span class="sourceLineNo">201</span> setInfoProvider(r.infoProvider());<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> addResponseHandlers(<a name="line.204"></a> -<span class="sourceLineNo">205</span> StreamableHandler.class,<a name="line.205"></a> -<span class="sourceLineNo">206</span> WritableHandler.class,<a name="line.206"></a> -<span class="sourceLineNo">207</span> ReaderHandler.class,<a name="line.207"></a> -<span class="sourceLineNo">208</span> InputStreamHandler.class,<a name="line.208"></a> -<span class="sourceLineNo">209</span> RedirectHandler.class,<a name="line.209"></a> -<span class="sourceLineNo">210</span> DefaultHandler.class<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> addMimeTypes(<a name="line.213"></a> -<span class="sourceLineNo">214</span> "text/css css CSS",<a name="line.214"></a> -<span class="sourceLineNo">215</span> "text/html html htm HTML",<a name="line.215"></a> -<span class="sourceLineNo">216</span> "text/plain txt text TXT",<a name="line.216"></a> -<span class="sourceLineNo">217</span> "application/javascript js",<a name="line.217"></a> -<span class="sourceLineNo">218</span> "image/png png",<a name="line.218"></a> -<span class="sourceLineNo">219</span> "image/gif gif",<a name="line.219"></a> -<span class="sourceLineNo">220</span> "application/xml xml XML",<a name="line.220"></a> -<span class="sourceLineNo">221</span> "application/json json JSON"<a name="line.221"></a> -<span class="sourceLineNo">222</span> );<a name="line.222"></a> -<span class="sourceLineNo">223</span> } catch (Exception e) {<a name="line.223"></a> -<span class="sourceLineNo">224</span> throw new ServletException(e);<a name="line.224"></a> -<span class="sourceLineNo">225</span> }<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> * Adds the specified {@link Var} classes to this config.<a name="line.229"></a> -<span class="sourceLineNo">230</span> * <p><a name="line.230"></a> -<span class="sourceLineNo">231</span> * These variables affect the variable resolver returned by {@link RestRequest#getVarResolverSession()} which is<a name="line.231"></a> -<span class="sourceLineNo">232</span> * used to resolve string variables of the form <js>"$X{...}"</js>.<a name="line.232"></a> -<span class="sourceLineNo">233</span> * <p><a name="line.233"></a> -<span class="sourceLineNo">234</span> * By default, this config includes the following variables:<a name="line.234"></a> -<span class="sourceLineNo">235</span> * <ul class='spaced-list'><a name="line.235"></a> -<span class="sourceLineNo">236</span> * <li>{@link SystemPropertiesVar}<a name="line.236"></a> -<span class="sourceLineNo">237</span> * <li>{@link EnvVariablesVar}<a name="line.237"></a> -<span class="sourceLineNo">238</span> * <li>{@link ConfigFileVar}<a name="line.238"></a> -<span class="sourceLineNo">239</span> * <li>{@link IfVar}<a name="line.239"></a> -<span class="sourceLineNo">240</span> * <li>{@link SwitchVar}<a name="line.240"></a> -<span class="sourceLineNo">241</span> * </ul><a name="line.241"></a> -<span class="sourceLineNo">242</span> * <p><a name="line.242"></a> -<span class="sourceLineNo">243</span> * Later during the construction of {@link RestContext}, we add the following variables:<a name="line.243"></a> -<span class="sourceLineNo">244</span> * <ul><a name="line.244"></a> -<span class="sourceLineNo">245</span> * <li>{@link LocalizationVar}<a name="line.245"></a> -<span class="sourceLineNo">246</span> * <li>{@link RequestVar}<a name="line.246"></a> -<span class="sourceLineNo">247</span> * <li>{@link SerializedRequestAttrVar}<a name="line.247"></a> -<span class="sourceLineNo">248</span> * <li>{@link ServletInitParamVar}<a name="line.248"></a> -<span class="sourceLineNo">249</span> * <li>{@link UrlEncodeVar}<a name="line.249"></a> -<span class="sourceLineNo">250</span> * </ul><a name="line.250"></a> -<span class="sourceLineNo">251</span> *<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param vars The {@link Var} classes to add to this config.<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @return This object (for method chaining).<a name="line.253"></a> -<span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> public RestConfig addVars(Class<?>...vars) {<a name="line.255"></a> -<span class="sourceLineNo">256</span> this.varResolverBuilder.vars(vars);<a name="line.256"></a> -<span class="sourceLineNo">257</span> return this;<a name="line.257"></a> -<span class="sourceLineNo">258</span> }<a name="line.258"></a> -<span class="sourceLineNo">259</span><a name="line.259"></a> -<span class="sourceLineNo">260</span> /**<a name="line.260"></a> -<span class="sourceLineNo">261</span> * Adds a var context object to this config.<a name="line.261"></a> -<span class="sourceLineNo">262</span> * <p><a name="line.262"></a> -<span class="sourceLineNo">263</span> * Var context objects are read-only objects associated with the variable resolver for<a name="line.263"></a> -<span class="sourceLineNo">264</span> * vars that require external information.<a name="line.264"></a> -<span class="sourceLineNo">265</span> * <p><a name="line.265"></a> -<span class="sourceLineNo">266</span> * For example, the {@link ConfigFileVar} needs access to this resource's {@link ConfigFile} through the {@link ConfigFileVar#SESSION_config}<a name="line.266"></a> -<span class="sourceLineNo">267</span> * object that can be specified as either a session object (temporary) or context object (permanent).<a name="line.267"></a> -<span class="sourceLineNo">268</span> * In this case, we call the following code to add it to the context map:<a name="line.268"></a> -<span class="sourceLineNo">269</span> * <p class='bcode'><a name="line.269"></a> -<span class="sourceLineNo">270</span> * config.addVarContextObject(<jsf>SESSION_config</jsf>, configFile);<a name="line.270"></a> -<span class="sourceLineNo">271</span> * </p><a name="line.271"></a> -<span class="sourceLineNo">272</span> *<a name="line.272"></a> -<span class="sourceLineNo">273</span> * @param name The context object key (i.e. the name that the Var class looks for).<a name="line.273"></a> -<span class="sourceLineNo">274</span> * @param object The context object.<a name="line.274"></a> -<span class="sourceLineNo">275</span> * @return This object (for method chaining).<a name="line.275"></a> -<span class="sourceLineNo">276</span> */<a name="line.276"></a> -<span class="sourceLineNo">277</span> public RestConfig addVarContextObject(String name, Object object) {<a name="line.277"></a> -<span class="sourceLineNo">278</span> this.varResolverBuilder.contextObject(name, object);<a name="line.278"></a> -<span class="sourceLineNo">279</span> return this;<a name="line.279"></a> -<span class="sourceLineNo">280</span> }<a name="line.280"></a> -<span class="sourceLineNo">281</span><a name="line.281"></a> -<span class="sourceLineNo">282</span> /**<a name="line.282"></a> -<span class="sourceLineNo">283</span> * Overwrites the default config file with a custom config file.<a name="line.283"></a> -<span class="sourceLineNo">284</span> * <p><a name="line.284"></a> -<span class="sourceLineNo">285</span> * By default, the config file is determined using the {@link RestResource#config() @RestResource.config()} annotation.<a name="line.285"></a> -<span class="sourceLineNo">286</span> * This method allows you to programmatically override it with your own custom config file.<a name="line.286"></a> -<span class="sourceLineNo">287</span> *<a name="line.287"></a> -<span class="sourceLineNo">288</span> * @param configFile The new config file.<a name="line.288"></a> -<span class="sourceLineNo">289</span> * @return This object (for method chaining).<a name="line.289"></a> -<span class="sourceLineNo">290</span> */<a name="line.290"></a> -<span class="sourceLineNo">291</span> public RestConfig setConfigFile(ConfigFile configFile) {<a name="line.291"></a> -<span class="sourceLineNo">292</span> this.configFile = configFile;<a name="line.292"></a> -<span class="sourceLineNo">293</span> return this;<a name="line.293"></a> -<span class="sourceLineNo">294</span> }<a name="line.294"></a> -<span class="sourceLineNo">295</span><a name="line.295"></a> -<span class="sourceLineNo">296</span> /**<a name="line.296"></a> -<span class="sourceLineNo">297</span> * Sets a property on this resource.<a name="line.297"></a> -<span class="sourceLineNo">298</span> * <p><a name="line.298"></a> -<span class="sourceLineNo">299</span> * This is the programmatic equivalent to the {@link RestResource#properties()} annotation.<a name="line.299"></a> -<span class="sourceLineNo">300</span> *<a name="line.300"></a> -<span class="sourceLineNo">301</span> * @param key The property name.<a name="line.301"></a> -<span class="sourceLineNo">302</span> * @param value The property value.<a name="line.302"></a> -<span class="sourceLineNo">303</span> * @return This object (for method chaining).<a name="line.303"></a> -<span class="sourceLineNo">304</span> */<a name="line.304"></a> -<span class="sourceLineNo">305</span> public RestConfig setProperty(String key, Object value) {<a name="line.305"></a> -<span class="sourceLineNo">306</span> this.properties.put(key, value);<a name="line.306"></a> -<span class="sourceLineNo">307</span> return this;<a name="line.307"></a> -<span class="sourceLineNo">308</span> }<a name="line.308"></a> -<span class="sourceLineNo">309</span><a name="line.309"></a> -<span class="sourceLineNo">310</span> /**<a name="line.310"></a> -<span class="sourceLineNo">311</span> * Sets multiple properties on this resource.<a name="line.311"></a> -<span class="sourceLineNo">312</span> * <p><a name="line.312"></a> -<span class="sourceLineNo">313</span> * This is the programmatic equivalent to the {@link RestResource#properties() @RestResource.properties()} annotation.<a name="line.313"></a> -<span class="sourceLineNo">314</span> * <p><a name="line.314"></a> -<span class="sourceLineNo">315</span> * Values in the map are added to the existing properties and are overwritten if duplicates are found.<a name="line.315"></a> -<span class="sourceLineNo">316</span> *<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @param properties The new properties to add to this config.<a name="line.317"></a> -<span class="sourceLineNo">318</span> * @return This object (for method chaining).<a name="line.318"></a> -<span class="sourceLineNo">319</span> */<a name="line.319"></a> -<span class="sourceLineNo">320</span> public RestConfig setProperties(Map<String,Object> properties) {<a name="line.320"></a> -<span class="sourceLineNo">321</span> this.properties.putAll(properties);<a name="line.321"></a> -<span class="sourceLineNo">322</span> return this;<a name="line.322"></a> -<span class="sourceLineNo">323</span> }<a name="line.323"></a> -<span class="sourceLineNo">324</span><a name="line.324"></a> -<span class="sourceLineNo">325</span> /**<a name="line.325"></a> -<span class="sourceLineNo">326</span> * Adds class-level bean filters to this resource.<a name="line.326"></a> -<span class="sourceLineNo">327</span> * <p><a name="line.327"></a> -<span class="sourceLineNo">328</span> * This is the programmatic equivalent to the {@link RestResource#beanFilters() @RestResource.beanFilters()} annotation.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * <p><a name="line.329"></a> -<span class="sourceLineNo">330</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.330"></a> -<span class="sourceLineNo">331</span> *<a name="line.331"></a> -<span class="sourceLineNo">332</span> * @param beanFilters The bean filters to add to this config.<a name="line.332"></a> -<span class="sourceLineNo">333</span> * @return This object (for method chaining).<a name="line.333"></a> -<span class="sourceLineNo">334</span> */<a name="line.334"></a> -<span class="sourceLineNo">335</span> public RestConfig addBeanFilters(Class<?>...beanFilters) {<a name="line.335"></a> -<span class="sourceLineNo">336</span> this.beanFilters.addAll(Arrays.asList(beanFilters));<a name="line.336"></a> -<span class="sourceLineNo">337</span> return this;<a name="line.337"></a> -<span class="sourceLineNo">338</span> }<a name="line.338"></a> -<span class="sourceLineNo">339</span><a name="line.339"></a> -<span class="sourceLineNo">340</span> /**<a name="line.340"></a> -<span class="sourceLineNo">341</span> * Adds class-level pojo swaps to this resource.<a name="line.341"></a> -<span class="sourceLineNo">342</span> * <p><a name="line.342"></a> -<span class="sourceLineNo">343</span> * This is the programmatic equivalent to the {@link RestResource#pojoSwaps() @RestResource.pojoSwaps()} annotation.<a name="line.343"></a> -<span class="sourceLineNo">344</span> * <p><a name="line.344"></a> -<span class="sourceLineNo">345</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.345"></a> -<span class="sourceLineNo">346</span> *<a name="line.346"></a> -<span class="sourceLineNo">347</span> * @param pojoSwaps The pojo swaps to add to this config.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @return This object (for method chaining).<a name="line.348"></a> -<span class="sourceLineNo">349</span> */<a name="line.349"></a> -<span class="sourceLineNo">350</span> public RestConfig addPojoSwaps(Class<?>...pojoSwaps) {<a name="line.350"></a> -<span class="sourceLineNo">351</span> this.pojoSwaps.addAll(Arrays.asList(pojoSwaps));<a name="line.351"></a> -<span class="sourceLineNo">352</span> return this;<a name="line.352"></a> -<span class="sourceLineNo">353</span> }<a name="line.353"></a> -<span class="sourceLineNo">354</span><a name="line.354"></a> -<span class="sourceLineNo">355</span> /**<a name="line.355"></a> -<span class="sourceLineNo">356</span> * Adds class-level serializers to this resource.<a name="line.356"></a> -<span class="sourceLineNo">357</span> * <p><a name="line.357"></a> -<span class="sourceLineNo">358</span> * This is the programmatic equivalent to the {@link RestResource#serializers() @RestResource.serializers()} annotation.<a name="line.358"></a> -<span class="sourceLineNo">359</span> * <p><a name="line.359"></a> -<span class="sourceLineNo">360</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.360"></a> -<span class="sourceLineNo">361</span> *<a name="line.361"></a> -<span class="sourceLineNo">362</span> * @param serializers The serializer classes to add to this config.<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @return This object (for method chaining).<a name="line.363"></a> -<span class="sourceLineNo">364</span> */<a name="line.364"></a> -<span class="sourceLineNo">365</span> public RestConfig addSerializers(Class<?>...serializers) {<a name="line.365"></a> -<span class="sourceLineNo">366</span> this.serializers.append(serializers);<a name="line.366"></a> -<span class="sourceLineNo">367</span> return this;<a name="line.367"></a> -<span class="sourceLineNo">368</span> }<a name="line.368"></a> -<span class="sourceLineNo">369</span><a name="line.369"></a> -<span class="sourceLineNo">370</span> /**<a name="line.370"></a> -<span class="sourceLineNo">371</span> * Adds class-level serializers to this resource.<a name="line.371"></a> -<span class="sourceLineNo">372</span> * <p><a name="line.372"></a> -<span class="sourceLineNo">373</span> * Same as {@link #addSerializers(Class...)} except allows you to pass in serializer instances.<a name="line.373"></a> -<span class="sourceLineNo">374</span> * The actual serializer ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config:<a name="line.374"></a> -<span class="sourceLineNo">375</span> * <p class='bcode'><a name="line.375"></a> -<span class="sourceLineNo">376</span> * serializer = serializer.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();<a name="line.376"></a> -<span class="sourceLineNo">377</span> * </p><a name="line.377"></a> -<span class="sourceLineNo">378</span> * <p><a name="line.378"></a> -<span class="sourceLineNo">379</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.379"></a> -<span class="sourceLineNo">380</span> *<a name="line.380"></a> -<span class="sourceLineNo">381</span> * @param serializers The serializers to add to this config.<a name="line.381"></a> -<span class="sourceLineNo">382</span> * @return This object (for method chaining).<a name="line.382"></a> -<span class="sourceLineNo">383</span> */<a name="line.383"></a> -<span class="sourceLineNo">384</span> public RestConfig addSerializers(Serializer...serializers) {<a name="line.384"></a> -<span class="sourceLineNo">385</span> this.serializers.append(serializers);<a name="line.385"></a> -<span class="sourceLineNo">386</span> return this;<a name="line.386"></a> -<span class="sourceLineNo">387</span> }<a name="line.387"></a> -<span class="sourceLineNo">388</span><a name="line.388"></a> -<span class="sourceLineNo">389</span> /**<a name="line.389"></a> -<span class="sourceLineNo">390</span> * Adds class-level parsers to this resource.<a name="line.390"></a> -<span class="sourceLineNo">391</span> * <p><a name="line.391"></a> -<span class="sourceLineNo">392</span> * This is the programmatic equivalent to the {@link RestResource#parsers() @RestResource.parsers()} annotation.<a name="line.392"></a> -<span class="sourceLineNo">393</span> * <p><a name="line.393"></a> -<span class="sourceLineNo">394</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.394"></a> -<span class="sourceLineNo">395</span> *<a name="line.395"></a> -<span class="sourceLineNo">396</span> * @param parsers The parser classes to add to this config.<a name="line.396"></a> -<span class="sourceLineNo">397</span> * @return This object (for method chaining).<a name="line.397"></a> -<span class="sourceLineNo">398</span> */<a name="line.398"></a> -<span class="sourceLineNo">399</span> public RestConfig addParsers(Class<?>...parsers) {<a name="line.399"></a> -<span class="sourceLineNo">400</span> this.parsers.append(parsers);<a name="line.400"></a> -<span class="sourceLineNo">401</span> return this;<a name="line.401"></a> -<span class="sourceLineNo">402</span> }<a name="line.402"></a> -<span class="sourceLineNo">403</span><a name="line.403"></a> -<span class="sourceLineNo">404</span> /**<a name="line.404"></a> -<span class="sourceLineNo">405</span> * Adds class-level parsers to this resource.<a name="line.405"></a> -<span class="sourceLineNo">406</span> * <p><a name="line.406"></a> -<span class="sourceLineNo">407</span> * Same as {@link #addParsers(Class...)} except allows you to pass in parser instances.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * The actual parser ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config:<a name="line.408"></a> -<span class="sourceLineNo">409</span> * <p class='bcode'><a name="line.409"></a> -<span class="sourceLineNo">410</span> * parser = parser.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();<a name="line.410"></a> -<span class="sourceLineNo">411</span> * </p><a name="line.411"></a> -<span class="sourceLineNo">412</span> * <p><a name="line.412"></a> -<span class="sourceLineNo">413</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.413"></a> -<span class="sourceLineNo">414</span> *<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @param parsers The parsers to add to this config.<a name="line.415"></a> -<span class="sourceLineNo">416</span> * @return This object (for method chaining).<a name="line.416"></a> -<span class="sourceLineNo">417</span> */<a name="line.417"></a> -<span class="sourceLineNo">418</span> public RestConfig addParsers(Parser...parsers) {<a name="line.418"></a> -<span class="sourceLineNo">419</span> this.parsers.append(parsers);<a name="line.419"></a> -<span class="sourceLineNo">420</span> return this;<a name="line.420"></a> -<span class="sourceLineNo">421</span> }<a name="line.421"></a> -<span class="sourceLineNo">422</span><a name="line.422"></a> -<span class="sourceLineNo">423</span> /**<a name="line.423"></a> -<span class="sourceLineNo">424</span> * Adds class-level encoders to this resource.<a name="line.424"></a> -<span class="sourceLineNo">425</span> * <p><a name="line.425"></a> -<span class="sourceLineNo">426</span> * This is the programmatic equivalent to the {@link RestResource#encoders() @RestResource.encoders()} annotation.<a name="line.426"></a> -<span class="sourceLineNo">427</span> * <p><a name="line.427"></a> -<span class="sourceLineNo">428</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.428"></a> -<span class="sourceLineNo">429</span> * <p><a name="line.429"></a> -<span class="sourceLineNo">430</span> * By default, only the {@link IdentityEncoder} is included in this list.<a name="line.430"></a> -<span class="sourceLineNo">431</span> *<a name="line.431"></a> -<span class="sourceLineNo">432</span> * @param encoders The parser classes to add to this config.<a name="line.432"></a> -<span class="sourceLineNo">433</span> * @return This object (for method chaining).<a name="line.433"></a> -<span class="sourceLineNo">434</span> */<a name="line.434"></a> -<span class="sourceLineNo">435</span> public RestConfig addEncoders(Class<?>...encoders) {<a name="line.435"></a> -<span class="sourceLineNo">436</span> this.encoders.append(encoders);<a name="line.436"></a> -<span class="sourceLineNo">437</span> return this;<a name="line.437"></a> -<span class="sourceLineNo">438</span> }<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> * Adds class-level encoders to this resource.<a name="line.441"></a> -<span class="sourceLineNo">442</span> * <p><a name="line.442"></a> -<span class="sourceLineNo">443</span> * Same as {@link #addEncoders(Class...)} except allows you to pass in encoder instances.<a name="line.443"></a> -<span class="sourceLineNo">444</span> *<a name="line.444"></a> -<span class="sourceLineNo">445</span> * @param encoders The encoders to add to this config.<a name="line.445"></a> -<span class="sourceLineNo">446</span> * @return This object (for method chaining).<a name="line.446"></a> -<span class="sourceLineNo">447</span> */<a name="line.447"></a> -<span class="sourceLineNo">448</span> public RestConfig addEncoders(Encoder...encoders) {<a name="line.448"></a> -<span class="sourceLineNo">449</span> this.encoders.append(encoders);<a name="line.449"></a> -<span class="sourceLineNo">450</span> return this;<a name="line.450"></a> -<span class="sourceLineNo">451</span> }<a name="line.451"></a> -<span class="sourceLineNo">452</span><a name="line.452"></a> -<span class="sourceLineNo">453</span> /**<a name="line.453"></a> -<span class="sourceLineNo">454</span> * Adds class-level converters to this resource.<a name="line.454"></a> -<span class="sourceLineNo">455</span> * <p><a name="line.455"></a> -<span class="sourceLineNo">456</span> * This is the programmatic equivalent to the {@link RestResource#converters() @RestResource.converters()} annotation.<a name="line.456"></a> -<span class="sourceLineNo">457</span> * <p><a name="line.457"></a> -<span class="sourceLineNo">458</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.458"></a> -<span class="sourceLineNo">459</span> * <p><a name="line.459"></a> -<span class="sourceLineNo">460</span> * By default, this config includes the following converters:<a name="line.460"></a> -<span class="sourceLineNo">461</span> * <ul class='spaced-list'><a name="line.461"></a> -<span class="sourceLineNo">462</span> * <li>{@link StreamableHandler}<a name="line.462"></a> -<span class="sourceLineNo">463</span> * <li>{@link WritableHandler}<a name="line.463"></a> -<span class="sourceLineNo">464</span> * <li>{@link ReaderHandler}<a name="line.464"></a> -<span class="sourceLineNo">465</span> * <li>{@link InputStreamHandler}<a name="line.465"></a> -<span class="sourceLineNo">466</span> * <li>{@link RedirectHandler}<a name="line.466"></a> -<span class="sourceLineNo">467</span> * <li>{@link DefaultHandler}<a name="line.467"></a> -<span class="sourceLineNo">468</span> * </ul><a name="line.468"></a> -<span class="sourceLineNo">469</span> *<a name="line.469"></a> -<span class="sourceLineNo">470</span> * @param converters The converter classes to add to this config.<a name="line.470"></a> -<span class="sourceLineNo">471</span> * @return This object (for method chaining).<a name="line.471"></a> -<span class="sourceLineNo">472</span> */<a name="line.472"></a> -<span class="sourceLineNo">473</span> public RestConfig addConverters(Class<?>...converters) {<a name="line.473"></a> -<span class="sourceLineNo">474</span> this.converters.addAll(Arrays.asList(converters));<a name="line.474"></a> -<span class="sourceLineNo">475</span> return this;<a name="line.475"></a> -<span class="sourceLineNo">476</span> }<a name="line.476"></a> -<span class="sourceLineNo">477</span><a name="line.477"></a> -<span class="sourceLineNo">478</span> /**<a name="line.478"></a> -<span class="sourceLineNo">479</span> * Adds class-level encoders to this resource.<a name="line.479"></a> -<span class="sourceLineNo">480</span> * <p><a name="line.480"></a> -<span class="sourceLineNo">481</span> * Same as {@link #addConverters(Class...)} except allows you to pass in converter instances.<a name="line.481"></a> -<span class="sourceLineNo">482</span> *<a name="line.482"></a> -<span class="sourceLineNo">483</span> * @param converters The converters to add to this config.<a name="line.483"></a> -<span class="sourceLineNo">484</span> * @return This object (for method chaining).<a name="line.484"></a> -<span class="sourceLineNo">485</span> */<a name="line.485"></a> -<span class="sourceLineNo">486</span> public RestConfig addConverters(RestConverter...converters) {<a name="line.486"></a> -<span class="sourceLineNo">487</span> this.converters.addAll(Arrays.asList(converters));<a name="line.487"></a> -<span class="sourceLineNo">488</span> return this;<a name="line.488"></a> -<span class="sourceLineNo">489</span> }<a name="line.489"></a> -<span class="sourceLineNo">490</span><a name="line.490"></a> -<span class="sourceLineNo">491</span> /**<a name="line.491"></a> -<span class="sourceLineNo">492</span> * Adds class-level guards to this resource.<a name="line.492"></a> -<span class="sourceLineNo">493</span> * <p><a name="line.493"></a> -<span class="sourceLineNo">494</span> * This is the programmatic equivalent to the {@link RestResource#guards() @RestResource.guards()} annotation.<a name="line.494"></a> -<span class="sourceLineNo">495</span> * <p><a name="line.495"></a> -<span class="sourceLineNo">496</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.496"></a> -<span class="sourceLineNo">497</span> *<a name="line.497"></a> -<span class="sourceLineNo">498</span> * @param guards The guard classes to add to this config.<a name="line.498"></a> -<span class="sourceLineNo">499</span> * @return This object (for method chaining).<a name="line.499"></a> -<span class="sourceLineNo">500</span> */<a name="line.500"></a> -<span class="sourceLineNo">501</span> public RestConfig addGuards(Class<?>...guards) {<a name="line.501"></a> -<span class="sourceLineNo">502</span> this.guards.addAll(Arrays.asList(guards));<a name="line.502"></a> -<span class="sourceLineNo">503</span> return this;<a name="line.503"></a> -<span class="sourceLineNo">504</span> }<a name="line.504"></a> -<span class="sourceLineNo">505</span><a name="line.505"></a> -<span class="sourceLineNo">506</span> /**<a name="line.506"></a> -<span class="sourceLineNo">507</span> * Adds class-level guards to this resource.<a name="line.507"></a> -<span class="sourceLineNo">508</span> * <p><a name="line.508"></a> -<span class="sourceLineNo">509</span> * Same as {@link #addGuards(Class...)} except allows you to pass in guard instances.<a name="line.509"></a> -<span class="sourceLineNo">510</span> *<a name="line.510"></a> -<span class="sourceLineNo">511</span> * @param guards The guards to add to this config.<a name="line.511"></a> -<span class="sourceLineNo">512</span> * @return This object (for method chaining).<a name="line.512"></a> -<span class="sourceLineNo">513</span> */<a name="line.513"></a> -<span class="sourceLineNo">514</span> public RestConfig addGuards(RestGuard...guards) {<a name="line.514"></a> -<span class="sourceLineNo">515</span> this.guards.addAll(Arrays.asList(guards));<a name="line.515"></a> -<span class="sourceLineNo">516</span> return this;<a name="line.516"></a> -<span class="sourceLineNo">517</span> }<a name="line.517"></a> -<span class="sourceLineNo">518</span><a name="line.518"></a> -<span class="sourceLineNo">519</span> /**<a name="line.519"></a> -<span class="sourceLineNo">520</span> * Adds MIME-type definitions.<a name="line.520"></a> -<span class="sourceLineNo">521</span> * <p><a name="line.521"></a> -<span class="sourceLineNo">522</span> * These definitions are used in the following locations for setting the media type on responses:<a name="line.522"></a> -<span class="sourceLineNo">523</span> * <ul><a name="line.523"></a> -<span class="sourceLineNo">524</span> * <li>{@link RestRequest#getReaderResource(String)}<a name="line.524"></a> -<span class="sourceLineNo">525</span> * <li>Static files resolved through {@link RestResource#staticFiles()}<a name="line.525"></a> -<span class="sourceLineNo">526</span> * </ul><a name="line.526"></a> -<span class="sourceLineNo">527</span> * <p><a name="line.527"></a> -<span class="sourceLineNo">528</span> * Refer to {@link MimetypesFileTypeMap#addMimeTypes(String)} for an explanation of the format.<a name="line.528"></a> +<span class="sourceLineNo">137</span> Map<Class<?>,RestResource> restResourceAnnotationsParentFirst = ReflectionUtils.findAnnotationsMapParentFirst(RestResource.class, resourceClass);<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> // Find our config file. It's the last non-empty @RestResource.config().<a name="line.139"></a> +<span class="sourceLineNo">140</span> String configPath = "";<a name="line.140"></a> +<span class="sourceLineNo">141</span> for (RestResource r : restResourceAnnotationsParentFirst.values())<a name="line.141"></a> +<span class="sourceLineNo">142</span> if (! r.config().isEmpty())<a name="line.142"></a> +<span class="sourceLineNo">143</span> configPath = r.config();<a name="line.143"></a> +<span class="sourceLineNo">144</span> String cf = vr.resolve(configPath);<a name="line.144"></a> +<span class="sourceLineNo">145</span> if (! cf.isEmpty())<a name="line.145"></a> +<span class="sourceLineNo">146</span> configFile = cfb.build(cf);<a name="line.146"></a> +<span class="sourceLineNo">147</span> configFile = configFile.getResolving(vr);<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span> // Add our config file to the variable resolver.<a name="line.149"></a> +<span class="sourceLineNo">150</span> varResolverBuilder.contextObject(ConfigFileVar.SESSION_config, configFile);<a name="line.150"></a> +<span class="sourceLineNo">151</span> vr = varResolverBuilder.build();<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> // Add our servlet URI to our properties.<a name="line.153"></a> +<span class="sourceLineNo">154</span> ServletContext ctx = config.getServletContext();<a name="line.154"></a> +<span class="sourceLineNo">155</span> String ctxPath = ctx.getContextPath();<a name="line.155"></a> +<span class="sourceLineNo">156</span> // Workaround for bug in Jetty that causes context path to always end in "null".<a name="line.156"></a> +<span class="sourceLineNo">157</span> if (ctxPath.endsWith("null"))<a name="line.157"></a> +<span class="sourceLineNo">158</span> ctxPath = ctxPath.substring(0, ctxPath.length()-4);<a name="line.158"></a> +<span class="sourceLineNo">159</span> properties.put(SERIALIZER_relativeUriBase, ctxPath);<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> // Add the servlet init parameters to our properties.<a name="line.161"></a> +<span class="sourceLineNo">162</span> for (Enumeration<String> ep = config.getInitParameterNames(); ep.hasMoreElements();) {<a name="line.162"></a> +<span class="sourceLineNo">163</span> String p = ep.nextElement();<a name="line.163"></a> +<span class="sourceLineNo">164</span> String initParam = config.getInitParameter(p);<a name="line.164"></a> +<span class="sourceLineNo">165</span> properties.put(vr.resolve(p), vr.resolve(initParam));<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> // Load stuff from parent-to-child order.<a name="line.168"></a> +<span class="sourceLineNo">169</span> // This allows child settings to overwrite parent settings.<a name="line.169"></a> +<span class="sourceLineNo">170</span> for (Map.Entry<Class<?>,RestResource> e : restResourceAnnotationsParentFirst.entrySet()) {<a name="line.170"></a> +<span class="sourceLineNo">171</span> Class<?> c = e.getKey();<a name="line.171"></a> +<span class="sourceLineNo">172</span> RestResource r = e.getValue();<a name="line.172"></a> +<span class="sourceLineNo">173</span> for (Property p : r.properties())<a name="line.173"></a> +<span class="sourceLineNo">174</span> properties.append(vr.resolve(p.name()), vr.resolve(p.value()));<a name="line.174"></a> +<span class="sourceLineNo">175</span> addSerializers(reverse(r.serializers())); // TODO - why reverse?<a name="line.175"></a> +<span class="sourceLineNo">176</span> addParsers(reverse(r.parsers())); // TODO - why reverse?<a name="line.176"></a> +<span class="sourceLineNo">177</span> addEncoders(reverse(r.encoders())); // TODO - why reverse?<a name="line.177"></a> +<span class="sourceLineNo">178</span> addDefaultRequestHeaders(r.defaultRequestHeaders());<a name="line.178"></a> +<span class="sourceLineNo">179</span> addDefaultResponseHeaders(r.defaultResponseHeaders());<a name="line.179"></a> +<span class="sourceLineNo">180</span> addResponseHandlers(r.responseHandlers());<a name="line.180"></a> +<span class="sourceLineNo">181</span> addConverters(r.converters());<a name="line.181"></a> +<span class="sourceLineNo">182</span> addGuards(reverse(r.guards()));<a name="line.182"></a> +<span class="sourceLineNo">183</span> addChildResources(r.children());<a name="line.183"></a> +<span class="sourceLineNo">184</span> addBeanFilters(r.beanFilters());<a name="line.184"></a> +<span class="sourceLineNo">185</span> addPojoSwaps(r.pojoSwaps());<a name="line.185"></a> +<span class="sourceLineNo">186</span> if (! r.stylesheet().isEmpty())<a name="line.186"></a> +<span class="sourceLineNo">187</span> setStyleSheet(c, r.stylesheet());<a name="line.187"></a> +<span class="sourceLineNo">188</span> if (! r.favicon().isEmpty())<a name="line.188"></a> +<span class="sourceLineNo">189</span> setFavIcon(c, r.favicon());<a name="line.189"></a> +<span class="sourceLineNo">190</span> if (! r.staticFiles().isEmpty())<a name="line.190"></a> +<span class="sourceLineNo">191</span> addStaticFiles(c, r.staticFiles());<a name="line.191"></a> +<span class="sourceLineNo">192</span> if (! r.path().isEmpty())<a name="line.192"></a> +<span class="sourceLineNo">193</span> setPath(r.path());<a name="line.193"></a> +<span class="sourceLineNo">194</span> if (! r.clientVersionHeader().isEmpty())<a name="line.194"></a> +<span class="sourceLineNo">195</span> setClientVersionHeader(r.clientVersionHeader());<a name="line.195"></a> +<span class="sourceLineNo">196</span> if (! r.pageTitle().isEmpty())<a name="line.196"></a> +<span class="sourceLineNo">197</span> setPageTitle(r.pageTitle());<a name="line.197"></a> +<span class="sourceLineNo">198</span> if (! r.pageText().isEmpty())<a name="line.198"></a> +<span class="sourceLineNo">199</span> setPageText(r.pageText());<a name="line.199"></a> +<span class="sourceLineNo">200</span> if (! r.pageLinks().isEmpty())<a name="line.200"></a> +<span class="sourceLineNo">201</span> setPageLinks(r.pageLinks());<a name="line.201"></a> +<span class="sourceLineNo">202</span> if (r.resourceResolver() != RestResourceResolver.class)<a name="line.202"></a> +<span class="sourceLineNo">203</span> setResourceResolver(r.resourceResolver());<a name="line.203"></a> +<span class="sourceLineNo">204</span> if (r.logger() != RestLogger.Normal.class)<a name="line.204"></a> +<span class="sourceLineNo">205</span> setLogger(r.logger());<a name="line.205"></a> +<span class="sourceLineNo">206</span> if (r.callHandler() != RestCallHandler.class)<a name="line.206"></a> +<span class="sourceLineNo">207</span> setCallHandler(r.callHandler());<a name="line.207"></a> +<span class="sourceLineNo">208</span> if (r.infoProvider() != RestInfoProvider.class)<a name="line.208"></a> +<span class="sourceLineNo">209</span> setInfoProvider(r.infoProvider());<a name="line.209"></a> +<span class="sourceLineNo">210</span> }<a name="line.210"></a> +<span class="sourceLineNo">211</span><a name="line.211"></a> +<span class="sourceLineNo">212</span> addResponseHandlers(<a name="line.212"></a> +<span class="sourceLineNo">213</span> StreamableHandler.class,<a name="line.213"></a> +<span class="sourceLineNo">214</span> WritableHandler.class,<a name="line.214"></a> +<span class="sourceLineNo">215</span> ReaderHandler.class,<a name="line.215"></a> +<span class="sourceLineNo">216</span> InputStreamHandler.class,<a name="line.216"></a> +<span class="sourceLineNo">217</span> RedirectHandler.class,<a name="line.217"></a> +<span class="sourceLineNo">218</span> DefaultHandler.class<a name="line.218"></a> +<span class="sourceLineNo">219</span> );<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> addMimeTypes(<a name="line.221"></a> +<span class="sourceLineNo">222</span> "text/css css CSS",<a name="line.222"></a> +<span class="sourceLineNo">223</span> "text/html html htm HTML",<a name="line.223"></a> +<span class="sourceLineNo">224</span> "text/plain txt text TXT",<a name="line.224"></a> +<span class="sourceLineNo">225</span> "application/javascript js",<a name="line.225"></a> +<span class="sourceLineNo">226</span> "image/png png",<a name="line.226"></a> +<span class="sourceLineNo">227</span> "image/gif gif",<a name="line.227"></a> +<span class="sourceLineNo">228</span> "application/xml xml XML",<a name="line.228"></a> +<span class="sourceLineNo">229</span> "application/json json JSON"<a name="line.229"></a> +<span class="sourceLineNo">230</span> );<a name="line.230"></a> +<span class="sourceLineNo">231</span> } catch (Exception e) {<a name="line.231"></a> +<span class="sourceLineNo">232</span> throw new ServletException(e);<a name="line.232"></a> +<span class="sourceLineNo">233</span> }<a name="line.233"></a> +<span class="sourceLineNo">234</span> }<a name="line.234"></a> +<span class="sourceLineNo">235</span><a name="line.235"></a> +<span class="sourceLineNo">236</span> /**<a name="line.236"></a> +<span class="sourceLineNo">237</span> * Adds the specified {@link Var} classes to this config.<a name="line.237"></a> +<span class="sourceLineNo">238</span> * <p><a name="line.238"></a> +<span class="sourceLineNo">239</span> * These variables affect the variable resolver returned by {@link RestRequest#getVarResolverSession()} which is<a name="line.239"></a> +<span class="sourceLineNo">240</span> * used to resolve string variables of the form <js>"$X{...}"</js>.<a name="line.240"></a> +<span class="sourceLineNo">241</span> * <p><a name="line.241"></a> +<span class="sourceLineNo">242</span> * By default, this config includes the following variables:<a name="line.242"></a> +<span class="sourceLineNo">243</span> * <ul class='spaced-list'><a name="line.243"></a> +<span class="sourceLineNo">244</span> * <li>{@link SystemPropertiesVar}<a name="line.244"></a> +<span class="sourceLineNo">245</span> * <li>{@link EnvVariablesVar}<a name="line.245"></a> +<span class="sourceLineNo">246</span> * <li>{@link ConfigFileVar}<a name="line.246"></a> +<span class="sourceLineNo">247</span> * <li>{@link IfVar}<a name="line.247"></a> +<span class="sourceLineNo">248</span> * <li>{@link SwitchVar}<a name="line.248"></a> +<span class="sourceLineNo">249</span> * </ul><a name="line.249"></a> +<span class="sourceLineNo">250</span> * <p><a name="line.250"></a> +<span class="sourceLineNo">251</span> * Later during the construction of {@link RestContext}, we add the following variables:<a name="line.251"></a> +<span class="sourceLineNo">252</span> * <ul><a name="line.252"></a> +<span class="sourceLineNo">253</span> * <li>{@link LocalizationVar}<a name="line.253"></a> +<span class="sourceLineNo">254</span> * <li>{@link RequestVar}<a name="line.254"></a> +<span class="sourceLineNo">255</span> * <li>{@link SerializedRequestAttrVar}<a name="line.255"></a> +<span class="sourceLineNo">256</span> * <li>{@link ServletInitParamVar}<a name="line.256"></a> +<span class="sourceLineNo">257</span> * <li>{@link UrlEncodeVar}<a name="line.257"></a> +<span class="sourceLineNo">258</span> * </ul><a name="line.258"></a> +<span class="sourceLineNo">259</span> *<a name="line.259"></a> +<span class="sourceLineNo">260</span> * @param vars The {@link Var} classes to add to this config.<a name="line.260"></a> +<span class="sourceLineNo">261</span> * @return This object (for method chaining).<a name="line.261"></a> +<span class="sourceLineNo">262</span> */<a name="line.262"></a> +<span class="sourceLineNo">263</span> public RestConfig addVars(Class<?>...vars) {<a name="line.263"></a> +<span class="sourceLineNo">264</span> this.varResolverBuilder.vars(vars);<a name="line.264"></a> +<span class="sourceLineNo">265</span> return this;<a name="line.265"></a> +<span class="sourceLineNo">266</span> }<a name="line.266"></a> +<span class="sourceLineNo">267</span><a name="line.267"></a> +<span class="sourceLineNo">268</span> /**<a name="line.268"></a> +<span class="sourceLineNo">269</span> * Adds a var context object to this config.<a name="line.269"></a> +<span class="sourceLineNo">270</span> * <p><a name="line.270"></a> +<span class="sourceLineNo">271</span> * Var context objects are read-only objects associated with the variable resolver for<a name="line.271"></a> +<span class="sourceLineNo">272</span> * vars that require external information.<a name="line.272"></a> +<span class="sourceLineNo">273</span> * <p><a name="line.273"></a> +<span class="sourceLineNo">274</span> * For example, the {@link ConfigFileVar} needs access to this resource's {@link ConfigFile} through the {@link ConfigFileVar#SESSION_config}<a name="line.274"></a> +<span class="sourceLineNo">275</span> * object that can be specified as either a session object (temporary) or context object (permanent).<a name="line.275"></a> +<span class="sourceLineNo">276</span> * In this case, we call the following code to add it to the context map:<a name="line.276"></a> +<span class="sourceLineNo">277</span> * <p class='bcode'><a name="line.277"></a> +<span class="sourceLineNo">278</span> * config.addVarContextObject(<jsf>SESSION_config</jsf>, configFile);<a name="line.278"></a> +<span class="sourceLineNo">279</span> * </p><a name="line.279"></a> +<span class="sourceLineNo">280</span> *<a name="line.280"></a> +<span class="sourceLineNo">281</span> * @param name The context object key (i.e. the name that the Var class looks for).<a name="line.281"></a> +<span class="sourceLineNo">282</span> * @param object The context object.<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @return This object (for method chaining).<a name="line.283"></a> +<span class="sourceLineNo">284</span> */<a name="line.284"></a> +<span class="sourceLineNo">285</span> public RestConfig addVarContextObject(String name, Object object) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> this.varResolverBuilder.contextObject(name, object);<a name="line.286"></a> +<span class="sourceLineNo">287</span> return this;<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> /**<a name="line.290"></a> +<span class="sourceLineNo">291</span> * Overwrites the default config file with a custom config file.<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <p><a name="line.292"></a> +<span class="sourceLineNo">293</span> * By default, the config file is determined using the {@link RestResource#config() @RestResource.config()} annotation.<a name="line.293"></a> +<span class="sourceLineNo">294</span> * This method allows you to programmatically override it with your own custom config file.<a name="line.294"></a> +<span class="sourceLineNo">295</span> *<a name="line.295"></a> +<span class="sourceLineNo">296</span> * @param configFile The new config file.<a name="line.296"></a> +<span class="sourceLineNo">297</span> * @return This object (for method chaining).<a name="line.297"></a> +<span class="sourceLineNo">298</span> */<a name="line.298"></a> +<span class="sourceLineNo">299</span> public RestConfig setConfigFile(ConfigFile configFile) {<a name="line.299"></a> +<span class="sourceLineNo">300</span> this.configFile = configFile;<a name="line.300"></a> +<span class="sourceLineNo">301</span> return this;<a name="line.301"></a> +<span class="sourceLineNo">302</span> }<a name="line.302"></a> +<span class="sourceLineNo">303</span><a name="line.303"></a> +<span class="sourceLineNo">304</span> /**<a name="line.304"></a> +<span class="sourceLineNo">305</span> * Sets a property on this resource.<a name="line.305"></a> +<span class="sourceLineNo">306</span> * <p><a name="line.306"></a> +<span class="sourceLineNo">307</span> * This is the programmatic equivalent to the {@link RestResource#properties()} annotation.<a name="line.307"></a> +<span class="sourceLineNo">308</span> *<a name="line.308"></a> +<span class="sourceLineNo">309</span> * @param key The property name.<a name="line.309"></a> +<span class="sourceLineNo">310</span> * @param value The property value.<a name="line.310"></a> +<span class="sourceLineNo">311</span> * @return This object (for method chaining).<a name="line.311"></a> +<span class="sourceLineNo">312</span> */<a name="line.312"></a> +<span class="sourceLineNo">313</span> public RestConfig setProperty(String key, Object value) {<a name="line.313"></a> +<span class="sourceLineNo">314</span> this.properties.put(key, value);<a name="line.314"></a> +<span class="sourceLineNo">315</span> return this;<a name="line.315"></a> +<span class="sourceLineNo">316</span> }<a name="line.316"></a> +<span class="sourceLineNo">317</span><a name="line.317"></a> +<span class="sourceLineNo">318</span> /**<a name="line.318"></a> +<span class="sourceLineNo">319</span> * Sets multiple properties on this resource.<a name="line.319"></a> +<span class="sourceLineNo">320</span> * <p><a name="line.320"></a> +<span class="sourceLineNo">321</span> * This is the programmatic equivalent to the {@link RestResource#properties() @RestResource.properties()} annotation.<a name="line.321"></a> +<span class="sourceLineNo">322</span> * <p><a name="line.322"></a> +<span class="sourceLineNo">323</span> * Values in the map are added to the existing properties and are overwritten if duplicates are found.<a name="line.323"></a> +<span class="sourceLineNo">324</span> *<a name="line.324"></a> +<span class="sourceLineNo">325</span> * @param properties The new properties to add to this config.<a name="line.325"></a> +<span class="sourceLineNo">326</span> * @return This object (for method chaining).<a name="line.326"></a> +<span class="sourceLineNo">327</span> */<a name="line.327"></a> +<span class="sourceLineNo">328</span> public RestConfig setProperties(Map<String,Object> properties) {<a name="line.328"></a> +<span class="sourceLineNo">329</span> this.properties.putAll(properties);<a name="line.329"></a> +<span class="sourceLineNo">330</span> return this;<a name="line.330"></a> +<span class="sourceLineNo">331</span> }<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> * Adds class-level bean filters to this resource.<a name="line.334"></a> +<span class="sourceLineNo">335</span> * <p><a name="line.335"></a> +<span class="sourceLineNo">336</span> * This is the programmatic equivalent to the {@link RestResource#beanFilters() @RestResource.beanFilters()} annotation.<a name="line.336"></a> +<span class="sourceLineNo">337</span> * <p><a name="line.337"></a> +<span class="sourceLineNo">338</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.338"></a> +<span class="sourceLineNo">339</span> *<a name="line.339"></a> +<span class="sourceLineNo">340</span> * @param beanFilters The bean filters to add to this config.<a name="line.340"></a> +<span class="sourceLineNo">341</span> * @return This object (for method chaining).<a name="line.341"></a> +<span class="sourceLineNo">342</span> */<a name="line.342"></a> +<span class="sourceLineNo">343</span> public RestConfig addBeanFilters(Class<?>...beanFilters) {<a name="line.343"></a> +<span class="sourceLineNo">344</span> this.beanFilters.addAll(Arrays.asList(beanFilters));<a name="line.344"></a> +<span class="sourceLineNo">345</span> return this;<a name="line.345"></a> +<span class="sourceLineNo">346</span> }<a name="line.346"></a> +<span class="sourceLineNo">347</span><a name="line.347"></a> +<span class="sourceLineNo">348</span> /**<a name="line.348"></a> +<span class="sourceLineNo">349</span> * Adds class-level pojo swaps to this resource.<a name="line.349"></a> +<span class="sourceLineNo">350</span> * <p><a name="line.350"></a> +<span class="sourceLineNo">351</span> * This is the programmatic equivalent to the {@link RestResource#pojoSwaps() @RestResource.pojoSwaps()} annotation.<a name="line.351"></a> +<span class="sourceLineNo">352</span> * <p><a name="line.352"></a> +<span class="sourceLineNo">353</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.353"></a> +<span class="sourceLineNo">354</span> *<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @param pojoSwaps The pojo swaps to add to this config.<a name="line.355"></a> +<span class="sourceLineNo">356</span> * @return This object (for method chaining).<a name="line.356"></a> +<span class="sourceLineNo">357</span> */<a name="line.357"></a> +<span class="sourceLineNo">358</span> public RestConfig addPojoSwaps(Class<?>...pojoSwaps) {<a name="line.358"></a> +<span class="sourceLineNo">359</span> this.pojoSwaps.addAll(Arrays.asList(pojoSwaps));<a name="line.359"></a> +<span class="sourceLineNo">360</span> return this;<a name="line.360"></a> +<span class="sourceLineNo">361</span> }<a name="line.361"></a> +<span class="sourceLineNo">362</span><a name="line.362"></a> +<span class="sourceLineNo">363</span> /**<a name="line.363"></a> +<span class="sourceLineNo">364</span> * Adds class-level serializers to this resource.<a name="line.364"></a> +<span class="sourceLineNo">365</span> * <p><a name="line.365"></a> +<span class="sourceLineNo">366</span> * This is the programmatic equivalent to the {@link RestResource#serializers() @RestResource.serializers()} annotation.<a name="line.366"></a> +<span class="sourceLineNo">367</span> * <p><a name="line.367"></a> +<span class="sourceLineNo">368</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.368"></a> +<span class="sourceLineNo">369</span> *<a name="line.369"></a> +<span class="sourceLineNo">370</span> * @param serializers The serializer classes to add to this config.<a name="line.370"></a> +<span class="sourceLineNo">371</span> * @return This object (for method chaining).<a name="line.371"></a> +<span class="sourceLineNo">372</span> */<a name="line.372"></a> +<span class="sourceLineNo">373</span> public RestConfig addSerializers(Class<?>...serializers) {<a name="line.373"></a> +<span class="sourceLineNo">374</span> this.serializers.append(serializers);<a name="line.374"></a> +<span class="sourceLineNo">375</span> return this;<a name="line.375"></a> +<span class="sourceLineNo">376</span> }<a name="line.376"></a> +<span class="sourceLineNo">377</span><a name="line.377"></a> +<span class="sourceLineNo">378</span> /**<a name="line.378"></a> +<span class="sourceLineNo">379</span> * Adds class-level serializers to this resource.<a name="line.379"></a> +<span class="sourceLineNo">380</span> * <p><a name="line.380"></a> +<span class="sourceLineNo">381</span> * Same as {@link #addSerializers(Class...)} except allows you to pass in serializer instances.<a name="line.381"></a> +<span class="sourceLineNo">382</span> * The actual serializer ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config:<a name="line.382"></a> +<span class="sourceLineNo">383</span> * <p class='bcode'><a name="line.383"></a> +<span class="sourceLineNo">384</span> * serializer = serializer.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();<a name="line.384"></a> +<span class="sourceLineNo">385</span> * </p><a name="line.385"></a> +<span class="sourceLineNo">386</span> * <p><a name="line.386"></a> +<span class="sourceLineNo">387</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.387"></a> +<span class="sourceLineNo">388</span> *<a name="line.388"></a> +<span class="sourceLineNo">389</span> * @param serializers The serializers to add to this config.<a name="line.389"></a> +<span class="sourceLineNo">390</span> * @return This object (for method chaining).<a name="line.390"></a> +<span class="sourceLineNo">391</span> */<a name="line.391"></a> +<span class="sourceLineNo">392</span> public RestConfig addSerializers(Serializer...serializers) {<a name="line.392"></a> +<span class="sourceLineNo">393</span> this.serializers.append(serializers);<a name="line.393"></a> +<span class="sourceLineNo">394</span> return this;<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> * Adds class-level parsers to this resource.<a name="line.398"></a> +<span class="sourceLineNo">399</span> * <p><a name="line.399"></a> +<span class="sourceLineNo">400</span> * This is the programmatic equivalent to the {@link RestResource#parsers() @RestResource.parsers()} annotation.<a name="line.400"></a> +<span class="sourceLineNo">401</span> * <p><a name="line.401"></a> +<span class="sourceLineNo">402</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.402"></a> +<span class="sourceLineNo">403</span> *<a name="line.403"></a> +<span class="sourceLineNo">404</span> * @param parsers The parser classes to add to this config.<a name="line.404"></a> +<span class="sourceLineNo">405</span> * @return This object (for method chaining).<a name="line.405"></a> +<span class="sourceLineNo">406</span> */<a name="line.406"></a> +<span class="sourceLineNo">407</span> public RestConfig addParsers(Class<?>...parsers) {<a name="line.407"></a> +<span class="sourceLineNo">408</span> this.parsers.append(parsers);<a name="line.408"></a> +<span class="sourceLineNo">409</span> return this;<a name="line.409"></a> +<span class="sourceLineNo">410</span> }<a name="line.410"></a> +<span class="sourceLineNo">411</span><a name="line.411"></a> +<span class="sourceLineNo">412</span> /**<a name="line.412"></a> +<span class="sourceLineNo">413</span> * Adds class-level parsers to this resource.<a name="line.413"></a> +<span class="sourceLineNo">414</span> * <p><a name="line.414"></a> +<span class="sourceLineNo">415</span> * Same as {@link #addParsers(Class...)} except allows you to pass in parser instances.<a name="line.415"></a> +<span class="sourceLineNo">416</span> * The actual parser ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config:<a name="line.416"></a> +<span class="sourceLineNo">417</span> * <p class='bcode'><a name="line.417"></a> +<span class="sourceLineNo">418</span> * parser = parser.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();<a name="line.418"></a> +<span class="sourceLineNo">419</span> * </p><a name="line.419"></a> +<span class="sourceLineNo">420</span> * <p><a name="line.420"></a> +<span class="sourceLineNo">421</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.421"></a> +<span class="sourceLineNo">422</span> *<a name="line.422"></a> +<span class="sourceLineNo">423</span> * @param parsers The parsers to add to this config.<a name="line.423"></a> +<span class="sourceLineNo">424</span> * @return This object (for method chaining).<a name="line.424"></a> +<span class="sourceLineNo">425</span> */<a name="line.425"></a> +<span class="sourceLineNo">426</span> public RestConfig addParsers(Parser...parsers) {<a name="line.426"></a> +<span class="sourceLineNo">427</span> this.parsers.append(parsers);<a name="line.427"></a> +<span class="sourceLineNo">428</span> return this;<a name="line.428"></a> +<span class="sourceLineNo">429</span> }<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> * Adds class-level encoders to this resource.<a name="line.432"></a> +<span class="sourceLineNo">433</span> * <p><a name="line.433"></a> +<span class="sourceLineNo">434</span> * This is the programmatic equivalent to the {@link RestResource#encoders() @RestResource.encoders()} annotation.<a name="line.434"></a> +<span class="sourceLineNo">435</span> * <p><a name="line.435"></a> +<span class="sourceLineNo">436</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.436"></a> +<span class="sourceLineNo">437</span> * <p><a name="line.437"></a> +<span class="sourceLineNo">438</span> * By default, only the {@link IdentityEncoder} is included in this list.<a name="line.438"></a> +<span class="sourceLineNo">439</span> *<a name="line.439"></a> +<span class="sourceLineNo">440</span> * @param encoders The parser classes to add to this config.<a name="line.440"></a> +<span class="sourceLineNo">441</span> * @return This object (for method chaining).<a name="line.441"></a> +<span class="sourceLineNo">442</span> */<a name="line.442"></a> +<span class="sourceLineNo">443</span> public RestConfig addEncoders(Class<?>...encoders) {<a name="line.443"></a> +<span class="sourceLineNo">444</span> this.encoders.append(encoders);<a name="line.444"></a> +<span class="sourceLineNo">445</span> return this;<a name="line.445"></a> +<span class="sourceLineNo">446</span> }<a name="line.446"></a> +<span class="sourceLineNo">447</span><a name="line.447"></a> +<span class="sourceLineNo">448</span> /**<a name="line.448"></a> +<span class="sourceLineNo">449</span> * Adds class-level encoders to this resource.<a name="line.449"></a> +<span class="sourceLineNo">450</span> * <p><a name="line.450"></a> +<span class="sourceLineNo">451</span> * Same as {@link #addEncoders(Class...)} except allows you to pass in encoder instances.<a name="line.451"></a> +<span class="sourceLineNo">452</span> *<a name="line.452"></a> +<span class="sourceLineNo">453</span> * @param encoders The encoders to add to this config.<a name="line.453"></a> +<span class="sourceLineNo">454</span> * @return This object (for method chaining).<a name="line.454"></a> +<span class="sourceLineNo">455</span> */<a name="line.455"></a> +<span class="sourceLineNo">456</span> public RestConfig addEncoders(Encoder...encoders) {<a name="line.456"></a> +<span class="sourceLineNo">457</span> this.encoders.append(encoders);<a name="line.457"></a> +<span class="sourceLineNo">458</span> return this;<a name="line.458"></a> +<span class="sourceLineNo">459</span> }<a name="line.459"></a> +<span class="sourceLineNo">460</span><a name="line.460"></a> +<span class="sourceLineNo">461</span> /**<a name="line.461"></a> +<span class="sourceLineNo">462</span> * Adds class-level converters to this resource.<a name="line.462"></a> +<span class="sourceLineNo">463</span> * <p><a name="line.463"></a> +<span class="sourceLineNo">464</span> * This is the programmatic equivalent to the {@link RestResource#converters() @RestResource.converters()} annotation.<a name="line.464"></a> +<span class="sourceLineNo">465</span> * <p><a name="line.465"></a> +<span class="sourceLineNo">466</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.466"></a> +<span class="sourceLineNo">467</span> * <p><a name="line.467"></a> +<span class="sourceLineNo">468</span> * By default, this config includes the following converters:<a name="line.468"></a> +<span class="sourceLineNo">469</span> * <ul class='spaced-list'><a name="line.469"></a> +<span class="sourceLineNo">470</span> * <li>{@link StreamableHandler}<a name="line.470"></a> +<span class="sourceLineNo">471</span> * <li>{@link WritableHandler}<a name="line.471"></a> +<span class="sourceLineNo">472</span> * <li>{@link ReaderHandler}<a name="line.472"></a> +<span class="sourceLineNo">473</span> * <li>{@link InputStreamHandler}<a name="line.473"></a> +<span class="sourceLineNo">474</span> * <li>{@link RedirectHandler}<a name="line.474"></a> +<span class="sourceLineNo">475</span> * <li>{@link DefaultHandler}<a name="line.475"></a> +<span class="sourceLineNo">476</span> * </ul><a name="line.476"></a> +<span class="sourceLineNo">477</span> *<a name="line.477"></a> +<span class="sourceLineNo">478</span> * @param converters The converter classes to add to this config.<a name="line.478"></a> +<span class="sourceLineNo">479</span> * @return This object (for method chaining).<a name="line.479"></a> +<span class="sourceLineNo">480</span> */<a name="line.480"></a> +<span class="sourceLineNo">481</span> public RestConfig addConverters(Class<?>...converters) {<a name="line.481"></a> +<span class="sourceLineNo">482</span> this.converters.addAll(Arrays.asList(converters));<a name="line.482"></a> +<span class="sourceLineNo">483</span> return this;<a name="line.483"></a> +<span class="sourceLineNo">484</span> }<a name="line.484"></a> +<span class="sourceLineNo">485</span><a name="line.485"></a> +<span class="sourceLineNo">486</span> /**<a name="line.486"></a> +<span class="sourceLineNo">487</span> * Adds class-level encoders to this resource.<a name="line.487"></a> +<span class="sourceLineNo">488</span> * <p><a name="line.488"></a> +<span class="sourceLineNo">489</span> * Same as {@link #addConverters(Class...)} except allows you to pass in converter instances.<a name="line.489"></a> +<span class="sourceLineNo">490</span> *<a name="line.490"></a> +<span class="sourceLineNo">491</span> * @param converters The converters to add to this config.<a name="line.491"></a> +<span class="sourceLineNo">492</span> * @return This object (for method chaining).<a name="line.492"></a> +<span class="sourceLineNo">493</span> */<a name="line.493"></a> +<span class="sourceLineNo">494</span> public RestConfig addConverters(RestConverter...converters) {<a name="line.494"></a> +<span class="sourceLineNo">495</span> this.converters.addAll(Arrays.asList(converters));<a name="line.495"></a> +<span class="sourceLineNo">496</span> return this;<a name="line.496"></a> +<span class="sourceLineNo">497</span> }<a name="line.497"></a> +<span class="sourceLineNo">498</span><a name="line.498"></a> +<span class="sourceLineNo">499</span> /**<a name="line.499"></a> +<span class="sourceLineNo">500</span> * Adds class-level guards to this resource.<a name="line.500"></a> +<span class="sourceLineNo">501</span> * <p><a name="line.501"></a> +<span class="sourceLineNo">502</span> * This is the programmatic equivalent to the {@link RestResource#guards() @RestResource.guards()} annotation.<a name="line.502"></a> +<span class="sourceLineNo">503</span> * <p><a name="line.503"></a> +<span class="sourceLineNo">504</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.<a name="line.504"></a> +<span class="sourceLineNo">505</span> *<a name="line.505"></a> +<span class="sourceLineNo">506</span> * @param guards The guard classes to add to this config.<a name="line.506"></a> +<span class="sourceLineNo">507</span> * @return This object (for method chaining).<a name="line.507"></a> +<span class="sourceLineNo">508</span> */<a name="line.508"></a> +<span class="sourceLineNo">509</span> public RestConfig addGuards(Class<?>...guards) {<a name="line.509"></a> +<span class="sourceLineNo">510</span> this.guards.addAll(Arrays.asList(guards));<a name="line.510"></a> +<span class="sourceLineNo">511</span> return this;<a name="line.511"></a> +<span class="sourceLineNo">512</span> }<a name="line.512"></a> +<span class="sourceLineNo">513</span><a name="line.513"></a> +<span class="sourceLineNo">514</span> /**<a name="line.514"></a> +<span class="sourceLineNo">515</span> * Adds class-level guards to this resource.<a name="line.515"></a> +<span class="sourceLineNo">516</span> * <p><a name="line.516"></a> +<span class="sourceLineNo">517</span> * Same as {@link #addGuards(Class...)} except allows you to pass in guard instances.<a name="line.517"></a> +<span class="sourceLineNo">518</span> *<a name="line.518"></a> +<span class="sourceLineNo">519</span> * @param guards The guards to add to this config.<a name="line.519"></a> +<span class="sourceLineNo">520</span> * @return This object (for method chaining).<a name="line.520"></a> +<span class="sourceLineNo">521</span> */<a name="line.521"></a> +<span class="sourceLineNo">522</span> public RestConfig addGuards(RestGuard...guards) {<a name="line.522"></a> +<span class="sourceLineNo">523</span> this.guards.addAll(Arrays.asList(guards));<a name="line.523"></a> +<span class="sourceLineNo">524</span> return this;<a name="line.524"></a> +<span class="sourceLineNo">525</span> }<a name="line.525"></a> +<span class="sourceLineNo">526</span><a name="line.526"></a> +<span class="sourceLineNo">527</span> /**<a name="line.527"></a> +<span class="sourceLineNo">528</span> * Adds MIME-type definitions.<a name="line.528"></a> <span class="sourceLineNo">529</span> * <p><a name="line.529"></a> -<span class="sourceLineNo">530</span> * By default, this config includes the following mime-type definitions:<a name="line.530"></a> -<span class="sourceLineNo">531</span> * <ul class='spaced-list'><a name="line.531"></a> -<span class="sourceLineNo">532</span> * <li><js>"text/css css CSS"</js><a name="line.532"></a> -<span class="sourceLineNo">533</span> * <li><js>"text/html html htm HTML"</js><a name="line.533"></a> -<span class="sourceLineNo">534</span> * <li><js>"text/plain txt text TXT"</js><a name="line.534"></a> -<span class="sourceLineNo">535</span> * <li><js>"application/javascript js"</js><a name="line.535"></a> -<span class="sourceLineNo">536</span> * <li><js>"image/png png"</js><a name="line.536"></a> -<span class="sourceLineNo">537</span> * <li><js>"image/gif gif"</js><a name="line.537"></a> -<span class="sourceLineNo">538</span> * <li><js>"application/xml xml XML"</js><a name="line.538"></a> -<span class="sourceLineNo">539</span> * <li><js>"application/json json JSON"</js><a name="line.539"></a> -<span class="sourceLineNo">540</span> * </ul><a name="line.540"></a> -<span class="sourceLineNo">541</span> *<a name="line.541"></a> -<span class="sourceLineNo">542</span> * @param mimeTypes The MIME-types to add to this config.<a name="line.542"></a> -<span class="sourceLineNo">543</span> * @return This object (for method chaining).<a name="line.543"></a> -<span class="sourceLineNo">544</span> */<a name="line.544"></a> -<span class="sourceLineNo">545</span> public RestConfig addMimeTypes(String...mimeTypes) {<a name="line.545"></a> -<span class="sourceLineNo">546</span> for (String mimeType : mimeTypes)<a name="line.546"></a> -<span class="sourceLineNo">547</span> this.mimeTypes.addMimeTypes(mimeType);<a name="line.547"></a> -<span class="sourceLineNo">548</span> return this;<a name="line.548"></a> -<span class="sourceLineNo">549</span> }<a name="line.549"></a> -<span class="sourceLineNo">550</span><a name="line.550"></a> -<span class="sourceLineNo">551</span> /**<a name="line.551"></a> -<span class="sourceLineNo">552</span> * Adds class-level default HTTP request headers to this resource.<a name="line.552"></a> -<span class="sourceLineNo">553</span> * <p><a name="line.553"></a> -<span class="sourceLineNo">554</span> * Default request headers are default values for when HTTP requests do not specify a header value.<a name="line.554"></a> -<span class="sourceLineNo">555</span> * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header value.<a name="line.555"></a> -<span class="sourceLineNo">556</span> * <p><a name="line.556"></a> -<span class="sourceLineNo">557</span> * This is the programmatic equivalent to the {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.<a name="line.557"></a> -<span class="sourceLineNo">558</span> *<a name="line.558"></a> -<span class="sourceLineNo">559</span> * @param name The HTTP header name.<a name="line.559"></a> -<span class="sourceLineNo">560</span> * @param value The HTTP header value.<a name="line.560"></a> -<span class="sourceLineNo">561</span> * @return This object (for method chaining).<a name="line.561"></a> -<span class="sourceLineNo">562</span> */<a name="line.562"></a> -<span class="sourceLineNo">563</span> public RestConfig addDefaultRequestHeader(String name, Object value) {<a name="line.563"></a> -<span class="sourceLineNo">564</span> this.defaultRequestHeaders.put(name, StringUtils.toString(value));<a name="line.564"></a> -<span class="sourceLineNo">565</span> return this;<a name="line.565"></a> -<span class="sourceLineNo">566</span> }<a name="line.566"></a> -<span class="sourceLineNo">567</span><a name="line.567"></a> -<span class="sourceLineNo">568</span> /**<a name="line.568"></a> -<span class="sourceLineNo">569</span> * Adds class-level default HTTP request headers to this resource.<a name="line.569"></a> -<span class="sourceLineNo">570</span> * <p><a name="line.570"></a> -<span class="sourceLineNo">571</span> * Default request headers are default values for when HTTP requests do not specify a header value.<a name="line.571"></a> -<span class="sourceLineNo">572</span> * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header value.<a name="line.572"></a> -<span class="sourceLineNo">573</span> * <p><a name="line.573"></a> -<span class="sourceLineNo">574</span> * This is the programmatic equivalent to the {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.<a name="line.574"></a> -<span class="sourceLineNo">575</span> *<a name="line.575"></a> -<span class="sourceLineNo">576</span> * @param headers HTTP headers of the form <js>"Name: Value"</js>.<a name="line.576"></a> -<span class="sourceLineNo">577</span> * @return This object (for method chaining).<a name="line.577"></a> -<span class="sourceLineNo">578</span> * @throws RestServletExcepti
<TRUNCATED>
